diff --git a/2025R2/rocky-prepost-scripting-manual/RAAirFlow.md b/2025R2/rocky-prepost-scripting-manual/RAAirFlow.md index ed16213271..483b176d9a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAAirFlow.md +++ b/2025R2/rocky-prepost-scripting-manual/RAAirFlow.md @@ -1,1275 +1,1276 @@ - - -# RAAirFlow - - - - - - -### *class* RAAirFlow - -Rocky PrePost Scripting wrapper for Lattice Boltzmann Air Flow. - -This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): - -```python -cfd_coupling = study.GetCFDCoupling() -cfd_coupling.SetupAirFlow() -airflow = cfd_coupling.GetAirFlow() -``` - -**Methods:** - -| [`AddCurve`](#generated.RAAirFlow.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAAirFlow.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.RAAirFlow.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAAirFlow.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAAirFlow.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.RAAirFlow.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAAirFlow.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAAirFlow.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.RAAirFlow.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.RAAirFlow.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.RAAirFlow.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.RAAirFlow.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAirDensity`](#generated.RAAirFlow.GetAirDensity)([unit]) | Get the value of "Air Density". | -| [`GetAirKinematicViscosity`](#generated.RAAirFlow.GetAirKinematicViscosity)([unit]) | Get the value of "Air Kinematic Viscosity". | -| [`GetBoundaryConditionType`](#generated.RAAirFlow.GetBoundaryConditionType)() | Get "Boundary Condition Type" as a string. | -| [`GetBoundingBox`](#generated.RAAirFlow.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAAirFlow.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAAirFlow.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAAirFlow.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAAirFlow.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAAirFlow.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAAirFlow.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAAirFlow.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellSize`](#generated.RAAirFlow.GetCellSize)([unit]) | Get the value of "Cell Size". | -| [`GetCellVolumeAsArray`](#generated.RAAirFlow.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAAirFlow.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAAirFlow.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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". | -| [`GetMaxZ`](#generated.RAAirFlow.GetMaxZ)([unit]) | Get the value of "Max Z". | -| [`GetMeshColoring`](#generated.RAAirFlow.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMinX`](#generated.RAAirFlow.GetMinX)([unit]) | Get the value of "Min X". | -| [`GetMinY`](#generated.RAAirFlow.GetMinY)([unit]) | Get the value of "Min Y". | -| [`GetMinZ`](#generated.RAAirFlow.GetMinZ)([unit]) | Get the value of "Min Z". | -| [`GetNumberOfCells`](#generated.RAAirFlow.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAAirFlow.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAAirFlow.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAAirFlow.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetSpeedOfSound`](#generated.RAAirFlow.GetSpeedOfSound)([unit]) | Get the value of "Speed of Sound". | -| [`GetStartTime`](#generated.RAAirFlow.GetStartTime)([unit]) | Get the value of "Start Time". | -| [`GetStartWhenParticlesEnter`](#generated.RAAirFlow.GetStartWhenParticlesEnter)() | Get the value of "Start When Particles Enter". | -| [`GetTimeSet`](#generated.RAAirFlow.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAAirFlow.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAAirFlow.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`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". | -| [`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. | -| [`IterCells`](#generated.RAAirFlow.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAAirFlow.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAAirFlow.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAAirFlow.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAAirFlow.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAAirFlow.RemoveProcess)() | Removes the process from the project. | -| [`SetAirDensity`](#generated.RAAirFlow.SetAirDensity)(value[, unit]) | Set the value of "Air Density". | -| [`SetAirKinematicViscosity`](#generated.RAAirFlow.SetAirKinematicViscosity)(value[, unit]) | Set the value of "Air Kinematic Viscosity". | -| [`SetBoundaryConditionType`](#generated.RAAirFlow.SetBoundaryConditionType)(value) | Set the value of "Boundary Condition Type". | -| [`SetCellSize`](#generated.RAAirFlow.SetCellSize)(value[, unit]) | Set the value of "Cell Size". | -| [`SetCurrentTimeStep`](#generated.RAAirFlow.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetInteractionScale`](#generated.RAAirFlow.SetInteractionScale)(value[, unit]) | Set the value of "Interaction Scale". | -| [`SetMaxX`](#generated.RAAirFlow.SetMaxX)(value[, unit]) | Set the value of "Max X". | -| [`SetMaxY`](#generated.RAAirFlow.SetMaxY)(value[, unit]) | Set the value of "Max Y". | -| [`SetMaxZ`](#generated.RAAirFlow.SetMaxZ)(value[, unit]) | Set the value of "Max Z". | -| [`SetMinX`](#generated.RAAirFlow.SetMinX)(value[, unit]) | Set the value of "Min X". | -| [`SetMinY`](#generated.RAAirFlow.SetMinY)(value[, unit]) | Set the value of "Min Y". | -| [`SetMinZ`](#generated.RAAirFlow.SetMinZ)(value[, unit]) | Set the value of "Min Z". | -| [`SetPartIdIfValid`](#generated.RAAirFlow.SetPartIdIfValid)() | Set the AirFlow's part_id, but only if AirFlow is enabled in the simulation. | -| [`SetSpeedOfSound`](#generated.RAAirFlow.SetSpeedOfSound)(value[, unit]) | Set the value of "Speed of Sound". | -| [`SetStartTime`](#generated.RAAirFlow.SetStartTime)(value[, unit]) | Set the value of "Start Time". | -| [`SetStartWhenParticlesEnter`](#generated.RAAirFlow.SetStartWhenParticlesEnter)(value) | Set the value of "Start When Particles Enter". | -| [`SetUseAirflow`](#generated.RAAirFlow.SetUseAirflow)(value) | Set the value of "Use Airflow". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAirDensity(unit: str | None = None) - -Get the value of “Air Density”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. - - - -#### GetAirKinematicViscosity(unit: str | None = None) - -Get the value of “Air Kinematic Viscosity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m2/s”. - - - -#### GetBoundaryConditionType() - -Get “Boundary Condition Type” as a string. - -* **Returns:** - The returned value will be one of [‘first_derivative’, ‘second_derivative’]. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellSize(unit: str | None = None) - -Get the value of “Cell Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetInteractionScale(unit: str | None = None) - -Get the value of “Interaction Scale”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetMaxX(unit: str | None = None) - -Get the value of “Max X”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMaxY(unit: str | None = None) - -Get the value of “Max Y”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMaxZ(unit: str | None = None) - -Get the value of “Max Z”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinX(unit: str | None = None) - -Get the value of “Min X”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMinY(unit: str | None = None) - -Get the value of “Min Y”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMinZ(unit: str | None = None) - -Get the value of “Min Z”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetSpeedOfSound(unit: str | None = None) - -Get the value of “Speed of Sound”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetStartWhenParticlesEnter() - -Get the value of “Start When Particles Enter”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetUseAirflow() - -Get the value of “Use Airflow”. - - - -#### GetValidBoundaryConditionTypeValues() - -Get a list of all possible values for “Boundary Condition Type”. - -* **Returns:** - The returned list is [‘first_derivative’, ‘second_derivative’]. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetAirDensity(value: str | float, unit: str | None = None) - -Set the value of “Air Density”. - -* **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 “kg/m3”. - - - -#### SetAirKinematicViscosity(value: str | float, unit: str | None = None) - -Set the value of “Air Kinematic Viscosity”. - -* **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 “m2/s”. - - - -#### SetBoundaryConditionType(value: str) - -Set the value of “Boundary Condition Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘first_derivative’, ‘second_derivative’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Boundary Condition Type” option. - - - -#### SetCellSize(value: str | float, unit: str | None = None) - -Set the value of “Cell Size”. - -* **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”. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetInteractionScale(value: str | float, unit: str | None = None) - -Set the value of “Interaction Scale”. - -* **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 “-“. - - - -#### SetMaxX(value: str | float, unit: str | None = None) - -Set the value of “Max X”. - -* **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”. - - - -#### SetMaxY(value: str | float, unit: str | None = None) - -Set the value of “Max Y”. - -* **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”. - - - -#### SetMaxZ(value: str | float, unit: str | None = None) - -Set the value of “Max Z”. - -* **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”. - - - -#### SetMinX(value: str | float, unit: str | None = None) - -Set the value of “Min X”. - -* **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”. - - - -#### SetMinY(value: str | float, unit: str | None = None) - -Set the value of “Min Y”. - -* **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”. - - - -#### SetMinZ(value: str | float, unit: str | None = None) - -Set the value of “Min Z”. - -* **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”. - - - -#### SetPartIdIfValid() - -Set the AirFlow’s part_id, but only if AirFlow is enabled in the simulation. - - - -#### SetSpeedOfSound(value: str | float, unit: str | None = None) - -Set the value of “Speed of Sound”. - -* **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/s”. - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetStartWhenParticlesEnter(value: bool) - -Set the value of “Start When Particles Enter”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseAirflow(value: bool) - -Set the value of “Use Airflow”. - -* **Parameters:** - **value** – The value to set. + + +# RAAirFlow + + + + + + +### *class* RAAirFlow + +Rocky PrePost Scripting wrapper for Lattice Boltzmann Air Flow. + +This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): + +```python +cfd_coupling = study.GetCFDCoupling() +cfd_coupling.SetupAirFlow() +airflow = cfd_coupling.GetAirFlow() +``` + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAAirFlow.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAAirFlow.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.RAAirFlow.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAAirFlow.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAAirFlow.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.RAAirFlow.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAAirFlow.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAAirFlow.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.RAAirFlow.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.RAAirFlow.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.RAAirFlow.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.RAAirFlow.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAirDensity`](#generated.RAAirFlow.GetAirDensity)([unit]) | Get the value of "Air Density". | +| [`GetAirKinematicViscosity`](#generated.RAAirFlow.GetAirKinematicViscosity)([unit]) | Get the value of "Air Kinematic Viscosity". | +| [`GetBoundaryConditionType`](#generated.RAAirFlow.GetBoundaryConditionType)() | Get "Boundary Condition Type" as a string. | +| [`GetBoundingBox`](#generated.RAAirFlow.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAAirFlow.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAAirFlow.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAAirFlow.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAAirFlow.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAAirFlow.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAAirFlow.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAAirFlow.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellSize`](#generated.RAAirFlow.GetCellSize)([unit]) | Get the value of "Cell Size". | +| [`GetCellVolumeAsArray`](#generated.RAAirFlow.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAAirFlow.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAAirFlow.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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". | +| [`GetMaxZ`](#generated.RAAirFlow.GetMaxZ)([unit]) | Get the value of "Max Z". | +| [`GetMeshColoring`](#generated.RAAirFlow.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMinX`](#generated.RAAirFlow.GetMinX)([unit]) | Get the value of "Min X". | +| [`GetMinY`](#generated.RAAirFlow.GetMinY)([unit]) | Get the value of "Min Y". | +| [`GetMinZ`](#generated.RAAirFlow.GetMinZ)([unit]) | Get the value of "Min Z". | +| [`GetNumberOfCells`](#generated.RAAirFlow.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAAirFlow.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAAirFlow.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAAirFlow.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetSpeedOfSound`](#generated.RAAirFlow.GetSpeedOfSound)([unit]) | Get the value of "Speed of Sound". | +| [`GetStartTime`](#generated.RAAirFlow.GetStartTime)([unit]) | Get the value of "Start Time". | +| [`GetStartWhenParticlesEnter`](#generated.RAAirFlow.GetStartWhenParticlesEnter)() | Get the value of "Start When Particles Enter". | +| [`GetTimeSet`](#generated.RAAirFlow.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAAirFlow.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAAirFlow.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`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". | +| [`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. | +| [`IterCells`](#generated.RAAirFlow.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAAirFlow.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAAirFlow.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAAirFlow.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAAirFlow.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAAirFlow.RemoveProcess)() | Removes the process from the project. | +| [`SetAirDensity`](#generated.RAAirFlow.SetAirDensity)(value[, unit]) | Set the value of "Air Density". | +| [`SetAirKinematicViscosity`](#generated.RAAirFlow.SetAirKinematicViscosity)(value[, unit]) | Set the value of "Air Kinematic Viscosity". | +| [`SetBoundaryConditionType`](#generated.RAAirFlow.SetBoundaryConditionType)(value) | Set the value of "Boundary Condition Type". | +| [`SetCellSize`](#generated.RAAirFlow.SetCellSize)(value[, unit]) | Set the value of "Cell Size". | +| [`SetCurrentTimeStep`](#generated.RAAirFlow.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetInteractionScale`](#generated.RAAirFlow.SetInteractionScale)(value[, unit]) | Set the value of "Interaction Scale". | +| [`SetMaxX`](#generated.RAAirFlow.SetMaxX)(value[, unit]) | Set the value of "Max X". | +| [`SetMaxY`](#generated.RAAirFlow.SetMaxY)(value[, unit]) | Set the value of "Max Y". | +| [`SetMaxZ`](#generated.RAAirFlow.SetMaxZ)(value[, unit]) | Set the value of "Max Z". | +| [`SetMinX`](#generated.RAAirFlow.SetMinX)(value[, unit]) | Set the value of "Min X". | +| [`SetMinY`](#generated.RAAirFlow.SetMinY)(value[, unit]) | Set the value of "Min Y". | +| [`SetMinZ`](#generated.RAAirFlow.SetMinZ)(value[, unit]) | Set the value of "Min Z". | +| [`SetPartIdIfValid`](#generated.RAAirFlow.SetPartIdIfValid)() | Set the AirFlow's part_id, but only if AirFlow is enabled in the simulation. | +| [`SetSpeedOfSound`](#generated.RAAirFlow.SetSpeedOfSound)(value[, unit]) | Set the value of "Speed of Sound". | +| [`SetStartTime`](#generated.RAAirFlow.SetStartTime)(value[, unit]) | Set the value of "Start Time". | +| [`SetStartWhenParticlesEnter`](#generated.RAAirFlow.SetStartWhenParticlesEnter)(value) | Set the value of "Start When Particles Enter". | +| [`SetUseAirflow`](#generated.RAAirFlow.SetUseAirflow)(value) | Set the value of "Use Airflow". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAirDensity(unit: str | None = None) + +Get the value of “Air Density”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. + + + +#### GetAirKinematicViscosity(unit: str | None = None) + +Get the value of “Air Kinematic Viscosity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m2/s”. + + + +#### GetBoundaryConditionType() + +Get “Boundary Condition Type” as a string. + +* **Returns:** + The returned value will be one of [‘first_derivative’, ‘second_derivative’]. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellSize(unit: str | None = None) + +Get the value of “Cell Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetInteractionScale(unit: str | None = None) + +Get the value of “Interaction Scale”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetMaxX(unit: str | None = None) + +Get the value of “Max X”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMaxY(unit: str | None = None) + +Get the value of “Max Y”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMaxZ(unit: str | None = None) + +Get the value of “Max Z”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinX(unit: str | None = None) + +Get the value of “Min X”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMinY(unit: str | None = None) + +Get the value of “Min Y”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMinZ(unit: str | None = None) + +Get the value of “Min Z”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetSpeedOfSound(unit: str | None = None) + +Get the value of “Speed of Sound”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetStartWhenParticlesEnter() + +Get the value of “Start When Particles Enter”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetUseAirflow() + +Get the value of “Use Airflow”. + + + +#### GetValidBoundaryConditionTypeValues() + +Get a list of all possible values for “Boundary Condition Type”. + +* **Returns:** + The returned list is [‘first_derivative’, ‘second_derivative’]. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetAirDensity(value: str | float, unit: str | None = None) + +Set the value of “Air Density”. + +* **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 “kg/m3”. + + + +#### SetAirKinematicViscosity(value: str | float, unit: str | None = None) + +Set the value of “Air Kinematic Viscosity”. + +* **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 “m2/s”. + + + +#### SetBoundaryConditionType(value: str) + +Set the value of “Boundary Condition Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘first_derivative’, ‘second_derivative’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Boundary Condition Type” option. + + + +#### SetCellSize(value: str | float, unit: str | None = None) + +Set the value of “Cell Size”. + +* **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”. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetInteractionScale(value: str | float, unit: str | None = None) + +Set the value of “Interaction Scale”. + +* **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 “-“. + + + +#### SetMaxX(value: str | float, unit: str | None = None) + +Set the value of “Max X”. + +* **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”. + + + +#### SetMaxY(value: str | float, unit: str | None = None) + +Set the value of “Max Y”. + +* **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”. + + + +#### SetMaxZ(value: str | float, unit: str | None = None) + +Set the value of “Max Z”. + +* **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”. + + + +#### SetMinX(value: str | float, unit: str | None = None) + +Set the value of “Min X”. + +* **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”. + + + +#### SetMinY(value: str | float, unit: str | None = None) + +Set the value of “Min Y”. + +* **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”. + + + +#### SetMinZ(value: str | float, unit: str | None = None) + +Set the value of “Min Z”. + +* **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”. + + + +#### SetPartIdIfValid() + +Set the AirFlow’s part_id, but only if AirFlow is enabled in the simulation. + + + +#### SetSpeedOfSound(value: str | float, unit: str | None = None) + +Set the value of “Speed of Sound”. + +* **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/s”. + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetStartWhenParticlesEnter(value: bool) + +Set the value of “Start When Particles Enter”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseAirflow(value: bool) + +Set the value of “Use Airflow”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RACFDCoupling.md b/2025R2/rocky-prepost-scripting-manual/RACFDCoupling.md index ef950dd099..9f7e0cd55f 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACFDCoupling.md +++ b/2025R2/rocky-prepost-scripting-manual/RACFDCoupling.md @@ -1,158 +1,159 @@ - - -# RACFDCoupling - - - - - - -### *class* RACFDCoupling - -Rocky PrePost Scripting wrapper to configure the CFD coupling mode in a project. - -This wrapper can be accessed directly via the project’s [`RAStudy`](RAStudy.md#generated.RAStudy): - -```python -cfd_coupling = study.GetCFDCoupling() -cfd_coupling.SetupFluentTwoWay('fluent.cas') -two_way_process = cfd_coupling.GetCouplingProcess() -``` - -**Methods:** - -| [`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() - -* **Return type:** - unicode -* **Returns:** - The current coupling mode - - - -#### GetCouplingProcess() - -* **Returns:** - The configured coupling process - - - -#### GetOneWayLBM() - -Get the PrePost Scripting wrapper for 1-Way LBM properties. - -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) - -Configure the project to use Fluent Two-Way Semi Resolved. - -* **Parameters:** - **cas_filename** – The filename describing the Fluent simulation - - - -#### SetupNoCoupling() - -Configure the project to use no CFD coupling. - - - -#### SetupOneWayConstant() - -Configure the project to use 1-Way Constant. - - - -#### SetupOneWayFluent(f2r_filename: str) - -Configure the project to use 1-Way Fluent. - -* **Parameters:** - **f2r_filename** – str - The exported file name describing the Fluent simulation - - - -#### SetupOneWayFluentSteadyState(f2r_filename: str) - -Deprecated: Use SetupOneWayFluent instead. - - - -#### SetupOneWayLBM() - -Configure the project to use 1-Way LBM. - - - -#### SetupTwoWayFluent(cas_filename: str) - -Configure the project to use 2-Way Fluent. - -* **Parameters:** - **cas_filename** – str - The Fluent file name describing the Fluent simulation + + +# RACFDCoupling + + + + + + +### *class* RACFDCoupling + +Rocky PrePost Scripting wrapper to configure the CFD coupling mode in a project. + +This wrapper can be accessed directly via the project’s [`RAStudy`](RAStudy.md#generated.RAStudy): + +```python +cfd_coupling = study.GetCFDCoupling() +cfd_coupling.SetupFluentTwoWay('fluent.cas') +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() + +* **Return type:** + unicode +* **Returns:** + The current coupling mode + + + +#### GetCouplingProcess() + +* **Returns:** + The configured coupling process + + + +#### GetOneWayLBM() + +Get the PrePost Scripting wrapper for 1-Way LBM properties. + +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) + +Configure the project to use Fluent Two-Way Semi Resolved. + +* **Parameters:** + **cas_filename** – The filename describing the Fluent simulation + + + +#### SetupNoCoupling() + +Configure the project to use no CFD coupling. + + + +#### SetupOneWayConstant() + +Configure the project to use 1-Way Constant. + + + +#### SetupOneWayFluent(f2r_filename: str) + +Configure the project to use 1-Way Fluent. + +* **Parameters:** + **f2r_filename** – str + The exported file name describing the Fluent simulation + + + +#### SetupOneWayFluentSteadyState(f2r_filename: str) + +Deprecated: Use SetupOneWayFluent instead. + + + +#### SetupOneWayLBM() + +Configure the project to use 1-Way LBM. + + + +#### SetupTwoWayFluent(cas_filename: str) + +Configure the project to use 2-Way Fluent. + +* **Parameters:** + **cas_filename** – str + The Fluent file name describing the Fluent simulation diff --git a/2025R2/rocky-prepost-scripting-manual/RACFDParametersList.md b/2025R2/rocky-prepost-scripting-manual/RACFDParametersList.md index b839da4753..475044ccbf 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACFDParametersList.md +++ b/2025R2/rocky-prepost-scripting-manual/RACFDParametersList.md @@ -1,73 +1,74 @@ - - -# RACFDParametersList - - - - - - -### *class* RACFDParametersList - -Rocky PrePost Scripting wrapper to manipulate the list of per-particle CFD parameters in a CFD coupling configuration. - -To get the [`RACFDParametersList`](#generated.RACFDParametersList) from a CFD coupling wrapper (such as [`RAConstantOneWayCoupling`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling), -`RAFluentOneWaySteadyCoupling`, or [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling)), use: - -```python -parameters_list = coupling_process.GetCFDParametersList() -``` - -The [`RACFDParametersList`](#generated.RACFDParametersList) class acts as a regular Python list, with the usual methods to iterate -and access individual parameter sets. Note that it’s not possible to add and remove items from the -list, as they are added and removed automatically as Particles are added or removed from the project. - -The items in the parameters list are of type [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters). - -**Methods:** - -| [`Clear`](#generated.RACFDParametersList.Clear)() | Overriden: Raises an error when called. | -|---------------------------------------------------------------------------------|-----------------------------------------------------| -| [`GetParametersFor`](#generated.RACFDParametersList.GetParametersFor)(particle) | Get the set of CFD parameters for a given Particle. | -| [`New`](#generated.RACFDParametersList.New)() | Overriden: Raises an error when called. | -| [`Remove`](#generated.RACFDParametersList.Remove)(item) | Overriden: Raises an error when called. | - - - -#### Clear() - -Overriden: Raises an error when called. - -RACFDPerParticleParameters are created and removed automatically when Particles are added -or removed. - - - -#### GetParametersFor(particle) - -Get the set of CFD parameters for a given Particle. - -* **Parameters:** - **particle** ([*RAParticle*](RAParticle.md#generated.RAParticle) *or* *str*) – Either the PrePost Scripting wrapper for a Particle, or the name of the Particle. -* **Return type:** - [RACFDPerParticleParameters](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - - - -#### New() - -Overriden: Raises an error when called. - -RACFDPerParticleParameters are created and removed automatically when Particles are added -or removed. - - - -#### Remove(item) - -Overriden: Raises an error when called. - -RACFDPerParticleParameters are created and removed automatically when Particles are added -or removed. + + +# RACFDParametersList + + + + + + +### *class* RACFDParametersList + +Rocky PrePost Scripting wrapper to manipulate the list of per-particle CFD parameters in a CFD coupling configuration. + +To get the [`RACFDParametersList`](#generated.RACFDParametersList) from a CFD coupling wrapper (such as [`RAConstantOneWayCoupling`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling), +`RAFluentOneWaySteadyCoupling`, or [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling)), use: + +```python +parameters_list = coupling_process.GetCFDParametersList() +``` + +The [`RACFDParametersList`](#generated.RACFDParametersList) class acts as a regular Python list, with the usual methods to iterate +and access individual parameter sets. Note that it’s not possible to add and remove items from the +list, as they are added and removed automatically as Particles are added or removed from the project. + +The items in the parameters list are of type [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters). + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------|-----------------------------------------------------| +| [`Clear`](#generated.RACFDParametersList.Clear)() | Overriden: Raises an error when called. | +| [`GetParametersFor`](#generated.RACFDParametersList.GetParametersFor)(particle) | Get the set of CFD parameters for a given Particle. | +| [`New`](#generated.RACFDParametersList.New)() | Overriden: Raises an error when called. | +| [`Remove`](#generated.RACFDParametersList.Remove)(item) | Overriden: Raises an error when called. | + + + +#### Clear() + +Overriden: Raises an error when called. + +RACFDPerParticleParameters are created and removed automatically when Particles are added +or removed. + + + +#### GetParametersFor(particle) + +Get the set of CFD parameters for a given Particle. + +* **Parameters:** + **particle** ([*RAParticle*](RAParticle.md#generated.RAParticle) *or* *str*) – Either the PrePost Scripting wrapper for a Particle, or the name of the Particle. +* **Return type:** + [RACFDPerParticleParameters](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + + + +#### New() + +Overriden: Raises an error when called. + +RACFDPerParticleParameters are created and removed automatically when Particles are added +or removed. + + + +#### Remove(item) + +Overriden: Raises an error when called. + +RACFDPerParticleParameters are created and removed automatically when Particles are added +or removed. diff --git a/2025R2/rocky-prepost-scripting-manual/RACFDPerParticleParameters.md b/2025R2/rocky-prepost-scripting-manual/RACFDPerParticleParameters.md index 9a1ec42dc7..ddc8059bc3 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACFDPerParticleParameters.md +++ b/2025R2/rocky-prepost-scripting-manual/RACFDPerParticleParameters.md @@ -1,287 +1,288 @@ - - -# RACFDPerParticleParameters - - - - - - -### *class* RACFDPerParticleParameters - -Rocky PrePost Scripting wrapper representing the set of CFD parameters for a specific Particle. - -Access individual sets of parameters via a `RABaseCFDCoupling`’s parameters list: - -```python -parameters_list = coupling_process.GetCFDParametersList() -parameters = parameters_list.GetParametersFor('Particle <01>') -``` - -**Methods:** - -| [`GetConvectiveHeatTransferLaw`](#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw)() | Get "Convective Heat Transfer Law" as a string. | -|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| -| [`GetDragLaw`](#generated.RACFDPerParticleParameters.GetDragLaw)() | Get "Drag Law" as a string. | -| [`GetLiftLaw`](#generated.RACFDPerParticleParameters.GetLiftLaw)() | Get "Lift Law" as a string. | -| [`GetMorsiAndAlexanderK1`](#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1)() | Get the value of "Morsi And Alexander K1". | -| [`GetMorsiAndAlexanderK2`](#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2)() | Get the value of "Morsi And Alexander K2". | -| [`GetMorsiAndAlexanderK3`](#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3)() | Get the value of "Morsi And Alexander K3". | -| [`GetSyamlalObrienC1`](#generated.RACFDPerParticleParameters.GetSyamlalObrienC1)() | Get the value of "Syamlal Obrien C1". | -| [`GetSyamlalObrienD1`](#generated.RACFDPerParticleParameters.GetSyamlalObrienD1)() | Get the value of "Syamlal Obrien D1". | -| [`GetTorqueLaw`](#generated.RACFDPerParticleParameters.GetTorqueLaw)() | Get "Torque Law" as a string. | -| [`GetUseUserDefinedConstants`](#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants)() | Get the value of "Use User Defined Constants". | -| [`GetValidConvectiveHeatTransferLawValues`](#generated.RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues)() | Get a list of all possible values for "Convective Heat Transfer Law". | -| [`GetValidDragLawValues`](#generated.RACFDPerParticleParameters.GetValidDragLawValues)() | Get a list of all possible values for "Drag Law". | -| [`GetValidLiftLawValues`](#generated.RACFDPerParticleParameters.GetValidLiftLawValues)() | Get a list of all possible values for "Lift Law". | -| [`GetValidTorqueLawValues`](#generated.RACFDPerParticleParameters.GetValidTorqueLawValues)() | Get a list of all possible values for "Torque Law". | -| [`GetValidVirtualMassLawValues`](#generated.RACFDPerParticleParameters.GetValidVirtualMassLawValues)() | Get a list of all possible values for "Virtual Mass Law". | -| [`GetVirtualMassLaw`](#generated.RACFDPerParticleParameters.GetVirtualMassLaw)() | Get "Virtual Mass Law" as a string. | -| [`SetConvectiveHeatTransferLaw`](#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw)(value) | Set the value of "Convective Heat Transfer Law". | -| [`SetDragLaw`](#generated.RACFDPerParticleParameters.SetDragLaw)(value) | Set the value of "Drag Law". | -| [`SetLiftLaw`](#generated.RACFDPerParticleParameters.SetLiftLaw)(value) | Set the value of "Lift Law". | -| [`SetMorsiAndAlexanderK1`](#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1)(value) | Set the value of "Morsi And Alexander K1". | -| [`SetMorsiAndAlexanderK2`](#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2)(value) | Set the value of "Morsi And Alexander K2". | -| [`SetMorsiAndAlexanderK3`](#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3)(value) | Set the value of "Morsi And Alexander K3". | -| [`SetSyamlalObrienC1`](#generated.RACFDPerParticleParameters.SetSyamlalObrienC1)(value) | Set the value of "Syamlal Obrien C1". | -| [`SetSyamlalObrienD1`](#generated.RACFDPerParticleParameters.SetSyamlalObrienD1)(value) | Set the value of "Syamlal Obrien D1". | -| [`SetTorqueLaw`](#generated.RACFDPerParticleParameters.SetTorqueLaw)(value) | Set the value of "Torque Law". | -| [`SetUseUserDefinedConstants`](#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants)(value) | Set the value of "Use User Defined Constants". | -| [`SetVirtualMassLaw`](#generated.RACFDPerParticleParameters.SetVirtualMassLaw)(value) | Set the value of "Virtual Mass Law". | - - - -#### GetConvectiveHeatTransferLaw() - -Get “Convective Heat Transfer Law” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’]. - - - -#### GetDragLaw() - -Get “Drag Law” as a string. - -* **Returns:** - The returned value will be one of [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’]. - - - -#### GetLiftLaw() - -Get “Lift Law” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’]. - - - -#### GetMorsiAndAlexanderK1() - -Get the value of “Morsi And Alexander K1”. - - - -#### GetMorsiAndAlexanderK2() - -Get the value of “Morsi And Alexander K2”. - - - -#### GetMorsiAndAlexanderK3() - -Get the value of “Morsi And Alexander K3”. - - - -#### GetSyamlalObrienC1() - -Get the value of “Syamlal Obrien C1”. - - - -#### GetSyamlalObrienD1() - -Get the value of “Syamlal Obrien D1”. - - - -#### GetTorqueLaw() - -Get “Torque Law” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘DennisSinghIngham1980’, ‘custom’]. - - - -#### GetUseUserDefinedConstants() - -Get the value of “Use User Defined Constants”. - - - -#### GetValidConvectiveHeatTransferLawValues() - -Get a list of all possible values for “Convective Heat Transfer Law”. - -* **Returns:** - The returned list is [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’]. - - - -#### GetValidDragLawValues() - -Get a list of all possible values for “Drag Law”. - -* **Returns:** - The returned list is [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’]. - - - -#### GetValidLiftLawValues() - -Get a list of all possible values for “Lift Law”. - -* **Returns:** - The returned list is [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’]. - - - -#### GetValidTorqueLawValues() - -Get a list of all possible values for “Torque Law”. - -* **Returns:** - The returned list is [‘none’, ‘DennisSinghIngham1980’, ‘custom’]. - - - -#### GetValidVirtualMassLawValues() - -Get a list of all possible values for “Virtual Mass Law”. - -* **Returns:** - The returned list is [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’]. - - - -#### GetVirtualMassLaw() - -Get “Virtual Mass Law” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’]. - - - -#### SetConvectiveHeatTransferLaw(value: str) - -Set the value of “Convective Heat Transfer Law”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Convective Heat Transfer Law” option. - - - -#### SetDragLaw(value: str) - -Set the value of “Drag Law”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Drag Law” option. - - - -#### SetLiftLaw(value: str) - -Set the value of “Lift Law”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Lift Law” option. - - - -#### SetMorsiAndAlexanderK1(value: str | float) - -Set the value of “Morsi And Alexander K1”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetMorsiAndAlexanderK2(value: str | float) - -Set the value of “Morsi And Alexander K2”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetMorsiAndAlexanderK3(value: str | float) - -Set the value of “Morsi And Alexander K3”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSyamlalObrienC1(value: str | float) - -Set the value of “Syamlal Obrien C1”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSyamlalObrienD1(value: str | float) - -Set the value of “Syamlal Obrien D1”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetTorqueLaw(value: str) - -Set the value of “Torque Law”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘DennisSinghIngham1980’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Torque Law” option. - - - -#### SetUseUserDefinedConstants(value: bool) - -Set the value of “Use User Defined Constants”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetVirtualMassLaw(value: str) - -Set the value of “Virtual Mass Law”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Virtual Mass Law” option. + + +# RACFDPerParticleParameters + + + + + + +### *class* RACFDPerParticleParameters + +Rocky PrePost Scripting wrapper representing the set of CFD parameters for a specific Particle. + +Access individual sets of parameters via a `RABaseCFDCoupling`’s parameters list: + +```python +parameters_list = coupling_process.GetCFDParametersList() +parameters = parameters_list.GetParametersFor('Particle <01>') +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| +| [`GetConvectiveHeatTransferLaw`](#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw)() | Get "Convective Heat Transfer Law" as a string. | +| [`GetDragLaw`](#generated.RACFDPerParticleParameters.GetDragLaw)() | Get "Drag Law" as a string. | +| [`GetLiftLaw`](#generated.RACFDPerParticleParameters.GetLiftLaw)() | Get "Lift Law" as a string. | +| [`GetMorsiAndAlexanderK1`](#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1)() | Get the value of "Morsi And Alexander K1". | +| [`GetMorsiAndAlexanderK2`](#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2)() | Get the value of "Morsi And Alexander K2". | +| [`GetMorsiAndAlexanderK3`](#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3)() | Get the value of "Morsi And Alexander K3". | +| [`GetSyamlalObrienC1`](#generated.RACFDPerParticleParameters.GetSyamlalObrienC1)() | Get the value of "Syamlal Obrien C1". | +| [`GetSyamlalObrienD1`](#generated.RACFDPerParticleParameters.GetSyamlalObrienD1)() | Get the value of "Syamlal Obrien D1". | +| [`GetTorqueLaw`](#generated.RACFDPerParticleParameters.GetTorqueLaw)() | Get "Torque Law" as a string. | +| [`GetUseUserDefinedConstants`](#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants)() | Get the value of "Use User Defined Constants". | +| [`GetValidConvectiveHeatTransferLawValues`](#generated.RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues)() | Get a list of all possible values for "Convective Heat Transfer Law". | +| [`GetValidDragLawValues`](#generated.RACFDPerParticleParameters.GetValidDragLawValues)() | Get a list of all possible values for "Drag Law". | +| [`GetValidLiftLawValues`](#generated.RACFDPerParticleParameters.GetValidLiftLawValues)() | Get a list of all possible values for "Lift Law". | +| [`GetValidTorqueLawValues`](#generated.RACFDPerParticleParameters.GetValidTorqueLawValues)() | Get a list of all possible values for "Torque Law". | +| [`GetValidVirtualMassLawValues`](#generated.RACFDPerParticleParameters.GetValidVirtualMassLawValues)() | Get a list of all possible values for "Virtual Mass Law". | +| [`GetVirtualMassLaw`](#generated.RACFDPerParticleParameters.GetVirtualMassLaw)() | Get "Virtual Mass Law" as a string. | +| [`SetConvectiveHeatTransferLaw`](#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw)(value) | Set the value of "Convective Heat Transfer Law". | +| [`SetDragLaw`](#generated.RACFDPerParticleParameters.SetDragLaw)(value) | Set the value of "Drag Law". | +| [`SetLiftLaw`](#generated.RACFDPerParticleParameters.SetLiftLaw)(value) | Set the value of "Lift Law". | +| [`SetMorsiAndAlexanderK1`](#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1)(value) | Set the value of "Morsi And Alexander K1". | +| [`SetMorsiAndAlexanderK2`](#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2)(value) | Set the value of "Morsi And Alexander K2". | +| [`SetMorsiAndAlexanderK3`](#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3)(value) | Set the value of "Morsi And Alexander K3". | +| [`SetSyamlalObrienC1`](#generated.RACFDPerParticleParameters.SetSyamlalObrienC1)(value) | Set the value of "Syamlal Obrien C1". | +| [`SetSyamlalObrienD1`](#generated.RACFDPerParticleParameters.SetSyamlalObrienD1)(value) | Set the value of "Syamlal Obrien D1". | +| [`SetTorqueLaw`](#generated.RACFDPerParticleParameters.SetTorqueLaw)(value) | Set the value of "Torque Law". | +| [`SetUseUserDefinedConstants`](#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants)(value) | Set the value of "Use User Defined Constants". | +| [`SetVirtualMassLaw`](#generated.RACFDPerParticleParameters.SetVirtualMassLaw)(value) | Set the value of "Virtual Mass Law". | + + + +#### GetConvectiveHeatTransferLaw() + +Get “Convective Heat Transfer Law” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’]. + + + +#### GetDragLaw() + +Get “Drag Law” as a string. + +* **Returns:** + The returned value will be one of [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’]. + + + +#### GetLiftLaw() + +Get “Lift Law” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’]. + + + +#### GetMorsiAndAlexanderK1() + +Get the value of “Morsi And Alexander K1”. + + + +#### GetMorsiAndAlexanderK2() + +Get the value of “Morsi And Alexander K2”. + + + +#### GetMorsiAndAlexanderK3() + +Get the value of “Morsi And Alexander K3”. + + + +#### GetSyamlalObrienC1() + +Get the value of “Syamlal Obrien C1”. + + + +#### GetSyamlalObrienD1() + +Get the value of “Syamlal Obrien D1”. + + + +#### GetTorqueLaw() + +Get “Torque Law” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘DennisSinghIngham1980’, ‘custom’]. + + + +#### GetUseUserDefinedConstants() + +Get the value of “Use User Defined Constants”. + + + +#### GetValidConvectiveHeatTransferLawValues() + +Get a list of all possible values for “Convective Heat Transfer Law”. + +* **Returns:** + The returned list is [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’]. + + + +#### GetValidDragLawValues() + +Get a list of all possible values for “Drag Law”. + +* **Returns:** + The returned list is [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’]. + + + +#### GetValidLiftLawValues() + +Get a list of all possible values for “Lift Law”. + +* **Returns:** + The returned list is [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’]. + + + +#### GetValidTorqueLawValues() + +Get a list of all possible values for “Torque Law”. + +* **Returns:** + The returned list is [‘none’, ‘DennisSinghIngham1980’, ‘custom’]. + + + +#### GetValidVirtualMassLawValues() + +Get a list of all possible values for “Virtual Mass Law”. + +* **Returns:** + The returned list is [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’]. + + + +#### GetVirtualMassLaw() + +Get “Virtual Mass Law” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’]. + + + +#### SetConvectiveHeatTransferLaw(value: str) + +Set the value of “Convective Heat Transfer Law”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Convective Heat Transfer Law” option. + + + +#### SetDragLaw(value: str) + +Set the value of “Drag Law”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Drag Law” option. + + + +#### SetLiftLaw(value: str) + +Set the value of “Lift Law”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Lift Law” option. + + + +#### SetMorsiAndAlexanderK1(value: str | float) + +Set the value of “Morsi And Alexander K1”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetMorsiAndAlexanderK2(value: str | float) + +Set the value of “Morsi And Alexander K2”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetMorsiAndAlexanderK3(value: str | float) + +Set the value of “Morsi And Alexander K3”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSyamlalObrienC1(value: str | float) + +Set the value of “Syamlal Obrien C1”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSyamlalObrienD1(value: str | float) + +Set the value of “Syamlal Obrien D1”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetTorqueLaw(value: str) + +Set the value of “Torque Law”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘DennisSinghIngham1980’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Torque Law” option. + + + +#### SetUseUserDefinedConstants(value: bool) + +Set the value of “Use User Defined Constants”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetVirtualMassLaw(value: str) + +Set the value of “Virtual Mass Law”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Virtual Mass Law” option. diff --git a/2025R2/rocky-prepost-scripting-manual/RACalculations.md b/2025R2/rocky-prepost-scripting-manual/RACalculations.md index 305f1b6db5..c644cc025e 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACalculations.md +++ b/2025R2/rocky-prepost-scripting-manual/RACalculations.md @@ -1,87 +1,88 @@ - - -# RACalculations - - - - - - -### *class* RACalculations - -Rocky api for particles calculations - -**Methods:** - -| [`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. | -| [`GetTagging`](#generated.RACalculations.GetTagging)(name) | Get the Tagging calculator with the given name. | -| [`GetTaggingNames`](#generated.RACalculations.GetTaggingNames)() | Get a list of the names of all Taggings in Particles Calculations. | - - - -#### CreateDivisionsTagging(selection: RAGridProcessElementItem) - -Create a Divisions Tagging calculator for the given particle-based selection process. - -* **Parameters:** - **selection** – Must be a particle selection type. - - - -#### CreateSelectionFlipCount(selection: RAGridProcessElementItem) - -Create a flip count grid function for the given selection process - - - -#### CreateSelectionResidenceTime(selection: RAGridProcessElementItem | str) - -Create a residence time grid function for the given selection process - - - -#### CreateSelectionTagging(selection: RAGridProcessElementItem) - -Deprecated: Use [`CreateTagging()`](#generated.RACalculations.CreateTagging) instead. - - - -#### CreateTagging(selection: RAGridProcessElementItem) - -Create a Tagging calculator for the given particle-based selection process. - -* **Parameters:** - **selection** – Must be a particle selection type. - - - -#### GetDivisionsTagging(name: str) - -Get the Divisions Tagging calculator with the given name. - - - -#### GetDivisionsTaggingNames() - -Get a list of the names of all Divisions Taggings in Particles Calculations. - - - -#### GetTagging(name: str) - -Get the Tagging calculator with the given name. - - - -#### GetTaggingNames() - -Get a list of the names of all Taggings in Particles Calculations. + + +# RACalculations + + + + + + +### *class* RACalculations + +Rocky api for particles calculations + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------| +| [`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. | +| [`GetTagging`](#generated.RACalculations.GetTagging)(name) | Get the Tagging calculator with the given name. | +| [`GetTaggingNames`](#generated.RACalculations.GetTaggingNames)() | Get a list of the names of all Taggings in Particles Calculations. | + + + +#### CreateDivisionsTagging(selection: RAGridProcessElementItem) + +Create a Divisions Tagging calculator for the given particle-based selection process. + +* **Parameters:** + **selection** – Must be a particle selection type. + + + +#### CreateSelectionFlipCount(selection: RAGridProcessElementItem) + +Create a flip count grid function for the given selection process + + + +#### CreateSelectionResidenceTime(selection: RAGridProcessElementItem | str) + +Create a residence time grid function for the given selection process + + + +#### CreateSelectionTagging(selection: RAGridProcessElementItem) + +Deprecated: Use [`CreateTagging()`](#generated.RACalculations.CreateTagging) instead. + + + +#### CreateTagging(selection: RAGridProcessElementItem) + +Create a Tagging calculator for the given particle-based selection process. + +* **Parameters:** + **selection** – Must be a particle selection type. + + + +#### GetDivisionsTagging(name: str) + +Get the Divisions Tagging calculator with the given name. + + + +#### GetDivisionsTaggingNames() + +Get a list of the names of all Divisions Taggings in Particles Calculations. + + + +#### GetTagging(name: str) + +Get the Tagging calculator with the given name. + + + +#### GetTaggingNames() + +Get a list of the names of all Taggings in Particles Calculations. diff --git a/2025R2/rocky-prepost-scripting-manual/RACircularSurface.md b/2025R2/rocky-prepost-scripting-manual/RACircularSurface.md index 316f38c291..5af20a3910 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACircularSurface.md +++ b/2025R2/rocky-prepost-scripting-manual/RACircularSurface.md @@ -1,1079 +1,1080 @@ - - -# RACircularSurface - - - - - - -### *class* RACircularSurface - -Rocky API for “Circular Surface” model. - -**Methods:** - -| [`AddCurve`](#generated.RACircularSurface.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RACircularSurface.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.RACircularSurface.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RACircularSurface.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RACircularSurface.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.RACircularSurface.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RACircularSurface.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACircularSurface.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.RACircularSurface.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.RACircularSurface.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.RACircularSurface.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.RACircularSurface.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RACircularSurface.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RACircularSurface.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RACircularSurface.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RACircularSurface.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RACircularSurface.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RACircularSurface.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RACircularSurface.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RACircularSurface.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RACircularSurface.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RACircularSurface.GetCenter)([unit]) | Get the value of "Center". | -| [`GetCurve`](#generated.RACircularSurface.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RACircularSurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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". | -| [`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. | -| [`GetOrientation`](#generated.RACircularSurface.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RACircularSurface.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RACircularSurface.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RACircularSurface.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RACircularSurface.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RACircularSurface.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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 | -| [`IterCellVertices`](#generated.RACircularSurface.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RACircularSurface.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RACircularSurface.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RACircularSurface.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RACircularSurface.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RACircularSurface.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RACircularSurface.RemoveProcess)() | Removes the process from the project. | -| [`SetCenter`](#generated.RACircularSurface.SetCenter)(values[, unit]) | Set the values of "Center". | -| [`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". | -| [`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. | -| [`SetOrientationFromBasisVector`](#generated.RACircularSurface.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit: str | None = None) - -Get the value of “Center”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMaxRadius(unit: str | None = None) - -Get the value of “Max Radius”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinRadius(unit: str | None = None) - -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”. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### HasMotionFrame() - -Whether the geometry is linked to a motion frame. - -* **Returns:** - True if geometry is linked to a motion frame False otherwise - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Center”. - -* **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. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetMaxRadius(value: str | float, unit: str | None = None) - -Set the value of “Max Radius”. - -* **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”. - - - -#### SetMinRadius(value: str | float, unit: str | None = None) - -Set the value of “Min Radius”. - -* **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”. - - - -#### 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. + + +# RACircularSurface + + + + + + +### *class* RACircularSurface + +Rocky API for “Circular Surface” model. + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RACircularSurface.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RACircularSurface.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.RACircularSurface.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RACircularSurface.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RACircularSurface.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.RACircularSurface.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RACircularSurface.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACircularSurface.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.RACircularSurface.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.RACircularSurface.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.RACircularSurface.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.RACircularSurface.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RACircularSurface.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RACircularSurface.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RACircularSurface.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RACircularSurface.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RACircularSurface.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RACircularSurface.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RACircularSurface.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RACircularSurface.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RACircularSurface.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RACircularSurface.GetCenter)([unit]) | Get the value of "Center". | +| [`GetCurve`](#generated.RACircularSurface.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RACircularSurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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". | +| [`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. | +| [`GetOrientation`](#generated.RACircularSurface.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RACircularSurface.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RACircularSurface.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RACircularSurface.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RACircularSurface.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RACircularSurface.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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 | +| [`IterCellVertices`](#generated.RACircularSurface.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RACircularSurface.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RACircularSurface.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RACircularSurface.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RACircularSurface.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RACircularSurface.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RACircularSurface.RemoveProcess)() | Removes the process from the project. | +| [`SetCenter`](#generated.RACircularSurface.SetCenter)(values[, unit]) | Set the values of "Center". | +| [`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". | +| [`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. | +| [`SetOrientationFromBasisVector`](#generated.RACircularSurface.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit: str | None = None) + +Get the value of “Center”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMaxRadius(unit: str | None = None) + +Get the value of “Max Radius”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinRadius(unit: str | None = None) + +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”. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### HasMotionFrame() + +Whether the geometry is linked to a motion frame. + +* **Returns:** + True if geometry is linked to a motion frame False otherwise + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Center”. + +* **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. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetMaxRadius(value: str | float, unit: str | None = None) + +Set the value of “Max Radius”. + +* **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”. + + + +#### SetMinRadius(value: str | float, unit: str | None = None) + +Set the value of “Min Radius”. + +* **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”. + + + +#### 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. diff --git a/2025R2/rocky-prepost-scripting-manual/RAConeCrusherFrame.md b/2025R2/rocky-prepost-scripting-manual/RAConeCrusherFrame.md index 46f1d5a593..7535908698 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAConeCrusherFrame.md +++ b/2025R2/rocky-prepost-scripting-manual/RAConeCrusherFrame.md @@ -1,248 +1,249 @@ - - -# RAConeCrusherFrame - - - - - - -### *class* RAConeCrusherFrame - -Rocky PrePost Scripting wrapper for a cone crusher frame. - -The class contains methods to configure a cone crusher frame. There are some options -to retrieve a specific [`RAConeCrusherFrame`](#generated.RAConeCrusherFrame) in a project from a [`RAStudy`](RAStudy.md#generated.RAStudy), -a [`RAMotionFrameSource`](RAMotionFrameSource.md#generated.RAMotionFrameSource), another [`RAConeCrusherFrame`](#generated.RAConeCrusherFrame) or a [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame): - -```python -# From the RAStudy -motion_frame = study.GetElement('') - -# From the RAMotionFrameSource -frame_source = study.GetMotionFrameSource() -motion_frame = frame_source.GetMotionFrame('') - -# From a "parent" motion frame -frame_1 = study.GetElement('') -frame_2 = frame_1.GetMotionFrame('') -``` - -Motion frames can be created on the “root” of the project’s cone crusher frames (the source returned -in [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource)), or as a ‘child’ frame of a pre-existing cone crusher frame: - -```python -frame_source = study.GetMotionFrameSource() - -# Create a motion frame with no parent frame -frame_1 = frame_source.NewConeCrusherFrame() -# Configure this new frame frame_1 -frame_1.SetInitialOrientation(...) -frame_1.SetPivotPoint(...) - -# Create a new frame, as a child of `frame_1` -frame_2 = frame_1.NewConeCrusherFrame() -# Configure this new frame frame_2 -frame_2.SetInitialOrientation(...) -# ... configure motions, etc. -``` - -**Methods:** - -| [`GetInitialOrientation`](#generated.RAConeCrusherFrame.GetInitialOrientation)([unit]) | Get the value of "Initial Orientation". | -|------------------------------------------------------------------------------------------------|--------------------------------------------------------------| -| [`GetMotionFrame`](#generated.RAConeCrusherFrame.GetMotionFrame)(frame_name) | Get a specific motion frame given its name. | -| [`GetParentMotionFrame`](#generated.RAConeCrusherFrame.GetParentMotionFrame)() | Gets the parent motion frame. | -| [`GetPivotPoint`](#generated.RAConeCrusherFrame.GetPivotPoint)([unit]) | Get the value of "Pivot Point". | -| [`GetRotationAxis`](#generated.RAConeCrusherFrame.GetRotationAxis)([unit]) | Get the value of "Rotation Axis". | -| [`GetRotationalVelocity`](#generated.RAConeCrusherFrame.GetRotationalVelocity)([unit]) | Get the value of "Rotational Velocity". | -| [`GetStartTime`](#generated.RAConeCrusherFrame.GetStartTime)([unit]) | Get the value of "Start Time". | -| [`GetStopTime`](#generated.RAConeCrusherFrame.GetStopTime)([unit]) | Get the value of "Stop Time". | -| [`IterMotionFrames`](#generated.RAConeCrusherFrame.IterMotionFrames)() | Iterates over all the motion frames available (recursively). | -| [`NewConeCrusherFrame`](#generated.RAConeCrusherFrame.NewConeCrusherFrame)() | Creates a new cone crusher frame. | -| [`NewFrame`](#generated.RAConeCrusherFrame.NewFrame)() | Creates a new motion frame. | -| [`RemoveFrame`](#generated.RAConeCrusherFrame.RemoveFrame)(motion_frame) | Removes a previously-created motion frame. | -| [`SetInitialOrientation`](#generated.RAConeCrusherFrame.SetInitialOrientation)(values[, unit]) | Set the values of "Initial Orientation". | -| [`SetPivotPoint`](#generated.RAConeCrusherFrame.SetPivotPoint)(values[, unit]) | Set the values of "Pivot Point". | -| [`SetRotationAxis`](#generated.RAConeCrusherFrame.SetRotationAxis)(values[, unit]) | Set the values of "Rotation Axis". | -| [`SetRotationalVelocity`](#generated.RAConeCrusherFrame.SetRotationalVelocity)(value[, unit]) | Set the value of "Rotational Velocity". | -| [`SetStartTime`](#generated.RAConeCrusherFrame.SetStartTime)(value[, unit]) | Set the value of "Start Time". | -| [`SetStopTime`](#generated.RAConeCrusherFrame.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | - - - -#### GetInitialOrientation(unit: str | None = None) - -Get the value of “Initial Orientation”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetMotionFrame(frame_name) - -Get a specific motion frame given its name. - -* **Parameters:** - **frame_name** (*unicode*) -* **Return type:** - [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) - - - -#### GetParentMotionFrame() - -Gets the parent motion frame. -If the Motion Frame is a RAMotionFrameSource it returns None. - -* **Return type:** - [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) - - - -#### GetPivotPoint(unit: str | None = None) - -Get the value of “Pivot Point”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetRotationAxis(unit: str | None = None) - -Get the value of “Rotation Axis”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetRotationalVelocity(unit: str | None = None) - -Get the value of “Rotational Velocity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad/s”. - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetStopTime(unit: str | None = None) - -Get the value of “Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### IterMotionFrames() - -Iterates over all the motion frames available (recursively). - -* **Return iter(RAMotionFrame):** - - - -#### NewConeCrusherFrame() - -Creates a new cone crusher frame. - -* **Return type:** - [RAConeCrusherFrame](#generated.RAConeCrusherFrame) - - - -#### NewFrame() - -Creates a new motion frame. - - - -#### RemoveFrame(motion_frame) - -Removes a previously-created motion frame. - -* **Parameters:** - **motion_frame** ([*RAMotionFrame*](RAMotionFrame.md#generated.RAMotionFrame) *or* [*RAConeCrusherFrame*](#generated.RAConeCrusherFrame)) - - - -#### SetInitialOrientation(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Initial Orientation”. - -* **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. - - - -#### SetPivotPoint(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Pivot Point”. - -* **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. - - - -#### SetRotationAxis(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Rotation Axis”. - -* **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. - - - -#### SetRotationalVelocity(value: str | float, unit: str | None = None) - -Set the value of “Rotational Velocity”. - -* **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/s”. - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetStopTime(value: str | float, unit: str | None = None) - -Set the value of “Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + +# RAConeCrusherFrame + + + + + + +### *class* RAConeCrusherFrame + +Rocky PrePost Scripting wrapper for a cone crusher frame. + +The class contains methods to configure a cone crusher frame. There are some options +to retrieve a specific [`RAConeCrusherFrame`](#generated.RAConeCrusherFrame) in a project from a [`RAStudy`](RAStudy.md#generated.RAStudy), +a [`RAMotionFrameSource`](RAMotionFrameSource.md#generated.RAMotionFrameSource), another [`RAConeCrusherFrame`](#generated.RAConeCrusherFrame) or a [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame): + +```python +# From the RAStudy +motion_frame = study.GetElement('') + +# From the RAMotionFrameSource +frame_source = study.GetMotionFrameSource() +motion_frame = frame_source.GetMotionFrame('') + +# From a "parent" motion frame +frame_1 = study.GetElement('') +frame_2 = frame_1.GetMotionFrame('') +``` + +Motion frames can be created on the “root” of the project’s cone crusher frames (the source returned +in [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource)), or as a ‘child’ frame of a pre-existing cone crusher frame: + +```python +frame_source = study.GetMotionFrameSource() + +# Create a motion frame with no parent frame +frame_1 = frame_source.NewConeCrusherFrame() +# Configure this new frame frame_1 +frame_1.SetInitialOrientation(...) +frame_1.SetPivotPoint(...) + +# Create a new frame, as a child of `frame_1` +frame_2 = frame_1.NewConeCrusherFrame() +# Configure this new frame frame_2 +frame_2.SetInitialOrientation(...) +# ... configure motions, etc. +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| [`GetInitialOrientation`](#generated.RAConeCrusherFrame.GetInitialOrientation)([unit]) | Get the value of "Initial Orientation". | +| [`GetMotionFrame`](#generated.RAConeCrusherFrame.GetMotionFrame)(frame_name) | Get a specific motion frame given its name. | +| [`GetParentMotionFrame`](#generated.RAConeCrusherFrame.GetParentMotionFrame)() | Gets the parent motion frame. | +| [`GetPivotPoint`](#generated.RAConeCrusherFrame.GetPivotPoint)([unit]) | Get the value of "Pivot Point". | +| [`GetRotationAxis`](#generated.RAConeCrusherFrame.GetRotationAxis)([unit]) | Get the value of "Rotation Axis". | +| [`GetRotationalVelocity`](#generated.RAConeCrusherFrame.GetRotationalVelocity)([unit]) | Get the value of "Rotational Velocity". | +| [`GetStartTime`](#generated.RAConeCrusherFrame.GetStartTime)([unit]) | Get the value of "Start Time". | +| [`GetStopTime`](#generated.RAConeCrusherFrame.GetStopTime)([unit]) | Get the value of "Stop Time". | +| [`IterMotionFrames`](#generated.RAConeCrusherFrame.IterMotionFrames)() | Iterates over all the motion frames available (recursively). | +| [`NewConeCrusherFrame`](#generated.RAConeCrusherFrame.NewConeCrusherFrame)() | Creates a new cone crusher frame. | +| [`NewFrame`](#generated.RAConeCrusherFrame.NewFrame)() | Creates a new motion frame. | +| [`RemoveFrame`](#generated.RAConeCrusherFrame.RemoveFrame)(motion_frame) | Removes a previously-created motion frame. | +| [`SetInitialOrientation`](#generated.RAConeCrusherFrame.SetInitialOrientation)(values[, unit]) | Set the values of "Initial Orientation". | +| [`SetPivotPoint`](#generated.RAConeCrusherFrame.SetPivotPoint)(values[, unit]) | Set the values of "Pivot Point". | +| [`SetRotationAxis`](#generated.RAConeCrusherFrame.SetRotationAxis)(values[, unit]) | Set the values of "Rotation Axis". | +| [`SetRotationalVelocity`](#generated.RAConeCrusherFrame.SetRotationalVelocity)(value[, unit]) | Set the value of "Rotational Velocity". | +| [`SetStartTime`](#generated.RAConeCrusherFrame.SetStartTime)(value[, unit]) | Set the value of "Start Time". | +| [`SetStopTime`](#generated.RAConeCrusherFrame.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | + + + +#### GetInitialOrientation(unit: str | None = None) + +Get the value of “Initial Orientation”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetMotionFrame(frame_name) + +Get a specific motion frame given its name. + +* **Parameters:** + **frame_name** (*unicode*) +* **Return type:** + [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) + + + +#### GetParentMotionFrame() + +Gets the parent motion frame. +If the Motion Frame is a RAMotionFrameSource it returns None. + +* **Return type:** + [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) + + + +#### GetPivotPoint(unit: str | None = None) + +Get the value of “Pivot Point”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetRotationAxis(unit: str | None = None) + +Get the value of “Rotation Axis”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetRotationalVelocity(unit: str | None = None) + +Get the value of “Rotational Velocity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad/s”. + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetStopTime(unit: str | None = None) + +Get the value of “Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### IterMotionFrames() + +Iterates over all the motion frames available (recursively). + +* **Return iter(RAMotionFrame):** + + + +#### NewConeCrusherFrame() + +Creates a new cone crusher frame. + +* **Return type:** + [RAConeCrusherFrame](#generated.RAConeCrusherFrame) + + + +#### NewFrame() + +Creates a new motion frame. + + + +#### RemoveFrame(motion_frame) + +Removes a previously-created motion frame. + +* **Parameters:** + **motion_frame** ([*RAMotionFrame*](RAMotionFrame.md#generated.RAMotionFrame) *or* [*RAConeCrusherFrame*](#generated.RAConeCrusherFrame)) + + + +#### SetInitialOrientation(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Initial Orientation”. + +* **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. + + + +#### SetPivotPoint(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Pivot Point”. + +* **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. + + + +#### SetRotationAxis(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Rotation Axis”. + +* **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. + + + +#### SetRotationalVelocity(value: str | float, unit: str | None = None) + +Set the value of “Rotational Velocity”. + +* **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/s”. + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetStopTime(value: str | float, unit: str | None = None) + +Set the value of “Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAConstantOneWayCoupling.md b/2025R2/rocky-prepost-scripting-manual/RAConstantOneWayCoupling.md index 6dec3e5bfc..2bb87764d9 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAConstantOneWayCoupling.md +++ b/2025R2/rocky-prepost-scripting-manual/RAConstantOneWayCoupling.md @@ -1,1494 +1,1495 @@ - - -# RAConstantOneWayCoupling - - - - - - -### *class* RAConstantOneWayCoupling - -Rocky PrePost Scripting wrapper for One-Way Constant CFD coupling properties. - -This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): - -```python -cfd_coupling = study.GetCFDCoupling() -cfd_coupling.SetupOneWayConstant() -constant_one_way = cfd_coupling.GetCouplingProcess() -``` - -**Methods:** - -| [`AddCurve`](#generated.RAConstantOneWayCoupling.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAConstantOneWayCoupling.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.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). | -| [`DisableTurbulentDispersion`](#generated.RAConstantOneWayCoupling.DisableTurbulentDispersion)() | Set the value of "Turbulent Dispersion" to False. | -| [`EditCustomCurve`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.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. | -| [`EnableTurbulentDispersion`](#generated.RAConstantOneWayCoupling.EnableTurbulentDispersion)() | Set the value of "Turbulent Dispersion" to True. | -| [`GetActivesArray`](#generated.RAConstantOneWayCoupling.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAConstantOneWayCoupling.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCFDParametersList`](#generated.RAConstantOneWayCoupling.GetCFDParametersList)() | Get the list of per-Particle CFD parameter sets. | -| [`GetCellAreaAsArray`](#generated.RAConstantOneWayCoupling.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAConstantOneWayCoupling.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAConstantOneWayCoupling.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAConstantOneWayCoupling.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAConstantOneWayCoupling.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAConstantOneWayCoupling.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAConstantOneWayCoupling.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAConstantOneWayCoupling.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetConvectiveHeatTransferLaw`](#generated.RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw)() | Get the current "Convective Heat Transfer Law". | -| [`GetCurve`](#generated.RAConstantOneWayCoupling.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAConstantOneWayCoupling.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAConstantOneWayCoupling.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAConstantOneWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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". | -| [`GetMorsiAndAlexanderK2`](#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK2)() | Get the current "Morsi And Alexander K2". | -| [`GetMorsiAndAlexanderK3`](#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK3)() | Get the current "Morsi And Alexander K3". | -| [`GetNumberOfCells`](#generated.RAConstantOneWayCoupling.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAConstantOneWayCoupling.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAConstantOneWayCoupling.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAConstantOneWayCoupling.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetSpecificHeat`](#generated.RAConstantOneWayCoupling.GetSpecificHeat)([unit]) | Get the value of "Specific Heat". | -| [`GetStartTime`](#generated.RAConstantOneWayCoupling.GetStartTime)([unit]) | Get the value of "Start Time". | -| [`GetSyamlalObrienC1`](#generated.RAConstantOneWayCoupling.GetSyamlalObrienC1)() | Get the current "Syamlal Obrien C1". | -| [`GetSyamlalObrienD1`](#generated.RAConstantOneWayCoupling.GetSyamlalObrienD1)() | Get the current "Syamlal Obrien D1". | -| [`GetTemperature`](#generated.RAConstantOneWayCoupling.GetTemperature)([unit]) | Get the value of "Temperature". | -| [`GetThermalConductivity`](#generated.RAConstantOneWayCoupling.GetThermalConductivity)([unit]) | Get the value of "Thermal Conductivity". | -| [`GetTimeSet`](#generated.RAConstantOneWayCoupling.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAConstantOneWayCoupling.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAConstantOneWayCoupling.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAConstantOneWayCoupling.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTorqueLaw`](#generated.RAConstantOneWayCoupling.GetTorqueLaw)() | Get the current "Torque Law". | -| [`GetTurbulentDissipationRate`](#generated.RAConstantOneWayCoupling.GetTurbulentDissipationRate)([unit]) | Get the value of "Turbulent Dissipation Rate". | -| [`GetTurbulentKineticEnergy`](#generated.RAConstantOneWayCoupling.GetTurbulentKineticEnergy)([unit]) | Get the value of "Turbulent Kinetic Energy". | -| [`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". | -| [`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. | -| [`IsCellActive`](#generated.RAConstantOneWayCoupling.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IsTurbulentDispersionEnabled`](#generated.RAConstantOneWayCoupling.IsTurbulentDispersionEnabled)() | Check if the "Turbulent Dispersion" is enabled. | -| [`IterCellVertices`](#generated.RAConstantOneWayCoupling.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAConstantOneWayCoupling.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAConstantOneWayCoupling.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAConstantOneWayCoupling.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAConstantOneWayCoupling.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAConstantOneWayCoupling.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAConstantOneWayCoupling.RemoveProcess)() | Removes the process from the project. | -| [`SetConvectiveHeatTransferLaw`](#generated.RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw)(value) | Set the current "Convective Heat Transfer Law". | -| [`SetCurrentTimeStep`](#generated.RAConstantOneWayCoupling.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDensity`](#generated.RAConstantOneWayCoupling.SetDensity)(value[, unit]) | Set the value of "Density". | -| [`SetDragLaw`](#generated.RAConstantOneWayCoupling.SetDragLaw)(value) | Set the current "Drag Law". | -| [`SetLiftLaw`](#generated.RAConstantOneWayCoupling.SetLiftLaw)(value) | Set the current "Lift Law". | -| [`SetMorsiAndAlexanderK1`](#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK1)(value) | Set the current "Morsi And Alexander K1". | -| [`SetMorsiAndAlexanderK2`](#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK2)(value) | Set the current "Morsi And Alexander K2". | -| [`SetMorsiAndAlexanderK3`](#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK3)(value) | Set the current "Morsi And Alexander K3". | -| [`SetPartIdIfValid`](#generated.RAConstantOneWayCoupling.SetPartIdIfValid)() | Subclasses should implement this method if it's a Process with visualization | -| [`SetSpecificHeat`](#generated.RAConstantOneWayCoupling.SetSpecificHeat)(value[, unit]) | Set the value of "Specific Heat". | -| [`SetStartTime`](#generated.RAConstantOneWayCoupling.SetStartTime)(value[, unit]) | Set the value of "Start Time". | -| [`SetSyamlalObrienC1`](#generated.RAConstantOneWayCoupling.SetSyamlalObrienC1)(value) | Set the current "Syamlal Obrien C1". | -| [`SetSyamlalObrienD1`](#generated.RAConstantOneWayCoupling.SetSyamlalObrienD1)(value) | Set the current "Syamlal Obrien D1". | -| [`SetTemperature`](#generated.RAConstantOneWayCoupling.SetTemperature)(value[, unit]) | Set the value of "Temperature". | -| [`SetThermalConductivity`](#generated.RAConstantOneWayCoupling.SetThermalConductivity)(value[, unit]) | Set the value of "Thermal Conductivity". | -| [`SetTorqueLaw`](#generated.RAConstantOneWayCoupling.SetTorqueLaw)(value) | Set the current "Torque Law". | -| [`SetTurbulentDissipationRate`](#generated.RAConstantOneWayCoupling.SetTurbulentDissipationRate)(value[, unit]) | Set the value of "Turbulent Dissipation Rate". | -| [`SetTurbulentKineticEnergy`](#generated.RAConstantOneWayCoupling.SetTurbulentKineticEnergy)(value[, unit]) | Set the value of "Turbulent Kinetic Energy". | -| [`SetUseTurbulentDispersion`](#generated.RAConstantOneWayCoupling.SetUseTurbulentDispersion)(value) | Set the value of "Use Turbulent Dispersion". | -| [`SetUseUserDefinedConstants`](#generated.RAConstantOneWayCoupling.SetUseUserDefinedConstants)(value) | Set the current "Use User Defined Constants". | -| [`SetVelocity`](#generated.RAConstantOneWayCoupling.SetVelocity)(values[, unit]) | Set the values of "Velocity". | -| [`SetVirtualMassLaw`](#generated.RAConstantOneWayCoupling.SetVirtualMassLaw)(value) | Set the current "Virtual Mass Law". | -| [`SetViscosity`](#generated.RAConstantOneWayCoupling.SetViscosity)(value[, unit]) | Set the value of "Viscosity". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableTurbulentDispersion() - -Set the value of “Turbulent Dispersion” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableTurbulentDispersion() - -Set the value of “Turbulent Dispersion” to True. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCFDParametersList() - -Get the list of per-Particle CFD parameter sets. - -* **Return type:** - [RACFDParametersList](RACFDParametersList.md#generated.RACFDParametersList) - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetConvectiveHeatTransferLaw() - -Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Convective Heat Transfer Law”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDensity(unit: str | None = None) - -Get the value of “Density”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. - - - -#### GetDragLaw() - -Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Drag Law”. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetLiftLaw() - -Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Lift Law”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMorsiAndAlexanderK1() - -Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K1”. - - - -#### GetMorsiAndAlexanderK2() - -Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K2”. - - - -#### GetMorsiAndAlexanderK3() - -Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K3”. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetSpecificHeat(unit: str | None = None) - -Get the value of “Specific Heat”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”. - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetSyamlalObrienC1() - -Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Syamlal Obrien C1”. - - - -#### GetSyamlalObrienD1() - -Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Syamlal Obrien D1”. - - - -#### GetTemperature(unit: str | None = None) - -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”. - - - -#### GetThermalConductivity(unit: str | None = None) - -Get the value of “Thermal Conductivity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTorqueLaw() - -Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Torque Law”. - - - -#### GetTurbulentDissipationRate(unit: str | None = None) - -Get the value of “Turbulent Dissipation Rate”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/kg”. - - - -#### GetTurbulentKineticEnergy(unit: str | None = None) - -Get the value of “Turbulent Kinetic Energy”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. - - - -#### GetUseTurbulentDispersion() - -Get the value of “Use Turbulent Dispersion”. - - - -#### GetUseUserDefinedConstants() - -Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Use User Defined Constants”. - - - -#### GetVelocity(unit: str | None = None) - -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”. - - - -#### GetVirtualMassLaw() - -Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Virtual Mass Law”. - - - -#### GetViscosity(unit: str | None = None) - -Get the value of “Viscosity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa.s”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsTurbulentDispersionEnabled() - -Check if the “Turbulent Dispersion” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetConvectiveHeatTransferLaw(value) - -Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDensity(value: str | float, unit: str | None = None) - -Set the value of “Density”. - -* **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 “kg/m3”. - - - -#### SetDragLaw(value) - -Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetLiftLaw(value) - -Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK1(value) - -Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK2(value) - -Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK3(value) - -Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetPartIdIfValid() - -Subclasses should implement this method if it’s a Process with visualization - - - -#### SetSpecificHeat(value: str | float, unit: str | None = None) - -Set the value of “Specific Heat”. - -* **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 “J/kg.K”. - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetSyamlalObrienC1(value) - -Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetSyamlalObrienD1(value) - -Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetTemperature(value: str | float, unit: str | None = None) - -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”. - - - -#### SetThermalConductivity(value: str | float, unit: str | None = None) - -Set the value of “Thermal Conductivity”. - -* **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 “W/m.K”. - - - -#### SetTorqueLaw(value) - -Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetTurbulentDissipationRate(value: str | float, unit: str | None = None) - -Set the value of “Turbulent Dissipation Rate”. - -* **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 “W/kg”. - - - -#### SetTurbulentKineticEnergy(value: str | float, unit: str | None = None) - -Set the value of “Turbulent Kinetic Energy”. - -* **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 “J/kg”. - - - -#### SetUseTurbulentDispersion(value: bool) - -Set the value of “Use Turbulent Dispersion”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseUserDefinedConstants(value) - -Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetVelocity(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Velocity”. - -* **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/s”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetVirtualMassLaw(value) - -Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetViscosity(value: str | float, unit: str | None = None) - -Set the value of “Viscosity”. - -* **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 “Pa.s”. + + +# RAConstantOneWayCoupling + + + + + + +### *class* RAConstantOneWayCoupling + +Rocky PrePost Scripting wrapper for One-Way Constant CFD coupling properties. + +This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): + +```python +cfd_coupling = study.GetCFDCoupling() +cfd_coupling.SetupOneWayConstant() +constant_one_way = cfd_coupling.GetCouplingProcess() +``` + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAConstantOneWayCoupling.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAConstantOneWayCoupling.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.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). | +| [`DisableTurbulentDispersion`](#generated.RAConstantOneWayCoupling.DisableTurbulentDispersion)() | Set the value of "Turbulent Dispersion" to False. | +| [`EditCustomCurve`](#generated.RAConstantOneWayCoupling.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.RAConstantOneWayCoupling.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. | +| [`EnableTurbulentDispersion`](#generated.RAConstantOneWayCoupling.EnableTurbulentDispersion)() | Set the value of "Turbulent Dispersion" to True. | +| [`GetActivesArray`](#generated.RAConstantOneWayCoupling.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAConstantOneWayCoupling.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCFDParametersList`](#generated.RAConstantOneWayCoupling.GetCFDParametersList)() | Get the list of per-Particle CFD parameter sets. | +| [`GetCellAreaAsArray`](#generated.RAConstantOneWayCoupling.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAConstantOneWayCoupling.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAConstantOneWayCoupling.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAConstantOneWayCoupling.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAConstantOneWayCoupling.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAConstantOneWayCoupling.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAConstantOneWayCoupling.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAConstantOneWayCoupling.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetConvectiveHeatTransferLaw`](#generated.RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw)() | Get the current "Convective Heat Transfer Law". | +| [`GetCurve`](#generated.RAConstantOneWayCoupling.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAConstantOneWayCoupling.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RAConstantOneWayCoupling.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAConstantOneWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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". | +| [`GetMorsiAndAlexanderK2`](#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK2)() | Get the current "Morsi And Alexander K2". | +| [`GetMorsiAndAlexanderK3`](#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK3)() | Get the current "Morsi And Alexander K3". | +| [`GetNumberOfCells`](#generated.RAConstantOneWayCoupling.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAConstantOneWayCoupling.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAConstantOneWayCoupling.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAConstantOneWayCoupling.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetSpecificHeat`](#generated.RAConstantOneWayCoupling.GetSpecificHeat)([unit]) | Get the value of "Specific Heat". | +| [`GetStartTime`](#generated.RAConstantOneWayCoupling.GetStartTime)([unit]) | Get the value of "Start Time". | +| [`GetSyamlalObrienC1`](#generated.RAConstantOneWayCoupling.GetSyamlalObrienC1)() | Get the current "Syamlal Obrien C1". | +| [`GetSyamlalObrienD1`](#generated.RAConstantOneWayCoupling.GetSyamlalObrienD1)() | Get the current "Syamlal Obrien D1". | +| [`GetTemperature`](#generated.RAConstantOneWayCoupling.GetTemperature)([unit]) | Get the value of "Temperature". | +| [`GetThermalConductivity`](#generated.RAConstantOneWayCoupling.GetThermalConductivity)([unit]) | Get the value of "Thermal Conductivity". | +| [`GetTimeSet`](#generated.RAConstantOneWayCoupling.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAConstantOneWayCoupling.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAConstantOneWayCoupling.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAConstantOneWayCoupling.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTorqueLaw`](#generated.RAConstantOneWayCoupling.GetTorqueLaw)() | Get the current "Torque Law". | +| [`GetTurbulentDissipationRate`](#generated.RAConstantOneWayCoupling.GetTurbulentDissipationRate)([unit]) | Get the value of "Turbulent Dissipation Rate". | +| [`GetTurbulentKineticEnergy`](#generated.RAConstantOneWayCoupling.GetTurbulentKineticEnergy)([unit]) | Get the value of "Turbulent Kinetic Energy". | +| [`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". | +| [`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. | +| [`IsCellActive`](#generated.RAConstantOneWayCoupling.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IsTurbulentDispersionEnabled`](#generated.RAConstantOneWayCoupling.IsTurbulentDispersionEnabled)() | Check if the "Turbulent Dispersion" is enabled. | +| [`IterCellVertices`](#generated.RAConstantOneWayCoupling.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAConstantOneWayCoupling.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAConstantOneWayCoupling.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAConstantOneWayCoupling.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAConstantOneWayCoupling.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAConstantOneWayCoupling.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAConstantOneWayCoupling.RemoveProcess)() | Removes the process from the project. | +| [`SetConvectiveHeatTransferLaw`](#generated.RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw)(value) | Set the current "Convective Heat Transfer Law". | +| [`SetCurrentTimeStep`](#generated.RAConstantOneWayCoupling.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDensity`](#generated.RAConstantOneWayCoupling.SetDensity)(value[, unit]) | Set the value of "Density". | +| [`SetDragLaw`](#generated.RAConstantOneWayCoupling.SetDragLaw)(value) | Set the current "Drag Law". | +| [`SetLiftLaw`](#generated.RAConstantOneWayCoupling.SetLiftLaw)(value) | Set the current "Lift Law". | +| [`SetMorsiAndAlexanderK1`](#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK1)(value) | Set the current "Morsi And Alexander K1". | +| [`SetMorsiAndAlexanderK2`](#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK2)(value) | Set the current "Morsi And Alexander K2". | +| [`SetMorsiAndAlexanderK3`](#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK3)(value) | Set the current "Morsi And Alexander K3". | +| [`SetPartIdIfValid`](#generated.RAConstantOneWayCoupling.SetPartIdIfValid)() | Subclasses should implement this method if it's a Process with visualization | +| [`SetSpecificHeat`](#generated.RAConstantOneWayCoupling.SetSpecificHeat)(value[, unit]) | Set the value of "Specific Heat". | +| [`SetStartTime`](#generated.RAConstantOneWayCoupling.SetStartTime)(value[, unit]) | Set the value of "Start Time". | +| [`SetSyamlalObrienC1`](#generated.RAConstantOneWayCoupling.SetSyamlalObrienC1)(value) | Set the current "Syamlal Obrien C1". | +| [`SetSyamlalObrienD1`](#generated.RAConstantOneWayCoupling.SetSyamlalObrienD1)(value) | Set the current "Syamlal Obrien D1". | +| [`SetTemperature`](#generated.RAConstantOneWayCoupling.SetTemperature)(value[, unit]) | Set the value of "Temperature". | +| [`SetThermalConductivity`](#generated.RAConstantOneWayCoupling.SetThermalConductivity)(value[, unit]) | Set the value of "Thermal Conductivity". | +| [`SetTorqueLaw`](#generated.RAConstantOneWayCoupling.SetTorqueLaw)(value) | Set the current "Torque Law". | +| [`SetTurbulentDissipationRate`](#generated.RAConstantOneWayCoupling.SetTurbulentDissipationRate)(value[, unit]) | Set the value of "Turbulent Dissipation Rate". | +| [`SetTurbulentKineticEnergy`](#generated.RAConstantOneWayCoupling.SetTurbulentKineticEnergy)(value[, unit]) | Set the value of "Turbulent Kinetic Energy". | +| [`SetUseTurbulentDispersion`](#generated.RAConstantOneWayCoupling.SetUseTurbulentDispersion)(value) | Set the value of "Use Turbulent Dispersion". | +| [`SetUseUserDefinedConstants`](#generated.RAConstantOneWayCoupling.SetUseUserDefinedConstants)(value) | Set the current "Use User Defined Constants". | +| [`SetVelocity`](#generated.RAConstantOneWayCoupling.SetVelocity)(values[, unit]) | Set the values of "Velocity". | +| [`SetVirtualMassLaw`](#generated.RAConstantOneWayCoupling.SetVirtualMassLaw)(value) | Set the current "Virtual Mass Law". | +| [`SetViscosity`](#generated.RAConstantOneWayCoupling.SetViscosity)(value[, unit]) | Set the value of "Viscosity". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableTurbulentDispersion() + +Set the value of “Turbulent Dispersion” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableTurbulentDispersion() + +Set the value of “Turbulent Dispersion” to True. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCFDParametersList() + +Get the list of per-Particle CFD parameter sets. + +* **Return type:** + [RACFDParametersList](RACFDParametersList.md#generated.RACFDParametersList) + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetConvectiveHeatTransferLaw() + +Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Convective Heat Transfer Law”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDensity(unit: str | None = None) + +Get the value of “Density”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. + + + +#### GetDragLaw() + +Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Drag Law”. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetLiftLaw() + +Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Lift Law”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMorsiAndAlexanderK1() + +Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K1”. + + + +#### GetMorsiAndAlexanderK2() + +Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K2”. + + + +#### GetMorsiAndAlexanderK3() + +Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K3”. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetSpecificHeat(unit: str | None = None) + +Get the value of “Specific Heat”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”. + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetSyamlalObrienC1() + +Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Syamlal Obrien C1”. + + + +#### GetSyamlalObrienD1() + +Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Syamlal Obrien D1”. + + + +#### GetTemperature(unit: str | None = None) + +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”. + + + +#### GetThermalConductivity(unit: str | None = None) + +Get the value of “Thermal Conductivity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTorqueLaw() + +Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Torque Law”. + + + +#### GetTurbulentDissipationRate(unit: str | None = None) + +Get the value of “Turbulent Dissipation Rate”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/kg”. + + + +#### GetTurbulentKineticEnergy(unit: str | None = None) + +Get the value of “Turbulent Kinetic Energy”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. + + + +#### GetUseTurbulentDispersion() + +Get the value of “Use Turbulent Dispersion”. + + + +#### GetUseUserDefinedConstants() + +Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Use User Defined Constants”. + + + +#### GetVelocity(unit: str | None = None) + +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”. + + + +#### GetVirtualMassLaw() + +Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Virtual Mass Law”. + + + +#### GetViscosity(unit: str | None = None) + +Get the value of “Viscosity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa.s”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsTurbulentDispersionEnabled() + +Check if the “Turbulent Dispersion” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetConvectiveHeatTransferLaw(value) + +Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDensity(value: str | float, unit: str | None = None) + +Set the value of “Density”. + +* **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 “kg/m3”. + + + +#### SetDragLaw(value) + +Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetLiftLaw(value) + +Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK1(value) + +Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK2(value) + +Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK3(value) + +Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetPartIdIfValid() + +Subclasses should implement this method if it’s a Process with visualization + + + +#### SetSpecificHeat(value: str | float, unit: str | None = None) + +Set the value of “Specific Heat”. + +* **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 “J/kg.K”. + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetSyamlalObrienC1(value) + +Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetSyamlalObrienD1(value) + +Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetTemperature(value: str | float, unit: str | None = None) + +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”. + + + +#### SetThermalConductivity(value: str | float, unit: str | None = None) + +Set the value of “Thermal Conductivity”. + +* **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 “W/m.K”. + + + +#### SetTorqueLaw(value) + +Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetTurbulentDissipationRate(value: str | float, unit: str | None = None) + +Set the value of “Turbulent Dissipation Rate”. + +* **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 “W/kg”. + + + +#### SetTurbulentKineticEnergy(value: str | float, unit: str | None = None) + +Set the value of “Turbulent Kinetic Energy”. + +* **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 “J/kg”. + + + +#### SetUseTurbulentDispersion(value: bool) + +Set the value of “Use Turbulent Dispersion”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseUserDefinedConstants(value) + +Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetVelocity(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Velocity”. + +* **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/s”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetVirtualMassLaw(value) + +Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetViscosity(value: str | float, unit: str | None = None) + +Set the value of “Viscosity”. + +* **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 “Pa.s”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAContactData.md b/2025R2/rocky-prepost-scripting-manual/RAContactData.md index 3e10ee68f8..4e5259d3f4 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAContactData.md +++ b/2025R2/rocky-prepost-scripting-manual/RAContactData.md @@ -1,1017 +1,1018 @@ - - -# RAContactData - - - - - - -### *class* RAContactData - -**Methods:** - -| [`AddCurve`](#generated.RAContactData.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAContactData.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.RAContactData.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAContactData.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAContactData.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.RAContactData.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAContactData.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAContactData.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.RAContactData.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). | -| [`DisableCollectContactsData`](#generated.RAContactData.DisableCollectContactsData)() | Set the value of "Collect Contacts Data" to False. | -| [`DisableIncludeAdhesiveContacts`](#generated.RAContactData.DisableIncludeAdhesiveContacts)() | Set the value of "Include Adhesive Contacts" to False. | -| [`EditCustomCurve`](#generated.RAContactData.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.RAContactData.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. | -| [`EnableCollectContactsData`](#generated.RAContactData.EnableCollectContactsData)() | Set the value of "Collect Contacts Data" to True. | -| [`EnableIncludeAdhesiveContacts`](#generated.RAContactData.EnableIncludeAdhesiveContacts)() | Set the value of "Include Adhesive Contacts" to True. | -| [`GetActivesArray`](#generated.RAContactData.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAContactData.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAContactData.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAContactData.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAContactData.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAContactData.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAContactData.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAContactData.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAContactData.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAContactData.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCollectContactsData`](#generated.RAContactData.GetCollectContactsData)() | Get the value of "Collect Contacts Data". | -| [`GetCurve`](#generated.RAContactData.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAContactData.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfNodes`](#generated.RAContactData.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAContactData.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAContactData.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RAContactData.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IsIncludeAdhesiveContactsEnabled`](#generated.RAContactData.IsIncludeAdhesiveContactsEnabled)() | Check if the "Include Adhesive Contacts" is enabled. | -| [`IterCellVertices`](#generated.RAContactData.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAContactData.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAContactData.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAContactData.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAContactData.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAContactData.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAContactData.RemoveProcess)() | It is not possible to remove the item "Contacts" from the project. | -| [`SetCollectContactsData`](#generated.RAContactData.SetCollectContactsData)(value) | Set the value of "Collect Contacts Data". | -| [`SetCurrentTimeStep`](#generated.RAContactData.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetIncludeAdhesiveContacts`](#generated.RAContactData.SetIncludeAdhesiveContacts)(value) | Set the value of "Include Adhesive Contacts". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableCollectContactsData() - -Set the value of “Collect Contacts Data” to False. - - - -#### DisableIncludeAdhesiveContacts() - -Set the value of “Include Adhesive Contacts” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableCollectContactsData() - -Set the value of “Collect Contacts Data” to True. - - - -#### EnableIncludeAdhesiveContacts() - -Set the value of “Include Adhesive Contacts” to True. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCollectContactsData() - -Get the value of “Collect Contacts Data”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetIncludeAdhesiveContacts() - -Get the value of “Include Adhesive Contacts”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsCollectContactsDataEnabled() - -Check if the “Collect Contacts Data” is enabled. - - - -#### IsIncludeAdhesiveContactsEnabled() - -Check if the “Include Adhesive Contacts” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -It is not possible to remove the item “Contacts” from the project. It’s a standard Rocky -item in project. - - - -#### SetCollectContactsData(value: bool) - -Set the value of “Collect Contacts Data”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetIncludeAdhesiveContacts(value: bool) - -Set the value of “Include Adhesive Contacts”. - -* **Parameters:** - **value** – The value to set. + + +# RAContactData + + + + + + +### *class* RAContactData + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAContactData.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAContactData.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.RAContactData.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAContactData.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAContactData.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.RAContactData.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAContactData.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAContactData.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.RAContactData.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). | +| [`DisableCollectContactsData`](#generated.RAContactData.DisableCollectContactsData)() | Set the value of "Collect Contacts Data" to False. | +| [`DisableIncludeAdhesiveContacts`](#generated.RAContactData.DisableIncludeAdhesiveContacts)() | Set the value of "Include Adhesive Contacts" to False. | +| [`EditCustomCurve`](#generated.RAContactData.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.RAContactData.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. | +| [`EnableCollectContactsData`](#generated.RAContactData.EnableCollectContactsData)() | Set the value of "Collect Contacts Data" to True. | +| [`EnableIncludeAdhesiveContacts`](#generated.RAContactData.EnableIncludeAdhesiveContacts)() | Set the value of "Include Adhesive Contacts" to True. | +| [`GetActivesArray`](#generated.RAContactData.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAContactData.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAContactData.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAContactData.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAContactData.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAContactData.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAContactData.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAContactData.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAContactData.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAContactData.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCollectContactsData`](#generated.RAContactData.GetCollectContactsData)() | Get the value of "Collect Contacts Data". | +| [`GetCurve`](#generated.RAContactData.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAContactData.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfNodes`](#generated.RAContactData.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAContactData.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAContactData.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RAContactData.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IsIncludeAdhesiveContactsEnabled`](#generated.RAContactData.IsIncludeAdhesiveContactsEnabled)() | Check if the "Include Adhesive Contacts" is enabled. | +| [`IterCellVertices`](#generated.RAContactData.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAContactData.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAContactData.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAContactData.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAContactData.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAContactData.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAContactData.RemoveProcess)() | It is not possible to remove the item "Contacts" from the project. | +| [`SetCollectContactsData`](#generated.RAContactData.SetCollectContactsData)(value) | Set the value of "Collect Contacts Data". | +| [`SetCurrentTimeStep`](#generated.RAContactData.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetIncludeAdhesiveContacts`](#generated.RAContactData.SetIncludeAdhesiveContacts)(value) | Set the value of "Include Adhesive Contacts". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableCollectContactsData() + +Set the value of “Collect Contacts Data” to False. + + + +#### DisableIncludeAdhesiveContacts() + +Set the value of “Include Adhesive Contacts” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableCollectContactsData() + +Set the value of “Collect Contacts Data” to True. + + + +#### EnableIncludeAdhesiveContacts() + +Set the value of “Include Adhesive Contacts” to True. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCollectContactsData() + +Get the value of “Collect Contacts Data”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetIncludeAdhesiveContacts() + +Get the value of “Include Adhesive Contacts”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsCollectContactsDataEnabled() + +Check if the “Collect Contacts Data” is enabled. + + + +#### IsIncludeAdhesiveContactsEnabled() + +Check if the “Include Adhesive Contacts” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +It is not possible to remove the item “Contacts” from the project. It’s a standard Rocky +item in project. + + + +#### SetCollectContactsData(value: bool) + +Set the value of “Collect Contacts Data”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetIncludeAdhesiveContacts(value: bool) + +Set the value of “Include Adhesive Contacts”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RAContactToParticleProcess.md b/2025R2/rocky-prepost-scripting-manual/RAContactToParticleProcess.md index 1b0f9f0f8e..9449c2df9a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAContactToParticleProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RAContactToParticleProcess.md @@ -1,978 +1,979 @@ - - -# RAContactToParticleProcess - - - - - - -### *class* RAContactToParticleProcess - -Process that computes particles from a selection of contacts. - -**Methods:** - -| [`AddCurve`](#generated.RAContactToParticleProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAContactToParticleProcess.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.RAContactToParticleProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAContactToParticleProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAContactToParticleProcess.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.RAContactToParticleProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAContactToParticleProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAContactToParticleProcess.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.RAContactToParticleProcess.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.RAContactToParticleProcess.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.RAContactToParticleProcess.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.RAContactToParticleProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAContactToParticleProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAContactToParticleProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAContactToParticleProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAContactToParticleProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAContactToParticleProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAContactToParticleProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAContactToParticleProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAContactToParticleProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAContactToParticleProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAContactToParticleProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAContactToParticleProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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). | -| [`GetNumberOfParticles`](#generated.RAContactToParticleProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAContactToParticleProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAContactToParticleProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RAContactToParticleProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RAContactToParticleProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAContactToParticleProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAContactToParticleProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAContactToParticleProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAContactToParticleProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAContactToParticleProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAContactToParticleProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAContactToParticleProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + +# RAContactToParticleProcess + + + + + + +### *class* RAContactToParticleProcess + +Process that computes particles from a selection of contacts. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAContactToParticleProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAContactToParticleProcess.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.RAContactToParticleProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAContactToParticleProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAContactToParticleProcess.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.RAContactToParticleProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAContactToParticleProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAContactToParticleProcess.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.RAContactToParticleProcess.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.RAContactToParticleProcess.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.RAContactToParticleProcess.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.RAContactToParticleProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAContactToParticleProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAContactToParticleProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAContactToParticleProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAContactToParticleProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAContactToParticleProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAContactToParticleProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAContactToParticleProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAContactToParticleProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAContactToParticleProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAContactToParticleProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAContactToParticleProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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). | +| [`GetNumberOfParticles`](#generated.RAContactToParticleProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RAContactToParticleProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAContactToParticleProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RAContactToParticleProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RAContactToParticleProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RAContactToParticleProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RAContactToParticleProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAContactToParticleProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAContactToParticleProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAContactToParticleProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAContactToParticleProcess.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAContactToParticleProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. diff --git a/2025R2/rocky-prepost-scripting-manual/RAContactsDataMeshColoring.md b/2025R2/rocky-prepost-scripting-manual/RAContactsDataMeshColoring.md index 36fd25451f..8357baf187 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAContactsDataMeshColoring.md +++ b/2025R2/rocky-prepost-scripting-manual/RAContactsDataMeshColoring.md @@ -1,184 +1,185 @@ - - -# RAContactsDataMeshColoring - - - - - - -### *class* RAContactsDataMeshColoring - -**Methods:** - -| [`GetAvailableGridFunctions`](#generated.RAContactsDataMeshColoring.GetAvailableGridFunctions)() | Get a list of all possible values for "GridFunctions". | -|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| -| [`GetAvailableGridFunctionsNames`](#generated.RAContactsDataMeshColoring.GetAvailableGridFunctionsNames)() | Get a list of all possible values for "GridFunctions" names. | -| [`GetContactsColor`](#generated.RAContactsDataMeshColoring.GetContactsColor)() | Get the value of "Node Color". | -| [`GetContactsNetworkColor`](#generated.RAContactsDataMeshColoring.GetContactsNetworkColor)() | Get the value of "Contacts Network Color". | -| [`GetContactsNetworkLineWidth`](#generated.RAContactsDataMeshColoring.GetContactsNetworkLineWidth)() | Get the value of "Contacts Network Line Width". | -| [`GetContactsNetworkProperty`](#generated.RAContactsDataMeshColoring.GetContactsNetworkProperty)() | Get the value of "Contacts Network GridFunction". | -| [`GetContactsNetworkVisible`](#generated.RAContactsDataMeshColoring.GetContactsNetworkVisible)() | Get the value of "Contacts Network Visible". | -| [`GetContactsPointSize`](#generated.RAContactsDataMeshColoring.GetContactsPointSize)() | Get the value of "Contacts Point Size". | -| [`GetContactsProperty`](#generated.RAContactsDataMeshColoring.GetContactsProperty)() | Get the value of "Contacts Property". | -| [`GetContactsVisible`](#generated.RAContactsDataMeshColoring.GetContactsVisible)() | Get the value of "Contacts Visible". | -| [`GetValidColoringModes`](#generated.RAContactsDataMeshColoring.GetValidColoringModes)() | Get a list with all possible coloring modes names. | -| [`SetContactsColor`](#generated.RAContactsDataMeshColoring.SetContactsColor)(values) | Set the values of "Contacts Color". | -| [`SetContactsNetworkColor`](#generated.RAContactsDataMeshColoring.SetContactsNetworkColor)(values) | Set the values of "Contacts Network Color". | -| [`SetContactsNetworkLineWidth`](#generated.RAContactsDataMeshColoring.SetContactsNetworkLineWidth)(value) | Set the value of "Contacts Network Line Width". | -| [`SetContactsNetworkProperty`](#generated.RAContactsDataMeshColoring.SetContactsNetworkProperty)(value) | Set the values of "Contacts Network GridFunction". | -| [`SetContactsNetworkVisible`](#generated.RAContactsDataMeshColoring.SetContactsNetworkVisible)(value) | Set the value of "Contacts Network Visible". | -| [`SetContactsPointSize`](#generated.RAContactsDataMeshColoring.SetContactsPointSize)(value) | Set the value of "Contacts Point Size". | -| [`SetContactsProperty`](#generated.RAContactsDataMeshColoring.SetContactsProperty)(value) | Set the values of "Contacts Property". | -| [`SetContactsVisible`](#generated.RAContactsDataMeshColoring.SetContactsVisible)(value) | Set the value of "Contacts Visible". | - - - -#### GetAvailableGridFunctions() - -Get a list of all possible values for “GridFunctions”. - -* **Returns:** - The returned set contains the SemanticAssociation of the available Grid Functions. - - - -#### GetAvailableGridFunctionsNames() - -Get a list of all possible values for “GridFunctions” names. - -* **Returns:** - The returned set contains the names of the available Grid Functions. - - - -#### GetContactsColor() - -Get the value of “Node Color”. - - - -#### GetContactsNetworkColor() - -Get the value of “Contacts Network Color”. - - - -#### GetContactsNetworkLineWidth() - -Get the value of “Contacts Network Line Width”. - - - -#### GetContactsNetworkProperty() - -Get the value of “Contacts Network GridFunction”. - - - -#### GetContactsNetworkVisible() - -Get the value of “Contacts Network Visible”. - - - -#### GetContactsPointSize() - -Get the value of “Contacts Point Size”. - - - -#### GetContactsProperty() - -Get the value of “Contacts Property”. - - - -#### GetContactsVisible() - -Get the value of “Contacts Visible”. - - - -#### GetValidColoringModes() - -Get a list with all possible coloring modes names. - -* **Returns:** - The returned values will be a combination of [‘Contacts’, ‘Contacts Network’] - - - -#### SetContactsColor(values: tuple[float, float, float]) - -Set the values of “Contacts Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. - - - -#### SetContactsNetworkColor(values: tuple[float, float, float]) - -Set the values of “Contacts Network Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. - - - -#### SetContactsNetworkLineWidth(value: float) - -Set the value of “Contacts Network Line Width”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetContactsNetworkProperty(value: type[SemanticAssociation] | str | None) - -Set the values of “Contacts Network GridFunction”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. - - - -#### SetContactsNetworkVisible(value: bool) - -Set the value of “Contacts Network Visible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetContactsPointSize(value: float) - -Set the value of “Contacts Point Size”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetContactsProperty(value: type[SemanticAssociation] | str | None) - -Set the values of “Contacts Property”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. - - - -#### SetContactsVisible(value: bool) - -Set the value of “Contacts Visible”. - -* **Parameters:** - **value** – The value to set. + + +# RAContactsDataMeshColoring + + + + + + +### *class* RAContactsDataMeshColoring + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| [`GetAvailableGridFunctions`](#generated.RAContactsDataMeshColoring.GetAvailableGridFunctions)() | Get a list of all possible values for "GridFunctions". | +| [`GetAvailableGridFunctionsNames`](#generated.RAContactsDataMeshColoring.GetAvailableGridFunctionsNames)() | Get a list of all possible values for "GridFunctions" names. | +| [`GetContactsColor`](#generated.RAContactsDataMeshColoring.GetContactsColor)() | Get the value of "Node Color". | +| [`GetContactsNetworkColor`](#generated.RAContactsDataMeshColoring.GetContactsNetworkColor)() | Get the value of "Contacts Network Color". | +| [`GetContactsNetworkLineWidth`](#generated.RAContactsDataMeshColoring.GetContactsNetworkLineWidth)() | Get the value of "Contacts Network Line Width". | +| [`GetContactsNetworkProperty`](#generated.RAContactsDataMeshColoring.GetContactsNetworkProperty)() | Get the value of "Contacts Network GridFunction". | +| [`GetContactsNetworkVisible`](#generated.RAContactsDataMeshColoring.GetContactsNetworkVisible)() | Get the value of "Contacts Network Visible". | +| [`GetContactsPointSize`](#generated.RAContactsDataMeshColoring.GetContactsPointSize)() | Get the value of "Contacts Point Size". | +| [`GetContactsProperty`](#generated.RAContactsDataMeshColoring.GetContactsProperty)() | Get the value of "Contacts Property". | +| [`GetContactsVisible`](#generated.RAContactsDataMeshColoring.GetContactsVisible)() | Get the value of "Contacts Visible". | +| [`GetValidColoringModes`](#generated.RAContactsDataMeshColoring.GetValidColoringModes)() | Get a list with all possible coloring modes names. | +| [`SetContactsColor`](#generated.RAContactsDataMeshColoring.SetContactsColor)(values) | Set the values of "Contacts Color". | +| [`SetContactsNetworkColor`](#generated.RAContactsDataMeshColoring.SetContactsNetworkColor)(values) | Set the values of "Contacts Network Color". | +| [`SetContactsNetworkLineWidth`](#generated.RAContactsDataMeshColoring.SetContactsNetworkLineWidth)(value) | Set the value of "Contacts Network Line Width". | +| [`SetContactsNetworkProperty`](#generated.RAContactsDataMeshColoring.SetContactsNetworkProperty)(value) | Set the values of "Contacts Network GridFunction". | +| [`SetContactsNetworkVisible`](#generated.RAContactsDataMeshColoring.SetContactsNetworkVisible)(value) | Set the value of "Contacts Network Visible". | +| [`SetContactsPointSize`](#generated.RAContactsDataMeshColoring.SetContactsPointSize)(value) | Set the value of "Contacts Point Size". | +| [`SetContactsProperty`](#generated.RAContactsDataMeshColoring.SetContactsProperty)(value) | Set the values of "Contacts Property". | +| [`SetContactsVisible`](#generated.RAContactsDataMeshColoring.SetContactsVisible)(value) | Set the value of "Contacts Visible". | + + + +#### GetAvailableGridFunctions() + +Get a list of all possible values for “GridFunctions”. + +* **Returns:** + The returned set contains the SemanticAssociation of the available Grid Functions. + + + +#### GetAvailableGridFunctionsNames() + +Get a list of all possible values for “GridFunctions” names. + +* **Returns:** + The returned set contains the names of the available Grid Functions. + + + +#### GetContactsColor() + +Get the value of “Node Color”. + + + +#### GetContactsNetworkColor() + +Get the value of “Contacts Network Color”. + + + +#### GetContactsNetworkLineWidth() + +Get the value of “Contacts Network Line Width”. + + + +#### GetContactsNetworkProperty() + +Get the value of “Contacts Network GridFunction”. + + + +#### GetContactsNetworkVisible() + +Get the value of “Contacts Network Visible”. + + + +#### GetContactsPointSize() + +Get the value of “Contacts Point Size”. + + + +#### GetContactsProperty() + +Get the value of “Contacts Property”. + + + +#### GetContactsVisible() + +Get the value of “Contacts Visible”. + + + +#### GetValidColoringModes() + +Get a list with all possible coloring modes names. + +* **Returns:** + The returned values will be a combination of [‘Contacts’, ‘Contacts Network’] + + + +#### SetContactsColor(values: tuple[float, float, float]) + +Set the values of “Contacts Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. + + + +#### SetContactsNetworkColor(values: tuple[float, float, float]) + +Set the values of “Contacts Network Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. + + + +#### SetContactsNetworkLineWidth(value: float) + +Set the value of “Contacts Network Line Width”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetContactsNetworkProperty(value: type[SemanticAssociation] | str | None) + +Set the values of “Contacts Network GridFunction”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. + + + +#### SetContactsNetworkVisible(value: bool) + +Set the value of “Contacts Network Visible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetContactsPointSize(value: float) + +Set the value of “Contacts Point Size”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetContactsProperty(value: type[SemanticAssociation] | str | None) + +Set the values of “Contacts Property”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. + + + +#### SetContactsVisible(value: bool) + +Set the value of “Contacts Visible”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RACoupledWall.md b/2025R2/rocky-prepost-scripting-manual/RACoupledWall.md index 85f54d16d8..4f79d92ec9 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACoupledWall.md +++ b/2025R2/rocky-prepost-scripting-manual/RACoupledWall.md @@ -1,1081 +1,1082 @@ - - -# RACoupledWall - - - - - - -### *class* RACoupledWall - -Rocky API Geometry model. - -**Methods:** - -| [`AddCurve`](#generated.RACoupledWall.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RACoupledWall.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.RACoupledWall.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RACoupledWall.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RACoupledWall.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.RACoupledWall.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RACoupledWall.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACoupledWall.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.RACoupledWall.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.RACoupledWall.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.RACoupledWall.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.RACoupledWall.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAvailableMaterials`](#generated.RACoupledWall.GetAvailableMaterials)() | Get all available Materials. | -| [`GetBoundingBox`](#generated.RACoupledWall.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RACoupledWall.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RACoupledWall.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RACoupledWall.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RACoupledWall.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RACoupledWall.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RACoupledWall.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RACoupledWall.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RACoupledWall.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RACoupledWall.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RACoupledWall.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RACoupledWall.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`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". | -| [`GetGeometryQuantity`](#generated.RACoupledWall.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`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. | -| [`GetOutputVariableValue`](#generated.RACoupledWall.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RACoupledWall.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RACoupledWall.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`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. | -| [`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 | -| [`IterCellVertices`](#generated.RACoupledWall.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RACoupledWall.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RACoupledWall.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RACoupledWall.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RACoupledWall.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RACoupledWall.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RACoupledWall.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RACoupledWall.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDisableTime`](#generated.RACoupledWall.SetDisableTime)(value[, unit]) | Set the value of "Disable Time". | -| [`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. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDisableTime(unit: str | None = None) - -Get the value of “Disable Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### 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. - - - -#### GetEnableTime(unit: str | None = None) - -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”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### HasMotionFrame() - -Whether the boundary is linked to a motion frame. - -* **Returns:** - True if boundary is linked to a motion frame False otherwise - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDisableTime(value: str | float, unit: str | None = None) - -Set the value of “Disable Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetEnableTime(value: str | float, unit: str | None = None) - -Set the value of “Enable Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. + + +# RACoupledWall + + + + + + +### *class* RACoupledWall + +Rocky API Geometry model. + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RACoupledWall.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RACoupledWall.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.RACoupledWall.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RACoupledWall.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RACoupledWall.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.RACoupledWall.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RACoupledWall.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACoupledWall.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.RACoupledWall.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.RACoupledWall.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.RACoupledWall.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.RACoupledWall.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAvailableMaterials`](#generated.RACoupledWall.GetAvailableMaterials)() | Get all available Materials. | +| [`GetBoundingBox`](#generated.RACoupledWall.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RACoupledWall.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RACoupledWall.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RACoupledWall.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RACoupledWall.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RACoupledWall.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RACoupledWall.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RACoupledWall.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RACoupledWall.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RACoupledWall.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RACoupledWall.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RACoupledWall.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`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". | +| [`GetGeometryQuantity`](#generated.RACoupledWall.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`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. | +| [`GetOutputVariableValue`](#generated.RACoupledWall.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RACoupledWall.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RACoupledWall.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`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. | +| [`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 | +| [`IterCellVertices`](#generated.RACoupledWall.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RACoupledWall.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RACoupledWall.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RACoupledWall.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RACoupledWall.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RACoupledWall.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RACoupledWall.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RACoupledWall.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDisableTime`](#generated.RACoupledWall.SetDisableTime)(value[, unit]) | Set the value of "Disable Time". | +| [`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. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDisableTime(unit: str | None = None) + +Get the value of “Disable Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### 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. + + + +#### GetEnableTime(unit: str | None = None) + +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”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### HasMotionFrame() + +Whether the boundary is linked to a motion frame. + +* **Returns:** + True if boundary is linked to a motion frame False otherwise + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDisableTime(value: str | float, unit: str | None = None) + +Set the value of “Disable Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetEnableTime(value: str | float, unit: str | None = None) + +Set the value of “Enable Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. diff --git a/2025R2/rocky-prepost-scripting-manual/RACubeGroup.md b/2025R2/rocky-prepost-scripting-manual/RACubeGroup.md index 3a32b9d6ee..9fa79d2454 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACubeGroup.md +++ b/2025R2/rocky-prepost-scripting-manual/RACubeGroup.md @@ -1,261 +1,262 @@ - - -# RACubeGroup - - - - - - -### *class* RACubeGroup - -**Methods:** - -| [`AddCurve`](#generated.RACubeGroup.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| -| [`GetCenter`](#generated.RACubeGroup.GetCenter)([unit]) | | -| [`GetCenterAfterMovement`](#generated.RACubeGroup.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | -| [`GetCurve`](#generated.RACubeGroup.GetCurve)(curve_name[, simulation_name, ...]) | Return the curves for the given element and name. | -| [`GetCurveNames`](#generated.RACubeGroup.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RACubeGroup.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetElementCurve`](#generated.RACubeGroup.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetMotionFrame`](#generated.RACubeGroup.GetMotionFrame)() | | -| [`GetNumpyCurve`](#generated.RACubeGroup.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RACubeGroup.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RACubeGroup.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RACubeGroup.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RACubeGroup.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetRotation`](#generated.RACubeGroup.GetRotation)([unit]) | | -| [`GetSize`](#generated.RACubeGroup.GetSize)([unit]) | | -| [`SetCenter`](#generated.RACubeGroup.SetCenter)(x, y, z[, unit]) | Sets the cube X, Y and Z center | -| [`SetMotionFrame`](#generated.RACubeGroup.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RACubeGroup.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RACubeGroup.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RACubeGroup.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RACubeGroup.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetRotation`](#generated.RACubeGroup.SetRotation)(x, y, z[, unit]) | Sets the cube X, Y and Z rotation | -| [`SetSize`](#generated.RACubeGroup.SetSize)(x, y, z[, unit]) | Sets the cube X, Y and Z magnitude | - - - -#### 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 - - - -#### GetCenter(unit=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z center - - - -#### GetCenterAfterMovement(timestep: int) - -Get the Process center position considering the assigned motion. - -* **Returns:** - Returns the X, Y and Z center - - - -#### 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. - - - -#### GetMotionFrame() - -* **Returns:** - The motion frame set in the process, or None if no motion is set. - - - -#### 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. - - - -#### GetRotation(unit=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cube rotation - - - -#### GetSize(unit: str | None = None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cube magnitude - - - -#### SetCenter(x: float, y: float, z: float, unit: str | None = None) - -Sets the cube X, Y and Z center - -* **Parameters:** - * **x** – float - The center X coordinate - * **y** – The center Y coordinate - * **z** – The center Z coordinate - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetRotation(x, y, z, unit=None) - -Sets the cube X, Y and Z rotation - -* **Parameters:** - * **x** – float - The X rotation - * **y** – The Y rotation - * **z** – The Z rotation - * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) - - - -#### SetSize(x: float, y: float, z: float, unit: str | None = None) - -Sets the cube X, Y and Z magnitude - -* **Parameters:** - * **x** – float - The X magnitude - * **y** – The Y magnitude - * **z** – The Z magnitude - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + +# RACubeGroup + + + + + + +### *class* RACubeGroup + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RACubeGroup.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`GetCenter`](#generated.RACubeGroup.GetCenter)([unit]) | | +| [`GetCenterAfterMovement`](#generated.RACubeGroup.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | +| [`GetCurve`](#generated.RACubeGroup.GetCurve)(curve_name[, simulation_name, ...]) | Return the curves for the given element and name. | +| [`GetCurveNames`](#generated.RACubeGroup.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RACubeGroup.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetElementCurve`](#generated.RACubeGroup.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetMotionFrame`](#generated.RACubeGroup.GetMotionFrame)() | | +| [`GetNumpyCurve`](#generated.RACubeGroup.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RACubeGroup.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RACubeGroup.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RACubeGroup.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RACubeGroup.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetRotation`](#generated.RACubeGroup.GetRotation)([unit]) | | +| [`GetSize`](#generated.RACubeGroup.GetSize)([unit]) | | +| [`SetCenter`](#generated.RACubeGroup.SetCenter)(x, y, z[, unit]) | Sets the cube X, Y and Z center | +| [`SetMotionFrame`](#generated.RACubeGroup.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RACubeGroup.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RACubeGroup.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RACubeGroup.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RACubeGroup.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetRotation`](#generated.RACubeGroup.SetRotation)(x, y, z[, unit]) | Sets the cube X, Y and Z rotation | +| [`SetSize`](#generated.RACubeGroup.SetSize)(x, y, z[, unit]) | Sets the cube X, Y and Z magnitude | + + + +#### 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 + + + +#### GetCenter(unit=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z center + + + +#### GetCenterAfterMovement(timestep: int) + +Get the Process center position considering the assigned motion. + +* **Returns:** + Returns the X, Y and Z center + + + +#### 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. + + + +#### GetMotionFrame() + +* **Returns:** + The motion frame set in the process, or None if no motion is set. + + + +#### 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. + + + +#### GetRotation(unit=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cube rotation + + + +#### GetSize(unit: str | None = None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cube magnitude + + + +#### SetCenter(x: float, y: float, z: float, unit: str | None = None) + +Sets the cube X, Y and Z center + +* **Parameters:** + * **x** – float + The center X coordinate + * **y** – The center Y coordinate + * **z** – The center Z coordinate + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetRotation(x, y, z, unit=None) + +Sets the cube X, Y and Z rotation + +* **Parameters:** + * **x** – float + The X rotation + * **y** – The Y rotation + * **z** – The Z rotation + * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) + + + +#### SetSize(x: float, y: float, z: float, unit: str | None = None) + +Sets the cube X, Y and Z magnitude + +* **Parameters:** + * **x** – float + The X magnitude + * **y** – The Y magnitude + * **z** – The Z magnitude + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) diff --git a/2025R2/rocky-prepost-scripting-manual/RACubeProcess.md b/2025R2/rocky-prepost-scripting-manual/RACubeProcess.md index b514f8e392..a4dbb511f6 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACubeProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RACubeProcess.md @@ -1,1179 +1,1180 @@ - - -# RACubeProcess - - - - - - -### *class* RACubeProcess - -**Methods:** - -| [`AddCurve`](#generated.RACubeProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RACubeProcess.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.RACubeProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RACubeProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RACubeProcess.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.RACubeProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RACubeProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACubeProcess.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.RACubeProcess.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.RACubeProcess.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.RACubeProcess.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.RACubeProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RACubeProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RACubeProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RACubeProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RACubeProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RACubeProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RACubeProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RACubeProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RACubeProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RACubeProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfNodes`](#generated.RACubeProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RACubeProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RACubeProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RACubeProcess.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RACubeProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RACubeProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RACubeProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RACubeProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetRotation`](#generated.RACubeProcess.GetRotation)([unit]) | | -| [`GetSize`](#generated.RACubeProcess.GetSize)([unit]) | | -| [`GetTimeSet`](#generated.RACubeProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RACubeProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RACubeProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RACubeProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RACubeProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RACubeProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`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. | -| [`SetOrientationFromAngleAndVector`](#generated.RACubeProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RACubeProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RACubeProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetRotation`](#generated.RACubeProcess.SetRotation)(x, y, z[, unit]) | Sets the cube X, Y and Z rotation | -| [`SetSize`](#generated.RACubeProcess.SetSize)(x, y, z[, unit]) | Sets the cube X, Y and Z magnitude | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z center - - - -#### GetCenterAfterMovement(timestep: int) - -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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cube rotation - - - -#### GetSize(unit: str | None = None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cube 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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(x: float, y: float, z: float, unit: str | None = None) - -Sets the cube X, Y and Z center - -* **Parameters:** - * **x** – float - The center X coordinate - * **y** – The center Y coordinate - * **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) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetRotation(x, y, z, unit=None) - -Sets the cube X, Y and Z rotation - -* **Parameters:** - * **x** – float - The X rotation - * **y** – The Y rotation - * **z** – The Z rotation - * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) - - - -#### SetSize(x: float, y: float, z: float, unit: str | None = None) - -Sets the cube X, Y and Z magnitude - -* **Parameters:** - * **x** – float - The X magnitude - * **y** – The Y magnitude - * **z** – The Z magnitude - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + +# RACubeProcess + + + + + + +### *class* RACubeProcess + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RACubeProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RACubeProcess.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.RACubeProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RACubeProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RACubeProcess.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.RACubeProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RACubeProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACubeProcess.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.RACubeProcess.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.RACubeProcess.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.RACubeProcess.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.RACubeProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RACubeProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RACubeProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RACubeProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RACubeProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RACubeProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RACubeProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RACubeProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RACubeProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RACubeProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfNodes`](#generated.RACubeProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfParticles`](#generated.RACubeProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RACubeProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RACubeProcess.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RACubeProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RACubeProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RACubeProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RACubeProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetRotation`](#generated.RACubeProcess.GetRotation)([unit]) | | +| [`GetSize`](#generated.RACubeProcess.GetSize)([unit]) | | +| [`GetTimeSet`](#generated.RACubeProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RACubeProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RACubeProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RACubeProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RACubeProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RACubeProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`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. | +| [`SetOrientationFromAngleAndVector`](#generated.RACubeProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RACubeProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RACubeProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetRotation`](#generated.RACubeProcess.SetRotation)(x, y, z[, unit]) | Sets the cube X, Y and Z rotation | +| [`SetSize`](#generated.RACubeProcess.SetSize)(x, y, z[, unit]) | Sets the cube X, Y and Z magnitude | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z center + + + +#### GetCenterAfterMovement(timestep: int) + +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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cube rotation + + + +#### GetSize(unit: str | None = None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cube 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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(x: float, y: float, z: float, unit: str | None = None) + +Sets the cube X, Y and Z center + +* **Parameters:** + * **x** – float + The center X coordinate + * **y** – The center Y coordinate + * **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) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetRotation(x, y, z, unit=None) + +Sets the cube X, Y and Z rotation + +* **Parameters:** + * **x** – float + The X rotation + * **y** – The Y rotation + * **z** – The Z rotation + * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) + + + +#### SetSize(x: float, y: float, z: float, unit: str | None = None) + +Sets the cube X, Y and Z magnitude + +* **Parameters:** + * **x** – float + The X magnitude + * **y** – The Y magnitude + * **z** – The Z magnitude + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) diff --git a/2025R2/rocky-prepost-scripting-manual/RACustomInput.md b/2025R2/rocky-prepost-scripting-manual/RACustomInput.md index a355e89dde..bbe67883e2 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACustomInput.md +++ b/2025R2/rocky-prepost-scripting-manual/RACustomInput.md @@ -1,193 +1,194 @@ - - -# RACustomInput - - - - - - -### *class* RACustomInput - -Rocky PrePost Scripting wrapper for a single Custom Input. - -This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s -data tree. Particle inputs can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) via: - -```python -input_1 = study.GetElement('Custom Input <1>') -input_2 = input_collection.GetParticleInput('Custom Input <2>') -``` - -Instances of [`RACustomInput`](#generated.RACustomInput) gives access to its two properties: -The id of the Particle that will be used in the particle generation and the path of the csv file which will -contain the information for each desired particle to be generated, such as, positioning, size, release time. - -**Methods:** - -| [`GetAvailableMotionFrames`](#generated.RACustomInput.GetAvailableMotionFrames)() | Get all available Motion Frames. | -|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| -| [`GetAvailableParticles`](#generated.RACustomInput.GetAvailableParticles)() | Get all available Particles. | -| [`GetDefaultTemperature`](#generated.RACustomInput.GetDefaultTemperature)([unit]) | Get the value of "Default Temperature". | -| [`GetFilePath`](#generated.RACustomInput.GetFilePath)() | Get the value of "File Path". | -| [`GetModuleProperties`](#generated.RACustomInput.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RACustomInput.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetMotionFrame`](#generated.RACustomInput.GetMotionFrame)() | Get the "Motion Frame". | -| [`GetParticle`](#generated.RACustomInput.GetParticle)() | Get the "Particle". | -| [`GetValidOptionsForModuleProperty`](#generated.RACustomInput.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`SetDefaultTemperature`](#generated.RACustomInput.SetDefaultTemperature)(value[, unit]) | Set the value of "Default Temperature". | -| [`SetFilePath`](#generated.RACustomInput.SetFilePath)(file_path) | Set the path of the file that will be used to generate the particles described on the content of the file. | -| [`SetModuleProperty`](#generated.RACustomInput.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetMotionFrame`](#generated.RACustomInput.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the custom input. | -| [`SetParticle`](#generated.RACustomInput.SetParticle)(value) | Set the "Particle". | - - - -#### GetAvailableMotionFrames() - -Get all available Motion Frames. - -* **Return type:** - List[[`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame)] - A list of [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame). - - - -#### GetAvailableParticles() - -Get all available Particles. - -* **Return type:** - List[[`RAParticle`](RAParticle.md#generated.RAParticle)] - A list of [`RAParticle`](RAParticle.md#generated.RAParticle). - - - -#### GetDefaultTemperature(unit: str | None = None) - -Get the value of “Default Temperature”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “K”. - - - -#### GetFilePath() - -Get the value of “File Path”. - -* **Return type:** - str - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetMotionFrame() - -Get the “Motion Frame”. - -* **Return type:** - [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame) - - - -#### GetParticle() - -Get the “Particle”. - -* **Return type:** - [`RAParticle`](RAParticle.md#generated.RAParticle) - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### SetDefaultTemperature(value: str | float, unit: str | None = None) - -Set the value of “Default 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”. - - - -#### SetFilePath(file_path) - -Set the path of the file that will be used to generate the particles -described on the content of the file. - -The accepted file extensions are [“.csv”, “.xls”, “.xlsx”, “.xlsm”, “.xlsb”, “.odf”]. - -* **Parameters:** - **file_path** (*str* *or* *Path*) - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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](RAMotionFrame.md#generated.RAMotionFrame) | str | None) - -Assign a Motion Frame to the custom input. - -* **Parameters:** - **motion_frame** – Either the API object or its name. - - - -#### SetParticle(value) - -Set the “Particle”. - -:param unicode, [`RAParticle`](RAParticle.md#generated.RAParticle) value: -: Either the API object wrapping the desired entity or its name. + + +# RACustomInput + + + + + + +### *class* RACustomInput + +Rocky PrePost Scripting wrapper for a single Custom Input. + +This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s +data tree. Particle inputs can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) via: + +```python +input_1 = study.GetElement('Custom Input <1>') +input_2 = input_collection.GetParticleInput('Custom Input <2>') +``` + +Instances of [`RACustomInput`](#generated.RACustomInput) gives access to its two properties: +The id of the Particle that will be used in the particle generation and the path of the csv file which will +contain the information for each desired particle to be generated, such as, positioning, size, release time. + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| [`GetAvailableMotionFrames`](#generated.RACustomInput.GetAvailableMotionFrames)() | Get all available Motion Frames. | +| [`GetAvailableParticles`](#generated.RACustomInput.GetAvailableParticles)() | Get all available Particles. | +| [`GetDefaultTemperature`](#generated.RACustomInput.GetDefaultTemperature)([unit]) | Get the value of "Default Temperature". | +| [`GetFilePath`](#generated.RACustomInput.GetFilePath)() | Get the value of "File Path". | +| [`GetModuleProperties`](#generated.RACustomInput.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RACustomInput.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetMotionFrame`](#generated.RACustomInput.GetMotionFrame)() | Get the "Motion Frame". | +| [`GetParticle`](#generated.RACustomInput.GetParticle)() | Get the "Particle". | +| [`GetValidOptionsForModuleProperty`](#generated.RACustomInput.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`SetDefaultTemperature`](#generated.RACustomInput.SetDefaultTemperature)(value[, unit]) | Set the value of "Default Temperature". | +| [`SetFilePath`](#generated.RACustomInput.SetFilePath)(file_path) | Set the path of the file that will be used to generate the particles described on the content of the file. | +| [`SetModuleProperty`](#generated.RACustomInput.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetMotionFrame`](#generated.RACustomInput.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the custom input. | +| [`SetParticle`](#generated.RACustomInput.SetParticle)(value) | Set the "Particle". | + + + +#### GetAvailableMotionFrames() + +Get all available Motion Frames. + +* **Return type:** + List[[`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame)] + A list of [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame). + + + +#### GetAvailableParticles() + +Get all available Particles. + +* **Return type:** + List[[`RAParticle`](RAParticle.md#generated.RAParticle)] + A list of [`RAParticle`](RAParticle.md#generated.RAParticle). + + + +#### GetDefaultTemperature(unit: str | None = None) + +Get the value of “Default Temperature”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “K”. + + + +#### GetFilePath() + +Get the value of “File Path”. + +* **Return type:** + str + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetMotionFrame() + +Get the “Motion Frame”. + +* **Return type:** + [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame) + + + +#### GetParticle() + +Get the “Particle”. + +* **Return type:** + [`RAParticle`](RAParticle.md#generated.RAParticle) + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### SetDefaultTemperature(value: str | float, unit: str | None = None) + +Set the value of “Default 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”. + + + +#### SetFilePath(file_path) + +Set the path of the file that will be used to generate the particles +described on the content of the file. + +The accepted file extensions are [“.csv”, “.xls”, “.xlsx”, “.xlsm”, “.xlsb”, “.odf”]. + +* **Parameters:** + **file_path** (*str* *or* *Path*) + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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](RAMotionFrame.md#generated.RAMotionFrame) | str | None) + +Assign a Motion Frame to the custom input. + +* **Parameters:** + **motion_frame** – Either the API object or its name. + + + +#### SetParticle(value) + +Set the “Particle”. + +:param unicode, [`RAParticle`](RAParticle.md#generated.RAParticle) value: +: Either the API object wrapping the desired entity or its name. diff --git a/2025R2/rocky-prepost-scripting-manual/RACylinderGroup.md b/2025R2/rocky-prepost-scripting-manual/RACylinderGroup.md index dba31673c2..41d4d32014 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACylinderGroup.md +++ b/2025R2/rocky-prepost-scripting-manual/RACylinderGroup.md @@ -1,324 +1,325 @@ - - -# RACylinderGroup - - - - - - -### *class* RACylinderGroup - -**Methods:** - -| [`AddCurve`](#generated.RACylinderGroup.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| -| [`GetCenter`](#generated.RACylinderGroup.GetCenter)([unit]) | | -| [`GetCenterAfterMovement`](#generated.RACylinderGroup.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | -| [`GetCurve`](#generated.RACylinderGroup.GetCurve)(curve_name[, simulation_name, ...]) | Return the curves for the given element and name. | -| [`GetCurveNames`](#generated.RACylinderGroup.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RACylinderGroup.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetElementCurve`](#generated.RACylinderGroup.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetFinalAngle`](#generated.RACylinderGroup.GetFinalAngle)([unit]) | | -| [`GetInitialAngle`](#generated.RACylinderGroup.GetInitialAngle)([unit]) | | -| [`GetInternalFactor`](#generated.RACylinderGroup.GetInternalFactor)([unit]) | | -| [`GetMotionFrame`](#generated.RACylinderGroup.GetMotionFrame)() | | -| [`GetNumpyCurve`](#generated.RACylinderGroup.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RACylinderGroup.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RACylinderGroup.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RACylinderGroup.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RACylinderGroup.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetRotation`](#generated.RACylinderGroup.GetRotation)([unit]) | | -| [`GetSize`](#generated.RACylinderGroup.GetSize)([unit]) | | -| [`SetCenter`](#generated.RACylinderGroup.SetCenter)(x, y, z[, unit]) | Sets the cylinder X, Y and Z center | -| [`SetFinalAngle`](#generated.RACylinderGroup.SetFinalAngle)(final_angle[, unit]) | Sets the final hole radius factor of the final given by the size | -| [`SetInitialAngle`](#generated.RACylinderGroup.SetInitialAngle)(initial_angle[, unit]) | Sets the initial hole radius factor of the external given by the size | -| [`SetInternalFactor`](#generated.RACylinderGroup.SetInternalFactor)(internal_factor[, unit]) | Sets the internal hole radius factor of the external given by the size | -| [`SetMotionFrame`](#generated.RACylinderGroup.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RACylinderGroup.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RACylinderGroup.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RACylinderGroup.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RACylinderGroup.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetRotation`](#generated.RACylinderGroup.SetRotation)(x, y, z[, unit]) | Sets the cylinder X, Y and Z rotation | -| [`SetSize`](#generated.RACylinderGroup.SetSize)(x, y, z[, unit]) | Sets the cylinder X, Y and Z magnitude | - - - -#### 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 - - - -#### GetCenter(unit=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z center - - - -#### GetCenterAfterMovement(timestep: int) - -Get the Process center position considering the assigned motion. - -* **Returns:** - Returns the X, Y and Z center - - - -#### 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. - - - -#### GetFinalAngle(unit=None) - -* **Return final_angle:** - float - The final angle (default dega) of the final given by the size - - - -#### GetInitialAngle(unit=None) - -* **Return initial_angle:** - float - The initial angle (default dega) of the external given by the size - - - -#### GetInternalFactor(unit=None) - -* **Return internal_factor:** - float - The internal hole radius factor (default %) of the external given by the size - - - -#### GetMotionFrame() - -* **Returns:** - The motion frame set in the process, or None if no motion is set. - - - -#### 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. - - - -#### GetRotation(unit=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cylinder rotation - - - -#### GetSize(unit: str | None = None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cylinder magnitude - - - -#### SetCenter(x: float, y: float, z: float, unit: str | None = None) - -Sets the cylinder X, Y and Z center - -* **Parameters:** - * **x** – float - The center X coordinate - * **y** – The center Y coordinate - * **z** – The center Z coordinate - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) - - - -#### SetFinalAngle(final_angle, unit=None) - -Sets the final hole radius factor of the final given by the size - -* **Parameters:** - * **final_angle** – float - The final angle - * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) - - - -#### SetInitialAngle(initial_angle, unit=None) - -Sets the initial hole radius factor of the external given by the size - -* **Parameters:** - * **initial_angle** – float - The initial angle - * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) - - - -#### SetInternalFactor(internal_factor, unit=None) - -Sets the internal hole radius factor of the external given by the size - -* **Parameters:** - * **internal_factor** – float - The internal factor - * **unit** (*str* *|**None*) – The unit of the given value or None if given in percentage (%) - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetRotation(x, y, z, unit=None) - -Sets the cylinder X, Y and Z rotation - -* **Parameters:** - * **x** – float - The X rotation - * **y** – The Y rotation - * **z** – The Z rotation - * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) - - - -#### SetSize(x: float, y: float, z: float, unit: str | None = None) - -Sets the cylinder X, Y and Z magnitude - -* **Parameters:** - * **x** – float - The X magnitude - * **y** – The Y magnitude - * **z** – The Z magnitude - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + +# RACylinderGroup + + + + + + +### *class* RACylinderGroup + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RACylinderGroup.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`GetCenter`](#generated.RACylinderGroup.GetCenter)([unit]) | | +| [`GetCenterAfterMovement`](#generated.RACylinderGroup.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | +| [`GetCurve`](#generated.RACylinderGroup.GetCurve)(curve_name[, simulation_name, ...]) | Return the curves for the given element and name. | +| [`GetCurveNames`](#generated.RACylinderGroup.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RACylinderGroup.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetElementCurve`](#generated.RACylinderGroup.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFinalAngle`](#generated.RACylinderGroup.GetFinalAngle)([unit]) | | +| [`GetInitialAngle`](#generated.RACylinderGroup.GetInitialAngle)([unit]) | | +| [`GetInternalFactor`](#generated.RACylinderGroup.GetInternalFactor)([unit]) | | +| [`GetMotionFrame`](#generated.RACylinderGroup.GetMotionFrame)() | | +| [`GetNumpyCurve`](#generated.RACylinderGroup.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RACylinderGroup.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RACylinderGroup.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RACylinderGroup.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RACylinderGroup.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetRotation`](#generated.RACylinderGroup.GetRotation)([unit]) | | +| [`GetSize`](#generated.RACylinderGroup.GetSize)([unit]) | | +| [`SetCenter`](#generated.RACylinderGroup.SetCenter)(x, y, z[, unit]) | Sets the cylinder X, Y and Z center | +| [`SetFinalAngle`](#generated.RACylinderGroup.SetFinalAngle)(final_angle[, unit]) | Sets the final hole radius factor of the final given by the size | +| [`SetInitialAngle`](#generated.RACylinderGroup.SetInitialAngle)(initial_angle[, unit]) | Sets the initial hole radius factor of the external given by the size | +| [`SetInternalFactor`](#generated.RACylinderGroup.SetInternalFactor)(internal_factor[, unit]) | Sets the internal hole radius factor of the external given by the size | +| [`SetMotionFrame`](#generated.RACylinderGroup.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RACylinderGroup.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RACylinderGroup.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RACylinderGroup.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RACylinderGroup.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetRotation`](#generated.RACylinderGroup.SetRotation)(x, y, z[, unit]) | Sets the cylinder X, Y and Z rotation | +| [`SetSize`](#generated.RACylinderGroup.SetSize)(x, y, z[, unit]) | Sets the cylinder X, Y and Z magnitude | + + + +#### 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 + + + +#### GetCenter(unit=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z center + + + +#### GetCenterAfterMovement(timestep: int) + +Get the Process center position considering the assigned motion. + +* **Returns:** + Returns the X, Y and Z center + + + +#### 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. + + + +#### GetFinalAngle(unit=None) + +* **Return final_angle:** + float + The final angle (default dega) of the final given by the size + + + +#### GetInitialAngle(unit=None) + +* **Return initial_angle:** + float + The initial angle (default dega) of the external given by the size + + + +#### GetInternalFactor(unit=None) + +* **Return internal_factor:** + float + The internal hole radius factor (default %) of the external given by the size + + + +#### GetMotionFrame() + +* **Returns:** + The motion frame set in the process, or None if no motion is set. + + + +#### 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. + + + +#### GetRotation(unit=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cylinder rotation + + + +#### GetSize(unit: str | None = None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cylinder magnitude + + + +#### SetCenter(x: float, y: float, z: float, unit: str | None = None) + +Sets the cylinder X, Y and Z center + +* **Parameters:** + * **x** – float + The center X coordinate + * **y** – The center Y coordinate + * **z** – The center Z coordinate + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + + +#### SetFinalAngle(final_angle, unit=None) + +Sets the final hole radius factor of the final given by the size + +* **Parameters:** + * **final_angle** – float + The final angle + * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) + + + +#### SetInitialAngle(initial_angle, unit=None) + +Sets the initial hole radius factor of the external given by the size + +* **Parameters:** + * **initial_angle** – float + The initial angle + * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) + + + +#### SetInternalFactor(internal_factor, unit=None) + +Sets the internal hole radius factor of the external given by the size + +* **Parameters:** + * **internal_factor** – float + The internal factor + * **unit** (*str* *|**None*) – The unit of the given value or None if given in percentage (%) + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetRotation(x, y, z, unit=None) + +Sets the cylinder X, Y and Z rotation + +* **Parameters:** + * **x** – float + The X rotation + * **y** – The Y rotation + * **z** – The Z rotation + * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) + + + +#### SetSize(x: float, y: float, z: float, unit: str | None = None) + +Sets the cylinder X, Y and Z magnitude + +* **Parameters:** + * **x** – float + The X magnitude + * **y** – The Y magnitude + * **z** – The Z magnitude + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) diff --git a/2025R2/rocky-prepost-scripting-manual/RACylinderProcess.md b/2025R2/rocky-prepost-scripting-manual/RACylinderProcess.md index bf91f608f7..ca4cdfd220 100644 --- a/2025R2/rocky-prepost-scripting-manual/RACylinderProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RACylinderProcess.md @@ -1,1200 +1,1201 @@ - - -# RACylinderProcess - - - - - - -### *class* RACylinderProcess - -**Methods:** - -| [`AddCurve`](#generated.RACylinderProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RACylinderProcess.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.RACylinderProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RACylinderProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RACylinderProcess.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.RACylinderProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RACylinderProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACylinderProcess.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.RACylinderProcess.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.RACylinderProcess.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.RACylinderProcess.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.RACylinderProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RACylinderProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RACylinderProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RACylinderProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RACylinderProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RACylinderProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RACylinderProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RACylinderProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RACylinderProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RACylinderProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RACylinderProcess.GetCenter)([unit]) | | -| [`GetCenterAfterMovement`](#generated.RACylinderProcess.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | -| [`GetCurve`](#generated.RACylinderProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetFinalAngle`](#generated.RACylinderProcess.GetFinalAngle)([unit]) | | -| [`GetGeometryQuantity`](#generated.RACylinderProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetMotionFrame`](#generated.RACylinderProcess.GetMotionFrame)() | | -| [`GetNumberOfCells`](#generated.RACylinderProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RACylinderProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RACylinderProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RACylinderProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RACylinderProcess.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RACylinderProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RACylinderProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RACylinderProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RACylinderProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetRotation`](#generated.RACylinderProcess.GetRotation)([unit]) | | -| [`GetSize`](#generated.RACylinderProcess.GetSize)([unit]) | | -| [`GetTimeSet`](#generated.RACylinderProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RACylinderProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RACylinderProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RACylinderProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RACylinderProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RACylinderProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RACylinderProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RACylinderProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCenter`](#generated.RACylinderProcess.SetCenter)(x, y, z[, unit]) | Sets the cylinder X, Y and Z center | -| [`SetCurrentTimeStep`](#generated.RACylinderProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetFinalAngle`](#generated.RACylinderProcess.SetFinalAngle)(final_angle[, unit]) | Sets the final hole radius factor of the final given by the size | -| [`SetInitialAngle`](#generated.RACylinderProcess.SetInitialAngle)(initial_angle[, unit]) | Sets the initial hole radius factor of the external given by the size | -| [`SetInternalFactor`](#generated.RACylinderProcess.SetInternalFactor)(internal_factor[, unit]) | Sets the internal hole radius factor of the external given by the size | -| [`SetMotionFrame`](#generated.RACylinderProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RACylinderProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RACylinderProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RACylinderProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RACylinderProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetRotation`](#generated.RACylinderProcess.SetRotation)(x, y, z[, unit]) | Sets the cylinder X, Y and Z rotation | -| [`SetSize`](#generated.RACylinderProcess.SetSize)(x, y, z[, unit]) | Sets the cylinder X, Y and Z magnitude | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z center - - - -#### GetCenterAfterMovement(timestep: int) - -Get the Process center position considering the assigned motion. - -* **Returns:** - Returns the X, Y and Z center - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetFinalAngle(unit=None) - -* **Return final_angle:** - float - The final angle (default dega) of the final given by the size - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetInitialAngle(unit=None) - -* **Return initial_angle:** - float - The initial angle (default dega) of the external given by the size - - - -#### GetInternalFactor(unit=None) - -* **Return internal_factor:** - float - The internal hole radius factor (default %) of the external given by the size - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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=None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cylinder rotation - - - -#### GetSize(unit: str | None = None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z cylinder 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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(x: float, y: float, z: float, unit: str | None = None) - -Sets the cylinder X, Y and Z center - -* **Parameters:** - * **x** – float - The center X coordinate - * **y** – The center Y coordinate - * **z** – The center Z coordinate - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetFinalAngle(final_angle, unit=None) - -Sets the final hole radius factor of the final given by the size - -* **Parameters:** - * **final_angle** – float - The final angle - * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) - - - -#### SetInitialAngle(initial_angle, unit=None) - -Sets the initial hole radius factor of the external given by the size - -* **Parameters:** - * **initial_angle** – float - The initial angle - * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) - - - -#### SetInternalFactor(internal_factor, unit=None) - -Sets the internal hole radius factor of the external given by the size - -* **Parameters:** - * **internal_factor** – float - The internal factor - * **unit** (*str* *|**None*) – The unit of the given value or None if given in percentage (%) - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetRotation(x, y, z, unit=None) - -Sets the cylinder X, Y and Z rotation - -* **Parameters:** - * **x** – float - The X rotation - * **y** – The Y rotation - * **z** – The Z rotation - * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) - - - -#### SetSize(x: float, y: float, z: float, unit: str | None = None) - -Sets the cylinder X, Y and Z magnitude - -* **Parameters:** - * **x** – float - The X magnitude - * **y** – The Y magnitude - * **z** – The Z magnitude - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + +# RACylinderProcess + + + + + + +### *class* RACylinderProcess + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RACylinderProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RACylinderProcess.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.RACylinderProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RACylinderProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RACylinderProcess.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.RACylinderProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RACylinderProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RACylinderProcess.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.RACylinderProcess.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.RACylinderProcess.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.RACylinderProcess.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.RACylinderProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RACylinderProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RACylinderProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RACylinderProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RACylinderProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RACylinderProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RACylinderProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RACylinderProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RACylinderProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RACylinderProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RACylinderProcess.GetCenter)([unit]) | | +| [`GetCenterAfterMovement`](#generated.RACylinderProcess.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | +| [`GetCurve`](#generated.RACylinderProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetFinalAngle`](#generated.RACylinderProcess.GetFinalAngle)([unit]) | | +| [`GetGeometryQuantity`](#generated.RACylinderProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetMotionFrame`](#generated.RACylinderProcess.GetMotionFrame)() | | +| [`GetNumberOfCells`](#generated.RACylinderProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RACylinderProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfParticles`](#generated.RACylinderProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RACylinderProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RACylinderProcess.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RACylinderProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RACylinderProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RACylinderProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RACylinderProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetRotation`](#generated.RACylinderProcess.GetRotation)([unit]) | | +| [`GetSize`](#generated.RACylinderProcess.GetSize)([unit]) | | +| [`GetTimeSet`](#generated.RACylinderProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RACylinderProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RACylinderProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RACylinderProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RACylinderProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RACylinderProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RACylinderProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RACylinderProcess.RemoveProcess)() | Removes the process from the project. | +| [`SetCenter`](#generated.RACylinderProcess.SetCenter)(x, y, z[, unit]) | Sets the cylinder X, Y and Z center | +| [`SetCurrentTimeStep`](#generated.RACylinderProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetFinalAngle`](#generated.RACylinderProcess.SetFinalAngle)(final_angle[, unit]) | Sets the final hole radius factor of the final given by the size | +| [`SetInitialAngle`](#generated.RACylinderProcess.SetInitialAngle)(initial_angle[, unit]) | Sets the initial hole radius factor of the external given by the size | +| [`SetInternalFactor`](#generated.RACylinderProcess.SetInternalFactor)(internal_factor[, unit]) | Sets the internal hole radius factor of the external given by the size | +| [`SetMotionFrame`](#generated.RACylinderProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RACylinderProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RACylinderProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RACylinderProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RACylinderProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetRotation`](#generated.RACylinderProcess.SetRotation)(x, y, z[, unit]) | Sets the cylinder X, Y and Z rotation | +| [`SetSize`](#generated.RACylinderProcess.SetSize)(x, y, z[, unit]) | Sets the cylinder X, Y and Z magnitude | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z center + + + +#### GetCenterAfterMovement(timestep: int) + +Get the Process center position considering the assigned motion. + +* **Returns:** + Returns the X, Y and Z center + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetFinalAngle(unit=None) + +* **Return final_angle:** + float + The final angle (default dega) of the final given by the size + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetInitialAngle(unit=None) + +* **Return initial_angle:** + float + The initial angle (default dega) of the external given by the size + + + +#### GetInternalFactor(unit=None) + +* **Return internal_factor:** + float + The internal hole radius factor (default %) of the external given by the size + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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=None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cylinder rotation + + + +#### GetSize(unit: str | None = None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z cylinder 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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(x: float, y: float, z: float, unit: str | None = None) + +Sets the cylinder X, Y and Z center + +* **Parameters:** + * **x** – float + The center X coordinate + * **y** – The center Y coordinate + * **z** – The center Z coordinate + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetFinalAngle(final_angle, unit=None) + +Sets the final hole radius factor of the final given by the size + +* **Parameters:** + * **final_angle** – float + The final angle + * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) + + + +#### SetInitialAngle(initial_angle, unit=None) + +Sets the initial hole radius factor of the external given by the size + +* **Parameters:** + * **initial_angle** – float + The initial angle + * **unit** (*str* *|**None*) – The unit of the given value or None if given in degrees (dega) + + + +#### SetInternalFactor(internal_factor, unit=None) + +Sets the internal hole radius factor of the external given by the size + +* **Parameters:** + * **internal_factor** – float + The internal factor + * **unit** (*str* *|**None*) – The unit of the given value or None if given in percentage (%) + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetRotation(x, y, z, unit=None) + +Sets the cylinder X, Y and Z rotation + +* **Parameters:** + * **x** – float + The X rotation + * **y** – The Y rotation + * **z** – The Z rotation + * **unit** (*str* *|**None*) – The unit of the given values or None if given in degrees (dega) + + + +#### SetSize(x: float, y: float, z: float, unit: str | None = None) + +Sets the cylinder X, Y and Z magnitude + +* **Parameters:** + * **x** – float + The X magnitude + * **y** – The Y magnitude + * **z** – The Z magnitude + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) diff --git a/2025R2/rocky-prepost-scripting-manual/RADivisionsTagging.md b/2025R2/rocky-prepost-scripting-manual/RADivisionsTagging.md index 833438ee06..7805750d93 100644 --- a/2025R2/rocky-prepost-scripting-manual/RADivisionsTagging.md +++ b/2025R2/rocky-prepost-scripting-manual/RADivisionsTagging.md @@ -1,147 +1,148 @@ - - -# RADivisionsTagging - - - - - - -### *class* RADivisionsTagging - -Rocky PrePost Scripting wrapper to manipulate Divisions Tagging Calculators in a project. - -The class corresponds to an individual “Divisions Tagging” calculation under -the “Particles Calculation” item on the project’s data tree. To create the -[`RADivisionsTagging`](#generated.RADivisionsTagging) from a [`RACalculations`](RACalculations.md#generated.RACalculations), use: - -```python -selection_process = study.GetElement('Cube <01>) -particles_calculations = study.GetCalculations() -divisions_tagging = particles_calculations.CreateDivisionsTagging(selection_process) -``` - -**Methods:** - -| [`GetDivisionsI`](#generated.RADivisionsTagging.GetDivisionsI)() | Get the value of "Divisions I". | -|------------------------------------------------------------------------------|---------------------------------------------------------------| -| [`GetDivisionsJ`](#generated.RADivisionsTagging.GetDivisionsJ)() | Get the value of "Divisions J". | -| [`GetDivisionsK`](#generated.RADivisionsTagging.GetDivisionsK)() | Get the value of "Divisions K". | -| [`GetGridFunctionName`](#generated.RADivisionsTagging.GetGridFunctionName)() | Get the tagging grid function name. | -| [`GetNameMask`](#generated.RADivisionsTagging.GetNameMask)() | Get the value of "Name Mask". | -| [`GetTagStride`](#generated.RADivisionsTagging.GetTagStride)() | Get the value of "Tag Stride". | -| [`GetTagValue`](#generated.RADivisionsTagging.GetTagValue)() | Get the value of "Tag Value". | -| [`GetTimeRangeFilter`](#generated.RADivisionsTagging.GetTimeRangeFilter)() | Get the API object that wraps the specific Time Range Filter. | -| [`SetDivisionsI`](#generated.RADivisionsTagging.SetDivisionsI)(value) | Set the value of "Divisions I". | -| [`SetDivisionsJ`](#generated.RADivisionsTagging.SetDivisionsJ)(value) | Set the value of "Divisions J". | -| [`SetDivisionsK`](#generated.RADivisionsTagging.SetDivisionsK)(value) | Set the value of "Divisions K". | -| [`SetNameMask`](#generated.RADivisionsTagging.SetNameMask)(value) | Set the value of "Name Mask". | -| [`SetTagStride`](#generated.RADivisionsTagging.SetTagStride)(value) | Set the value of "Tag Stride". | -| [`SetTagValue`](#generated.RADivisionsTagging.SetTagValue)(value) | Set the value of "Tag Value". | - - - -#### GetDivisionsI() - -Get the value of “Divisions I”. - - - -#### GetDivisionsJ() - -Get the value of “Divisions J”. - - - -#### GetDivisionsK() - -Get the value of “Divisions K”. - - - -#### GetGridFunctionName() - -Get the tagging grid function name. This name can be used to access the tagging grid -function on a particle-based process. -:rtype: str - - - -#### GetNameMask() - -Get the value of “Name Mask”. - - - -#### GetTagStride() - -Get the value of “Tag Stride”. - - - -#### GetTagValue() - -Get the value of “Tag Value”. - - - -#### GetTimeRangeFilter() - -Get the API object that wraps the specific Time Range Filter. -:rtype: RATimeRangeFilter - - - -#### SetDivisionsI(value: str | int) - -Set the value of “Divisions I”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetDivisionsJ(value: str | int) - -Set the value of “Divisions J”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetDivisionsK(value: str | int) - -Set the value of “Divisions K”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetNameMask(value: str) - -Set the value of “Name Mask”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetTagStride(value: str | int) - -Set the value of “Tag Stride”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetTagValue(value: str | int) - -Set the value of “Tag Value”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. + + +# RADivisionsTagging + + + + + + +### *class* RADivisionsTagging + +Rocky PrePost Scripting wrapper to manipulate Divisions Tagging Calculators in a project. + +The class corresponds to an individual “Divisions Tagging” calculation under +the “Particles Calculation” item on the project’s data tree. To create the +[`RADivisionsTagging`](#generated.RADivisionsTagging) from a [`RACalculations`](RACalculations.md#generated.RACalculations), use: + +```python +selection_process = study.GetElement('Cube <01>) +particles_calculations = study.GetCalculations() +divisions_tagging = particles_calculations.CreateDivisionsTagging(selection_process) +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------|---------------------------------------------------------------| +| [`GetDivisionsI`](#generated.RADivisionsTagging.GetDivisionsI)() | Get the value of "Divisions I". | +| [`GetDivisionsJ`](#generated.RADivisionsTagging.GetDivisionsJ)() | Get the value of "Divisions J". | +| [`GetDivisionsK`](#generated.RADivisionsTagging.GetDivisionsK)() | Get the value of "Divisions K". | +| [`GetGridFunctionName`](#generated.RADivisionsTagging.GetGridFunctionName)() | Get the tagging grid function name. | +| [`GetNameMask`](#generated.RADivisionsTagging.GetNameMask)() | Get the value of "Name Mask". | +| [`GetTagStride`](#generated.RADivisionsTagging.GetTagStride)() | Get the value of "Tag Stride". | +| [`GetTagValue`](#generated.RADivisionsTagging.GetTagValue)() | Get the value of "Tag Value". | +| [`GetTimeRangeFilter`](#generated.RADivisionsTagging.GetTimeRangeFilter)() | Get the API object that wraps the specific Time Range Filter. | +| [`SetDivisionsI`](#generated.RADivisionsTagging.SetDivisionsI)(value) | Set the value of "Divisions I". | +| [`SetDivisionsJ`](#generated.RADivisionsTagging.SetDivisionsJ)(value) | Set the value of "Divisions J". | +| [`SetDivisionsK`](#generated.RADivisionsTagging.SetDivisionsK)(value) | Set the value of "Divisions K". | +| [`SetNameMask`](#generated.RADivisionsTagging.SetNameMask)(value) | Set the value of "Name Mask". | +| [`SetTagStride`](#generated.RADivisionsTagging.SetTagStride)(value) | Set the value of "Tag Stride". | +| [`SetTagValue`](#generated.RADivisionsTagging.SetTagValue)(value) | Set the value of "Tag Value". | + + + +#### GetDivisionsI() + +Get the value of “Divisions I”. + + + +#### GetDivisionsJ() + +Get the value of “Divisions J”. + + + +#### GetDivisionsK() + +Get the value of “Divisions K”. + + + +#### GetGridFunctionName() + +Get the tagging grid function name. This name can be used to access the tagging grid +function on a particle-based process. +:rtype: str + + + +#### GetNameMask() + +Get the value of “Name Mask”. + + + +#### GetTagStride() + +Get the value of “Tag Stride”. + + + +#### GetTagValue() + +Get the value of “Tag Value”. + + + +#### GetTimeRangeFilter() + +Get the API object that wraps the specific Time Range Filter. +:rtype: RATimeRangeFilter + + + +#### SetDivisionsI(value: str | int) + +Set the value of “Divisions I”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetDivisionsJ(value: str | int) + +Set the value of “Divisions J”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetDivisionsK(value: str | int) + +Set the value of “Divisions K”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetNameMask(value: str) + +Set the value of “Name Mask”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetTagStride(value: str | int) + +Set the value of “Tag Stride”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetTagValue(value: str | int) + +Set the value of “Tag Value”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. diff --git a/2025R2/rocky-prepost-scripting-manual/RADomainSettings.md b/2025R2/rocky-prepost-scripting-manual/RADomainSettings.md index 28c15b60e3..04efd478a4 100644 --- a/2025R2/rocky-prepost-scripting-manual/RADomainSettings.md +++ b/2025R2/rocky-prepost-scripting-manual/RADomainSettings.md @@ -1,352 +1,353 @@ - - -# RADomainSettings - - - - - - -### *class* RADomainSettings - -Rocky PrePost Scripting wrapper for Domain Setings properties. - -This wrapper corresponds to the “Domain Settings” item on a project’s data tree. Access it from -the [`RAStudy`](RAStudy.md#generated.RAStudy) with: - -```python -domain_settings = study.GetDomainSettings() -``` - -**Methods:** - -| [`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() - -Set the value of “Periodic At Geometry Limits” to False. - - - -#### DisableUseBoundaryLimits() - -Set the value of “Use Boundary Limits” to False. - - - -#### EnablePeriodicAtGeometryLimits() - -Set the value of “Periodic At Geometry Limits” to True. - - - -#### EnableUseBoundaryLimits() - -Set the value of “Use Boundary Limits” to True. - - - -#### GetBoundariesDirections() - -Deprecated: use GetCartesianPeriodicDirections() instead. - - - -#### GetCartesianPeriodicDirections() - -Get “Cartesian Periodic Directions” as a string. - -* **Returns:** - The returned value will be one of [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’]. - - - -#### GetCoordinateLimitsMaxValues(unit: str | None = None) - -Get the value of “Coordinate Limits Max Values”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCoordinateLimitsMinValues(unit: str | None = None) - -Get the value of “Coordinate Limits Min Values”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCylindricalPeriodicDirections() - -Get “Cylindrical Periodic Directions” as a string. - -* **Returns:** - The returned value will be one of [‘X’, ‘Y’, ‘Z’]. - - - -#### GetDomainType() - -Get “Domain Type” as a string. - -* **Returns:** - The returned value will be one of [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’]. - - - -#### GetInitialAngle(unit: str | None = None) - -Get the value of “Initial Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetNumberOfDivisions() - -Get the value of “Number of Divisions”. - - - -#### GetPeriodicAtGeometryLimits() - -Get the value of “Periodic At Geometry Limits”. - - - -#### GetPeriodicLimitsMaxCoordinates(unit: str | None = None) - -Get the value of “Periodic Limits Max Coordinates”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetPeriodicLimitsMinCoordinates(unit: str | None = None) - -Get the value of “Periodic Limits Min Coordinates”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetUseBoundaryLimits() - -Get the value of “Use Boundary Limits”. - - - -#### GetValidBoundariesDirectionsValues() - -Deprecated: use GetValidPeriodicDirectionsValues() instead. - - - -#### GetValidCartesianPeriodicDirectionsValues() - -Get a list of all possible values for “Cartesian Periodic Directions”. - -* **Returns:** - The returned list is [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’]. - - - -#### GetValidCylindricalPeriodicDirectionsValues() - -Get a list of all possible values for “Cylindrical Periodic Directions”. - -* **Returns:** - The returned list is [‘X’, ‘Y’, ‘Z’]. - - - -#### GetValidDomainTypeValues() - -Get a list of all possible values for “Domain Type”. - -* **Returns:** - The returned list is [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’]. - - - -#### IsPeriodicAtGeometryLimitsEnabled() - -Check if the “Periodic At Geometry Limits” is enabled. - - - -#### IsUseBoundaryLimitsEnabled() - -Check if the “Use Boundary Limits” is enabled. - - - -#### SetBoundariesDirections(value) - -Deprecated: use SetCartesianPeriodicDirections(value) instead. - - - -#### SetCartesianPeriodicDirections(value: str) - -Set the value of “Cartesian Periodic Directions”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Cartesian Periodic Directions” option. - - - -#### SetCoordinateLimitsMaxValues(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Coordinate Limits Max Values”. - -* **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. - - - -#### SetCoordinateLimitsMinValues(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Coordinate Limits Min Values”. - -* **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. - - - -#### SetCylindricalPeriodicDirections(value: str) - -Set the value of “Cylindrical Periodic Directions”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘X’, ‘Y’, ‘Z’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Cylindrical Periodic Directions” option. - - - -#### SetDomainType(value: str) - -Set the value of “Domain Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Domain Type” option. - - - -#### SetInitialAngle(value: str | float, unit: str | None = None) - -Set the value of “Initial 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 “dega”. - - - -#### SetNumberOfDivisions(value: str | int) - -Set the value of “Number of Divisions”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetPeriodicAtGeometryLimits(value: bool) - -Set the value of “Periodic At Geometry Limits”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetPeriodicLimitsMaxCoordinates(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Periodic Limits Max Coordinates”. - -* **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. - - - -#### SetPeriodicLimitsMinCoordinates(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Periodic Limits Min Coordinates”. - -* **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. - - - -#### SetUseBoundaryLimits(value: bool) - -Set the value of “Use Boundary Limits”. - -* **Parameters:** - **value** – The value to set. + + +# RADomainSettings + + + + + + +### *class* RADomainSettings + +Rocky PrePost Scripting wrapper for Domain Setings properties. + +This wrapper corresponds to the “Domain Settings” item on a project’s data tree. Access it from +the [`RAStudy`](RAStudy.md#generated.RAStudy) with: + +```python +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() + +Set the value of “Periodic At Geometry Limits” to False. + + + +#### DisableUseBoundaryLimits() + +Set the value of “Use Boundary Limits” to False. + + + +#### EnablePeriodicAtGeometryLimits() + +Set the value of “Periodic At Geometry Limits” to True. + + + +#### EnableUseBoundaryLimits() + +Set the value of “Use Boundary Limits” to True. + + + +#### GetBoundariesDirections() + +Deprecated: use GetCartesianPeriodicDirections() instead. + + + +#### GetCartesianPeriodicDirections() + +Get “Cartesian Periodic Directions” as a string. + +* **Returns:** + The returned value will be one of [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’]. + + + +#### GetCoordinateLimitsMaxValues(unit: str | None = None) + +Get the value of “Coordinate Limits Max Values”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCoordinateLimitsMinValues(unit: str | None = None) + +Get the value of “Coordinate Limits Min Values”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCylindricalPeriodicDirections() + +Get “Cylindrical Periodic Directions” as a string. + +* **Returns:** + The returned value will be one of [‘X’, ‘Y’, ‘Z’]. + + + +#### GetDomainType() + +Get “Domain Type” as a string. + +* **Returns:** + The returned value will be one of [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’]. + + + +#### GetInitialAngle(unit: str | None = None) + +Get the value of “Initial Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetNumberOfDivisions() + +Get the value of “Number of Divisions”. + + + +#### GetPeriodicAtGeometryLimits() + +Get the value of “Periodic At Geometry Limits”. + + + +#### GetPeriodicLimitsMaxCoordinates(unit: str | None = None) + +Get the value of “Periodic Limits Max Coordinates”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetPeriodicLimitsMinCoordinates(unit: str | None = None) + +Get the value of “Periodic Limits Min Coordinates”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetUseBoundaryLimits() + +Get the value of “Use Boundary Limits”. + + + +#### GetValidBoundariesDirectionsValues() + +Deprecated: use GetValidPeriodicDirectionsValues() instead. + + + +#### GetValidCartesianPeriodicDirectionsValues() + +Get a list of all possible values for “Cartesian Periodic Directions”. + +* **Returns:** + The returned list is [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’]. + + + +#### GetValidCylindricalPeriodicDirectionsValues() + +Get a list of all possible values for “Cylindrical Periodic Directions”. + +* **Returns:** + The returned list is [‘X’, ‘Y’, ‘Z’]. + + + +#### GetValidDomainTypeValues() + +Get a list of all possible values for “Domain Type”. + +* **Returns:** + The returned list is [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’]. + + + +#### IsPeriodicAtGeometryLimitsEnabled() + +Check if the “Periodic At Geometry Limits” is enabled. + + + +#### IsUseBoundaryLimitsEnabled() + +Check if the “Use Boundary Limits” is enabled. + + + +#### SetBoundariesDirections(value) + +Deprecated: use SetCartesianPeriodicDirections(value) instead. + + + +#### SetCartesianPeriodicDirections(value: str) + +Set the value of “Cartesian Periodic Directions”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘NONE’, ‘X’, ‘Y’, ‘XY’, ‘Z’, ‘XZ’, ‘YZ’, ‘XYZ’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Cartesian Periodic Directions” option. + + + +#### SetCoordinateLimitsMaxValues(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Coordinate Limits Max Values”. + +* **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. + + + +#### SetCoordinateLimitsMinValues(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Coordinate Limits Min Values”. + +* **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. + + + +#### SetCylindricalPeriodicDirections(value: str) + +Set the value of “Cylindrical Periodic Directions”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘X’, ‘Y’, ‘Z’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Cylindrical Periodic Directions” option. + + + +#### SetDomainType(value: str) + +Set the value of “Domain Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘NONE’, ‘CARTESIAN’, ‘CYLINDRICAL’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Domain Type” option. + + + +#### SetInitialAngle(value: str | float, unit: str | None = None) + +Set the value of “Initial 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 “dega”. + + + +#### SetNumberOfDivisions(value: str | int) + +Set the value of “Number of Divisions”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetPeriodicAtGeometryLimits(value: bool) + +Set the value of “Periodic At Geometry Limits”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetPeriodicLimitsMaxCoordinates(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Periodic Limits Max Coordinates”. + +* **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. + + + +#### SetPeriodicLimitsMinCoordinates(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Periodic Limits Min Coordinates”. + +* **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. + + + +#### SetUseBoundaryLimits(value: bool) + +Set the value of “Use Boundary Limits”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RAEulerianStatistics.md b/2025R2/rocky-prepost-scripting-manual/RAEulerianStatistics.md index 7bcf967595..3cc66a5fa8 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAEulerianStatistics.md +++ b/2025R2/rocky-prepost-scripting-manual/RAEulerianStatistics.md @@ -1,1041 +1,1042 @@ - - -# RAEulerianStatistics - - - - - - -### *class* RAEulerianStatistics - -**Methods:** - -| [`AddCurve`](#generated.RAEulerianStatistics.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAEulerianStatistics.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.RAEulerianStatistics.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAEulerianStatistics.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAEulerianStatistics.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). | -| [`CreateEulerianGridFunction`](#generated.RAEulerianStatistics.CreateEulerianGridFunction)(operation_name, ...) | Add a new grid function to the Eulerian Statistics. | -| [`CreateGridFunction`](#generated.RAEulerianStatistics.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAEulerianStatistics.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAEulerianStatistics.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.RAEulerianStatistics.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.RAEulerianStatistics.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.RAEulerianStatistics.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.RAEulerianStatistics.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAvailableOperations`](#generated.RAEulerianStatistics.GetAvailableOperations)() | Get a list with the operations that can be passed to CreateGridFunction(). | -| [`GetBoundingBox`](#generated.RAEulerianStatistics.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAEulerianStatistics.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAEulerianStatistics.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAEulerianStatistics.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAEulerianStatistics.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAEulerianStatistics.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAEulerianStatistics.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAEulerianStatistics.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAEulerianStatistics.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAEulerianStatistics.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAEulerianStatistics.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAEulerianStatistics.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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). | -| [`GetNumberOfParticles`](#generated.RAEulerianStatistics.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAEulerianStatistics.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAEulerianStatistics.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetParticleGridFunctionNames`](#generated.RAEulerianStatistics.GetParticleGridFunctionNames)() | Get a list with the particle grid function names that can be passed to CreateGridFunction(). | -| [`GetTimeSet`](#generated.RAEulerianStatistics.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RAEulerianStatistics.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAEulerianStatistics.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAEulerianStatistics.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAEulerianStatistics.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAEulerianStatistics.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAEulerianStatistics.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAEulerianStatistics.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAEulerianStatistics.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDivisions`](#generated.RAEulerianStatistics.SetDivisions)(divisions) | Set the number of divisions in i/j/k. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateEulerianGridFunction(operation_name: str, value_name: str, weight_name: str | None = None) - -Add a new grid function to the Eulerian Statistics. - -This method takes an operation and one (or two) particle grid function names and creates -a new grid function for this EulerianStatistics. For instance, the call: - -> CreateEulerianGridFunction(‘Weighted Average’, ‘Velocity : Translational : Absolute’, ‘Particle Mass’) - -… will create the Weighted Average of Velocity : Translational : Absolute by Particle Mass -grid function. The grid function PrePost Scripting wrapper is returned. - -* **Parameters:** - * **operation_name** (*unicode*) – The name of the operation to be performed on the particles in each grid block. Must be - one of GetAvailableOperations(). - * **value_name** (*unicode*) – The name of the first particle grid function to be used (the “value”). Must be one of - GetParticleGridFunctionNames(). - * **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 - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableOperations() - -Get a list with the operations that can be passed to CreateGridFunction(). - -* **Return type:** - list(unicode) - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDivisions() - -Get the number of divisions in i/j/k. - -* **Return type:** - tuple(int) - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetParticleGridFunctionNames() - -Get a list with the particle grid function names that can be passed to CreateGridFunction(). - -* **Return type:** - list(unicode) - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDivisions(divisions: tuple[int, int, int]) - -Set the number of divisions in i/j/k. Note that the minimum value for each number is 1. - -* **Parameters:** - **divisions** (*tuple* *(**int* *)*) – The divisions in (i,j,k) order. + + +# RAEulerianStatistics + + + + + + +### *class* RAEulerianStatistics + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAEulerianStatistics.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAEulerianStatistics.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.RAEulerianStatistics.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAEulerianStatistics.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAEulerianStatistics.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). | +| [`CreateEulerianGridFunction`](#generated.RAEulerianStatistics.CreateEulerianGridFunction)(operation_name, ...) | Add a new grid function to the Eulerian Statistics. | +| [`CreateGridFunction`](#generated.RAEulerianStatistics.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAEulerianStatistics.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAEulerianStatistics.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.RAEulerianStatistics.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.RAEulerianStatistics.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.RAEulerianStatistics.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.RAEulerianStatistics.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAvailableOperations`](#generated.RAEulerianStatistics.GetAvailableOperations)() | Get a list with the operations that can be passed to CreateGridFunction(). | +| [`GetBoundingBox`](#generated.RAEulerianStatistics.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAEulerianStatistics.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAEulerianStatistics.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAEulerianStatistics.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAEulerianStatistics.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAEulerianStatistics.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAEulerianStatistics.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAEulerianStatistics.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAEulerianStatistics.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAEulerianStatistics.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAEulerianStatistics.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAEulerianStatistics.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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). | +| [`GetNumberOfParticles`](#generated.RAEulerianStatistics.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RAEulerianStatistics.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAEulerianStatistics.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetParticleGridFunctionNames`](#generated.RAEulerianStatistics.GetParticleGridFunctionNames)() | Get a list with the particle grid function names that can be passed to CreateGridFunction(). | +| [`GetTimeSet`](#generated.RAEulerianStatistics.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RAEulerianStatistics.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RAEulerianStatistics.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RAEulerianStatistics.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAEulerianStatistics.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAEulerianStatistics.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAEulerianStatistics.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAEulerianStatistics.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAEulerianStatistics.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDivisions`](#generated.RAEulerianStatistics.SetDivisions)(divisions) | Set the number of divisions in i/j/k. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateEulerianGridFunction(operation_name: str, value_name: str, weight_name: str | None = None) + +Add a new grid function to the Eulerian Statistics. + +This method takes an operation and one (or two) particle grid function names and creates +a new grid function for this EulerianStatistics. For instance, the call: + +> CreateEulerianGridFunction(‘Weighted Average’, ‘Velocity : Translational : Absolute’, ‘Particle Mass’) + +… will create the Weighted Average of Velocity : Translational : Absolute by Particle Mass +grid function. The grid function PrePost Scripting wrapper is returned. + +* **Parameters:** + * **operation_name** (*unicode*) – The name of the operation to be performed on the particles in each grid block. Must be + one of GetAvailableOperations(). + * **value_name** (*unicode*) – The name of the first particle grid function to be used (the “value”). Must be one of + GetParticleGridFunctionNames(). + * **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 + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableOperations() + +Get a list with the operations that can be passed to CreateGridFunction(). + +* **Return type:** + list(unicode) + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDivisions() + +Get the number of divisions in i/j/k. + +* **Return type:** + tuple(int) + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetParticleGridFunctionNames() + +Get a list with the particle grid function names that can be passed to CreateGridFunction(). + +* **Return type:** + list(unicode) + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDivisions(divisions: tuple[int, int, int]) + +Set the number of divisions in i/j/k. Note that the minimum value for each number is 1. + +* **Parameters:** + **divisions** (*tuple* *(**int* *)*) – The divisions in (i,j,k) order. diff --git a/2025R2/rocky-prepost-scripting-manual/RAExportToolkit.md b/2025R2/rocky-prepost-scripting-manual/RAExportToolkit.md index 3bb311417e..da55525ee7 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAExportToolkit.md +++ b/2025R2/rocky-prepost-scripting-manual/RAExportToolkit.md @@ -1,134 +1,135 @@ - - -# RAExportToolkit - - - - - - -### *class* RAExportToolkit - -Helper class, tied to a RAStudy, to perform export actions in Rocky. - -This toolkit can be obtained via a [`RAStudy`](RAStudy.md#generated.RAStudy): - -```python -study = app.GetStudy() -export_toolkit = study.GetExportToolkit() -``` - -**Methods:** - -| [`ExportFEMForces`](#generated.RAExportToolkit.ExportFEMForces)(csv_filename, entities_to_export) | See [`ExportGeometryLoads()`](#generated.RAExportToolkit.ExportGeometryLoads). | -|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| -| [`ExportGeometryLoads`](#generated.RAExportToolkit.ExportGeometryLoads)(csv_filename, ...[, ...]) | Export the FEM forces of one or more entities to a CSV file. | -| [`ExportGeometryLoadsMultiTime`](#generated.RAExportToolkit.ExportGeometryLoadsMultiTime)(csv_filename, ...) | Export the FEM forces of one or more entities to one or multiple CSV files. | -| [`ExportHTC`](#generated.RAExportToolkit.ExportHTC)(csv_filename, entities_to_export, ...) | Export the HTC of one or more entities to a CSV file. | -| [`ExportParticleToStl`](#generated.RAExportToolkit.ExportParticleToStl)(stl_filename, particle) | Export one and only one Particle (scaled or not) to STL file. | -| [`ExportToSTL`](#generated.RAExportToolkit.ExportToSTL)(stl_filename, entities[, ...]) | Export one or more entities (scaled or not) to STL files. | - - - -#### ExportFEMForces(csv_filename: str, entities_to_export: ApiElementItem | str | list, timestep_to_export: ITimeStep | str | int | None = None, apply_transformation: bool = True) - -See [`ExportGeometryLoads()`](#generated.RAExportToolkit.ExportGeometryLoads). - -File will have area and X, Y and Z forces also exported. - - - -#### ExportGeometryLoads(csv_filename: str, entities_to_export: ApiElementItem | str | list, timestep_to_export: ITimeStep | str | int | None = None, apply_transformation: bool = True, export_forces: bool = False) - -Export the FEM forces of one or more entities to a CSV file. One CSV file may contain the -forces of more than one entity, but only of a single timestep. - -* **Parameters:** - * **csv_filename** – The full pathname of the CSV file to generate. Previously existing files will be overwritten. - * **entities_to_export** – The entities to export. This parameter can be a single item, in which case it can be an - ApiElementItem instance or the name of such an instance. The parameter can also be an - iterable containing any mix of the two types mentioned. - * **timestep_to_export** – The timestep of which the FEM forces will be exported. Passing None means that the current - active timestep will be exported instead. - * **apply_transformation** – True whether boundary coordinates and forces should be transformed back to boundary’s - original position, before all movements took place. - * **export_forces** – Flag to export force instead of pressure components. - - - -#### ExportGeometryLoadsMultiTime(csv_filename: str, entities_to_export: ApiElementItem | str | list, timesteps_to_export: list[ITimeStep | int], apply_transformation: bool = True, export_forces: bool = False, show_progress: bool = False) - -Export the FEM forces of one or more entities to one or multiple CSV files. Each CSV contains the -forces of more than one entity, but only of a single timestep. - -* **Parameters:** - * **csv_filename** – The full pathname of the CSV file to generate. Previously existing files will be overwritten. - If timesteps_to_export has more than one timestep csv_filename will be modified to include the index - e.g. my_csv_file.csv will write to my_csv_file_01.csv, my_csv_file_02.csv, etc - * **entities_to_export** – The entities to export. This parameter can be a single item, in which case it can be an - ApiElementItem instance or the name of such an instance. The parameter can also be an - iterable containing any mix of the two types mentioned. - * **timesteps_to_export** – The list of times to export. Passing None or an empty list means that the current - active timestep will be exported instead. - * **apply_transformation** – True whether boundary coordinates and forces should be transformed back to boundary’s - original position, before all movements took place. - * **export_forces** – Flag to export force instead of pressure components. - * **show_progress** – Whether a progress dialog should be shown during export. - - - -#### ExportHTC(csv_filename: str, entities_to_export: ApiElementItem | str | list, timestep_to_export: ITimeStep | str | int | None, apply_transformation: bool, ref_temperature: float | None) - -Export the HTC of one or more entities to a CSV file. One CSV file may contain the -HTC value of more than one entity, but only of a single timestep. - -* **Parameters:** - * **csv_filename** – The full pathname of the CSV file to generate. Previously existing files will be overwritten. - * **entities_to_export** – The entities to export. This parameter can be a single item, in which case it can be an - ApiElementItem instance or the name of such an instance. The parameter can also be an - iterable containing any mix of the two types mentioned. - * **timestep_to_export** – The timestep of which the HTC values will be exported. Passing None means that the current - active timestep will be exported instead. - * **apply_transformation** – True whether boundary coordinates and forces should be transformed back to boundary’s - original position, before all movements took place. - * **ref_temperature** – The arbitrary reference temperature. If None is passed we assume that thermal is - enabled and the adjacent temperature will be used. - - - -#### ExportParticleToStl(stl_filename: str, particle: str | Particle | ApiElementItem, time_to_export: ITimeStep | int | None = None, output_unit: str | None = None, target_size: float | None = None, target_unit: str | None = None) - -Export one and only one Particle (scaled or not) to STL file. The origin of Particle can be from a name, subject or the api element. - -* **Parameters:** - * **stl_filename** – The name of the resulting STL file. If multiple files are generated, the name of the - entities will be appended to the filename, before the ‘.stl’ extension. - * **particle** – The targets to export. The ‘particle’ can be the name of the Particle to export, the Subject instance, or the - ApiElementItem instance. - * **time_to_export** – The timestep for which to export the items. If None is passed, the application’s current - timestep will be used. - * **output_unit** – The optional output unit. If None is passed, the geometry will be exported in its native - unit (meters). - * **target_size** – The value of the wished scalar to scale the Particle - * **target_unit** – The unit of the wished scalar to scale the Particle - - - -#### ExportToSTL(stl_filename: str, entities: Subject | ApiElementItem | str | list, time_to_export: ITimeStep | int | None = None, output_unit: str | None = None) - -Export one or more entities (scaled or not) to STL files. Valid entities to export are conveyors, custom -boundaries and any user process created with one of the aforementioned types in its process -hierarchy. - -* **Parameters:** - * **stl_filename** – The name of the resulting STL file. If multiple files are generated, the name of the - entities will be appended to the filename, before the ‘.stl’ extension. - * **entities** – The targets to export. This can be a list of elements, or a single element. Each - ‘element’ can be the name of the geometry to export, the Subject instance, or the - ApiElementItem instance. - * **time_to_export** – The timestep for which to export the items. If None is passed, the application’s current - timestep will be used. - * **output_unit** – The optional output unit. If None is passed, the geometry will be exported in its native - unit (meters). + + +# RAExportToolkit + + + + + + +### *class* RAExportToolkit + +Helper class, tied to a RAStudy, to perform export actions in Rocky. + +This toolkit can be obtained via a [`RAStudy`](RAStudy.md#generated.RAStudy): + +```python +study = app.GetStudy() +export_toolkit = study.GetExportToolkit() +``` + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| +| [`ExportFEMForces`](#generated.RAExportToolkit.ExportFEMForces)(csv_filename, entities_to_export) | See [`ExportGeometryLoads()`](#generated.RAExportToolkit.ExportGeometryLoads). | +| [`ExportGeometryLoads`](#generated.RAExportToolkit.ExportGeometryLoads)(csv_filename, ...[, ...]) | Export the FEM forces of one or more entities to a CSV file. | +| [`ExportGeometryLoadsMultiTime`](#generated.RAExportToolkit.ExportGeometryLoadsMultiTime)(csv_filename, ...) | Export the FEM forces of one or more entities to one or multiple CSV files. | +| [`ExportHTC`](#generated.RAExportToolkit.ExportHTC)(csv_filename, entities_to_export, ...) | Export the HTC of one or more entities to a CSV file. | +| [`ExportParticleToStl`](#generated.RAExportToolkit.ExportParticleToStl)(stl_filename, particle) | Export one and only one Particle (scaled or not) to STL file. | +| [`ExportToSTL`](#generated.RAExportToolkit.ExportToSTL)(stl_filename, entities[, ...]) | Export one or more entities (scaled or not) to STL files. | + + + +#### ExportFEMForces(csv_filename: str, entities_to_export: ApiElementItem | str | list, timestep_to_export: ITimeStep | str | int | None = None, apply_transformation: bool = True) + +See [`ExportGeometryLoads()`](#generated.RAExportToolkit.ExportGeometryLoads). + +File will have area and X, Y and Z forces also exported. + + + +#### ExportGeometryLoads(csv_filename: str, entities_to_export: ApiElementItem | str | list, timestep_to_export: ITimeStep | str | int | None = None, apply_transformation: bool = True, export_forces: bool = False) + +Export the FEM forces of one or more entities to a CSV file. One CSV file may contain the +forces of more than one entity, but only of a single timestep. + +* **Parameters:** + * **csv_filename** – The full pathname of the CSV file to generate. Previously existing files will be overwritten. + * **entities_to_export** – The entities to export. This parameter can be a single item, in which case it can be an + ApiElementItem instance or the name of such an instance. The parameter can also be an + iterable containing any mix of the two types mentioned. + * **timestep_to_export** – The timestep of which the FEM forces will be exported. Passing None means that the current + active timestep will be exported instead. + * **apply_transformation** – True whether boundary coordinates and forces should be transformed back to boundary’s + original position, before all movements took place. + * **export_forces** – Flag to export force instead of pressure components. + + + +#### ExportGeometryLoadsMultiTime(csv_filename: str, entities_to_export: ApiElementItem | str | list, timesteps_to_export: list[ITimeStep | int], apply_transformation: bool = True, export_forces: bool = False, show_progress: bool = False) + +Export the FEM forces of one or more entities to one or multiple CSV files. Each CSV contains the +forces of more than one entity, but only of a single timestep. + +* **Parameters:** + * **csv_filename** – The full pathname of the CSV file to generate. Previously existing files will be overwritten. + If timesteps_to_export has more than one timestep csv_filename will be modified to include the index + e.g. my_csv_file.csv will write to my_csv_file_01.csv, my_csv_file_02.csv, etc + * **entities_to_export** – The entities to export. This parameter can be a single item, in which case it can be an + ApiElementItem instance or the name of such an instance. The parameter can also be an + iterable containing any mix of the two types mentioned. + * **timesteps_to_export** – The list of times to export. Passing None or an empty list means that the current + active timestep will be exported instead. + * **apply_transformation** – True whether boundary coordinates and forces should be transformed back to boundary’s + original position, before all movements took place. + * **export_forces** – Flag to export force instead of pressure components. + * **show_progress** – Whether a progress dialog should be shown during export. + + + +#### ExportHTC(csv_filename: str, entities_to_export: ApiElementItem | str | list, timestep_to_export: ITimeStep | str | int | None, apply_transformation: bool, ref_temperature: float | None) + +Export the HTC of one or more entities to a CSV file. One CSV file may contain the +HTC value of more than one entity, but only of a single timestep. + +* **Parameters:** + * **csv_filename** – The full pathname of the CSV file to generate. Previously existing files will be overwritten. + * **entities_to_export** – The entities to export. This parameter can be a single item, in which case it can be an + ApiElementItem instance or the name of such an instance. The parameter can also be an + iterable containing any mix of the two types mentioned. + * **timestep_to_export** – The timestep of which the HTC values will be exported. Passing None means that the current + active timestep will be exported instead. + * **apply_transformation** – True whether boundary coordinates and forces should be transformed back to boundary’s + original position, before all movements took place. + * **ref_temperature** – The arbitrary reference temperature. If None is passed we assume that thermal is + enabled and the adjacent temperature will be used. + + + +#### ExportParticleToStl(stl_filename: str, particle: str | Particle | ApiElementItem, time_to_export: ITimeStep | int | None = None, output_unit: str | None = None, target_size: float | None = None, target_unit: str | None = None) + +Export one and only one Particle (scaled or not) to STL file. The origin of Particle can be from a name, subject or the api element. + +* **Parameters:** + * **stl_filename** – The name of the resulting STL file. If multiple files are generated, the name of the + entities will be appended to the filename, before the ‘.stl’ extension. + * **particle** – The targets to export. The ‘particle’ can be the name of the Particle to export, the Subject instance, or the + ApiElementItem instance. + * **time_to_export** – The timestep for which to export the items. If None is passed, the application’s current + timestep will be used. + * **output_unit** – The optional output unit. If None is passed, the geometry will be exported in its native + unit (meters). + * **target_size** – The value of the wished scalar to scale the Particle + * **target_unit** – The unit of the wished scalar to scale the Particle + + + +#### ExportToSTL(stl_filename: str, entities: Subject | ApiElementItem | str | list, time_to_export: ITimeStep | int | None = None, output_unit: str | None = None) + +Export one or more entities (scaled or not) to STL files. Valid entities to export are conveyors, custom +boundaries and any user process created with one of the aforementioned types in its process +hierarchy. + +* **Parameters:** + * **stl_filename** – The name of the resulting STL file. If multiple files are generated, the name of the + entities will be appended to the filename, before the ‘.stl’ extension. + * **entities** – The targets to export. This can be a list of elements, or a single element. Each + ‘element’ can be the name of the geometry to export, the Subject instance, or the + ApiElementItem instance. + * **time_to_export** – The timestep for which to export the items. If None is passed, the application’s current + timestep will be used. + * **output_unit** – The optional output unit. If None is passed, the geometry will be exported in its native + unit (meters). diff --git a/2025R2/rocky-prepost-scripting-manual/RAFeedConveyor.md b/2025R2/rocky-prepost-scripting-manual/RAFeedConveyor.md index 89c2e4930d..93e92ddea7 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFeedConveyor.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFeedConveyor.md @@ -1,1793 +1,1794 @@ - - -# RAFeedConveyor - - - - - - -### *class* RAFeedConveyor - -Rocky api Feed Conveyor model. - -**Methods:** - -| [`AddCurve`](#generated.RAFeedConveyor.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAFeedConveyor.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.RAFeedConveyor.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAFeedConveyor.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAFeedConveyor.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.RAFeedConveyor.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAFeedConveyor.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFeedConveyor.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.RAFeedConveyor.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.RAFeedConveyor.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.RAFeedConveyor.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. | -| [`GetAccelerationPeriod`](#generated.RAFeedConveyor.GetAccelerationPeriod)([unit]) | Get the value of "Acceleration Period". | -| [`GetActivesArray`](#generated.RAFeedConveyor.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAlignmentAngle`](#generated.RAFeedConveyor.GetAlignmentAngle)([unit]) | Get the value of "Alignment Angle". | -| [`GetAvailableMaterials`](#generated.RAFeedConveyor.GetAvailableMaterials)() | Get all available Materials. | -| [`GetBeginningStartTime`](#generated.RAFeedConveyor.GetBeginningStartTime)([unit]) | Get the value of "Beginning Start Time". | -| [`GetBeginningStopTime`](#generated.RAFeedConveyor.GetBeginningStopTime)([unit]) | Get the value of "Beginning Stop Time". | -| [`GetBeltInclineAngle`](#generated.RAFeedConveyor.GetBeltInclineAngle)([unit]) | Get the value of "Belt Incline Angle". | -| [`GetBeltProfile`](#generated.RAFeedConveyor.GetBeltProfile)() | | -| [`GetBeltProfileName`](#generated.RAFeedConveyor.GetBeltProfileName)() | Get the name of the belt profile. | -| [`GetBeltSpeed`](#generated.RAFeedConveyor.GetBeltSpeed)([unit]) | Get the value of "Belt Speed". | -| [`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. | -| [`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. | -| [`GetCellFromIJK`](#generated.RAFeedConveyor.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAFeedConveyor.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAFeedConveyor.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAFeedConveyor.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAFeedConveyor.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAFeedConveyor.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAFeedConveyor.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAFeedConveyor.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetDecelerationPeriod`](#generated.RAFeedConveyor.GetDecelerationPeriod)([unit]) | Get the value of "Deceleration Period". | -| [`GetDiameter`](#generated.RAFeedConveyor.GetDiameter)([unit]) | Get the value of "Diameter". | -| [`GetDropBoxHeight`](#generated.RAFeedConveyor.GetDropBoxHeight)([unit]) | Get the value of "Drop Box Height". | -| [`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. | -| [`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. | -| [`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. | -| [`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". | -| [`GetLoadingLength`](#generated.RAFeedConveyor.GetLoadingLength)([unit]) | Get the value of "Loading Length". | -| [`GetMaterial`](#generated.RAFeedConveyor.GetMaterial)() | Get the "Material". | -| [`GetMeshColoring`](#generated.RAFeedConveyor.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetModuleProperties`](#generated.RAFeedConveyor.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RAFeedConveyor.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetNumberOfCells`](#generated.RAFeedConveyor.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAFeedConveyor.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAFeedConveyor.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOffsetToIdlers`](#generated.RAFeedConveyor.GetOffsetToIdlers)([unit]) | Get the value of "Offset To Idlers". | -| [`GetOutOfPlaneOffset`](#generated.RAFeedConveyor.GetOutOfPlaneOffset)([unit]) | Get the value of "Out of Plane Offset". | -| [`GetOutputVariableValue`](#generated.RAFeedConveyor.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetReturnBeltAngle`](#generated.RAFeedConveyor.GetReturnBeltAngle)([unit]) | Get the value of "Return Belt Angle". | -| [`GetSkirtboardHeight`](#generated.RAFeedConveyor.GetSkirtboardHeight)([unit]) | Get the value of "Skirtboard Height". | -| [`GetSkirtboardLength`](#generated.RAFeedConveyor.GetSkirtboardLength)([unit]) | Get the value of "Skirtboard Length". | -| [`GetSphBoundaryType`](#generated.RAFeedConveyor.GetSphBoundaryType)() | Get "Sph Boundary Type" as a string. | -| [`GetSurfaceTensionContactAngle`](#generated.RAFeedConveyor.GetSurfaceTensionContactAngle)([unit]) | Get the value of "Surface Tension Contact Angle". | -| [`GetTemperature`](#generated.RAFeedConveyor.GetTemperature)([unit]) | Get the value of "Temperature". | -| [`GetThermalBoundaryConditionType`](#generated.RAFeedConveyor.GetThermalBoundaryConditionType)() | Get "Thermal Boundary Condition Type" as a string. | -| [`GetTimeSet`](#generated.RAFeedConveyor.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAFeedConveyor.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAFeedConveyor.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAFeedConveyor.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTransitionLength`](#generated.RAFeedConveyor.GetTransitionLength)([unit]) | Get the value of "Transition Length". | -| [`GetTriangleSize`](#generated.RAFeedConveyor.GetTriangleSize)([unit]) | Get the value of "Triangle Size". | -| [`GetValidBeltProfileNames`](#generated.RAFeedConveyor.GetValidBeltProfileNames)() | Return a list with possible values for belt profile. | -| [`GetValidOptionsForModuleProperty`](#generated.RAFeedConveyor.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`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". | -| [`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. | -| [`IsCellActive`](#generated.RAFeedConveyor.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IterCellVertices`](#generated.RAFeedConveyor.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAFeedConveyor.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAFeedConveyor.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAFeedConveyor.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAFeedConveyor.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAFeedConveyor.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAFeedConveyor.RemoveProcess)() | Removes the process from the project. | -| [`SetAccelerationPeriod`](#generated.RAFeedConveyor.SetAccelerationPeriod)(value[, unit]) | Set the value of "Acceleration Period". | -| [`SetAlignmentAngle`](#generated.RAFeedConveyor.SetAlignmentAngle)(value[, unit]) | Set the value of "Alignment Angle". | -| [`SetBeginningStartTime`](#generated.RAFeedConveyor.SetBeginningStartTime)(value[, unit]) | Set the value of "Beginning Start Time". | -| [`SetBeginningStopTime`](#generated.RAFeedConveyor.SetBeginningStopTime)(value[, unit]) | Set the value of "Beginning Stop Time". | -| [`SetBeltInclineAngle`](#generated.RAFeedConveyor.SetBeltInclineAngle)(value[, unit]) | Set the value of "Belt Incline Angle". | -| [`SetBeltProfile`](#generated.RAFeedConveyor.SetBeltProfile)(belt_profile_name) | Set the belt profile object through its name as shown in the UI. | -| [`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". | -| [`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". | -| [`SetDropBoxHeight`](#generated.RAFeedConveyor.SetDropBoxHeight)(value[, unit]) | Set the value of "Drop Box Height". | -| [`SetDropBoxLength`](#generated.RAFeedConveyor.SetDropBoxLength)(value[, unit]) | Set the value of "Drop Box Length". | -| [`SetDropBoxWidth`](#generated.RAFeedConveyor.SetDropBoxWidth)(value[, unit]) | Set the value of "Drop Box Width". | -| [`SetFaceWidth`](#generated.RAFeedConveyor.SetFaceWidth)(value[, unit]) | Set the value of "Face Width". | -| [`SetFrontPlateOffset`](#generated.RAFeedConveyor.SetFrontPlateOffset)(value[, unit]) | Set the value of "Front Plate Offset". | -| [`SetHeightOffset`](#generated.RAFeedConveyor.SetHeightOffset)(value[, unit]) | Set the value of "Height Offset". | -| [`SetHorizontalOffset`](#generated.RAFeedConveyor.SetHorizontalOffset)(value[, unit]) | Set the value of "Horizontal Offset". | -| [`SetLengthOffset`](#generated.RAFeedConveyor.SetLengthOffset)(value[, unit]) | Set the value of "Length Offset". | -| [`SetLoadingLength`](#generated.RAFeedConveyor.SetLoadingLength)(value[, unit]) | Set the value of "Loading Length". | -| [`SetMaterial`](#generated.RAFeedConveyor.SetMaterial)(value) | Set the "Material". | -| [`SetModuleProperty`](#generated.RAFeedConveyor.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetOffsetToIdlers`](#generated.RAFeedConveyor.SetOffsetToIdlers)(value[, unit]) | Set the value of "Offset To Idlers". | -| [`SetOutOfPlaneOffset`](#generated.RAFeedConveyor.SetOutOfPlaneOffset)(value[, unit]) | Set the value of "Out of Plane Offset". | -| [`SetReturnBeltAngle`](#generated.RAFeedConveyor.SetReturnBeltAngle)(value[, unit]) | Set the value of "Return Belt Angle". | -| [`SetSkirtboardHeight`](#generated.RAFeedConveyor.SetSkirtboardHeight)(value[, unit]) | Set the value of "Skirtboard Height". | -| [`SetSkirtboardLength`](#generated.RAFeedConveyor.SetSkirtboardLength)(value[, unit]) | Set the value of "Skirtboard Length". | -| [`SetSphBoundaryType`](#generated.RAFeedConveyor.SetSphBoundaryType)(value) | Set the value of "Sph Boundary Type". | -| [`SetSurfaceTensionContactAngle`](#generated.RAFeedConveyor.SetSurfaceTensionContactAngle)(value[, unit]) | Set the value of "Surface Tension Contact Angle". | -| [`SetTemperature`](#generated.RAFeedConveyor.SetTemperature)(value[, unit]) | Set the value of "Temperature". | -| [`SetThermalBoundaryConditionType`](#generated.RAFeedConveyor.SetThermalBoundaryConditionType)(value) | Set the value of "Thermal Boundary Condition Type". | -| [`SetTransitionLength`](#generated.RAFeedConveyor.SetTransitionLength)(value[, unit]) | Set the value of "Transition Length". | -| [`SetTriangleSize`](#generated.RAFeedConveyor.SetTriangleSize)(value[, unit]) | Set the value of "Triangle Size". | -| [`SetVerticalOffset`](#generated.RAFeedConveyor.SetVerticalOffset)(value[, unit]) | Set the value of "Vertical Offset". | -| [`SetWallThickness`](#generated.RAFeedConveyor.SetWallThickness)(value[, unit]) | Set the value of "Wall Thickness". | -| [`SetWidth`](#generated.RAFeedConveyor.SetWidth)(value[, unit]) | Set the value of "Width". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetAccelerationPeriod(unit: str | None = None) - -Get the value of “Acceleration Period”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAlignmentAngle(unit: str | None = None) - -Get the value of “Alignment Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetBeginningStartTime(unit: str | None = None) - -Get the value of “Beginning Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetBeginningStopTime(unit: str | None = None) - -Get the value of “Beginning Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetBeltInclineAngle(unit: str | None = None) - -Get the value of “Belt Incline Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. - - - -#### GetBeltProfile() - -* **Return type:** - ApiElementItem -* **Returns:** - The API object that wraps the current belt profile. - - - -#### GetBeltProfileName() - -Get the name of the belt profile. - -* **Return type:** - str -* **Returns:** - A string describing the type of belt profile. The returned value will be one of the strings - in the “Belt Profile” drop-down menu in the UI. - - - -#### GetBeltSpeed(unit: str | None = None) - -Get the value of “Belt Speed”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### GetBeltThickness(unit: str | None = None) - -Get the value of “Belt Thickness”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetBeltWidth(unit: str | None = None) - -Get the value of “Belt Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDecelerationPeriod(unit: str | None = None) - -Get the value of “Deceleration Period”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetDiameter(unit: str | None = None) - -Get the value of “Diameter”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetDropBoxHeight(unit: str | None = None) - -Get the value of “Drop Box Height”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetDropBoxLength(unit: str | None = None) - -Get the value of “Drop Box Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetDropBoxWidth(unit: str | None = None) - -Get the value of “Drop Box Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### 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. - - - -#### GetFaceWidth(unit: str | None = None) - -Get the value of “Face Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetFrontPlateOffset(unit: str | None = None) - -Get the value of “Front Plate Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetHeightOffset(unit: str | None = None) - -Get the value of “Height Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetHorizontalOffset(unit: str | None = None) - -Get the value of “Horizontal Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetLengthOffset(unit: str | None = None) - -Get the value of “Length Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetLoadingLength(unit: str | None = None) - -Get the value of “Loading Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOffsetToIdlers(unit: str | None = None) - -Get the value of “Offset To Idlers”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetOutOfPlaneOffset(unit: str | None = None) - -Get the value of “Out of Plane Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetReturnBeltAngle(unit: str | None = None) - -Get the value of “Return Belt Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. - - - -#### GetSkirtboardHeight(unit: str | None = None) - -Get the value of “Skirtboard Height”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetSkirtboardLength(unit: str | None = None) - -Get the value of “Skirtboard Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetSphBoundaryType() - -Get “Sph Boundary Type” as a string. - -* **Returns:** - The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. - - - -#### GetSurfaceTensionContactAngle(unit: str | None = None) - -Get the value of “Surface Tension Contact Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetTemperature(unit: str | None = None) - -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”. - - - -#### GetThermalBoundaryConditionType() - -Get “Thermal Boundary Condition Type” as a string. - -* **Returns:** - The returned value will be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTransitionLength(unit: str | None = None) - -Get the value of “Transition Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetTriangleSize(unit: str | None = None) - -Get the value of “Triangle Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetValidBeltProfileNames() - -Return a list with possible values for belt profile. - -* **Return type:** - list(str) -* **Returns:** - A list of accepted values for SetBeltProfile(). - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### GetValidSphBoundaryTypeValues() - -Get a list of all possible values for “Sph Boundary Type”. - -* **Returns:** - The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. - - - -#### GetValidThermalBoundaryConditionTypeValues() - -Get a list of all possible values for “Thermal Boundary Condition Type”. - -* **Returns:** - The returned list is [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. - - - -#### GetVerticalOffset(unit: str | None = None) - -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”. - - - -#### GetWallThickness(unit: str | None = None) - -Get the value of “Wall Thickness”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetWidth(unit: str | None = None) - -Get the value of “Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetAccelerationPeriod(value: str | float, unit: str | None = None) - -Set the value of “Acceleration 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”. - - - -#### SetAlignmentAngle(value: str | float, unit: str | None = None) - -Set the value of “Alignment 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 “dega”. - - - -#### SetBeginningStartTime(value: str | float, unit: str | None = None) - -Set the value of “Beginning Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetBeginningStopTime(value: str | float, unit: str | None = None) - -Set the value of “Beginning Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetBeltInclineAngle(value: str | float, unit: str | None = None) - -Set the value of “Belt Incline 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”. - - - -#### SetBeltProfile(belt_profile_name) - -Set the belt profile object through its name as shown in the UI. - -* **Parameters:** - **belt_profile_name** (*str*) – Accepted values are the strings in the “Belt Profile” dropdown menu in the UI. -* **Return type:** - ApiElementItem -* **Returns:** - The PrePost Scripting wrapper representing the belt profile. - - - -#### SetBeltSpeed(value: str | float, unit: str | None = None) - -Set the value of “Belt Speed”. - -* **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/s”. - - - -#### SetBeltThickness(value: str | float, unit: str | None = None) - -Set the value of “Belt Thickness”. - -* **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”. - - - -#### SetBeltWidth(value: str | float, unit: str | None = None) - -Set the value of “Belt Width”. - -* **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”. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDecelerationPeriod(value: str | float, unit: str | None = None) - -Set the value of “Deceleration 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”. - - - -#### SetDiameter(value: str | float, unit: str | None = None) - -Set the value of “Diameter”. - -* **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”. - - - -#### SetDropBoxHeight(value: str | float, unit: str | None = None) - -Set the value of “Drop Box Height”. - -* **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”. - - - -#### SetDropBoxLength(value: str | float, unit: str | None = None) - -Set the value of “Drop Box Length”. - -* **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”. - - - -#### SetDropBoxWidth(value: str | float, unit: str | None = None) - -Set the value of “Drop Box Width”. - -* **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”. - - - -#### SetFaceWidth(value: str | float, unit: str | None = None) - -Set the value of “Face Width”. - -* **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”. - - - -#### SetFrontPlateOffset(value: str | float, unit: str | None = None) - -Set the value of “Front Plate Offset”. - -* **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”. - - - -#### SetHeightOffset(value: str | float, unit: str | None = None) - -Set the value of “Height Offset”. - -* **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”. - - - -#### SetHorizontalOffset(value: str | float, unit: str | None = None) - -Set the value of “Horizontal Offset”. - -* **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”. - - - -#### SetLengthOffset(value: str | float, unit: str | None = None) - -Set the value of “Length Offset”. - -* **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”. - - - -#### SetLoadingLength(value: str | float, unit: str | None = None) - -Set the value of “Loading Length”. - -* **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”. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetOffsetToIdlers(value: str | float, unit: str | None = None) - -Set the value of “Offset To Idlers”. - -* **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”. - - - -#### SetOutOfPlaneOffset(value: str | float, unit: str | None = None) - -Set the value of “Out of Plane Offset”. - -* **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”. - - - -#### SetReturnBeltAngle(value: str | float, unit: str | None = None) - -Set the value of “Return Belt 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”. - - - -#### SetSkirtboardHeight(value: str | float, unit: str | None = None) - -Set the value of “Skirtboard Height”. - -* **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”. - - - -#### SetSkirtboardLength(value: str | float, unit: str | None = None) - -Set the value of “Skirtboard Length”. - -* **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”. - - - -#### SetSphBoundaryType(value: str) - -Set the value of “Sph Boundary Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Sph Boundary Type” option. - - - -#### SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) - -Set the value of “Surface Tension Contact 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 “dega”. - - - -#### SetTemperature(value: str | float, unit: str | None = None) - -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”. - - - -#### SetThermalBoundaryConditionType(value: str) - -Set the value of “Thermal Boundary Condition Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Thermal Boundary Condition Type” option. - - - -#### SetTransitionLength(value: str | float, unit: str | None = None) - -Set the value of “Transition Length”. - -* **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”. - - - -#### SetTriangleSize(value: str | float, unit: str | None = None) - -Set the value of “Triangle Size”. - -* **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”. - - - -#### SetVerticalOffset(value: str | float, unit: str | None = None) - -Set the value of “Vertical Offset”. - -* **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”. - - - -#### SetWallThickness(value: str | float, unit: str | None = None) - -Set the value of “Wall Thickness”. - -* **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”. - - - -#### SetWidth(value: str | float, unit: str | None = None) - -Set the value of “Width”. - -* **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”. + + +# RAFeedConveyor + + + + + + +### *class* RAFeedConveyor + +Rocky api Feed Conveyor model. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAFeedConveyor.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAFeedConveyor.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.RAFeedConveyor.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAFeedConveyor.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAFeedConveyor.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.RAFeedConveyor.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAFeedConveyor.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFeedConveyor.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.RAFeedConveyor.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.RAFeedConveyor.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.RAFeedConveyor.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. | +| [`GetAccelerationPeriod`](#generated.RAFeedConveyor.GetAccelerationPeriod)([unit]) | Get the value of "Acceleration Period". | +| [`GetActivesArray`](#generated.RAFeedConveyor.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAlignmentAngle`](#generated.RAFeedConveyor.GetAlignmentAngle)([unit]) | Get the value of "Alignment Angle". | +| [`GetAvailableMaterials`](#generated.RAFeedConveyor.GetAvailableMaterials)() | Get all available Materials. | +| [`GetBeginningStartTime`](#generated.RAFeedConveyor.GetBeginningStartTime)([unit]) | Get the value of "Beginning Start Time". | +| [`GetBeginningStopTime`](#generated.RAFeedConveyor.GetBeginningStopTime)([unit]) | Get the value of "Beginning Stop Time". | +| [`GetBeltInclineAngle`](#generated.RAFeedConveyor.GetBeltInclineAngle)([unit]) | Get the value of "Belt Incline Angle". | +| [`GetBeltProfile`](#generated.RAFeedConveyor.GetBeltProfile)() | | +| [`GetBeltProfileName`](#generated.RAFeedConveyor.GetBeltProfileName)() | Get the name of the belt profile. | +| [`GetBeltSpeed`](#generated.RAFeedConveyor.GetBeltSpeed)([unit]) | Get the value of "Belt Speed". | +| [`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. | +| [`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. | +| [`GetCellFromIJK`](#generated.RAFeedConveyor.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAFeedConveyor.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAFeedConveyor.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAFeedConveyor.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAFeedConveyor.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAFeedConveyor.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAFeedConveyor.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RAFeedConveyor.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetDecelerationPeriod`](#generated.RAFeedConveyor.GetDecelerationPeriod)([unit]) | Get the value of "Deceleration Period". | +| [`GetDiameter`](#generated.RAFeedConveyor.GetDiameter)([unit]) | Get the value of "Diameter". | +| [`GetDropBoxHeight`](#generated.RAFeedConveyor.GetDropBoxHeight)([unit]) | Get the value of "Drop Box Height". | +| [`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. | +| [`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. | +| [`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. | +| [`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". | +| [`GetLoadingLength`](#generated.RAFeedConveyor.GetLoadingLength)([unit]) | Get the value of "Loading Length". | +| [`GetMaterial`](#generated.RAFeedConveyor.GetMaterial)() | Get the "Material". | +| [`GetMeshColoring`](#generated.RAFeedConveyor.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetModuleProperties`](#generated.RAFeedConveyor.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAFeedConveyor.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetNumberOfCells`](#generated.RAFeedConveyor.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAFeedConveyor.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAFeedConveyor.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOffsetToIdlers`](#generated.RAFeedConveyor.GetOffsetToIdlers)([unit]) | Get the value of "Offset To Idlers". | +| [`GetOutOfPlaneOffset`](#generated.RAFeedConveyor.GetOutOfPlaneOffset)([unit]) | Get the value of "Out of Plane Offset". | +| [`GetOutputVariableValue`](#generated.RAFeedConveyor.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetReturnBeltAngle`](#generated.RAFeedConveyor.GetReturnBeltAngle)([unit]) | Get the value of "Return Belt Angle". | +| [`GetSkirtboardHeight`](#generated.RAFeedConveyor.GetSkirtboardHeight)([unit]) | Get the value of "Skirtboard Height". | +| [`GetSkirtboardLength`](#generated.RAFeedConveyor.GetSkirtboardLength)([unit]) | Get the value of "Skirtboard Length". | +| [`GetSphBoundaryType`](#generated.RAFeedConveyor.GetSphBoundaryType)() | Get "Sph Boundary Type" as a string. | +| [`GetSurfaceTensionContactAngle`](#generated.RAFeedConveyor.GetSurfaceTensionContactAngle)([unit]) | Get the value of "Surface Tension Contact Angle". | +| [`GetTemperature`](#generated.RAFeedConveyor.GetTemperature)([unit]) | Get the value of "Temperature". | +| [`GetThermalBoundaryConditionType`](#generated.RAFeedConveyor.GetThermalBoundaryConditionType)() | Get "Thermal Boundary Condition Type" as a string. | +| [`GetTimeSet`](#generated.RAFeedConveyor.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAFeedConveyor.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAFeedConveyor.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAFeedConveyor.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTransitionLength`](#generated.RAFeedConveyor.GetTransitionLength)([unit]) | Get the value of "Transition Length". | +| [`GetTriangleSize`](#generated.RAFeedConveyor.GetTriangleSize)([unit]) | Get the value of "Triangle Size". | +| [`GetValidBeltProfileNames`](#generated.RAFeedConveyor.GetValidBeltProfileNames)() | Return a list with possible values for belt profile. | +| [`GetValidOptionsForModuleProperty`](#generated.RAFeedConveyor.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`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". | +| [`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. | +| [`IsCellActive`](#generated.RAFeedConveyor.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IterCellVertices`](#generated.RAFeedConveyor.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAFeedConveyor.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAFeedConveyor.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAFeedConveyor.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAFeedConveyor.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAFeedConveyor.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAFeedConveyor.RemoveProcess)() | Removes the process from the project. | +| [`SetAccelerationPeriod`](#generated.RAFeedConveyor.SetAccelerationPeriod)(value[, unit]) | Set the value of "Acceleration Period". | +| [`SetAlignmentAngle`](#generated.RAFeedConveyor.SetAlignmentAngle)(value[, unit]) | Set the value of "Alignment Angle". | +| [`SetBeginningStartTime`](#generated.RAFeedConveyor.SetBeginningStartTime)(value[, unit]) | Set the value of "Beginning Start Time". | +| [`SetBeginningStopTime`](#generated.RAFeedConveyor.SetBeginningStopTime)(value[, unit]) | Set the value of "Beginning Stop Time". | +| [`SetBeltInclineAngle`](#generated.RAFeedConveyor.SetBeltInclineAngle)(value[, unit]) | Set the value of "Belt Incline Angle". | +| [`SetBeltProfile`](#generated.RAFeedConveyor.SetBeltProfile)(belt_profile_name) | Set the belt profile object through its name as shown in the UI. | +| [`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". | +| [`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". | +| [`SetDropBoxHeight`](#generated.RAFeedConveyor.SetDropBoxHeight)(value[, unit]) | Set the value of "Drop Box Height". | +| [`SetDropBoxLength`](#generated.RAFeedConveyor.SetDropBoxLength)(value[, unit]) | Set the value of "Drop Box Length". | +| [`SetDropBoxWidth`](#generated.RAFeedConveyor.SetDropBoxWidth)(value[, unit]) | Set the value of "Drop Box Width". | +| [`SetFaceWidth`](#generated.RAFeedConveyor.SetFaceWidth)(value[, unit]) | Set the value of "Face Width". | +| [`SetFrontPlateOffset`](#generated.RAFeedConveyor.SetFrontPlateOffset)(value[, unit]) | Set the value of "Front Plate Offset". | +| [`SetHeightOffset`](#generated.RAFeedConveyor.SetHeightOffset)(value[, unit]) | Set the value of "Height Offset". | +| [`SetHorizontalOffset`](#generated.RAFeedConveyor.SetHorizontalOffset)(value[, unit]) | Set the value of "Horizontal Offset". | +| [`SetLengthOffset`](#generated.RAFeedConveyor.SetLengthOffset)(value[, unit]) | Set the value of "Length Offset". | +| [`SetLoadingLength`](#generated.RAFeedConveyor.SetLoadingLength)(value[, unit]) | Set the value of "Loading Length". | +| [`SetMaterial`](#generated.RAFeedConveyor.SetMaterial)(value) | Set the "Material". | +| [`SetModuleProperty`](#generated.RAFeedConveyor.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetOffsetToIdlers`](#generated.RAFeedConveyor.SetOffsetToIdlers)(value[, unit]) | Set the value of "Offset To Idlers". | +| [`SetOutOfPlaneOffset`](#generated.RAFeedConveyor.SetOutOfPlaneOffset)(value[, unit]) | Set the value of "Out of Plane Offset". | +| [`SetReturnBeltAngle`](#generated.RAFeedConveyor.SetReturnBeltAngle)(value[, unit]) | Set the value of "Return Belt Angle". | +| [`SetSkirtboardHeight`](#generated.RAFeedConveyor.SetSkirtboardHeight)(value[, unit]) | Set the value of "Skirtboard Height". | +| [`SetSkirtboardLength`](#generated.RAFeedConveyor.SetSkirtboardLength)(value[, unit]) | Set the value of "Skirtboard Length". | +| [`SetSphBoundaryType`](#generated.RAFeedConveyor.SetSphBoundaryType)(value) | Set the value of "Sph Boundary Type". | +| [`SetSurfaceTensionContactAngle`](#generated.RAFeedConveyor.SetSurfaceTensionContactAngle)(value[, unit]) | Set the value of "Surface Tension Contact Angle". | +| [`SetTemperature`](#generated.RAFeedConveyor.SetTemperature)(value[, unit]) | Set the value of "Temperature". | +| [`SetThermalBoundaryConditionType`](#generated.RAFeedConveyor.SetThermalBoundaryConditionType)(value) | Set the value of "Thermal Boundary Condition Type". | +| [`SetTransitionLength`](#generated.RAFeedConveyor.SetTransitionLength)(value[, unit]) | Set the value of "Transition Length". | +| [`SetTriangleSize`](#generated.RAFeedConveyor.SetTriangleSize)(value[, unit]) | Set the value of "Triangle Size". | +| [`SetVerticalOffset`](#generated.RAFeedConveyor.SetVerticalOffset)(value[, unit]) | Set the value of "Vertical Offset". | +| [`SetWallThickness`](#generated.RAFeedConveyor.SetWallThickness)(value[, unit]) | Set the value of "Wall Thickness". | +| [`SetWidth`](#generated.RAFeedConveyor.SetWidth)(value[, unit]) | Set the value of "Width". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetAccelerationPeriod(unit: str | None = None) + +Get the value of “Acceleration Period”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAlignmentAngle(unit: str | None = None) + +Get the value of “Alignment Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetBeginningStartTime(unit: str | None = None) + +Get the value of “Beginning Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetBeginningStopTime(unit: str | None = None) + +Get the value of “Beginning Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetBeltInclineAngle(unit: str | None = None) + +Get the value of “Belt Incline Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. + + + +#### GetBeltProfile() + +* **Return type:** + ApiElementItem +* **Returns:** + The API object that wraps the current belt profile. + + + +#### GetBeltProfileName() + +Get the name of the belt profile. + +* **Return type:** + str +* **Returns:** + A string describing the type of belt profile. The returned value will be one of the strings + in the “Belt Profile” drop-down menu in the UI. + + + +#### GetBeltSpeed(unit: str | None = None) + +Get the value of “Belt Speed”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### GetBeltThickness(unit: str | None = None) + +Get the value of “Belt Thickness”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetBeltWidth(unit: str | None = None) + +Get the value of “Belt Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDecelerationPeriod(unit: str | None = None) + +Get the value of “Deceleration Period”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetDiameter(unit: str | None = None) + +Get the value of “Diameter”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetDropBoxHeight(unit: str | None = None) + +Get the value of “Drop Box Height”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetDropBoxLength(unit: str | None = None) + +Get the value of “Drop Box Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetDropBoxWidth(unit: str | None = None) + +Get the value of “Drop Box Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### 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. + + + +#### GetFaceWidth(unit: str | None = None) + +Get the value of “Face Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetFrontPlateOffset(unit: str | None = None) + +Get the value of “Front Plate Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetHeightOffset(unit: str | None = None) + +Get the value of “Height Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetHorizontalOffset(unit: str | None = None) + +Get the value of “Horizontal Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetLengthOffset(unit: str | None = None) + +Get the value of “Length Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetLoadingLength(unit: str | None = None) + +Get the value of “Loading Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOffsetToIdlers(unit: str | None = None) + +Get the value of “Offset To Idlers”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetOutOfPlaneOffset(unit: str | None = None) + +Get the value of “Out of Plane Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetReturnBeltAngle(unit: str | None = None) + +Get the value of “Return Belt Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. + + + +#### GetSkirtboardHeight(unit: str | None = None) + +Get the value of “Skirtboard Height”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetSkirtboardLength(unit: str | None = None) + +Get the value of “Skirtboard Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetSphBoundaryType() + +Get “Sph Boundary Type” as a string. + +* **Returns:** + The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + + +#### GetSurfaceTensionContactAngle(unit: str | None = None) + +Get the value of “Surface Tension Contact Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetTemperature(unit: str | None = None) + +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”. + + + +#### GetThermalBoundaryConditionType() + +Get “Thermal Boundary Condition Type” as a string. + +* **Returns:** + The returned value will be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTransitionLength(unit: str | None = None) + +Get the value of “Transition Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetTriangleSize(unit: str | None = None) + +Get the value of “Triangle Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetValidBeltProfileNames() + +Return a list with possible values for belt profile. + +* **Return type:** + list(str) +* **Returns:** + A list of accepted values for SetBeltProfile(). + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### GetValidSphBoundaryTypeValues() + +Get a list of all possible values for “Sph Boundary Type”. + +* **Returns:** + The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + + +#### GetValidThermalBoundaryConditionTypeValues() + +Get a list of all possible values for “Thermal Boundary Condition Type”. + +* **Returns:** + The returned list is [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. + + + +#### GetVerticalOffset(unit: str | None = None) + +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”. + + + +#### GetWallThickness(unit: str | None = None) + +Get the value of “Wall Thickness”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetWidth(unit: str | None = None) + +Get the value of “Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetAccelerationPeriod(value: str | float, unit: str | None = None) + +Set the value of “Acceleration 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”. + + + +#### SetAlignmentAngle(value: str | float, unit: str | None = None) + +Set the value of “Alignment 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 “dega”. + + + +#### SetBeginningStartTime(value: str | float, unit: str | None = None) + +Set the value of “Beginning Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetBeginningStopTime(value: str | float, unit: str | None = None) + +Set the value of “Beginning Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetBeltInclineAngle(value: str | float, unit: str | None = None) + +Set the value of “Belt Incline 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”. + + + +#### SetBeltProfile(belt_profile_name) + +Set the belt profile object through its name as shown in the UI. + +* **Parameters:** + **belt_profile_name** (*str*) – Accepted values are the strings in the “Belt Profile” dropdown menu in the UI. +* **Return type:** + ApiElementItem +* **Returns:** + The PrePost Scripting wrapper representing the belt profile. + + + +#### SetBeltSpeed(value: str | float, unit: str | None = None) + +Set the value of “Belt Speed”. + +* **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/s”. + + + +#### SetBeltThickness(value: str | float, unit: str | None = None) + +Set the value of “Belt Thickness”. + +* **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”. + + + +#### SetBeltWidth(value: str | float, unit: str | None = None) + +Set the value of “Belt Width”. + +* **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”. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDecelerationPeriod(value: str | float, unit: str | None = None) + +Set the value of “Deceleration 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”. + + + +#### SetDiameter(value: str | float, unit: str | None = None) + +Set the value of “Diameter”. + +* **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”. + + + +#### SetDropBoxHeight(value: str | float, unit: str | None = None) + +Set the value of “Drop Box Height”. + +* **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”. + + + +#### SetDropBoxLength(value: str | float, unit: str | None = None) + +Set the value of “Drop Box Length”. + +* **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”. + + + +#### SetDropBoxWidth(value: str | float, unit: str | None = None) + +Set the value of “Drop Box Width”. + +* **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”. + + + +#### SetFaceWidth(value: str | float, unit: str | None = None) + +Set the value of “Face Width”. + +* **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”. + + + +#### SetFrontPlateOffset(value: str | float, unit: str | None = None) + +Set the value of “Front Plate Offset”. + +* **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”. + + + +#### SetHeightOffset(value: str | float, unit: str | None = None) + +Set the value of “Height Offset”. + +* **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”. + + + +#### SetHorizontalOffset(value: str | float, unit: str | None = None) + +Set the value of “Horizontal Offset”. + +* **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”. + + + +#### SetLengthOffset(value: str | float, unit: str | None = None) + +Set the value of “Length Offset”. + +* **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”. + + + +#### SetLoadingLength(value: str | float, unit: str | None = None) + +Set the value of “Loading Length”. + +* **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”. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetOffsetToIdlers(value: str | float, unit: str | None = None) + +Set the value of “Offset To Idlers”. + +* **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”. + + + +#### SetOutOfPlaneOffset(value: str | float, unit: str | None = None) + +Set the value of “Out of Plane Offset”. + +* **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”. + + + +#### SetReturnBeltAngle(value: str | float, unit: str | None = None) + +Set the value of “Return Belt 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”. + + + +#### SetSkirtboardHeight(value: str | float, unit: str | None = None) + +Set the value of “Skirtboard Height”. + +* **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”. + + + +#### SetSkirtboardLength(value: str | float, unit: str | None = None) + +Set the value of “Skirtboard Length”. + +* **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”. + + + +#### SetSphBoundaryType(value: str) + +Set the value of “Sph Boundary Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Sph Boundary Type” option. + + + +#### SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) + +Set the value of “Surface Tension Contact 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 “dega”. + + + +#### SetTemperature(value: str | float, unit: str | None = None) + +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”. + + + +#### SetThermalBoundaryConditionType(value: str) + +Set the value of “Thermal Boundary Condition Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Thermal Boundary Condition Type” option. + + + +#### SetTransitionLength(value: str | float, unit: str | None = None) + +Set the value of “Transition Length”. + +* **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”. + + + +#### SetTriangleSize(value: str | float, unit: str | None = None) + +Set the value of “Triangle Size”. + +* **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”. + + + +#### SetVerticalOffset(value: str | float, unit: str | None = None) + +Set the value of “Vertical Offset”. + +* **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”. + + + +#### SetWallThickness(value: str | float, unit: str | None = None) + +Set the value of “Wall Thickness”. + +* **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”. + + + +#### SetWidth(value: str | float, unit: str | None = None) + +Set the value of “Width”. + +* **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/2025R2/rocky-prepost-scripting-manual/RAFilterProcess.md b/2025R2/rocky-prepost-scripting-manual/RAFilterProcess.md index 6115342982..9f17ec5b90 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFilterProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFilterProcess.md @@ -1,1112 +1,1113 @@ - - -# RAFilterProcess - - - - - - -### *class* RAFilterProcess - -PrePost Scripting wrapper for Property Processes. - -Limits properties by a specific cut or range of values. - -#### NOTE -Originally named “RAPropertyProcess”. Although the public api uses “Filter” -for functions related to this process, the original “PropertyProcess” name -is still used internally. - -**Methods:** - -| [`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) | | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetCutValue(unit=None) - -* **Return type:** - Scalar -* **Returns:** - Returns the single, exact value by which you want the property results limited when Type is Value - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMaxValue(unit=None) - -* **Return type:** - Scalar -* **Returns:** - Returns the highest value by which you want the property results limited when Type is Range - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinValue(unit=None) - -* **Return type:** - Scalar -* **Returns:** - Returns the lowest value by which you want the property results limited when Type is Range - - - -#### GetMode() - -* **Return type:** - unicode -* **Returns:** - ‘Cut’ or ‘Select’, whether the property process is selecting or cutting the cell’s from the input process - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetPropertyGridFunction() - -Get the grid function which this property process will use to filter its input elements - -* **Return type:** - unicode -* **Returns:** - The current grid function - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetType() - -* **Return type:** - ‘Value’ or ‘Range’ -* **Returns:** - Return whether the property process filters elements that match a specific value or a range of values - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetCutValue(value, unit=None) - -Sets the single, exact value by which you want the property results limited when Type is Value - -* **Parameters:** - * **value** – float - The new cut value - * **unit** (*str* *|**None*) – The unit of the given value or None if given the same unit already used - - - -#### SetMaxValue(value, unit=None) - -Sets the highest value by which you want the property results limited when Type is Range - -* **Parameters:** - * **value** – float - The new maximum value - * **unit** (*str* *|**None*) – The unit of the given value or None if given the same unit already used - - - -#### SetMinValue(value, unit=None) - -Sets the lowest value by which you want the property results limited when Type is Range - -* **Parameters:** - * **value** – float - The new minimum value - * **unit** (*str* *|**None*) – The unit of the given value or None if given the same unit already used - - - -#### SetMode(property_mode) - -* **Parameters:** - **plane_mode** – ‘Cut’ or ‘Select’ - Sets whether the property process is selecting or cutting the cell’s from the input process - - - -#### SetPropertyGridFunction(grid_function, realization=None) - -Set the grid function which this property process will use to filter its input elements - -* **Parameters:** - * **grid_function** (*unicode*) – The new grid function - * **realization** (*unicode*) – An additional keyword to identify the curve realization - - - -#### SetType(filter_type) - -* **Parameters:** - **filter_type** – ‘Value’ or ‘Range’ - Sets whether the property process filters elements that match a specific value or a range of values + + +# RAFilterProcess + + + + + + +### *class* RAFilterProcess + +PrePost Scripting wrapper for Property Processes. + +Limits properties by a specific cut or range of values. + +#### NOTE +Originally named “RAPropertyProcess”. Although the public api uses “Filter” +for functions related to this process, the original “PropertyProcess” name +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) | | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetCutValue(unit=None) + +* **Return type:** + Scalar +* **Returns:** + Returns the single, exact value by which you want the property results limited when Type is Value + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMaxValue(unit=None) + +* **Return type:** + Scalar +* **Returns:** + Returns the highest value by which you want the property results limited when Type is Range + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinValue(unit=None) + +* **Return type:** + Scalar +* **Returns:** + Returns the lowest value by which you want the property results limited when Type is Range + + + +#### GetMode() + +* **Return type:** + unicode +* **Returns:** + ‘Cut’ or ‘Select’, whether the property process is selecting or cutting the cell’s from the input process + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetPropertyGridFunction() + +Get the grid function which this property process will use to filter its input elements + +* **Return type:** + unicode +* **Returns:** + The current grid function + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetType() + +* **Return type:** + ‘Value’ or ‘Range’ +* **Returns:** + Return whether the property process filters elements that match a specific value or a range of values + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetCutValue(value, unit=None) + +Sets the single, exact value by which you want the property results limited when Type is Value + +* **Parameters:** + * **value** – float + The new cut value + * **unit** (*str* *|**None*) – The unit of the given value or None if given the same unit already used + + + +#### SetMaxValue(value, unit=None) + +Sets the highest value by which you want the property results limited when Type is Range + +* **Parameters:** + * **value** – float + The new maximum value + * **unit** (*str* *|**None*) – The unit of the given value or None if given the same unit already used + + + +#### SetMinValue(value, unit=None) + +Sets the lowest value by which you want the property results limited when Type is Range + +* **Parameters:** + * **value** – float + The new minimum value + * **unit** (*str* *|**None*) – The unit of the given value or None if given the same unit already used + + + +#### SetMode(property_mode) + +* **Parameters:** + **plane_mode** – ‘Cut’ or ‘Select’ + Sets whether the property process is selecting or cutting the cell’s from the input process + + + +#### SetPropertyGridFunction(grid_function, realization=None) + +Set the grid function which this property process will use to filter its input elements + +* **Parameters:** + * **grid_function** (*unicode*) – The new grid function + * **realization** (*unicode*) – An additional keyword to identify the curve realization + + + +#### SetType(filter_type) + +* **Parameters:** + **filter_type** – ‘Value’ or ‘Range’ + Sets whether the property process filters elements that match a specific value or a range of values diff --git a/2025R2/rocky-prepost-scripting-manual/RAFiveRollsBeltProfile.md b/2025R2/rocky-prepost-scripting-manual/RAFiveRollsBeltProfile.md index 3d121c91a3..842741b867 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFiveRollsBeltProfile.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFiveRollsBeltProfile.md @@ -1,213 +1,214 @@ - - -# RAFiveRollsBeltProfile - - - - - - -### *class* RAFiveRollsBeltProfile - -Rocky API for a Five Rolls Belt Profile model. - -**Methods:** - -| [`DisableUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths)() | Set the value of "Use 0223 Ratio For Roll Lengths" to False. | -|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| -| [`EnableUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths)() | Set the value of "Use 0223 Ratio For Roll Lengths" to True. | -| [`GetAvailableMaterials`](#generated.RAFiveRollsBeltProfile.GetAvailableMaterials)() | Get all available Materials. | -| [`GetCenterRollLength`](#generated.RAFiveRollsBeltProfile.GetCenterRollLength)([unit]) | Get the value of "Center Roll Length". | -| [`GetLastRollAngle`](#generated.RAFiveRollsBeltProfile.GetLastRollAngle)([unit]) | Get the value of "Last Roll Angle". | -| [`GetLowerCornerRadius`](#generated.RAFiveRollsBeltProfile.GetLowerCornerRadius)([unit]) | Get the value of "Lower Corner Radius". | -| [`GetMaterial`](#generated.RAFiveRollsBeltProfile.GetMaterial)() | Get the "Material". | -| [`GetSideRollLength`](#generated.RAFiveRollsBeltProfile.GetSideRollLength)([unit]) | Get the value of "Side Roll Length". | -| [`GetTroughingAngle`](#generated.RAFiveRollsBeltProfile.GetTroughingAngle)([unit]) | Get the value of "Troughing Angle". | -| [`GetUpperCornerRadius`](#generated.RAFiveRollsBeltProfile.GetUpperCornerRadius)([unit]) | Get the value of "Upper Corner Radius". | -| [`GetUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths)() | Get the value of "Use 0223 Ratio For Roll Lengths". | -| [`IsUse0223RatioForRollLengthsEnabled`](#generated.RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled)() | Check if the "Use 0223 Ratio For Roll Lengths" is enabled. | -| [`SetCenterRollLength`](#generated.RAFiveRollsBeltProfile.SetCenterRollLength)(value[, unit]) | Set the value of "Center Roll Length". | -| [`SetLastRollAngle`](#generated.RAFiveRollsBeltProfile.SetLastRollAngle)(value[, unit]) | Set the value of "Last Roll Angle". | -| [`SetLowerCornerRadius`](#generated.RAFiveRollsBeltProfile.SetLowerCornerRadius)(value[, unit]) | Set the value of "Lower Corner Radius". | -| [`SetMaterial`](#generated.RAFiveRollsBeltProfile.SetMaterial)(value) | Set the "Material". | -| [`SetSideRollLength`](#generated.RAFiveRollsBeltProfile.SetSideRollLength)(value[, unit]) | Set the value of "Side Roll Length". | -| [`SetTroughingAngle`](#generated.RAFiveRollsBeltProfile.SetTroughingAngle)(value[, unit]) | Set the value of "Troughing Angle". | -| [`SetUpperCornerRadius`](#generated.RAFiveRollsBeltProfile.SetUpperCornerRadius)(value[, unit]) | Set the value of "Upper Corner Radius". | -| [`SetUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths)(value) | Set the value of "Use 0223 Ratio For Roll Lengths". | - - - -#### DisableUse0223RatioForRollLengths() - -Set the value of “Use 0223 Ratio For Roll Lengths” to False. - - - -#### EnableUse0223RatioForRollLengths() - -Set the value of “Use 0223 Ratio For Roll Lengths” to True. - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetCenterRollLength(unit: str | None = None) - -Get the value of “Center Roll Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetLastRollAngle(unit: str | None = None) - -Get the value of “Last Roll Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. - - - -#### GetLowerCornerRadius(unit: str | None = None) - -Get the value of “Lower Corner Radius”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetSideRollLength(unit: str | None = None) - -Get the value of “Side Roll Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetTroughingAngle(unit: str | None = None) - -Get the value of “Troughing Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetUpperCornerRadius(unit: str | None = None) - -Get the value of “Upper Corner Radius”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetUse0223RatioForRollLengths() - -Get the value of “Use 0223 Ratio For Roll Lengths”. - - - -#### IsUse0223RatioForRollLengthsEnabled() - -Check if the “Use 0223 Ratio For Roll Lengths” is enabled. - - - -#### SetCenterRollLength(value: str | float, unit: str | None = None) - -Set the value of “Center Roll Length”. - -* **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”. - - - -#### SetLastRollAngle(value: str | float, unit: str | None = None) - -Set the value of “Last Roll 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”. - - - -#### SetLowerCornerRadius(value: str | float, unit: str | None = None) - -Set the value of “Lower Corner Radius”. - -* **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”. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetSideRollLength(value: str | float, unit: str | None = None) - -Set the value of “Side Roll Length”. - -* **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”. - - - -#### SetTroughingAngle(value: str | float, unit: str | None = None) - -Set the value of “Troughing 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 “dega”. - - - -#### SetUpperCornerRadius(value: str | float, unit: str | None = None) - -Set the value of “Upper Corner Radius”. - -* **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”. - - - -#### SetUse0223RatioForRollLengths(value: bool) - -Set the value of “Use 0223 Ratio For Roll Lengths”. - -* **Parameters:** - **value** – The value to set. + + +# RAFiveRollsBeltProfile + + + + + + +### *class* RAFiveRollsBeltProfile + +Rocky API for a Five Rolls Belt Profile model. + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| [`DisableUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths)() | Set the value of "Use 0223 Ratio For Roll Lengths" to False. | +| [`EnableUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths)() | Set the value of "Use 0223 Ratio For Roll Lengths" to True. | +| [`GetAvailableMaterials`](#generated.RAFiveRollsBeltProfile.GetAvailableMaterials)() | Get all available Materials. | +| [`GetCenterRollLength`](#generated.RAFiveRollsBeltProfile.GetCenterRollLength)([unit]) | Get the value of "Center Roll Length". | +| [`GetLastRollAngle`](#generated.RAFiveRollsBeltProfile.GetLastRollAngle)([unit]) | Get the value of "Last Roll Angle". | +| [`GetLowerCornerRadius`](#generated.RAFiveRollsBeltProfile.GetLowerCornerRadius)([unit]) | Get the value of "Lower Corner Radius". | +| [`GetMaterial`](#generated.RAFiveRollsBeltProfile.GetMaterial)() | Get the "Material". | +| [`GetSideRollLength`](#generated.RAFiveRollsBeltProfile.GetSideRollLength)([unit]) | Get the value of "Side Roll Length". | +| [`GetTroughingAngle`](#generated.RAFiveRollsBeltProfile.GetTroughingAngle)([unit]) | Get the value of "Troughing Angle". | +| [`GetUpperCornerRadius`](#generated.RAFiveRollsBeltProfile.GetUpperCornerRadius)([unit]) | Get the value of "Upper Corner Radius". | +| [`GetUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths)() | Get the value of "Use 0223 Ratio For Roll Lengths". | +| [`IsUse0223RatioForRollLengthsEnabled`](#generated.RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled)() | Check if the "Use 0223 Ratio For Roll Lengths" is enabled. | +| [`SetCenterRollLength`](#generated.RAFiveRollsBeltProfile.SetCenterRollLength)(value[, unit]) | Set the value of "Center Roll Length". | +| [`SetLastRollAngle`](#generated.RAFiveRollsBeltProfile.SetLastRollAngle)(value[, unit]) | Set the value of "Last Roll Angle". | +| [`SetLowerCornerRadius`](#generated.RAFiveRollsBeltProfile.SetLowerCornerRadius)(value[, unit]) | Set the value of "Lower Corner Radius". | +| [`SetMaterial`](#generated.RAFiveRollsBeltProfile.SetMaterial)(value) | Set the "Material". | +| [`SetSideRollLength`](#generated.RAFiveRollsBeltProfile.SetSideRollLength)(value[, unit]) | Set the value of "Side Roll Length". | +| [`SetTroughingAngle`](#generated.RAFiveRollsBeltProfile.SetTroughingAngle)(value[, unit]) | Set the value of "Troughing Angle". | +| [`SetUpperCornerRadius`](#generated.RAFiveRollsBeltProfile.SetUpperCornerRadius)(value[, unit]) | Set the value of "Upper Corner Radius". | +| [`SetUse0223RatioForRollLengths`](#generated.RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths)(value) | Set the value of "Use 0223 Ratio For Roll Lengths". | + + + +#### DisableUse0223RatioForRollLengths() + +Set the value of “Use 0223 Ratio For Roll Lengths” to False. + + + +#### EnableUse0223RatioForRollLengths() + +Set the value of “Use 0223 Ratio For Roll Lengths” to True. + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetCenterRollLength(unit: str | None = None) + +Get the value of “Center Roll Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetLastRollAngle(unit: str | None = None) + +Get the value of “Last Roll Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. + + + +#### GetLowerCornerRadius(unit: str | None = None) + +Get the value of “Lower Corner Radius”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetSideRollLength(unit: str | None = None) + +Get the value of “Side Roll Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetTroughingAngle(unit: str | None = None) + +Get the value of “Troughing Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetUpperCornerRadius(unit: str | None = None) + +Get the value of “Upper Corner Radius”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetUse0223RatioForRollLengths() + +Get the value of “Use 0223 Ratio For Roll Lengths”. + + + +#### IsUse0223RatioForRollLengthsEnabled() + +Check if the “Use 0223 Ratio For Roll Lengths” is enabled. + + + +#### SetCenterRollLength(value: str | float, unit: str | None = None) + +Set the value of “Center Roll Length”. + +* **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”. + + + +#### SetLastRollAngle(value: str | float, unit: str | None = None) + +Set the value of “Last Roll 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”. + + + +#### SetLowerCornerRadius(value: str | float, unit: str | None = None) + +Set the value of “Lower Corner Radius”. + +* **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”. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetSideRollLength(value: str | float, unit: str | None = None) + +Set the value of “Side Roll Length”. + +* **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”. + + + +#### SetTroughingAngle(value: str | float, unit: str | None = None) + +Set the value of “Troughing 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 “dega”. + + + +#### SetUpperCornerRadius(value: str | float, unit: str | None = None) + +Set the value of “Upper Corner Radius”. + +* **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”. + + + +#### SetUse0223RatioForRollLengths(value: bool) + +Set the value of “Use 0223 Ratio For Roll Lengths”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RAFluentOneWayCoupling.md b/2025R2/rocky-prepost-scripting-manual/RAFluentOneWayCoupling.md index 0464d708c4..05ad04d935 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFluentOneWayCoupling.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFluentOneWayCoupling.md @@ -1,1382 +1,1383 @@ - - -# RAFluentOneWayCoupling - - - - - - -### *class* RAFluentOneWayCoupling - -Rocky PrePost Scripting wrapper to Fluent one way CFD coupling process. - -This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): - -```python -cfd_coupling = study.GetCFDCoupling() -cfd_coupling.SetupOneWayFluent('fluent.cas') -one_way_process = cfd_coupling.GetCouplingProcess() -``` - -**Methods:** - -| [`AddCurve`](#generated.RAFluentOneWayCoupling.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAFluentOneWayCoupling.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCoupledBoundaries`](#generated.RAFluentOneWayCoupling.CreateCoupledBoundaries)(coupled_boundary_names) | Create a coupled boundary for each of the coupled boundary name passed by the user. | -| [`CreateCurveOutputVariable`](#generated.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAvailableCoupledBoundaryNames`](#generated.RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames)() | Obtain the names of the boundaries available for coupling in the fluent file. | -| [`GetBoundingBox`](#generated.RAFluentOneWayCoupling.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCFDParametersList`](#generated.RAFluentOneWayCoupling.GetCFDParametersList)() | Get the list of per-Particle CFD parameter sets. | -| [`GetCellAreaAsArray`](#generated.RAFluentOneWayCoupling.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAFluentOneWayCoupling.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAFluentOneWayCoupling.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAFluentOneWayCoupling.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAFluentOneWayCoupling.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAFluentOneWayCoupling.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAFluentOneWayCoupling.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAFluentOneWayCoupling.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetConvectiveHeatTransferLaw`](#generated.RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw)() | Get the current "Convective Heat Transfer Law". | -| [`GetCurve`](#generated.RAFluentOneWayCoupling.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAFluentOneWayCoupling.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAFluentOneWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetMorsiAndAlexanderK1`](#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK1)() | Get the current "Morsi And Alexander K1". | -| [`GetMorsiAndAlexanderK2`](#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK2)() | Get the current "Morsi And Alexander K2". | -| [`GetMorsiAndAlexanderK3`](#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK3)() | Get the current "Morsi And Alexander K3". | -| [`GetNumberOfCells`](#generated.RAFluentOneWayCoupling.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAFluentOneWayCoupling.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAFluentOneWayCoupling.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAFluentOneWayCoupling.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetOverwriteCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance)() | Get the value of "Overwrite Cfd Update Distance". | -| [`GetStartTime`](#generated.RAFluentOneWayCoupling.GetStartTime)([unit]) | Get the value of "Start Time". | -| [`GetSyamlalObrienC1`](#generated.RAFluentOneWayCoupling.GetSyamlalObrienC1)() | Get the current "Syamlal Obrien C1". | -| [`GetSyamlalObrienD1`](#generated.RAFluentOneWayCoupling.GetSyamlalObrienD1)() | Get the current "Syamlal Obrien D1". | -| [`GetTimeSet`](#generated.RAFluentOneWayCoupling.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAFluentOneWayCoupling.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAFluentOneWayCoupling.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAFluentOneWayCoupling.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTorqueLaw`](#generated.RAFluentOneWayCoupling.GetTorqueLaw)() | Get the current "Torque Law". | -| [`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". | -| [`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 | -| [`IterCellVertices`](#generated.RAFluentOneWayCoupling.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAFluentOneWayCoupling.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAFluentOneWayCoupling.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAFluentOneWayCoupling.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAFluentOneWayCoupling.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAFluentOneWayCoupling.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAFluentOneWayCoupling.RemoveProcess)() | Removes the process from the project. | -| [`SetConvectiveHeatTransferLaw`](#generated.RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw)(value) | Set the current "Convective Heat Transfer Law". | -| [`SetCurrentTimeStep`](#generated.RAFluentOneWayCoupling.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDragLaw`](#generated.RAFluentOneWayCoupling.SetDragLaw)(value) | Set the current "Drag Law". | -| [`SetIsOneWayPeriodic`](#generated.RAFluentOneWayCoupling.SetIsOneWayPeriodic)(value) | Set the value of "Is One Way Periodic". | -| [`SetLiftLaw`](#generated.RAFluentOneWayCoupling.SetLiftLaw)(value) | Set the current "Lift Law". | -| [`SetMorsiAndAlexanderK1`](#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK1)(value) | Set the current "Morsi And Alexander K1". | -| [`SetMorsiAndAlexanderK2`](#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK2)(value) | Set the current "Morsi And Alexander K2". | -| [`SetMorsiAndAlexanderK3`](#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK3)(value) | Set the current "Morsi And Alexander K3". | -| [`SetOverwriteCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance)(value) | Set the value of "Overwrite Cfd Update Distance". | -| [`SetPartIdIfValid`](#generated.RAFluentOneWayCoupling.SetPartIdIfValid)() | Subclasses should implement this method if it's a Process with visualization | -| [`SetStartTime`](#generated.RAFluentOneWayCoupling.SetStartTime)(value[, unit]) | Set the value of "Start Time". | -| [`SetSyamlalObrienC1`](#generated.RAFluentOneWayCoupling.SetSyamlalObrienC1)(value) | Set the current "Syamlal Obrien C1". | -| [`SetSyamlalObrienD1`](#generated.RAFluentOneWayCoupling.SetSyamlalObrienD1)(value) | Set the current "Syamlal Obrien D1". | -| [`SetTorqueLaw`](#generated.RAFluentOneWayCoupling.SetTorqueLaw)(value) | Set the current "Torque Law". | -| [`SetUseTurbulentDispersion`](#generated.RAFluentOneWayCoupling.SetUseTurbulentDispersion)(value) | Set the value of "Use Turbulent Dispersion". | -| [`SetUseUserDefinedConstants`](#generated.RAFluentOneWayCoupling.SetUseUserDefinedConstants)(value) | Set the current "Use User Defined Constants". | -| [`SetUserCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.SetUserCfdUpdateDistance)(value[, unit]) | Set the value of "User Cfd Update Distance". | -| [`SetVirtualMassLaw`](#generated.RAFluentOneWayCoupling.SetVirtualMassLaw)(value) | Set the current "Virtual Mass Law". | -| [`SetupStoreFiles`](#generated.RAFluentOneWayCoupling.SetupStoreFiles)(filename) | Set the file with Fluent to Rocky information. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCoupledBoundaries(coupled_boundary_names: list[str]) - -Create a coupled boundary for each of the coupled boundary name passed by the user. -Check GetAvailableCoupledBoundaryNames to obtain the list of available boundaries. - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableCoupledBoundaryNames() - -Obtain the names of the boundaries available for coupling in the fluent file. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCFDParametersList() - -Get the list of per-Particle CFD parameter sets. - -* **Return type:** - [RACFDParametersList](RACFDParametersList.md#generated.RACFDParametersList) - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetConvectiveHeatTransferLaw() - -Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Convective Heat Transfer Law”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDragLaw() - -Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Drag Law”. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetIsOneWayPeriodic() - -Get the value of “Is One Way Periodic”. - - - -#### GetLiftLaw() - -Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Lift Law”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMorsiAndAlexanderK1() - -Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K1”. - - - -#### GetMorsiAndAlexanderK2() - -Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K2”. - - - -#### GetMorsiAndAlexanderK3() - -Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K3”. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetOverwriteCfdUpdateDistance() - -Get the value of “Overwrite Cfd Update Distance”. - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetSyamlalObrienC1() - -Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Syamlal Obrien C1”. - - - -#### GetSyamlalObrienD1() - -Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Syamlal Obrien D1”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTorqueLaw() - -Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Torque Law”. - - - -#### GetUseTurbulentDispersion() - -Get the value of “Use Turbulent Dispersion”. - - - -#### GetUseUserDefinedConstants() - -Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Use User Defined Constants”. - - - -#### GetUserCfdUpdateDistance(unit: str | None = None) - -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”. - - - -#### GetVirtualMassLaw() - -Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Virtual Mass Law”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetConvectiveHeatTransferLaw(value) - -Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDragLaw(value) - -Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetIsOneWayPeriodic(value: bool) - -Set the value of “Is One Way Periodic”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetLiftLaw(value) - -Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK1(value) - -Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK2(value) - -Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK3(value) - -Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetOverwriteCfdUpdateDistance(value: bool) - -Set the value of “Overwrite Cfd Update Distance”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetPartIdIfValid() - -Subclasses should implement this method if it’s a Process with visualization - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetSyamlalObrienC1(value) - -Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetSyamlalObrienD1(value) - -Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetTorqueLaw(value) - -Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetUseTurbulentDispersion(value: bool) - -Set the value of “Use Turbulent Dispersion”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseUserDefinedConstants(value) - -Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetUserCfdUpdateDistance(value: str | float, unit: str | None = None) - -Set the value of “User Cfd Update Distance”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “m”. - - - -#### SetVirtualMassLaw(value) - -Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetupStoreFiles(filename) - -Set the file with Fluent to Rocky information. - -* **Parameters:** - **filename** (*str*) – The filename for the .f2r file. + + +# RAFluentOneWayCoupling + + + + + + +### *class* RAFluentOneWayCoupling + +Rocky PrePost Scripting wrapper to Fluent one way CFD coupling process. + +This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): + +```python +cfd_coupling = study.GetCFDCoupling() +cfd_coupling.SetupOneWayFluent('fluent.cas') +one_way_process = cfd_coupling.GetCouplingProcess() +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAFluentOneWayCoupling.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAFluentOneWayCoupling.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCoupledBoundaries`](#generated.RAFluentOneWayCoupling.CreateCoupledBoundaries)(coupled_boundary_names) | Create a coupled boundary for each of the coupled boundary name passed by the user. | +| [`CreateCurveOutputVariable`](#generated.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.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.RAFluentOneWayCoupling.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAvailableCoupledBoundaryNames`](#generated.RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames)() | Obtain the names of the boundaries available for coupling in the fluent file. | +| [`GetBoundingBox`](#generated.RAFluentOneWayCoupling.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCFDParametersList`](#generated.RAFluentOneWayCoupling.GetCFDParametersList)() | Get the list of per-Particle CFD parameter sets. | +| [`GetCellAreaAsArray`](#generated.RAFluentOneWayCoupling.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAFluentOneWayCoupling.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAFluentOneWayCoupling.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAFluentOneWayCoupling.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAFluentOneWayCoupling.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAFluentOneWayCoupling.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAFluentOneWayCoupling.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAFluentOneWayCoupling.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetConvectiveHeatTransferLaw`](#generated.RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw)() | Get the current "Convective Heat Transfer Law". | +| [`GetCurve`](#generated.RAFluentOneWayCoupling.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAFluentOneWayCoupling.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAFluentOneWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetMorsiAndAlexanderK1`](#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK1)() | Get the current "Morsi And Alexander K1". | +| [`GetMorsiAndAlexanderK2`](#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK2)() | Get the current "Morsi And Alexander K2". | +| [`GetMorsiAndAlexanderK3`](#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK3)() | Get the current "Morsi And Alexander K3". | +| [`GetNumberOfCells`](#generated.RAFluentOneWayCoupling.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAFluentOneWayCoupling.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAFluentOneWayCoupling.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAFluentOneWayCoupling.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetOverwriteCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance)() | Get the value of "Overwrite Cfd Update Distance". | +| [`GetStartTime`](#generated.RAFluentOneWayCoupling.GetStartTime)([unit]) | Get the value of "Start Time". | +| [`GetSyamlalObrienC1`](#generated.RAFluentOneWayCoupling.GetSyamlalObrienC1)() | Get the current "Syamlal Obrien C1". | +| [`GetSyamlalObrienD1`](#generated.RAFluentOneWayCoupling.GetSyamlalObrienD1)() | Get the current "Syamlal Obrien D1". | +| [`GetTimeSet`](#generated.RAFluentOneWayCoupling.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAFluentOneWayCoupling.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAFluentOneWayCoupling.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAFluentOneWayCoupling.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTorqueLaw`](#generated.RAFluentOneWayCoupling.GetTorqueLaw)() | Get the current "Torque Law". | +| [`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". | +| [`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 | +| [`IterCellVertices`](#generated.RAFluentOneWayCoupling.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAFluentOneWayCoupling.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAFluentOneWayCoupling.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAFluentOneWayCoupling.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAFluentOneWayCoupling.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAFluentOneWayCoupling.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAFluentOneWayCoupling.RemoveProcess)() | Removes the process from the project. | +| [`SetConvectiveHeatTransferLaw`](#generated.RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw)(value) | Set the current "Convective Heat Transfer Law". | +| [`SetCurrentTimeStep`](#generated.RAFluentOneWayCoupling.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDragLaw`](#generated.RAFluentOneWayCoupling.SetDragLaw)(value) | Set the current "Drag Law". | +| [`SetIsOneWayPeriodic`](#generated.RAFluentOneWayCoupling.SetIsOneWayPeriodic)(value) | Set the value of "Is One Way Periodic". | +| [`SetLiftLaw`](#generated.RAFluentOneWayCoupling.SetLiftLaw)(value) | Set the current "Lift Law". | +| [`SetMorsiAndAlexanderK1`](#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK1)(value) | Set the current "Morsi And Alexander K1". | +| [`SetMorsiAndAlexanderK2`](#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK2)(value) | Set the current "Morsi And Alexander K2". | +| [`SetMorsiAndAlexanderK3`](#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK3)(value) | Set the current "Morsi And Alexander K3". | +| [`SetOverwriteCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance)(value) | Set the value of "Overwrite Cfd Update Distance". | +| [`SetPartIdIfValid`](#generated.RAFluentOneWayCoupling.SetPartIdIfValid)() | Subclasses should implement this method if it's a Process with visualization | +| [`SetStartTime`](#generated.RAFluentOneWayCoupling.SetStartTime)(value[, unit]) | Set the value of "Start Time". | +| [`SetSyamlalObrienC1`](#generated.RAFluentOneWayCoupling.SetSyamlalObrienC1)(value) | Set the current "Syamlal Obrien C1". | +| [`SetSyamlalObrienD1`](#generated.RAFluentOneWayCoupling.SetSyamlalObrienD1)(value) | Set the current "Syamlal Obrien D1". | +| [`SetTorqueLaw`](#generated.RAFluentOneWayCoupling.SetTorqueLaw)(value) | Set the current "Torque Law". | +| [`SetUseTurbulentDispersion`](#generated.RAFluentOneWayCoupling.SetUseTurbulentDispersion)(value) | Set the value of "Use Turbulent Dispersion". | +| [`SetUseUserDefinedConstants`](#generated.RAFluentOneWayCoupling.SetUseUserDefinedConstants)(value) | Set the current "Use User Defined Constants". | +| [`SetUserCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.SetUserCfdUpdateDistance)(value[, unit]) | Set the value of "User Cfd Update Distance". | +| [`SetVirtualMassLaw`](#generated.RAFluentOneWayCoupling.SetVirtualMassLaw)(value) | Set the current "Virtual Mass Law". | +| [`SetupStoreFiles`](#generated.RAFluentOneWayCoupling.SetupStoreFiles)(filename) | Set the file with Fluent to Rocky information. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCoupledBoundaries(coupled_boundary_names: list[str]) + +Create a coupled boundary for each of the coupled boundary name passed by the user. +Check GetAvailableCoupledBoundaryNames to obtain the list of available boundaries. + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableCoupledBoundaryNames() + +Obtain the names of the boundaries available for coupling in the fluent file. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCFDParametersList() + +Get the list of per-Particle CFD parameter sets. + +* **Return type:** + [RACFDParametersList](RACFDParametersList.md#generated.RACFDParametersList) + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetConvectiveHeatTransferLaw() + +Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Convective Heat Transfer Law”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDragLaw() + +Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Drag Law”. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetIsOneWayPeriodic() + +Get the value of “Is One Way Periodic”. + + + +#### GetLiftLaw() + +Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Lift Law”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMorsiAndAlexanderK1() + +Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K1”. + + + +#### GetMorsiAndAlexanderK2() + +Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K2”. + + + +#### GetMorsiAndAlexanderK3() + +Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K3”. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetOverwriteCfdUpdateDistance() + +Get the value of “Overwrite Cfd Update Distance”. + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetSyamlalObrienC1() + +Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Syamlal Obrien C1”. + + + +#### GetSyamlalObrienD1() + +Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Syamlal Obrien D1”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTorqueLaw() + +Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Torque Law”. + + + +#### GetUseTurbulentDispersion() + +Get the value of “Use Turbulent Dispersion”. + + + +#### GetUseUserDefinedConstants() + +Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Use User Defined Constants”. + + + +#### GetUserCfdUpdateDistance(unit: str | None = None) + +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”. + + + +#### GetVirtualMassLaw() + +Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Virtual Mass Law”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetConvectiveHeatTransferLaw(value) + +Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDragLaw(value) + +Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetIsOneWayPeriodic(value: bool) + +Set the value of “Is One Way Periodic”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetLiftLaw(value) + +Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK1(value) + +Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK2(value) + +Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK3(value) + +Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetOverwriteCfdUpdateDistance(value: bool) + +Set the value of “Overwrite Cfd Update Distance”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetPartIdIfValid() + +Subclasses should implement this method if it’s a Process with visualization + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetSyamlalObrienC1(value) + +Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetSyamlalObrienD1(value) + +Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetTorqueLaw(value) + +Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetUseTurbulentDispersion(value: bool) + +Set the value of “Use Turbulent Dispersion”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseUserDefinedConstants(value) + +Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetUserCfdUpdateDistance(value: str | float, unit: str | None = None) + +Set the value of “User Cfd Update Distance”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “m”. + + + +#### SetVirtualMassLaw(value) + +Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetupStoreFiles(filename) + +Set the file with Fluent to Rocky information. + +* **Parameters:** + **filename** (*str*) – The filename for the .f2r file. diff --git a/2025R2/rocky-prepost-scripting-manual/RAFluentSemiResolvedCoupling.md b/2025R2/rocky-prepost-scripting-manual/RAFluentSemiResolvedCoupling.md index 8a8b34ef44..83896b5914 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFluentSemiResolvedCoupling.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFluentSemiResolvedCoupling.md @@ -1,182 +1,183 @@ - - -# RAFluentSemiResolvedCoupling - - - - - - -### *class* RAFluentSemiResolvedCoupling - -PrePost Scripting wrapper class for the Fluent Two-Way Semi Resolved coupling mode - -**Methods:** - -| [`GetCouplingFilesKept`](#generated.RAFluentSemiResolvedCoupling.GetCouplingFilesKept)() | Get the value of "Coupling Files Kept". | -|---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| -| [`GetFluentAdditionalArgs`](#generated.RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs)() | Get the value of "Fluent Additional Args". | -| [`GetFluentExecutionMode`](#generated.RAFluentSemiResolvedCoupling.GetFluentExecutionMode)() | Get "Fluent Execution Mode" as a string. | -| [`GetFluentOutputFrequencyMultiplier`](#generated.RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier)() | Get the value of "Fluent Output Frequency Multiplier". | -| [`GetFluentReleases`](#generated.RAFluentSemiResolvedCoupling.GetFluentReleases)() | Get a list of available Fluent releases. | -| [`GetFluentSolverProcesses`](#generated.RAFluentSemiResolvedCoupling.GetFluentSolverProcesses)() | Get the value of "Fluent Solver Processes". | -| [`GetFluentVersion`](#generated.RAFluentSemiResolvedCoupling.GetFluentVersion)() | Get the value of "Version". | -| [`GetUseDatInitialization`](#generated.RAFluentSemiResolvedCoupling.GetUseDatInitialization)() | Get the value of "Use Dat Initialization". | -| [`GetValidFluentExecutionModeValues`](#generated.RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues)() | Get a list of all possible values for "Fluent Execution Mode". | -| [`SetCouplingFilesKept`](#generated.RAFluentSemiResolvedCoupling.SetCouplingFilesKept)(value) | Set the value of "Coupling Files Kept". | -| [`SetFluentAdditionalArgs`](#generated.RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs)(value) | Set the value of "Fluent Additional Args". | -| [`SetFluentExecutionMode`](#generated.RAFluentSemiResolvedCoupling.SetFluentExecutionMode)(value) | Set the value of "Fluent Execution Mode". | -| [`SetFluentOutputFrequencyMultiplier`](#generated.RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier)(value) | Set the value of "Fluent Output Frequency Multiplier". | -| [`SetFluentSolverProcesses`](#generated.RAFluentSemiResolvedCoupling.SetFluentSolverProcesses)(value) | Set the value of "Fluent Solver Processes". | -| [`SetFluentVersion`](#generated.RAFluentSemiResolvedCoupling.SetFluentVersion)(fluent_version) | Set the Ansys Fluent version to be used in CFD coupling (deprecated). | -| [`SetPartIdIfValid`](#generated.RAFluentSemiResolvedCoupling.SetPartIdIfValid)() | Set the process' part id (unused for now) | -| [`SetUseDatInitialization`](#generated.RAFluentSemiResolvedCoupling.SetUseDatInitialization)(value) | Set the value of "Use Dat Initialization". | -| [`SetupStoreFiles`](#generated.RAFluentSemiResolvedCoupling.SetupStoreFiles)(cas_filename[, case_config]) | Copies CAS file to Rocky's project folder and update Fluent info | - - - -#### GetCouplingFilesKept() - -Get the value of “Coupling Files Kept”. - - - -#### GetFluentAdditionalArgs() - -Get the value of “Fluent Additional Args”. - - - -#### GetFluentExecutionMode() - -Get “Fluent Execution Mode” as a string. - -* **Returns:** - The returned value will be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. - - - -#### GetFluentOutputFrequencyMultiplier() - -Get the value of “Fluent Output Frequency Multiplier”. - - - -#### GetFluentReleases() - -Get a list of available Fluent releases. - -* **Return type:** - list(unicode) -* **Returns:** - The list of available Fluent releases - - - -#### GetFluentSolverProcesses() - -Get the value of “Fluent Solver Processes”. - - - -#### GetFluentVersion() - -Get the value of “Version”. - -* **Return type:** - str - - - -#### GetUseDatInitialization() - -Get the value of “Use Dat Initialization”. - - - -#### GetValidFluentExecutionModeValues() - -Get a list of all possible values for “Fluent Execution Mode”. - -* **Returns:** - The returned list is [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. - - - -#### SetCouplingFilesKept(value: str | int) - -Set the value of “Coupling Files Kept”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetFluentAdditionalArgs(value: str) - -Set the value of “Fluent Additional Args”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFluentExecutionMode(value: str) - -Set the value of “Fluent Execution Mode”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Fluent Execution Mode” option. - - - -#### SetFluentOutputFrequencyMultiplier(value: str | int) - -Set the value of “Fluent Output Frequency Multiplier”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetFluentSolverProcesses(value: str | int) - -Set the value of “Fluent Solver Processes”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetFluentVersion(fluent_version: str) - -Set the Ansys Fluent version to be used in CFD coupling (deprecated). - -Currently, it’s not possible to change the version of Ansys Fluent used for CFD coupling. -This method is being kept for backward compatibility (and also because there’s a chance -of this feature to be brought back in future version). - - - -#### SetPartIdIfValid() - -Set the process’ part id (unused for now) - - - -#### SetUseDatInitialization(value: bool) - -Set the value of “Use Dat Initialization”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetupStoreFiles(cas_filename: str, case_config: FluentCaseConfig | None = None) - -Copies CAS file to Rocky’s project folder and update Fluent info + + +# RAFluentSemiResolvedCoupling + + + + + + +### *class* RAFluentSemiResolvedCoupling + +PrePost Scripting wrapper class for the Fluent Two-Way Semi Resolved coupling mode + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| +| [`GetCouplingFilesKept`](#generated.RAFluentSemiResolvedCoupling.GetCouplingFilesKept)() | Get the value of "Coupling Files Kept". | +| [`GetFluentAdditionalArgs`](#generated.RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs)() | Get the value of "Fluent Additional Args". | +| [`GetFluentExecutionMode`](#generated.RAFluentSemiResolvedCoupling.GetFluentExecutionMode)() | Get "Fluent Execution Mode" as a string. | +| [`GetFluentOutputFrequencyMultiplier`](#generated.RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier)() | Get the value of "Fluent Output Frequency Multiplier". | +| [`GetFluentReleases`](#generated.RAFluentSemiResolvedCoupling.GetFluentReleases)() | Get a list of available Fluent releases. | +| [`GetFluentSolverProcesses`](#generated.RAFluentSemiResolvedCoupling.GetFluentSolverProcesses)() | Get the value of "Fluent Solver Processes". | +| [`GetFluentVersion`](#generated.RAFluentSemiResolvedCoupling.GetFluentVersion)() | Get the value of "Version". | +| [`GetUseDatInitialization`](#generated.RAFluentSemiResolvedCoupling.GetUseDatInitialization)() | Get the value of "Use Dat Initialization". | +| [`GetValidFluentExecutionModeValues`](#generated.RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues)() | Get a list of all possible values for "Fluent Execution Mode". | +| [`SetCouplingFilesKept`](#generated.RAFluentSemiResolvedCoupling.SetCouplingFilesKept)(value) | Set the value of "Coupling Files Kept". | +| [`SetFluentAdditionalArgs`](#generated.RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs)(value) | Set the value of "Fluent Additional Args". | +| [`SetFluentExecutionMode`](#generated.RAFluentSemiResolvedCoupling.SetFluentExecutionMode)(value) | Set the value of "Fluent Execution Mode". | +| [`SetFluentOutputFrequencyMultiplier`](#generated.RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier)(value) | Set the value of "Fluent Output Frequency Multiplier". | +| [`SetFluentSolverProcesses`](#generated.RAFluentSemiResolvedCoupling.SetFluentSolverProcesses)(value) | Set the value of "Fluent Solver Processes". | +| [`SetFluentVersion`](#generated.RAFluentSemiResolvedCoupling.SetFluentVersion)(fluent_version) | Set the Ansys Fluent version to be used in CFD coupling (deprecated). | +| [`SetPartIdIfValid`](#generated.RAFluentSemiResolvedCoupling.SetPartIdIfValid)() | Set the process' part id (unused for now) | +| [`SetUseDatInitialization`](#generated.RAFluentSemiResolvedCoupling.SetUseDatInitialization)(value) | Set the value of "Use Dat Initialization". | +| [`SetupStoreFiles`](#generated.RAFluentSemiResolvedCoupling.SetupStoreFiles)(cas_filename[, case_config]) | Copies CAS file to Rocky's project folder and update Fluent info | + + + +#### GetCouplingFilesKept() + +Get the value of “Coupling Files Kept”. + + + +#### GetFluentAdditionalArgs() + +Get the value of “Fluent Additional Args”. + + + +#### GetFluentExecutionMode() + +Get “Fluent Execution Mode” as a string. + +* **Returns:** + The returned value will be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. + + + +#### GetFluentOutputFrequencyMultiplier() + +Get the value of “Fluent Output Frequency Multiplier”. + + + +#### GetFluentReleases() + +Get a list of available Fluent releases. + +* **Return type:** + list(unicode) +* **Returns:** + The list of available Fluent releases + + + +#### GetFluentSolverProcesses() + +Get the value of “Fluent Solver Processes”. + + + +#### GetFluentVersion() + +Get the value of “Version”. + +* **Return type:** + str + + + +#### GetUseDatInitialization() + +Get the value of “Use Dat Initialization”. + + + +#### GetValidFluentExecutionModeValues() + +Get a list of all possible values for “Fluent Execution Mode”. + +* **Returns:** + The returned list is [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. + + + +#### SetCouplingFilesKept(value: str | int) + +Set the value of “Coupling Files Kept”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetFluentAdditionalArgs(value: str) + +Set the value of “Fluent Additional Args”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFluentExecutionMode(value: str) + +Set the value of “Fluent Execution Mode”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Fluent Execution Mode” option. + + + +#### SetFluentOutputFrequencyMultiplier(value: str | int) + +Set the value of “Fluent Output Frequency Multiplier”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetFluentSolverProcesses(value: str | int) + +Set the value of “Fluent Solver Processes”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetFluentVersion(fluent_version: str) + +Set the Ansys Fluent version to be used in CFD coupling (deprecated). + +Currently, it’s not possible to change the version of Ansys Fluent used for CFD coupling. +This method is being kept for backward compatibility (and also because there’s a chance +of this feature to be brought back in future version). + + + +#### SetPartIdIfValid() + +Set the process’ part id (unused for now) + + + +#### SetUseDatInitialization(value: bool) + +Set the value of “Use Dat Initialization”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetupStoreFiles(cas_filename: str, case_config: FluentCaseConfig | None = None) + +Copies CAS file to Rocky’s project folder and update Fluent info diff --git a/2025R2/rocky-prepost-scripting-manual/RAFluentTwoWayCoupling.md b/2025R2/rocky-prepost-scripting-manual/RAFluentTwoWayCoupling.md index aaf793cada..587512da0a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFluentTwoWayCoupling.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFluentTwoWayCoupling.md @@ -1,1962 +1,1963 @@ - - -# RAFluentTwoWayCoupling - - - - - - -### *class* RAFluentTwoWayCoupling - -Rocky PrePost Scripting wrapper to manipulate Fluent Two-Way coupling properties. - -This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): - -```python -cfd_coupling = study.GetCFDCoupling() -cfd_coupling.SetupFluentTwoWay('fluent.cas') -two_way_process = cfd_coupling.GetCouplingProcess() -``` - -**Methods:** - -| [`AddCurve`](#generated.RAFluentTwoWayCoupling.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAFluentTwoWayCoupling.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CloseFluent`](#generated.RAFluentTwoWayCoupling.CloseFluent)() | Closes a running Fluent application | -| [`CreateCoupledBoundaries`](#generated.RAFluentTwoWayCoupling.CreateCoupledBoundaries)(coupled_boundary_names) | Create a coupled boundary for each of the coupled boundary name passed by the user. | -| [`CreateCurveOutputVariable`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.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). | -| [`DisableBackDiffusion`](#generated.RAFluentTwoWayCoupling.DisableBackDiffusion)() | Set the value of "Back Diffusion" to False. | -| [`DisableSubstepping`](#generated.RAFluentTwoWayCoupling.DisableSubstepping)() | Set the value of "Substepping" to False. | -| [`EditCustomCurve`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.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. | -| [`EnableBackDiffusion`](#generated.RAFluentTwoWayCoupling.EnableBackDiffusion)() | Set the value of "Back Diffusion" to True. | -| [`EnableSubstepping`](#generated.RAFluentTwoWayCoupling.EnableSubstepping)() | Set the value of "Substepping" to True. | -| [`GetAbsoluteValue`](#generated.RAFluentTwoWayCoupling.GetAbsoluteValue)([unit]) | Get the value of "Absolute Value". | -| [`GetActivesArray`](#generated.RAFluentTwoWayCoupling.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAvailableCoupledBoundaryNames`](#generated.RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames)() | Obtain the names of the boundaries available for coupling in the fluent file. | -| [`GetAveragingMethod`](#generated.RAFluentTwoWayCoupling.GetAveragingMethod)() | Deprecated: Use [`GetMappingMethod()`](#generated.RAFluentTwoWayCoupling.GetMappingMethod) instead. | -| [`GetAveragingRadiusType`](#generated.RAFluentTwoWayCoupling.GetAveragingRadiusType)() | Get "Averaging Radius Type" as a string. | -| [`GetBackDiffusion`](#generated.RAFluentTwoWayCoupling.GetBackDiffusion)() | Get the value of "Back Diffusion". | -| [`GetBoundingBox`](#generated.RAFluentTwoWayCoupling.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCFDParametersList`](#generated.RAFluentTwoWayCoupling.GetCFDParametersList)() | Get the list of per-Particle CFD parameter sets. | -| [`GetCellAreaAsArray`](#generated.RAFluentTwoWayCoupling.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAFluentTwoWayCoupling.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAFluentTwoWayCoupling.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAFluentTwoWayCoupling.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAFluentTwoWayCoupling.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAFluentTwoWayCoupling.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAFluentTwoWayCoupling.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAFluentTwoWayCoupling.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetConvectiveHeatTransferLaw`](#generated.RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw)() | Get the current "Convective Heat Transfer Law". | -| [`GetCouplingFilesKept`](#generated.RAFluentTwoWayCoupling.GetCouplingFilesKept)() | Get the value of "Coupling Files Kept". | -| [`GetCurve`](#generated.RAFluentTwoWayCoupling.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAFluentTwoWayCoupling.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAFluentTwoWayCoupling.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetDecompositionFactor`](#generated.RAFluentTwoWayCoupling.GetDecompositionFactor)() | Get the value of "Decomposition Factor". | -| [`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. | -| [`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". | -| [`GetFluentReleases`](#generated.RAFluentTwoWayCoupling.GetFluentReleases)() | Get a list of available Fluent releases. | -| [`GetFluentSolverProcesses`](#generated.RAFluentTwoWayCoupling.GetFluentSolverProcesses)() | Get the value of "Fluent Solver Processes". | -| [`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. | -| [`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. | -| [`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". | -| [`GetMorsiAndAlexanderK1`](#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1)() | Get the current "Morsi And Alexander K1". | -| [`GetMorsiAndAlexanderK2`](#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2)() | Get the current "Morsi And Alexander K2". | -| [`GetMorsiAndAlexanderK3`](#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3)() | Get the current "Morsi And Alexander K3". | -| [`GetNumberOfCells`](#generated.RAFluentTwoWayCoupling.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAFluentTwoWayCoupling.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfSubsteps`](#generated.RAFluentTwoWayCoupling.GetNumberOfSubsteps)() | Get the value of "Number of Substeps". | -| [`GetNumberOfThreads`](#generated.RAFluentTwoWayCoupling.GetNumberOfThreads)() | Get the value of "Number of Threads". | -| [`GetNumpyCurve`](#generated.RAFluentTwoWayCoupling.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAFluentTwoWayCoupling.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetOverwriteCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance)() | Get the value of "Overwrite Cfd Update Distance". | -| [`GetSolidsMaximumVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget)() | Get the value of "Solids Maximum Volume Fraction Target". | -| [`GetSubstepping`](#generated.RAFluentTwoWayCoupling.GetSubstepping)() | Get the value of "Substepping". | -| [`GetSyamlalObrienC1`](#generated.RAFluentTwoWayCoupling.GetSyamlalObrienC1)() | Get the current "Syamlal Obrien C1". | -| [`GetSyamlalObrienD1`](#generated.RAFluentTwoWayCoupling.GetSyamlalObrienD1)() | Get the current "Syamlal Obrien D1". | -| [`GetTimeSet`](#generated.RAFluentTwoWayCoupling.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAFluentTwoWayCoupling.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAFluentTwoWayCoupling.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAFluentTwoWayCoupling.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTorqueLaw`](#generated.RAFluentTwoWayCoupling.GetTorqueLaw)() | Get the current "Torque Law". | -| [`GetUseDatInitialization`](#generated.RAFluentTwoWayCoupling.GetUseDatInitialization)() | Get the value of "Use Dat Initialization". | -| [`GetUseTurbulentDispersion`](#generated.RAFluentTwoWayCoupling.GetUseTurbulentDispersion)() | Get the value of "Use Turbulent Dispersion". | -| [`GetUseUserDefinedConstants`](#generated.RAFluentTwoWayCoupling.GetUseUserDefinedConstants)() | Get the current "Use User Defined Constants". | -| [`GetUserCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.GetUserCfdUpdateDistance)([unit]) | Get the value of "User Cfd Update Distance". | -| [`GetValidAveragingMethodValues`](#generated.RAFluentTwoWayCoupling.GetValidAveragingMethodValues)() | Deprecated: Use [`GetValidMappingMethodValues()`](#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) instead. | -| [`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". | -| [`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. | -| [`IsBackDiffusionEnabled`](#generated.RAFluentTwoWayCoupling.IsBackDiffusionEnabled)() | Check if the "Back Diffusion" is enabled. | -| [`IsCellActive`](#generated.RAFluentTwoWayCoupling.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IsFluentRunning`](#generated.RAFluentTwoWayCoupling.IsFluentRunning)() | Whether a Rocky-created Fluent process is running. | -| [`IsSubsteppingEnabled`](#generated.RAFluentTwoWayCoupling.IsSubsteppingEnabled)() | Check if the "Substepping" is enabled. | -| [`IterCellVertices`](#generated.RAFluentTwoWayCoupling.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAFluentTwoWayCoupling.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAFluentTwoWayCoupling.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAFluentTwoWayCoupling.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAFluentTwoWayCoupling.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAFluentTwoWayCoupling.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAFluentTwoWayCoupling.RemoveProcess)() | Removes the process from the project. | -| [`SetAbsoluteValue`](#generated.RAFluentTwoWayCoupling.SetAbsoluteValue)(value[, unit]) | Set the value of "Absolute Value". | -| [`SetAveragingMethod`](#generated.RAFluentTwoWayCoupling.SetAveragingMethod)(value) | Deprecated: Use [`SetMappingMethod()`](#generated.RAFluentTwoWayCoupling.SetMappingMethod) instead. | -| [`SetAveragingRadiusType`](#generated.RAFluentTwoWayCoupling.SetAveragingRadiusType)(value) | Set the value of "Averaging Radius Type". | -| [`SetBackDiffusion`](#generated.RAFluentTwoWayCoupling.SetBackDiffusion)(value) | Set the value of "Back Diffusion". | -| [`SetConvectiveHeatTransferLaw`](#generated.RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw)(value) | Set the current "Convective Heat Transfer Law". | -| [`SetCouplingFilesKept`](#generated.RAFluentTwoWayCoupling.SetCouplingFilesKept)(value) | Set the value of "Coupling Files Kept". | -| [`SetCurrentTimeStep`](#generated.RAFluentTwoWayCoupling.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDecompositionFactor`](#generated.RAFluentTwoWayCoupling.SetDecompositionFactor)(value) | Set the value of "Decomposition Factor". | -| [`SetDiffusionCoefficient`](#generated.RAFluentTwoWayCoupling.SetDiffusionCoefficient)(value[, unit]) | Set the value of "Diffusion Coefficient". | -| [`SetDragLaw`](#generated.RAFluentTwoWayCoupling.SetDragLaw)(value) | Set the current "Drag Law". | -| [`SetFluentAdditionalArgs`](#generated.RAFluentTwoWayCoupling.SetFluentAdditionalArgs)(value) | Set the value of "Fluent Additional Args". | -| [`SetFluentExecutionMode`](#generated.RAFluentTwoWayCoupling.SetFluentExecutionMode)(value) | Set the value of "Fluent Execution Mode". | -| [`SetFluentOutputFrequencyMultiplier`](#generated.RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier)(value) | Set the value of "Fluent Output Frequency Multiplier". | -| [`SetFluentSolverProcesses`](#generated.RAFluentTwoWayCoupling.SetFluentSolverProcesses)(value) | Set the value of "Fluent Solver Processes". | -| [`SetFluentVersion`](#generated.RAFluentTwoWayCoupling.SetFluentVersion)(fluent_version) | Set the Ansys Fluent version to be used in CFD coupling (deprecated). | -| [`SetFractionParticleSize`](#generated.RAFluentTwoWayCoupling.SetFractionParticleSize)(value[, unit]) | Set the value of "Fraction Particle Size". | -| [`SetLiftLaw`](#generated.RAFluentTwoWayCoupling.SetLiftLaw)(value) | Set the current "Lift Law". | -| [`SetMappingMethod`](#generated.RAFluentTwoWayCoupling.SetMappingMethod)(value) | Set the value of "Mapping Method". | -| [`SetMaximumIterations`](#generated.RAFluentTwoWayCoupling.SetMaximumIterations)(value) | Set the value of "Maximum Iterations". | -| [`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". | -| [`SetMorsiAndAlexanderK2`](#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2)(value) | Set the current "Morsi And Alexander K2". | -| [`SetMorsiAndAlexanderK3`](#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3)(value) | Set the current "Morsi And Alexander K3". | -| [`SetNumberOfSubsteps`](#generated.RAFluentTwoWayCoupling.SetNumberOfSubsteps)(value) | Set the value of "Number of Substeps". | -| [`SetNumberOfThreads`](#generated.RAFluentTwoWayCoupling.SetNumberOfThreads)(value) | Set the value of "Number of Threads". | -| [`SetOverwriteCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance)(value) | Set the value of "Overwrite Cfd Update Distance". | -| [`SetPartIdIfValid`](#generated.RAFluentTwoWayCoupling.SetPartIdIfValid)() | Subclasses should implement this method if it's a Process with visualization | -| [`SetSolidsMaximumVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget)(value) | Set the value of "Solids Maximum Volume Fraction Target". | -| [`SetSubstepping`](#generated.RAFluentTwoWayCoupling.SetSubstepping)(value) | Set the value of "Substepping". | -| [`SetSyamlalObrienC1`](#generated.RAFluentTwoWayCoupling.SetSyamlalObrienC1)(value) | Set the current "Syamlal Obrien C1". | -| [`SetSyamlalObrienD1`](#generated.RAFluentTwoWayCoupling.SetSyamlalObrienD1)(value) | Set the current "Syamlal Obrien D1". | -| [`SetTorqueLaw`](#generated.RAFluentTwoWayCoupling.SetTorqueLaw)(value) | Set the current "Torque Law". | -| [`SetUseDatInitialization`](#generated.RAFluentTwoWayCoupling.SetUseDatInitialization)(value) | Set the value of "Use Dat Initialization". | -| [`SetUseTurbulentDispersion`](#generated.RAFluentTwoWayCoupling.SetUseTurbulentDispersion)(value) | Set the value of "Use Turbulent Dispersion". | -| [`SetUseUserDefinedConstants`](#generated.RAFluentTwoWayCoupling.SetUseUserDefinedConstants)(value) | Set the current "Use User Defined Constants". | -| [`SetUserCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.SetUserCfdUpdateDistance)(value[, unit]) | Set the value of "User Cfd Update Distance". | -| [`SetVirtualMassLaw`](#generated.RAFluentTwoWayCoupling.SetVirtualMassLaw)(value) | Set the current "Virtual Mass Law". | -| [`SetVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.SetVolumeFractionTarget)(value) | Deprecated: Use [`SetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) instead. | -| [`SetupStoreFiles`](#generated.RAFluentTwoWayCoupling.SetupStoreFiles)(cas_filename[, case_config]) | Copies CAS file to Rocky's project folder and update Fluent info | -| [`StartFluent`](#generated.RAFluentTwoWayCoupling.StartFluent)() | Starts Fluent application | -| [`UpdateFluentInfo`](#generated.RAFluentTwoWayCoupling.UpdateFluentInfo)() | Updates the latest changes from Fluent setup. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CloseFluent() - -Closes a running Fluent application - - - -#### CreateCoupledBoundaries(coupled_boundary_names: list[str]) - -Create a coupled boundary for each of the coupled boundary name passed by the user. -Check GetAvailableCoupledBoundaryNames to obtain the list of available boundaries. - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableBackDiffusion() - -Set the value of “Back Diffusion” to False. - - - -#### DisableSubstepping() - -Set the value of “Substepping” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableBackDiffusion() - -Set the value of “Back Diffusion” to True. - - - -#### EnableSubstepping() - -Set the value of “Substepping” to True. - - - -#### GetAbsoluteValue(unit: str | None = None) - -Get the value of “Absolute Value”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableCoupledBoundaryNames() - -Obtain the names of the boundaries available for coupling in the fluent file. - - - -#### GetAveragingMethod() - -Deprecated: Use [`GetMappingMethod()`](#generated.RAFluentTwoWayCoupling.GetMappingMethod) instead. - -* **Returns:** - The returned value will be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. - - - -#### GetAveragingRadiusType() - -Get “Averaging Radius Type” as a string. - -* **Returns:** - The returned value will be one of [‘FractionMaximumParticleSize’, ‘AbsoluteValue’]. - - - -#### GetBackDiffusion() - -Get the value of “Back Diffusion”. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCFDParametersList() - -Get the list of per-Particle CFD parameter sets. - -* **Return type:** - [RACFDParametersList](RACFDParametersList.md#generated.RACFDParametersList) - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetConvectiveHeatTransferLaw() - -Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Convective Heat Transfer Law”. - - - -#### GetCouplingFilesKept() - -Get the value of “Coupling Files Kept”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDecompositionFactor() - -Get the value of “Decomposition Factor”. - - - -#### GetDiffusionCoefficient(unit: str | None = None) - -Get the value of “Diffusion Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m2/s”. - - - -#### GetDragLaw() - -Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Drag Law”. - - - -#### 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. - - - -#### GetFluentAdditionalArgs() - -Get the value of “Fluent Additional Args”. - - - -#### GetFluentExecutionMode() - -Get “Fluent Execution Mode” as a string. - -* **Returns:** - The returned value will be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. - - - -#### GetFluentOutputFrequencyMultiplier() - -Get the value of “Fluent Output Frequency Multiplier”. - - - -#### GetFluentReleases() - -Get a list of available Fluent releases. - -* **Return type:** - list(unicode) -* **Returns:** - The list of available Fluent releases - - - -#### GetFluentSolverProcesses() - -Get the value of “Fluent Solver Processes”. - - - -#### GetFluentVersion() - -Get the value of “Version”. - -* **Return type:** - str - - - -#### GetFractionParticleSize(unit: str | None = None) - -Get the value of “Fraction Particle Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetLiftLaw() - -Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Lift Law”. - - - -#### GetMappingMethod() - -Get “Mapping Method” as a string. - -* **Returns:** - The returned value will be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. - - - -#### GetMaximumIterations() - -Get the value of “Maximum Iterations”. - - - -#### GetMaximumResidualTolerance() - -Get the value of “Maximum Residual Tolerance”. - - - -#### GetMaximumTimeSteps() - -Get the value of “Maximum Time Steps”. - - - -#### GetMaximumVolumeFraction(unit: str | None = None) - -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]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinimumIterations() - -Get the value of “Minimum Iterations”. - - - -#### GetMinimumTimeSteps() - -Get the value of “Minimum Time Steps”. - - - -#### GetMorsiAndAlexanderK1() - -Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K1”. - - - -#### GetMorsiAndAlexanderK2() - -Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K2”. - - - -#### GetMorsiAndAlexanderK3() - -Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Morsi And Alexander K3”. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfSubsteps() - -Get the value of “Number of Substeps”. - - - -#### GetNumberOfThreads() - -Get the value of “Number of Threads”. - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetOverwriteCfdUpdateDistance() - -Get the value of “Overwrite Cfd Update Distance”. - - - -#### GetSolidsMaximumVolumeFractionTarget() - -Get the value of “Solids Maximum Volume Fraction Target”. - - - -#### GetSubstepping() - -Get the value of “Substepping”. - - - -#### GetSyamlalObrienC1() - -Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Syamlal Obrien C1”. - - - -#### GetSyamlalObrienD1() - -Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Syamlal Obrien D1”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTorqueLaw() - -Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Torque Law”. - - - -#### GetUseDatInitialization() - -Get the value of “Use Dat Initialization”. - - - -#### GetUseTurbulentDispersion() - -Get the value of “Use Turbulent Dispersion”. - - - -#### GetUseUserDefinedConstants() - -Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Use User Defined Constants”. - - - -#### GetUserCfdUpdateDistance(unit: str | None = None) - -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”. - - - -#### GetValidAveragingMethodValues() - -Deprecated: Use [`GetValidMappingMethodValues()`](#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) instead. - -* **Returns:** - The returned list is [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. - - - -#### GetValidAveragingRadiusTypeValues() - -Get a list of all possible values for “Averaging Radius Type”. - -* **Returns:** - The returned list is [‘FractionMaximumParticleSize’, ‘AbsoluteValue’]. - - - -#### GetValidFluentExecutionModeValues() - -Get a list of all possible values for “Fluent Execution Mode”. - -* **Returns:** - The returned list is [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. - - - -#### GetValidMappingMethodValues() - -Get a list of all possible values for “Mapping Method”. - -* **Returns:** - The returned list is [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. - - - -#### GetVirtualMassLaw() - -Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - for the Particles have different values for the “Virtual Mass Law”. - - - -#### GetVolumeFractionTarget() - -Deprecated: Use [`GetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) instead. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsBackDiffusionEnabled() - -Check if the “Back Diffusion” is enabled. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsFluentRunning() - -Whether a Rocky-created Fluent process is running. - -* **Returns:** - True whether a Fluent application is running false otherwise - - - -#### IsSubsteppingEnabled() - -Check if the “Substepping” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetAbsoluteValue(value: str | float, unit: str | None = None) - -Set the value of “Absolute Value”. - -* **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”. - - - -#### SetAveragingMethod(value: str) - -Deprecated: Use [`SetMappingMethod()`](#generated.RAFluentTwoWayCoupling.SetMappingMethod) instead. - -* **Parameters:** - **value** – The value to set. Must be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Averaging Method” option. - - - -#### SetAveragingRadiusType(value: str) - -Set the value of “Averaging Radius Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘FractionMaximumParticleSize’, ‘AbsoluteValue’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Averaging Radius Type” option. - - - -#### SetBackDiffusion(value: bool) - -Set the value of “Back Diffusion”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetConvectiveHeatTransferLaw(value) - -Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetCouplingFilesKept(value: str | int) - -Set the value of “Coupling Files Kept”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDecompositionFactor(value: str | float) - -Set the value of “Decomposition Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetDiffusionCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Diffusion Coefficient”. - -* **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 “m2/s”. - - - -#### SetDragLaw(value) - -Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetFluentAdditionalArgs(value: str) - -Set the value of “Fluent Additional Args”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFluentExecutionMode(value: str) - -Set the value of “Fluent Execution Mode”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Fluent Execution Mode” option. - - - -#### SetFluentOutputFrequencyMultiplier(value: str | int) - -Set the value of “Fluent Output Frequency Multiplier”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetFluentSolverProcesses(value: str | int) - -Set the value of “Fluent Solver Processes”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetFluentVersion(fluent_version) - -Set the Ansys Fluent version to be used in CFD coupling (deprecated). - -Currently, it’s not possible to change the version of Ansys Fluent used for CFD coupling. -This method is being kept for backward compatibility (and also because there’s a chance -of this feature to be brought back in future version). - - - -#### SetFractionParticleSize(value: str | float, unit: str | None = None) - -Set the value of “Fraction Particle Size”. - -* **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 “-“. - - - -#### SetLiftLaw(value) - -Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMappingMethod(value: str) - -Set the value of “Mapping Method”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Mapping Method” option. - - - -#### SetMaximumIterations(value: str | int) - -Set the value of “Maximum Iterations”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMaximumResidualTolerance(value: str | float) - -Set the value of “Maximum Residual Tolerance”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetMaximumTimeSteps(value: str | int) - -Set the value of “Maximum Time Steps”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMaximumVolumeFraction(value: str | float, unit: str | None = None) - -Set the value of “Maximum Volume Fraction”. - -* **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 “-“. - - - -#### SetMaximumVolumeFractionTarget(value) - -Deprecated: use SetSolidsMaximumVolumeFractionTarget instead - - - -#### SetMinimumIterations(value: str | int) - -Set the value of “Minimum Iterations”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMinimumTimeSteps(value: str | int) - -Set the value of “Minimum Time Steps”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMorsiAndAlexanderK1(value) - -Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK2(value) - -Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetMorsiAndAlexanderK3(value) - -Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetNumberOfSubsteps(value: str | int) - -Set the value of “Number of Substeps”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetNumberOfThreads(value: str | int) - -Set the value of “Number of Threads”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetOverwriteCfdUpdateDistance(value: bool) - -Set the value of “Overwrite Cfd Update Distance”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetPartIdIfValid() - -Subclasses should implement this method if it’s a Process with visualization - - - -#### SetSolidsMaximumVolumeFractionTarget(value: str | float) - -Set the value of “Solids Maximum Volume Fraction Target”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSubstepping(value: bool) - -Set the value of “Substepping”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetSyamlalObrienC1(value) - -Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetSyamlalObrienD1(value) - -Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetTorqueLaw(value) - -Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetUseDatInitialization(value: bool) - -Set the value of “Use Dat Initialization”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseTurbulentDispersion(value: bool) - -Set the value of “Use Turbulent Dispersion”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseUserDefinedConstants(value) - -Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetUserCfdUpdateDistance(value: str | float, unit: str | None = None) - -Set the value of “User Cfd Update Distance”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “m”. - - - -#### SetVirtualMassLaw(value) - -Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual -[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. - -See also [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) - -* **Raises:** - **RockyApiError** – If there are no Particles in the project yet. - - - -#### SetVolumeFractionTarget(value: float) - -Deprecated: Use [`SetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) instead. - -* **Parameters:** - **value** – The value to set. - - - -#### SetupStoreFiles(cas_filename, case_config=None) - -Copies CAS file to Rocky’s project folder and update Fluent info - - - -#### StartFluent() - -Starts Fluent application - - - -#### UpdateFluentInfo() - -Updates the latest changes from Fluent setup. + + +# RAFluentTwoWayCoupling + + + + + + +### *class* RAFluentTwoWayCoupling + +Rocky PrePost Scripting wrapper to manipulate Fluent Two-Way coupling properties. + +This wrapper can be accessed via the project’s [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling): + +```python +cfd_coupling = study.GetCFDCoupling() +cfd_coupling.SetupFluentTwoWay('fluent.cas') +two_way_process = cfd_coupling.GetCouplingProcess() +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAFluentTwoWayCoupling.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAFluentTwoWayCoupling.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CloseFluent`](#generated.RAFluentTwoWayCoupling.CloseFluent)() | Closes a running Fluent application | +| [`CreateCoupledBoundaries`](#generated.RAFluentTwoWayCoupling.CreateCoupledBoundaries)(coupled_boundary_names) | Create a coupled boundary for each of the coupled boundary name passed by the user. | +| [`CreateCurveOutputVariable`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.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). | +| [`DisableBackDiffusion`](#generated.RAFluentTwoWayCoupling.DisableBackDiffusion)() | Set the value of "Back Diffusion" to False. | +| [`DisableSubstepping`](#generated.RAFluentTwoWayCoupling.DisableSubstepping)() | Set the value of "Substepping" to False. | +| [`EditCustomCurve`](#generated.RAFluentTwoWayCoupling.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.RAFluentTwoWayCoupling.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. | +| [`EnableBackDiffusion`](#generated.RAFluentTwoWayCoupling.EnableBackDiffusion)() | Set the value of "Back Diffusion" to True. | +| [`EnableSubstepping`](#generated.RAFluentTwoWayCoupling.EnableSubstepping)() | Set the value of "Substepping" to True. | +| [`GetAbsoluteValue`](#generated.RAFluentTwoWayCoupling.GetAbsoluteValue)([unit]) | Get the value of "Absolute Value". | +| [`GetActivesArray`](#generated.RAFluentTwoWayCoupling.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAvailableCoupledBoundaryNames`](#generated.RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames)() | Obtain the names of the boundaries available for coupling in the fluent file. | +| [`GetAveragingMethod`](#generated.RAFluentTwoWayCoupling.GetAveragingMethod)() | Deprecated: Use [`GetMappingMethod()`](#generated.RAFluentTwoWayCoupling.GetMappingMethod) instead. | +| [`GetAveragingRadiusType`](#generated.RAFluentTwoWayCoupling.GetAveragingRadiusType)() | Get "Averaging Radius Type" as a string. | +| [`GetBackDiffusion`](#generated.RAFluentTwoWayCoupling.GetBackDiffusion)() | Get the value of "Back Diffusion". | +| [`GetBoundingBox`](#generated.RAFluentTwoWayCoupling.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCFDParametersList`](#generated.RAFluentTwoWayCoupling.GetCFDParametersList)() | Get the list of per-Particle CFD parameter sets. | +| [`GetCellAreaAsArray`](#generated.RAFluentTwoWayCoupling.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAFluentTwoWayCoupling.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAFluentTwoWayCoupling.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAFluentTwoWayCoupling.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAFluentTwoWayCoupling.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAFluentTwoWayCoupling.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAFluentTwoWayCoupling.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAFluentTwoWayCoupling.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetConvectiveHeatTransferLaw`](#generated.RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw)() | Get the current "Convective Heat Transfer Law". | +| [`GetCouplingFilesKept`](#generated.RAFluentTwoWayCoupling.GetCouplingFilesKept)() | Get the value of "Coupling Files Kept". | +| [`GetCurve`](#generated.RAFluentTwoWayCoupling.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAFluentTwoWayCoupling.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RAFluentTwoWayCoupling.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetDecompositionFactor`](#generated.RAFluentTwoWayCoupling.GetDecompositionFactor)() | Get the value of "Decomposition Factor". | +| [`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. | +| [`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". | +| [`GetFluentReleases`](#generated.RAFluentTwoWayCoupling.GetFluentReleases)() | Get a list of available Fluent releases. | +| [`GetFluentSolverProcesses`](#generated.RAFluentTwoWayCoupling.GetFluentSolverProcesses)() | Get the value of "Fluent Solver Processes". | +| [`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. | +| [`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. | +| [`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". | +| [`GetMorsiAndAlexanderK1`](#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1)() | Get the current "Morsi And Alexander K1". | +| [`GetMorsiAndAlexanderK2`](#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2)() | Get the current "Morsi And Alexander K2". | +| [`GetMorsiAndAlexanderK3`](#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3)() | Get the current "Morsi And Alexander K3". | +| [`GetNumberOfCells`](#generated.RAFluentTwoWayCoupling.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAFluentTwoWayCoupling.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfSubsteps`](#generated.RAFluentTwoWayCoupling.GetNumberOfSubsteps)() | Get the value of "Number of Substeps". | +| [`GetNumberOfThreads`](#generated.RAFluentTwoWayCoupling.GetNumberOfThreads)() | Get the value of "Number of Threads". | +| [`GetNumpyCurve`](#generated.RAFluentTwoWayCoupling.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAFluentTwoWayCoupling.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetOverwriteCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance)() | Get the value of "Overwrite Cfd Update Distance". | +| [`GetSolidsMaximumVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget)() | Get the value of "Solids Maximum Volume Fraction Target". | +| [`GetSubstepping`](#generated.RAFluentTwoWayCoupling.GetSubstepping)() | Get the value of "Substepping". | +| [`GetSyamlalObrienC1`](#generated.RAFluentTwoWayCoupling.GetSyamlalObrienC1)() | Get the current "Syamlal Obrien C1". | +| [`GetSyamlalObrienD1`](#generated.RAFluentTwoWayCoupling.GetSyamlalObrienD1)() | Get the current "Syamlal Obrien D1". | +| [`GetTimeSet`](#generated.RAFluentTwoWayCoupling.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAFluentTwoWayCoupling.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAFluentTwoWayCoupling.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAFluentTwoWayCoupling.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTorqueLaw`](#generated.RAFluentTwoWayCoupling.GetTorqueLaw)() | Get the current "Torque Law". | +| [`GetUseDatInitialization`](#generated.RAFluentTwoWayCoupling.GetUseDatInitialization)() | Get the value of "Use Dat Initialization". | +| [`GetUseTurbulentDispersion`](#generated.RAFluentTwoWayCoupling.GetUseTurbulentDispersion)() | Get the value of "Use Turbulent Dispersion". | +| [`GetUseUserDefinedConstants`](#generated.RAFluentTwoWayCoupling.GetUseUserDefinedConstants)() | Get the current "Use User Defined Constants". | +| [`GetUserCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.GetUserCfdUpdateDistance)([unit]) | Get the value of "User Cfd Update Distance". | +| [`GetValidAveragingMethodValues`](#generated.RAFluentTwoWayCoupling.GetValidAveragingMethodValues)() | Deprecated: Use [`GetValidMappingMethodValues()`](#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) instead. | +| [`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". | +| [`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. | +| [`IsBackDiffusionEnabled`](#generated.RAFluentTwoWayCoupling.IsBackDiffusionEnabled)() | Check if the "Back Diffusion" is enabled. | +| [`IsCellActive`](#generated.RAFluentTwoWayCoupling.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IsFluentRunning`](#generated.RAFluentTwoWayCoupling.IsFluentRunning)() | Whether a Rocky-created Fluent process is running. | +| [`IsSubsteppingEnabled`](#generated.RAFluentTwoWayCoupling.IsSubsteppingEnabled)() | Check if the "Substepping" is enabled. | +| [`IterCellVertices`](#generated.RAFluentTwoWayCoupling.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAFluentTwoWayCoupling.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAFluentTwoWayCoupling.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAFluentTwoWayCoupling.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAFluentTwoWayCoupling.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAFluentTwoWayCoupling.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAFluentTwoWayCoupling.RemoveProcess)() | Removes the process from the project. | +| [`SetAbsoluteValue`](#generated.RAFluentTwoWayCoupling.SetAbsoluteValue)(value[, unit]) | Set the value of "Absolute Value". | +| [`SetAveragingMethod`](#generated.RAFluentTwoWayCoupling.SetAveragingMethod)(value) | Deprecated: Use [`SetMappingMethod()`](#generated.RAFluentTwoWayCoupling.SetMappingMethod) instead. | +| [`SetAveragingRadiusType`](#generated.RAFluentTwoWayCoupling.SetAveragingRadiusType)(value) | Set the value of "Averaging Radius Type". | +| [`SetBackDiffusion`](#generated.RAFluentTwoWayCoupling.SetBackDiffusion)(value) | Set the value of "Back Diffusion". | +| [`SetConvectiveHeatTransferLaw`](#generated.RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw)(value) | Set the current "Convective Heat Transfer Law". | +| [`SetCouplingFilesKept`](#generated.RAFluentTwoWayCoupling.SetCouplingFilesKept)(value) | Set the value of "Coupling Files Kept". | +| [`SetCurrentTimeStep`](#generated.RAFluentTwoWayCoupling.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDecompositionFactor`](#generated.RAFluentTwoWayCoupling.SetDecompositionFactor)(value) | Set the value of "Decomposition Factor". | +| [`SetDiffusionCoefficient`](#generated.RAFluentTwoWayCoupling.SetDiffusionCoefficient)(value[, unit]) | Set the value of "Diffusion Coefficient". | +| [`SetDragLaw`](#generated.RAFluentTwoWayCoupling.SetDragLaw)(value) | Set the current "Drag Law". | +| [`SetFluentAdditionalArgs`](#generated.RAFluentTwoWayCoupling.SetFluentAdditionalArgs)(value) | Set the value of "Fluent Additional Args". | +| [`SetFluentExecutionMode`](#generated.RAFluentTwoWayCoupling.SetFluentExecutionMode)(value) | Set the value of "Fluent Execution Mode". | +| [`SetFluentOutputFrequencyMultiplier`](#generated.RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier)(value) | Set the value of "Fluent Output Frequency Multiplier". | +| [`SetFluentSolverProcesses`](#generated.RAFluentTwoWayCoupling.SetFluentSolverProcesses)(value) | Set the value of "Fluent Solver Processes". | +| [`SetFluentVersion`](#generated.RAFluentTwoWayCoupling.SetFluentVersion)(fluent_version) | Set the Ansys Fluent version to be used in CFD coupling (deprecated). | +| [`SetFractionParticleSize`](#generated.RAFluentTwoWayCoupling.SetFractionParticleSize)(value[, unit]) | Set the value of "Fraction Particle Size". | +| [`SetLiftLaw`](#generated.RAFluentTwoWayCoupling.SetLiftLaw)(value) | Set the current "Lift Law". | +| [`SetMappingMethod`](#generated.RAFluentTwoWayCoupling.SetMappingMethod)(value) | Set the value of "Mapping Method". | +| [`SetMaximumIterations`](#generated.RAFluentTwoWayCoupling.SetMaximumIterations)(value) | Set the value of "Maximum Iterations". | +| [`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". | +| [`SetMorsiAndAlexanderK2`](#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2)(value) | Set the current "Morsi And Alexander K2". | +| [`SetMorsiAndAlexanderK3`](#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3)(value) | Set the current "Morsi And Alexander K3". | +| [`SetNumberOfSubsteps`](#generated.RAFluentTwoWayCoupling.SetNumberOfSubsteps)(value) | Set the value of "Number of Substeps". | +| [`SetNumberOfThreads`](#generated.RAFluentTwoWayCoupling.SetNumberOfThreads)(value) | Set the value of "Number of Threads". | +| [`SetOverwriteCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance)(value) | Set the value of "Overwrite Cfd Update Distance". | +| [`SetPartIdIfValid`](#generated.RAFluentTwoWayCoupling.SetPartIdIfValid)() | Subclasses should implement this method if it's a Process with visualization | +| [`SetSolidsMaximumVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget)(value) | Set the value of "Solids Maximum Volume Fraction Target". | +| [`SetSubstepping`](#generated.RAFluentTwoWayCoupling.SetSubstepping)(value) | Set the value of "Substepping". | +| [`SetSyamlalObrienC1`](#generated.RAFluentTwoWayCoupling.SetSyamlalObrienC1)(value) | Set the current "Syamlal Obrien C1". | +| [`SetSyamlalObrienD1`](#generated.RAFluentTwoWayCoupling.SetSyamlalObrienD1)(value) | Set the current "Syamlal Obrien D1". | +| [`SetTorqueLaw`](#generated.RAFluentTwoWayCoupling.SetTorqueLaw)(value) | Set the current "Torque Law". | +| [`SetUseDatInitialization`](#generated.RAFluentTwoWayCoupling.SetUseDatInitialization)(value) | Set the value of "Use Dat Initialization". | +| [`SetUseTurbulentDispersion`](#generated.RAFluentTwoWayCoupling.SetUseTurbulentDispersion)(value) | Set the value of "Use Turbulent Dispersion". | +| [`SetUseUserDefinedConstants`](#generated.RAFluentTwoWayCoupling.SetUseUserDefinedConstants)(value) | Set the current "Use User Defined Constants". | +| [`SetUserCfdUpdateDistance`](#generated.RAFluentTwoWayCoupling.SetUserCfdUpdateDistance)(value[, unit]) | Set the value of "User Cfd Update Distance". | +| [`SetVirtualMassLaw`](#generated.RAFluentTwoWayCoupling.SetVirtualMassLaw)(value) | Set the current "Virtual Mass Law". | +| [`SetVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.SetVolumeFractionTarget)(value) | Deprecated: Use [`SetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) instead. | +| [`SetupStoreFiles`](#generated.RAFluentTwoWayCoupling.SetupStoreFiles)(cas_filename[, case_config]) | Copies CAS file to Rocky's project folder and update Fluent info | +| [`StartFluent`](#generated.RAFluentTwoWayCoupling.StartFluent)() | Starts Fluent application | +| [`UpdateFluentInfo`](#generated.RAFluentTwoWayCoupling.UpdateFluentInfo)() | Updates the latest changes from Fluent setup. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CloseFluent() + +Closes a running Fluent application + + + +#### CreateCoupledBoundaries(coupled_boundary_names: list[str]) + +Create a coupled boundary for each of the coupled boundary name passed by the user. +Check GetAvailableCoupledBoundaryNames to obtain the list of available boundaries. + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableBackDiffusion() + +Set the value of “Back Diffusion” to False. + + + +#### DisableSubstepping() + +Set the value of “Substepping” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableBackDiffusion() + +Set the value of “Back Diffusion” to True. + + + +#### EnableSubstepping() + +Set the value of “Substepping” to True. + + + +#### GetAbsoluteValue(unit: str | None = None) + +Get the value of “Absolute Value”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableCoupledBoundaryNames() + +Obtain the names of the boundaries available for coupling in the fluent file. + + + +#### GetAveragingMethod() + +Deprecated: Use [`GetMappingMethod()`](#generated.RAFluentTwoWayCoupling.GetMappingMethod) instead. + +* **Returns:** + The returned value will be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. + + + +#### GetAveragingRadiusType() + +Get “Averaging Radius Type” as a string. + +* **Returns:** + The returned value will be one of [‘FractionMaximumParticleSize’, ‘AbsoluteValue’]. + + + +#### GetBackDiffusion() + +Get the value of “Back Diffusion”. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCFDParametersList() + +Get the list of per-Particle CFD parameter sets. + +* **Return type:** + [RACFDParametersList](RACFDParametersList.md#generated.RACFDParametersList) + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetConvectiveHeatTransferLaw() + +Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Convective Heat Transfer Law”. + + + +#### GetCouplingFilesKept() + +Get the value of “Coupling Files Kept”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDecompositionFactor() + +Get the value of “Decomposition Factor”. + + + +#### GetDiffusionCoefficient(unit: str | None = None) + +Get the value of “Diffusion Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m2/s”. + + + +#### GetDragLaw() + +Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Drag Law”. + + + +#### 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. + + + +#### GetFluentAdditionalArgs() + +Get the value of “Fluent Additional Args”. + + + +#### GetFluentExecutionMode() + +Get “Fluent Execution Mode” as a string. + +* **Returns:** + The returned value will be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. + + + +#### GetFluentOutputFrequencyMultiplier() + +Get the value of “Fluent Output Frequency Multiplier”. + + + +#### GetFluentReleases() + +Get a list of available Fluent releases. + +* **Return type:** + list(unicode) +* **Returns:** + The list of available Fluent releases + + + +#### GetFluentSolverProcesses() + +Get the value of “Fluent Solver Processes”. + + + +#### GetFluentVersion() + +Get the value of “Version”. + +* **Return type:** + str + + + +#### GetFractionParticleSize(unit: str | None = None) + +Get the value of “Fraction Particle Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetLiftLaw() + +Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Lift Law”. + + + +#### GetMappingMethod() + +Get “Mapping Method” as a string. + +* **Returns:** + The returned value will be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. + + + +#### GetMaximumIterations() + +Get the value of “Maximum Iterations”. + + + +#### GetMaximumResidualTolerance() + +Get the value of “Maximum Residual Tolerance”. + + + +#### GetMaximumTimeSteps() + +Get the value of “Maximum Time Steps”. + + + +#### GetMaximumVolumeFraction(unit: str | None = None) + +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]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinimumIterations() + +Get the value of “Minimum Iterations”. + + + +#### GetMinimumTimeSteps() + +Get the value of “Minimum Time Steps”. + + + +#### GetMorsiAndAlexanderK1() + +Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K1”. + + + +#### GetMorsiAndAlexanderK2() + +Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K2”. + + + +#### GetMorsiAndAlexanderK3() + +Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Morsi And Alexander K3”. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfSubsteps() + +Get the value of “Number of Substeps”. + + + +#### GetNumberOfThreads() + +Get the value of “Number of Threads”. + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetOverwriteCfdUpdateDistance() + +Get the value of “Overwrite Cfd Update Distance”. + + + +#### GetSolidsMaximumVolumeFractionTarget() + +Get the value of “Solids Maximum Volume Fraction Target”. + + + +#### GetSubstepping() + +Get the value of “Substepping”. + + + +#### GetSyamlalObrienC1() + +Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Syamlal Obrien C1”. + + + +#### GetSyamlalObrienD1() + +Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Syamlal Obrien D1”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTorqueLaw() + +Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Torque Law”. + + + +#### GetUseDatInitialization() + +Get the value of “Use Dat Initialization”. + + + +#### GetUseTurbulentDispersion() + +Get the value of “Use Turbulent Dispersion”. + + + +#### GetUseUserDefinedConstants() + +Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Use User Defined Constants”. + + + +#### GetUserCfdUpdateDistance(unit: str | None = None) + +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”. + + + +#### GetValidAveragingMethodValues() + +Deprecated: Use [`GetValidMappingMethodValues()`](#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) instead. + +* **Returns:** + The returned list is [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. + + + +#### GetValidAveragingRadiusTypeValues() + +Get a list of all possible values for “Averaging Radius Type”. + +* **Returns:** + The returned list is [‘FractionMaximumParticleSize’, ‘AbsoluteValue’]. + + + +#### GetValidFluentExecutionModeValues() + +Get a list of all possible values for “Fluent Execution Mode”. + +* **Returns:** + The returned list is [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. + + + +#### GetValidMappingMethodValues() + +Get a list of all possible values for “Mapping Method”. + +* **Returns:** + The returned list is [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. + + + +#### GetVirtualMassLaw() + +Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet, or if the [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + for the Particles have different values for the “Virtual Mass Law”. + + + +#### GetVolumeFractionTarget() + +Deprecated: Use [`GetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) instead. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsBackDiffusionEnabled() + +Check if the “Back Diffusion” is enabled. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsFluentRunning() + +Whether a Rocky-created Fluent process is running. + +* **Returns:** + True whether a Fluent application is running false otherwise + + + +#### IsSubsteppingEnabled() + +Check if the “Substepping” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetAbsoluteValue(value: str | float, unit: str | None = None) + +Set the value of “Absolute Value”. + +* **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”. + + + +#### SetAveragingMethod(value: str) + +Deprecated: Use [`SetMappingMethod()`](#generated.RAFluentTwoWayCoupling.SetMappingMethod) instead. + +* **Parameters:** + **value** – The value to set. Must be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Averaging Method” option. + + + +#### SetAveragingRadiusType(value: str) + +Set the value of “Averaging Radius Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘FractionMaximumParticleSize’, ‘AbsoluteValue’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Averaging Radius Type” option. + + + +#### SetBackDiffusion(value: bool) + +Set the value of “Back Diffusion”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetConvectiveHeatTransferLaw(value) + +Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetCouplingFilesKept(value: str | int) + +Set the value of “Coupling Files Kept”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDecompositionFactor(value: str | float) + +Set the value of “Decomposition Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetDiffusionCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Diffusion Coefficient”. + +* **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 “m2/s”. + + + +#### SetDragLaw(value) + +Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetFluentAdditionalArgs(value: str) + +Set the value of “Fluent Additional Args”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFluentExecutionMode(value: str) + +Set the value of “Fluent Execution Mode”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Fluent Execution Mode” option. + + + +#### SetFluentOutputFrequencyMultiplier(value: str | int) + +Set the value of “Fluent Output Frequency Multiplier”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetFluentSolverProcesses(value: str | int) + +Set the value of “Fluent Solver Processes”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetFluentVersion(fluent_version) + +Set the Ansys Fluent version to be used in CFD coupling (deprecated). + +Currently, it’s not possible to change the version of Ansys Fluent used for CFD coupling. +This method is being kept for backward compatibility (and also because there’s a chance +of this feature to be brought back in future version). + + + +#### SetFractionParticleSize(value: str | float, unit: str | None = None) + +Set the value of “Fraction Particle Size”. + +* **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 “-“. + + + +#### SetLiftLaw(value) + +Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMappingMethod(value: str) + +Set the value of “Mapping Method”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Mapping Method” option. + + + +#### SetMaximumIterations(value: str | int) + +Set the value of “Maximum Iterations”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMaximumResidualTolerance(value: str | float) + +Set the value of “Maximum Residual Tolerance”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetMaximumTimeSteps(value: str | int) + +Set the value of “Maximum Time Steps”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMaximumVolumeFraction(value: str | float, unit: str | None = None) + +Set the value of “Maximum Volume Fraction”. + +* **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 “-“. + + + +#### SetMaximumVolumeFractionTarget(value) + +Deprecated: use SetSolidsMaximumVolumeFractionTarget instead + + + +#### SetMinimumIterations(value: str | int) + +Set the value of “Minimum Iterations”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMinimumTimeSteps(value: str | int) + +Set the value of “Minimum Time Steps”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMorsiAndAlexanderK1(value) + +Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK2(value) + +Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetMorsiAndAlexanderK3(value) + +Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetNumberOfSubsteps(value: str | int) + +Set the value of “Number of Substeps”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetNumberOfThreads(value: str | int) + +Set the value of “Number of Threads”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetOverwriteCfdUpdateDistance(value: bool) + +Set the value of “Overwrite Cfd Update Distance”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetPartIdIfValid() + +Subclasses should implement this method if it’s a Process with visualization + + + +#### SetSolidsMaximumVolumeFractionTarget(value: str | float) + +Set the value of “Solids Maximum Volume Fraction Target”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSubstepping(value: bool) + +Set the value of “Substepping”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetSyamlalObrienC1(value) + +Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetSyamlalObrienD1(value) + +Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetTorqueLaw(value) + +Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetUseDatInitialization(value: bool) + +Set the value of “Use Dat Initialization”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseTurbulentDispersion(value: bool) + +Set the value of “Use Turbulent Dispersion”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseUserDefinedConstants(value) + +Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetUserCfdUpdateDistance(value: str | float, unit: str | None = None) + +Set the value of “User Cfd Update Distance”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “m”. + + + +#### SetVirtualMassLaw(value) + +Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual +[`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) configured in the coupling. + +See also [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) + +* **Raises:** + **RockyApiError** – If there are no Particles in the project yet. + + + +#### SetVolumeFractionTarget(value: float) + +Deprecated: Use [`SetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) instead. + +* **Parameters:** + **value** – The value to set. + + + +#### SetupStoreFiles(cas_filename, case_config=None) + +Copies CAS file to Rocky’s project folder and update Fluent info + + + +#### StartFluent() + +Starts Fluent application + + + +#### UpdateFluentInfo() + +Updates the latest changes from Fluent setup. diff --git a/2025R2/rocky-prepost-scripting-manual/RAFluidInlet.md b/2025R2/rocky-prepost-scripting-manual/RAFluidInlet.md index fba4e942ac..f26e70ab34 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFluidInlet.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFluidInlet.md @@ -1,198 +1,199 @@ - - -# RAFluidInlet - - - - - - -### *class* RAFluidInlet - -Rocky PrePost Scripting wrapper for a single Fluid Inlet input. - -This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s -data tree. Particle inputs can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) via: - -```python -input_1 = study.GetElement('Fluid Inlet <1>') -input_2 = input_collection.GetParticleInput('Fluid Inlet <2>') -``` - -Instances of [`RAFluidInlet`](#generated.RAFluidInlet) has properties that can be manipulated -directly, such as the input’s name and the particle entry point. - -**Methods:** - -| [`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". | -| [`GetMassFlowRate`](#generated.RAFluidInlet.GetMassFlowRate)([unit]) | Get the value of "Mass Flow Rate". | -| [`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". | -| [`SetBoundaryCondition`](#generated.RAFluidInlet.SetBoundaryCondition)(value) | Set the value of "Boundary Condition". | -| [`SetEntryPoint`](#generated.RAFluidInlet.SetEntryPoint)(value) | Set the "Entry Point". | -| [`SetMassFlowRate`](#generated.RAFluidInlet.SetMassFlowRate)(value[, unit]) | Set the value of "Mass Flow Rate". | -| [`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". | - - - -#### GetAvailableEntryPoints() - -Get all available Entry Points. - -* **Return type:** - List[[`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface)] - A list of [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface). - - - -#### GetBoundaryCondition() - -Get “Boundary Condition” as a string. - -* **Returns:** - The returned value will be one of [‘mass_flow_rate’, ‘velocity’]. - - - -#### GetEntryPoint() - -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) - - - -#### GetMassFlowRate(unit: str | None = None) - -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”. - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetStopTime(unit: str | None = None) - -Get the value of “Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetTemperature(unit: str | None = None) - -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”. - - - -#### GetValidBoundaryConditionValues() - -Get a list of all possible values for “Boundary Condition”. - -* **Returns:** - The returned list is [‘mass_flow_rate’, ‘velocity’]. - - - -#### GetVelocity(unit: str | None = None) - -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”. - - - -#### SetBoundaryCondition(value: str) - -Set the value of “Boundary Condition”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘mass_flow_rate’, ‘velocity’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Boundary Condition” option. - - - -#### SetEntryPoint(value) - -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. - - - -#### SetMassFlowRate(value: str | float, unit: str | None = None) - -Set the value of “Mass Flow Rate”. - -* **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 “t/h”. - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetStopTime(value: str | float, unit: str | None = None) - -Set the value of “Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetTemperature(value: str | float, unit: str | None = None) - -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”. - - - -#### SetVelocity(value: str | float, unit: str | None = None) - -Set the value of “Velocity”. - -* **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/s”. + + +# RAFluidInlet + + + + + + +### *class* RAFluidInlet + +Rocky PrePost Scripting wrapper for a single Fluid Inlet input. + +This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s +data tree. Particle inputs can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) via: + +```python +input_1 = study.GetElement('Fluid Inlet <1>') +input_2 = input_collection.GetParticleInput('Fluid Inlet <2>') +``` + +Instances of [`RAFluidInlet`](#generated.RAFluidInlet) has properties that can be manipulated +directly, such as the input’s name and the particle entry point. + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| [`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". | +| [`GetMassFlowRate`](#generated.RAFluidInlet.GetMassFlowRate)([unit]) | Get the value of "Mass Flow Rate". | +| [`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". | +| [`SetBoundaryCondition`](#generated.RAFluidInlet.SetBoundaryCondition)(value) | Set the value of "Boundary Condition". | +| [`SetEntryPoint`](#generated.RAFluidInlet.SetEntryPoint)(value) | Set the "Entry Point". | +| [`SetMassFlowRate`](#generated.RAFluidInlet.SetMassFlowRate)(value[, unit]) | Set the value of "Mass Flow Rate". | +| [`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". | + + + +#### GetAvailableEntryPoints() + +Get all available Entry Points. + +* **Return type:** + List[[`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface)] + A list of [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface). + + + +#### GetBoundaryCondition() + +Get “Boundary Condition” as a string. + +* **Returns:** + The returned value will be one of [‘mass_flow_rate’, ‘velocity’]. + + + +#### GetEntryPoint() + +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) + + + +#### GetMassFlowRate(unit: str | None = None) + +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”. + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetStopTime(unit: str | None = None) + +Get the value of “Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetTemperature(unit: str | None = None) + +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”. + + + +#### GetValidBoundaryConditionValues() + +Get a list of all possible values for “Boundary Condition”. + +* **Returns:** + The returned list is [‘mass_flow_rate’, ‘velocity’]. + + + +#### GetVelocity(unit: str | None = None) + +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”. + + + +#### SetBoundaryCondition(value: str) + +Set the value of “Boundary Condition”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘mass_flow_rate’, ‘velocity’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Boundary Condition” option. + + + +#### SetEntryPoint(value) + +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. + + + +#### SetMassFlowRate(value: str | float, unit: str | None = None) + +Set the value of “Mass Flow Rate”. + +* **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 “t/h”. + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetStopTime(value: str | float, unit: str | None = None) + +Set the value of “Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetTemperature(value: str | float, unit: str | None = None) + +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”. + + + +#### SetVelocity(value: str | float, unit: str | None = None) + +Set the value of “Velocity”. + +* **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/s”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAFluidMaterial.md b/2025R2/rocky-prepost-scripting-manual/RAFluidMaterial.md index 836e00b163..48b75d346a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFluidMaterial.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFluidMaterial.md @@ -1,181 +1,182 @@ - - -# RAFluidMaterial - - - - - - -### *class* RAFluidMaterial - -Rocky PrePost Scripting wrapper for individual fluid materials in a project. - -Retrieve individual materials from the [`RAStudy`](RAStudy.md#generated.RAStudy) -or the [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) via: - -```python -material_1 = study.GetElement('fluid material 1') -material_2 = material_collection.GetMaterial('fluid material 2') -material_3 = material_collection[2] -``` - -**Methods:** - -| [`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". | - - - -#### GetDensity(unit: str | None = None) - -Get the value of “Density”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - 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) - -Get the value of “Specific Heat”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”. - - - -#### GetThermalConductivity(unit: str | None = None) - -Get the value of “Thermal Conductivity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### GetViscosity(unit: str | None = None) - -Get the value of “Viscosity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa.s”. - - - -#### SetDensity(value: str | float, unit: str | None = None) - -Set the value of “Density”. - -* **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 “kg/m3”. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetSoundSpeed(value: str | float, unit: str | None = None) - -Deprecated: Use this method from RASPHSettings instead - - - -#### SetSpecificHeat(value: str | float, unit: str | None = None) - -Set the value of “Specific Heat”. - -* **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 “J/kg.K”. - - - -#### SetThermalConductivity(value: str | float, unit: str | None = None) - -Set the value of “Thermal Conductivity”. - -* **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 “W/m.K”. - - - -#### SetViscosity(value: str | float, unit: str | None = None) - -Set the value of “Viscosity”. - -* **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 “Pa.s”. + + +# RAFluidMaterial + + + + + + +### *class* RAFluidMaterial + +Rocky PrePost Scripting wrapper for individual fluid materials in a project. + +Retrieve individual materials from the [`RAStudy`](RAStudy.md#generated.RAStudy) +or the [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) via: + +```python +material_1 = study.GetElement('fluid material 1') +material_2 = material_collection.GetMaterial('fluid material 2') +material_3 = material_collection[2] +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [`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". | + + + +#### GetDensity(unit: str | None = None) + +Get the value of “Density”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - 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) + +Get the value of “Specific Heat”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”. + + + +#### GetThermalConductivity(unit: str | None = None) + +Get the value of “Thermal Conductivity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### GetViscosity(unit: str | None = None) + +Get the value of “Viscosity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa.s”. + + + +#### SetDensity(value: str | float, unit: str | None = None) + +Set the value of “Density”. + +* **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 “kg/m3”. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetSoundSpeed(value: str | float, unit: str | None = None) + +Deprecated: Use this method from RASPHSettings instead + + + +#### SetSpecificHeat(value: str | float, unit: str | None = None) + +Set the value of “Specific Heat”. + +* **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 “J/kg.K”. + + + +#### SetThermalConductivity(value: str | float, unit: str | None = None) + +Set the value of “Thermal Conductivity”. + +* **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 “W/m.K”. + + + +#### SetViscosity(value: str | float, unit: str | None = None) + +Set the value of “Viscosity”. + +* **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 “Pa.s”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAFreeBodyRotation.md b/2025R2/rocky-prepost-scripting-manual/RAFreeBodyRotation.md index 9feb1b77eb..72be129692 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFreeBodyRotation.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFreeBodyRotation.md @@ -1,60 +1,61 @@ - - -# RAFreeBodyRotation - - - - - - -### *class* RAFreeBodyRotation - -Rocky PrePost Scripting wrapper representing a Free Body Rotation motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Free Body Rotation') -free_body_rotation = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetFreeMotionDirection`](#generated.RAFreeBodyRotation.GetFreeMotionDirection)() | Get "Free Motion Direction" as a string. | -|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| -| [`GetValidFreeMotionDirectionValues`](#generated.RAFreeBodyRotation.GetValidFreeMotionDirectionValues)() | Get a list of all possible values for "Free Motion Direction". | -| [`SetFreeMotionDirection`](#generated.RAFreeBodyRotation.SetFreeMotionDirection)(value) | Set the value of "Free Motion Direction". | - - - -#### GetFreeMotionDirection() - -Get “Free Motion Direction” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### GetValidFreeMotionDirectionValues() - -Get a list of all possible values for “Free Motion Direction”. - -* **Returns:** - The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### SetFreeMotionDirection(value: str) - -Set the value of “Free Motion Direction”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Free Motion Direction” option. + + +# RAFreeBodyRotation + + + + + + +### *class* RAFreeBodyRotation + +Rocky PrePost Scripting wrapper representing a Free Body Rotation motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Free Body Rotation') +free_body_rotation = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| [`GetFreeMotionDirection`](#generated.RAFreeBodyRotation.GetFreeMotionDirection)() | Get "Free Motion Direction" as a string. | +| [`GetValidFreeMotionDirectionValues`](#generated.RAFreeBodyRotation.GetValidFreeMotionDirectionValues)() | Get a list of all possible values for "Free Motion Direction". | +| [`SetFreeMotionDirection`](#generated.RAFreeBodyRotation.SetFreeMotionDirection)(value) | Set the value of "Free Motion Direction". | + + + +#### GetFreeMotionDirection() + +Get “Free Motion Direction” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### GetValidFreeMotionDirectionValues() + +Get a list of all possible values for “Free Motion Direction”. + +* **Returns:** + The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### SetFreeMotionDirection(value: str) + +Set the value of “Free Motion Direction”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Free Motion Direction” option. diff --git a/2025R2/rocky-prepost-scripting-manual/RAFreeBodyTranslation.md b/2025R2/rocky-prepost-scripting-manual/RAFreeBodyTranslation.md index fbf2ffbfc7..71b7cd4491 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAFreeBodyTranslation.md +++ b/2025R2/rocky-prepost-scripting-manual/RAFreeBodyTranslation.md @@ -1,60 +1,61 @@ - - -# RAFreeBodyTranslation - - - - - - -### *class* RAFreeBodyTranslation - -Rocky PrePost Scripting wrapper representing a Free Body Translation motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Free Body Translation') -free_body_translation = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetFreeMotionDirection`](#generated.RAFreeBodyTranslation.GetFreeMotionDirection)() | Get "Free Motion Direction" as a string. | -|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| -| [`GetValidFreeMotionDirectionValues`](#generated.RAFreeBodyTranslation.GetValidFreeMotionDirectionValues)() | Get a list of all possible values for "Free Motion Direction". | -| [`SetFreeMotionDirection`](#generated.RAFreeBodyTranslation.SetFreeMotionDirection)(value) | Set the value of "Free Motion Direction". | - - - -#### GetFreeMotionDirection() - -Get “Free Motion Direction” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### GetValidFreeMotionDirectionValues() - -Get a list of all possible values for “Free Motion Direction”. - -* **Returns:** - The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### SetFreeMotionDirection(value: str) - -Set the value of “Free Motion Direction”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Free Motion Direction” option. + + +# RAFreeBodyTranslation + + + + + + +### *class* RAFreeBodyTranslation + +Rocky PrePost Scripting wrapper representing a Free Body Translation motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Free Body Translation') +free_body_translation = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| [`GetFreeMotionDirection`](#generated.RAFreeBodyTranslation.GetFreeMotionDirection)() | Get "Free Motion Direction" as a string. | +| [`GetValidFreeMotionDirectionValues`](#generated.RAFreeBodyTranslation.GetValidFreeMotionDirectionValues)() | Get a list of all possible values for "Free Motion Direction". | +| [`SetFreeMotionDirection`](#generated.RAFreeBodyTranslation.SetFreeMotionDirection)(value) | Set the value of "Free Motion Direction". | + + + +#### GetFreeMotionDirection() + +Get “Free Motion Direction” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### GetValidFreeMotionDirectionValues() + +Get a list of all possible values for “Free Motion Direction”. + +* **Returns:** + The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### SetFreeMotionDirection(value: str) + +Set the value of “Free Motion Direction”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Free Motion Direction” option. diff --git a/2025R2/rocky-prepost-scripting-manual/RAGeometryCollection.md b/2025R2/rocky-prepost-scripting-manual/RAGeometryCollection.md index 19dc08a787..f31eb0efb7 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAGeometryCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAGeometryCollection.md @@ -1,113 +1,114 @@ - - -# RAGeometryCollection - - - - - - -### *class* RAGeometryCollection - -Rocky PrePost Scripting wrapper for the collection of geometries in a project. - -The class represents the “Geometries” item on the project data tree. To get the [`RAGeometryCollection`](#generated.RAGeometryCollection) -from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: - -```python -geometry_collection = study.GetGeometryCollection() -``` - -This class contains methods to iterate and retrieve the geometries in a given project, manipulating -the collection as a regular Python list, e.g.: - -```python -for geometry in geometry_collection: - print(geometry.GetName()) - -feed_conveyor = geometry_collection[1] -inlet = geometry_collection.GetGeometry('Inlet <01>') -``` - -To create the different kind of geometries (conveyors, inlets and custom geometries), see -[`RAStudy`](RAStudy.md#generated.RAStudy). - -**Methods:** - -| [`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. | - - - -#### GetBoundingBox(time_step: ITimeStep | None, force_load: bool = False) - -Get the bounding box containing all geometries in this collection, at the given time. - -* **Parameters:** - * **time_step** (*ITimeStep*) - * **force_load** (*bool*) -* **Rtype (FixedArray, FixedArray):** -* **Returns:** - The bounding box of all the geometries in the passed time step, or None if the box - could not be computed. - - - -#### GetGeometry(geometry_name) - -Get a geometry from its name. - -* **Parameters:** - **geometry_name** (*unicode*) - - - -#### GetGeometryNames() - -Get the names of the geometries in this collection. - - - -#### IterInletGeometries() - -Iterate over the inlet geometries. - - - -#### IterInputGeometries() - -Deprecated: Use [`IterInletGeometries()`](#generated.RAGeometryCollection.IterInletGeometries) instead. - - - -#### IterSurfaces() - -Iterate over the surface geometries. - - - -#### IterSystemCouplingWalls() - -Iterate over the System Coupling walls geometries. - - - -#### IterWalls() - -Iterate over the walls geometries. - - - -#### RemoveGeometry(geometry: RABaseGeometry | str | None) - -Remove the given geometry from the project. + + +# RAGeometryCollection + + + + + + +### *class* RAGeometryCollection + +Rocky PrePost Scripting wrapper for the collection of geometries in a project. + +The class represents the “Geometries” item on the project data tree. To get the [`RAGeometryCollection`](#generated.RAGeometryCollection) +from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: + +```python +geometry_collection = study.GetGeometryCollection() +``` + +This class contains methods to iterate and retrieve the geometries in a given project, manipulating +the collection as a regular Python list, e.g.: + +```python +for geometry in geometry_collection: + print(geometry.GetName()) + +feed_conveyor = geometry_collection[1] +inlet = geometry_collection.GetGeometry('Inlet <01>') +``` + +To create the different kind of geometries (conveyors, inlets and custom geometries), see +[`RAStudy`](RAStudy.md#generated.RAStudy). + +**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. | + + + +#### GetBoundingBox(time_step: ITimeStep | None, force_load: bool = False) + +Get the bounding box containing all geometries in this collection, at the given time. + +* **Parameters:** + * **time_step** (*ITimeStep*) + * **force_load** (*bool*) +* **Rtype (FixedArray, FixedArray):** +* **Returns:** + The bounding box of all the geometries in the passed time step, or None if the box + could not be computed. + + + +#### GetGeometry(geometry_name) + +Get a geometry from its name. + +* **Parameters:** + **geometry_name** (*unicode*) + + + +#### GetGeometryNames() + +Get the names of the geometries in this collection. + + + +#### IterInletGeometries() + +Iterate over the inlet geometries. + + + +#### IterInputGeometries() + +Deprecated: Use [`IterInletGeometries()`](#generated.RAGeometryCollection.IterInletGeometries) instead. + + + +#### IterSurfaces() + +Iterate over the surface geometries. + + + +#### IterSystemCouplingWalls() + +Iterate over the System Coupling walls geometries. + + + +#### IterWalls() + +Iterate over the walls geometries. + + + +#### RemoveGeometry(geometry: RABaseGeometry | str | None) + +Remove the given geometry from the project. diff --git a/2025R2/rocky-prepost-scripting-manual/RAInletGeometry.md b/2025R2/rocky-prepost-scripting-manual/RAInletGeometry.md index 1b21b94f11..3f5a28d89d 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAInletGeometry.md +++ b/2025R2/rocky-prepost-scripting-manual/RAInletGeometry.md @@ -1,1114 +1,1115 @@ - - -# RAInletGeometry - - - - - - -### *class* RAInletGeometry - -Rocky API Inlet model. - -**Methods:** - -| [`AddCurve`](#generated.RAInletGeometry.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAInletGeometry.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.RAInletGeometry.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAInletGeometry.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAInletGeometry.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.RAInletGeometry.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAInletGeometry.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAInletGeometry.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.RAInletGeometry.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.RAInletGeometry.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.RAInletGeometry.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.RAInletGeometry.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAlignmentAngle`](#generated.RAInletGeometry.GetAlignmentAngle)([unit]) | Get the value of "Alignment Angle". | -| [`GetBoundingBox`](#generated.RAInletGeometry.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAInletGeometry.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAInletGeometry.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAInletGeometry.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAInletGeometry.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAInletGeometry.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAInletGeometry.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAInletGeometry.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAInletGeometry.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RAInletGeometry.GetCenter)([unit]) | Get the value of "Center". | -| [`GetCircularMinMaxRadius`](#generated.RAInletGeometry.GetCircularMinMaxRadius)([unit]) | Get the minimum and maximum radiuses for circular inlets. | -| [`GetCurve`](#generated.RAInletGeometry.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAInletGeometry.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfCells`](#generated.RAInletGeometry.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAInletGeometry.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAInletGeometry.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAInletGeometry.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetRectangularSize`](#generated.RAInletGeometry.GetRectangularSize)([unit]) | Get the rectangular length and width of the inlet. | -| [`GetTimeSet`](#generated.RAInletGeometry.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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 | -| [`IterCellVertices`](#generated.RAInletGeometry.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAInletGeometry.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAInletGeometry.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAInletGeometry.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAInletGeometry.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAInletGeometry.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAInletGeometry.RemoveProcess)() | Removes the process from the project. | -| [`SetAlignmentAngle`](#generated.RAInletGeometry.SetAlignmentAngle)(value[, unit]) | Set the value of "Alignment Angle". | -| [`SetCenter`](#generated.RAInletGeometry.SetCenter)(values[, unit]) | Set the values of "Center". | -| [`SetCircularMinMaxRadius`](#generated.RAInletGeometry.SetCircularMinMaxRadius)(min_radius, max_radius) | Set the minimum and maximum radiuses for circular inlets. | -| [`SetCurrentTimeStep`](#generated.RAInletGeometry.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetGeometryType`](#generated.RAInletGeometry.SetGeometryType)(geometry_type) | Sets Inlet geometry type, rectangular or circular | -| [`SetInclineAngle`](#generated.RAInletGeometry.SetInclineAngle)(value[, unit]) | Set the value of "Incline Angle". | -| [`SetLength`](#generated.RAInletGeometry.SetLength)(value[, unit]) | Set the value of "Length". | -| [`SetRectangularSize`](#generated.RAInletGeometry.SetRectangularSize)(length, width[, unit]) | Sets inlet rectangular size. | -| [`SetWidth`](#generated.RAInletGeometry.SetWidth)(value[, unit]) | Set the value of "Width". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAlignmentAngle(unit: str | None = None) - -Get the value of “Alignment Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit: str | None = None) - -Get the value of “Center”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCircularMinMaxRadius(unit: str | None = None) - -Get the minimum and maximum radiuses for circular inlets. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. -* **Returns:** - A tuple with (minimum_radius, maximum_radius) - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryType() - -Get the Inlet geometry type, which is either ‘rectangular’ or ‘circular’. - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetInclineAngle(unit: str | None = None) - -Get the value of “Incline Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetLength(unit: str | None = None) - -Get the value of “Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetRectangularSize(unit: str | None = None) - -Get the rectangular length and width of the inlet. - -* **Parameters:** - **unit** – The optional unit of the returned values. If no unit is passed, the values will be in ‘m’. -* **Returns:** - A (length, width) tuple. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetWidth(unit: str | None = None) - -Get the value of “Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetAlignmentAngle(value: str | float, unit: str | None = None) - -Set the value of “Alignment 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 “dega”. - - - -#### SetCenter(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Center”. - -* **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. - - - -#### SetCircularMinMaxRadius(min_radius: float, max_radius: float, unit: str | None = None) - -Set the minimum and maximum radiuses for circular inlets. - -* **Parameters:** - **unit** – The unit for the radiuses. If no unit is provided, the radiuses will be assumed to be - in “m”. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetGeometryType(geometry_type: str) - -Sets Inlet geometry type, rectangular or circular - -* **Parameters:** - **geometry_type** – Inlet geometry’s type, ‘rectangular’ or ‘circular’. - - - -#### SetInclineAngle(value: str | float, unit: str | None = None) - -Set the value of “Incline 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 “dega”. - - - -#### SetLength(value: str | float, unit: str | None = None) - -Set the value of “Length”. - -* **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”. - - - -#### SetRectangularSize(length: float, width: float, unit: str | None = None) - -Sets inlet rectangular size. - -* **Parameters:** - * **width** – Inlet width - * **length** – Inlet length - * **unit** – The optional unit. If no unit is passed, ‘m’ is used. - - - -#### SetWidth(value: str | float, unit: str | None = None) - -Set the value of “Width”. - -* **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”. + + +# RAInletGeometry + + + + + + +### *class* RAInletGeometry + +Rocky API Inlet model. + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAInletGeometry.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAInletGeometry.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.RAInletGeometry.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAInletGeometry.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAInletGeometry.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.RAInletGeometry.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAInletGeometry.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAInletGeometry.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.RAInletGeometry.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.RAInletGeometry.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.RAInletGeometry.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.RAInletGeometry.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAlignmentAngle`](#generated.RAInletGeometry.GetAlignmentAngle)([unit]) | Get the value of "Alignment Angle". | +| [`GetBoundingBox`](#generated.RAInletGeometry.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAInletGeometry.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAInletGeometry.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAInletGeometry.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAInletGeometry.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAInletGeometry.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAInletGeometry.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAInletGeometry.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAInletGeometry.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RAInletGeometry.GetCenter)([unit]) | Get the value of "Center". | +| [`GetCircularMinMaxRadius`](#generated.RAInletGeometry.GetCircularMinMaxRadius)([unit]) | Get the minimum and maximum radiuses for circular inlets. | +| [`GetCurve`](#generated.RAInletGeometry.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAInletGeometry.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfCells`](#generated.RAInletGeometry.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAInletGeometry.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAInletGeometry.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAInletGeometry.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetRectangularSize`](#generated.RAInletGeometry.GetRectangularSize)([unit]) | Get the rectangular length and width of the inlet. | +| [`GetTimeSet`](#generated.RAInletGeometry.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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 | +| [`IterCellVertices`](#generated.RAInletGeometry.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAInletGeometry.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAInletGeometry.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAInletGeometry.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAInletGeometry.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAInletGeometry.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAInletGeometry.RemoveProcess)() | Removes the process from the project. | +| [`SetAlignmentAngle`](#generated.RAInletGeometry.SetAlignmentAngle)(value[, unit]) | Set the value of "Alignment Angle". | +| [`SetCenter`](#generated.RAInletGeometry.SetCenter)(values[, unit]) | Set the values of "Center". | +| [`SetCircularMinMaxRadius`](#generated.RAInletGeometry.SetCircularMinMaxRadius)(min_radius, max_radius) | Set the minimum and maximum radiuses for circular inlets. | +| [`SetCurrentTimeStep`](#generated.RAInletGeometry.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetGeometryType`](#generated.RAInletGeometry.SetGeometryType)(geometry_type) | Sets Inlet geometry type, rectangular or circular | +| [`SetInclineAngle`](#generated.RAInletGeometry.SetInclineAngle)(value[, unit]) | Set the value of "Incline Angle". | +| [`SetLength`](#generated.RAInletGeometry.SetLength)(value[, unit]) | Set the value of "Length". | +| [`SetRectangularSize`](#generated.RAInletGeometry.SetRectangularSize)(length, width[, unit]) | Sets inlet rectangular size. | +| [`SetWidth`](#generated.RAInletGeometry.SetWidth)(value[, unit]) | Set the value of "Width". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAlignmentAngle(unit: str | None = None) + +Get the value of “Alignment Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit: str | None = None) + +Get the value of “Center”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCircularMinMaxRadius(unit: str | None = None) + +Get the minimum and maximum radiuses for circular inlets. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. +* **Returns:** + A tuple with (minimum_radius, maximum_radius) + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryType() + +Get the Inlet geometry type, which is either ‘rectangular’ or ‘circular’. + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetInclineAngle(unit: str | None = None) + +Get the value of “Incline Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetLength(unit: str | None = None) + +Get the value of “Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetRectangularSize(unit: str | None = None) + +Get the rectangular length and width of the inlet. + +* **Parameters:** + **unit** – The optional unit of the returned values. If no unit is passed, the values will be in ‘m’. +* **Returns:** + A (length, width) tuple. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetWidth(unit: str | None = None) + +Get the value of “Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetAlignmentAngle(value: str | float, unit: str | None = None) + +Set the value of “Alignment 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 “dega”. + + + +#### SetCenter(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Center”. + +* **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. + + + +#### SetCircularMinMaxRadius(min_radius: float, max_radius: float, unit: str | None = None) + +Set the minimum and maximum radiuses for circular inlets. + +* **Parameters:** + **unit** – The unit for the radiuses. If no unit is provided, the radiuses will be assumed to be + in “m”. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetGeometryType(geometry_type: str) + +Sets Inlet geometry type, rectangular or circular + +* **Parameters:** + **geometry_type** – Inlet geometry’s type, ‘rectangular’ or ‘circular’. + + + +#### SetInclineAngle(value: str | float, unit: str | None = None) + +Set the value of “Incline 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 “dega”. + + + +#### SetLength(value: str | float, unit: str | None = None) + +Set the value of “Length”. + +* **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”. + + + +#### SetRectangularSize(length: float, width: float, unit: str | None = None) + +Sets inlet rectangular size. + +* **Parameters:** + * **width** – Inlet width + * **length** – Inlet length + * **unit** – The optional unit. If no unit is passed, ‘m’ is used. + + + +#### SetWidth(value: str | float, unit: str | None = None) + +Set the value of “Width”. + +* **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/2025R2/rocky-prepost-scripting-manual/RAInletsOutletsCollection.md b/2025R2/rocky-prepost-scripting-manual/RAInletsOutletsCollection.md index f265c59778..178dc3361b 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAInletsOutletsCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAInletsOutletsCollection.md @@ -1,126 +1,127 @@ - - -# RAInletsOutletsCollection - - - - - - -### *class* RAInletsOutletsCollection - -Rocky PrePost Scripting wrapper for the collection of particle inputs in a project. - -This wrapper corresponds to the “Inputs” item in the project’s data tree. To retrieve the -[`RAInletsOutletsCollection`](#generated.RAInletsOutletsCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: - -```python -input_collection = study.GetParticleInputCollection() -``` - -Instances of the [`RAInletsOutletsCollection`](#generated.RAInletsOutletsCollection) class act as regular Python lists, and can be -iterated on, accessed via index, etc: - -```python -input_1 = input_collection.New() -input_2 = input_collection[1] -del input_collection[0] -for input in input_collection: - print(input.GetName()) -``` - -Items in this list are of type [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet). - -**Methods:** - -| [`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() - -Add a new CustomInput. Returns the newly created item. - - - -#### AddFluidInlet() - -Add a new SPHInlet. Returns the newly created item. - - - -#### AddOutlet() - -Add a new Outlet. Returns the newly created item. - - - -#### AddParticleInlet() - -Add a new ParticleInlet. Returns the newly created item. - - - -#### AddVolumetricInlet() - -Add a new VolumeFill. Returns the newly created item. - - - -#### Clear() - -Remove all items from the list. - - - -#### GetParticleInput(input_name) - -Get the particle input with the given name. - -* **Parameters:** - **input_name** (*unicode*) -* **Return type:** - [RAParticleInlet](RAParticleInlet.md#generated.RAParticleInlet) - - - -#### GetParticleInputNames() - -Get the names of all particle inputs. - -* **Return type:** - list(unicode) - - - -#### New() - -Add a new item. Returns the newly created item. - -* **Return type:** - ApiElementItem - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAInletsOutletsCollection + + + + + + +### *class* RAInletsOutletsCollection + +Rocky PrePost Scripting wrapper for the collection of particle inputs in a project. + +This wrapper corresponds to the “Inputs” item in the project’s data tree. To retrieve the +[`RAInletsOutletsCollection`](#generated.RAInletsOutletsCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: + +```python +input_collection = study.GetParticleInputCollection() +``` + +Instances of the [`RAInletsOutletsCollection`](#generated.RAInletsOutletsCollection) class act as regular Python lists, and can be +iterated on, accessed via index, etc: + +```python +input_1 = input_collection.New() +input_2 = input_collection[1] +del input_collection[0] +for input in input_collection: + print(input.GetName()) +``` + +Items in this list are of type [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet). + +**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() + +Add a new CustomInput. Returns the newly created item. + + + +#### AddFluidInlet() + +Add a new SPHInlet. Returns the newly created item. + + + +#### AddOutlet() + +Add a new Outlet. Returns the newly created item. + + + +#### AddParticleInlet() + +Add a new ParticleInlet. Returns the newly created item. + + + +#### AddVolumetricInlet() + +Add a new VolumeFill. Returns the newly created item. + + + +#### Clear() + +Remove all items from the list. + + + +#### GetParticleInput(input_name) + +Get the particle input with the given name. + +* **Parameters:** + **input_name** (*unicode*) +* **Return type:** + [RAParticleInlet](RAParticleInlet.md#generated.RAParticleInlet) + + + +#### GetParticleInputNames() + +Get the names of all particle inputs. + +* **Return type:** + list(unicode) + + + +#### New() + +Add a new item. Returns the newly created item. + +* **Return type:** + ApiElementItem + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAInputVariables.md b/2025R2/rocky-prepost-scripting-manual/RAInputVariables.md index 5b9a4e0b33..3b6c2bca67 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAInputVariables.md +++ b/2025R2/rocky-prepost-scripting-manual/RAInputVariables.md @@ -1,72 +1,73 @@ - - -# RAInputVariables - - - - - - -### *class* RAInputVariables - -Rocky PrePost Scripting wrapper for the list of parametric input variables. - -The input variables correspond to the Variables list on the Input tab of a project’s -Expressions/Variables dock. This wrapper can be used to create, remove and list a project’s -input variables. - -Retrieve the [`RAInputVariables`](#generated.RAInputVariables) through the corresponding [`RAProject`](RAProject.md#generated.RAProject). -Example usage: - -```python -project = app.GetProject() -input_variables = project.GetInputVariables() - -input_variables.CreateVariable('a', value=1) -input_variables.CreateVariable('b', value=2) - -input_variables.RemoveVariable('a') - -for variable in input_variables: - variable.SetValue(3) - -b = input_variables.GetVariableByName('b') -b.SetValue(4) -``` - -**Methods:** - -| [`CreateVariable`](#generated.RAInputVariables.CreateVariable)(name[, value]) | Create a new input variable. | -|---------------------------------------------------------------------------------|----------------------------------------------| -| [`GetVariableByName`](#generated.RAInputVariables.GetVariableByName)(name) | Get an existing input variable via its name. | -| [`RemoveVariable`](#generated.RAInputVariables.RemoveVariable)(variable) | Remove an input variable. | - - - -#### CreateVariable(name: str, value: float = 0.0) - -Create a new input variable. Returns the new variable. - -* **Parameters:** - * **name** – The variable’s name. - * **value** – The initial value for the variable. - - - -#### GetVariableByName(name: str) - -Get an existing input variable via its name. - -* **Parameters:** - **name** – The input variable’s name. - - - -#### RemoveVariable(variable: [RAParametricVar](RAParametricVar.md#generated.RAParametricVar) | str) - -Remove an input variable. - -* **Parameters:** - **variable** – Either an instance of RAParametricVar or the name of the variable to remove. + + +# RAInputVariables + + + + + + +### *class* RAInputVariables + +Rocky PrePost Scripting wrapper for the list of parametric input variables. + +The input variables correspond to the Variables list on the Input tab of a project’s +Expressions/Variables dock. This wrapper can be used to create, remove and list a project’s +input variables. + +Retrieve the [`RAInputVariables`](#generated.RAInputVariables) through the corresponding [`RAProject`](RAProject.md#generated.RAProject). +Example usage: + +```python +project = app.GetProject() +input_variables = project.GetInputVariables() + +input_variables.CreateVariable('a', value=1) +input_variables.CreateVariable('b', value=2) + +input_variables.RemoveVariable('a') + +for variable in input_variables: + variable.SetValue(3) + +b = input_variables.GetVariableByName('b') +b.SetValue(4) +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------|----------------------------------------------| +| [`CreateVariable`](#generated.RAInputVariables.CreateVariable)(name[, value]) | Create a new input variable. | +| [`GetVariableByName`](#generated.RAInputVariables.GetVariableByName)(name) | Get an existing input variable via its name. | +| [`RemoveVariable`](#generated.RAInputVariables.RemoveVariable)(variable) | Remove an input variable. | + + + +#### CreateVariable(name: str, value: float = 0.0) + +Create a new input variable. Returns the new variable. + +* **Parameters:** + * **name** – The variable’s name. + * **value** – The initial value for the variable. + + + +#### GetVariableByName(name: str) + +Get an existing input variable via its name. + +* **Parameters:** + **name** – The input variable’s name. + + + +#### RemoveVariable(variable: [RAParametricVar](RAParametricVar.md#generated.RAParametricVar) | str) + +Remove an input variable. + +* **Parameters:** + **variable** – Either an instance of RAParametricVar or the name of the variable to remove. diff --git a/2025R2/rocky-prepost-scripting-manual/RAInspectorProcess.md b/2025R2/rocky-prepost-scripting-manual/RAInspectorProcess.md index 9e636944f6..4272efc053 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAInspectorProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RAInspectorProcess.md @@ -1,976 +1,977 @@ - - -# RAInspectorProcess - - - - - - -### *class* RAInspectorProcess - -**Methods:** - -| [`AddCurve`](#generated.RAInspectorProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAInspectorProcess.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.RAInspectorProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAInspectorProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAInspectorProcess.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.RAInspectorProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAInspectorProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAInspectorProcess.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.RAInspectorProcess.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.RAInspectorProcess.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.RAInspectorProcess.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.RAInspectorProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAInspectorProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAInspectorProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAInspectorProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAInspectorProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAInspectorProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAInspectorProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAInspectorProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAInspectorProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAInspectorProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAInspectorProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAInspectorProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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). | -| [`GetNumberOfParticles`](#generated.RAInspectorProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAInspectorProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAInspectorProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RAInspectorProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RAInspectorProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAInspectorProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAInspectorProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAInspectorProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAInspectorProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAInspectorProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAInspectorProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAInspectorProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + +# RAInspectorProcess + + + + + + +### *class* RAInspectorProcess + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAInspectorProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAInspectorProcess.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.RAInspectorProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAInspectorProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAInspectorProcess.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.RAInspectorProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAInspectorProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAInspectorProcess.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.RAInspectorProcess.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.RAInspectorProcess.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.RAInspectorProcess.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.RAInspectorProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAInspectorProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAInspectorProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAInspectorProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAInspectorProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAInspectorProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAInspectorProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAInspectorProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAInspectorProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAInspectorProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAInspectorProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAInspectorProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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). | +| [`GetNumberOfParticles`](#generated.RAInspectorProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RAInspectorProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAInspectorProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RAInspectorProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RAInspectorProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RAInspectorProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RAInspectorProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAInspectorProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAInspectorProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAInspectorProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAInspectorProcess.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAInspectorProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. diff --git a/2025R2/rocky-prepost-scripting-manual/RAJointsDataMeshColoring.md b/2025R2/rocky-prepost-scripting-manual/RAJointsDataMeshColoring.md index fe2200823a..93201c655a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAJointsDataMeshColoring.md +++ b/2025R2/rocky-prepost-scripting-manual/RAJointsDataMeshColoring.md @@ -1,184 +1,185 @@ - - -# RAJointsDataMeshColoring - - - - - - -### *class* RAJointsDataMeshColoring - -**Methods:** - -| [`GetAvailableGridFunctions`](#generated.RAJointsDataMeshColoring.GetAvailableGridFunctions)() | Get a list of all possible values for "GridFunctions". | -|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| -| [`GetAvailableGridFunctionsNames`](#generated.RAJointsDataMeshColoring.GetAvailableGridFunctionsNames)() | Get a list of all possible values for "GridFunctions" names. | -| [`GetJointsColor`](#generated.RAJointsDataMeshColoring.GetJointsColor)() | Get the value of "Node Color". | -| [`GetJointsConnectivityColor`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityColor)() | Get the value of "Joints Connectivity Color". | -| [`GetJointsConnectivityLineWidth`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityLineWidth)() | Get the value of "Joints Connectivity Line Width". | -| [`GetJointsConnectivityProperty`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityProperty)() | Get the value of "Joints Connectivity GridFunction". | -| [`GetJointsConnectivityVisible`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityVisible)() | Get the value of "Joints Connectivity Visible". | -| [`GetJointsPointSize`](#generated.RAJointsDataMeshColoring.GetJointsPointSize)() | Get the value of "Joints Point Size". | -| [`GetJointsProperty`](#generated.RAJointsDataMeshColoring.GetJointsProperty)() | Get the value of "Joints Property". | -| [`GetJointsVisible`](#generated.RAJointsDataMeshColoring.GetJointsVisible)() | Get the value of "Joints Visible". | -| [`GetValidColoringModes`](#generated.RAJointsDataMeshColoring.GetValidColoringModes)() | Get a list with all possible coloring modes names. | -| [`SetJointsColor`](#generated.RAJointsDataMeshColoring.SetJointsColor)(values) | Set the values of "Joints Color". | -| [`SetJointsConnectivityColor`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityColor)(values) | Set the values of "Joints Connectivity Color". | -| [`SetJointsConnectivityLineWidth`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityLineWidth)(value) | Set the value of "Joints Connectivity Line Width". | -| [`SetJointsConnectivityProperty`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityProperty)(value) | Set the values of "Joints Connectivity GridFunction". | -| [`SetJointsConnectivityVisible`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityVisible)(value) | Set the value of "Joints Connectivity Visible". | -| [`SetJointsPointSize`](#generated.RAJointsDataMeshColoring.SetJointsPointSize)(value) | Set the value of "Joints Point Size". | -| [`SetJointsProperty`](#generated.RAJointsDataMeshColoring.SetJointsProperty)(value) | Set the values of "Joints Property". | -| [`SetJointsVisible`](#generated.RAJointsDataMeshColoring.SetJointsVisible)(value) | Set the value of "Joints Visible". | - - - -#### GetAvailableGridFunctions() - -Get a list of all possible values for “GridFunctions”. - -* **Returns:** - The returned set contains the SemanticAssociation of the available Grid Functions. - - - -#### GetAvailableGridFunctionsNames() - -Get a list of all possible values for “GridFunctions” names. - -* **Returns:** - The returned set contains the names of the available Grid Functions. - - - -#### GetJointsColor() - -Get the value of “Node Color”. - - - -#### GetJointsConnectivityColor() - -Get the value of “Joints Connectivity Color”. - - - -#### GetJointsConnectivityLineWidth() - -Get the value of “Joints Connectivity Line Width”. - - - -#### GetJointsConnectivityProperty() - -Get the value of “Joints Connectivity GridFunction”. - - - -#### GetJointsConnectivityVisible() - -Get the value of “Joints Connectivity Visible”. - - - -#### GetJointsPointSize() - -Get the value of “Joints Point Size”. - - - -#### GetJointsProperty() - -Get the value of “Joints Property”. - - - -#### GetJointsVisible() - -Get the value of “Joints Visible”. - - - -#### GetValidColoringModes() - -Get a list with all possible coloring modes names. - -* **Returns:** - The returned values will be a combination of [‘Joints’, ‘Joints Connectivity’] - - - -#### SetJointsColor(values: tuple[float, float, float]) - -Set the values of “Joints Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. - - - -#### SetJointsConnectivityColor(values: tuple[float, float, float]) - -Set the values of “Joints Connectivity Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. - - - -#### SetJointsConnectivityLineWidth(value: float) - -Set the value of “Joints Connectivity Line Width”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetJointsConnectivityProperty(value: type[SemanticAssociation] | str | None) - -Set the values of “Joints Connectivity GridFunction”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. - - - -#### SetJointsConnectivityVisible(value: bool) - -Set the value of “Joints Connectivity Visible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetJointsPointSize(value: float) - -Set the value of “Joints Point Size”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetJointsProperty(value: type[SemanticAssociation] | str | None) - -Set the values of “Joints Property”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. - - - -#### SetJointsVisible(value: bool) - -Set the value of “Joints Visible”. - -* **Parameters:** - **value** – The value to set. + + +# RAJointsDataMeshColoring + + + + + + +### *class* RAJointsDataMeshColoring + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| [`GetAvailableGridFunctions`](#generated.RAJointsDataMeshColoring.GetAvailableGridFunctions)() | Get a list of all possible values for "GridFunctions". | +| [`GetAvailableGridFunctionsNames`](#generated.RAJointsDataMeshColoring.GetAvailableGridFunctionsNames)() | Get a list of all possible values for "GridFunctions" names. | +| [`GetJointsColor`](#generated.RAJointsDataMeshColoring.GetJointsColor)() | Get the value of "Node Color". | +| [`GetJointsConnectivityColor`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityColor)() | Get the value of "Joints Connectivity Color". | +| [`GetJointsConnectivityLineWidth`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityLineWidth)() | Get the value of "Joints Connectivity Line Width". | +| [`GetJointsConnectivityProperty`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityProperty)() | Get the value of "Joints Connectivity GridFunction". | +| [`GetJointsConnectivityVisible`](#generated.RAJointsDataMeshColoring.GetJointsConnectivityVisible)() | Get the value of "Joints Connectivity Visible". | +| [`GetJointsPointSize`](#generated.RAJointsDataMeshColoring.GetJointsPointSize)() | Get the value of "Joints Point Size". | +| [`GetJointsProperty`](#generated.RAJointsDataMeshColoring.GetJointsProperty)() | Get the value of "Joints Property". | +| [`GetJointsVisible`](#generated.RAJointsDataMeshColoring.GetJointsVisible)() | Get the value of "Joints Visible". | +| [`GetValidColoringModes`](#generated.RAJointsDataMeshColoring.GetValidColoringModes)() | Get a list with all possible coloring modes names. | +| [`SetJointsColor`](#generated.RAJointsDataMeshColoring.SetJointsColor)(values) | Set the values of "Joints Color". | +| [`SetJointsConnectivityColor`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityColor)(values) | Set the values of "Joints Connectivity Color". | +| [`SetJointsConnectivityLineWidth`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityLineWidth)(value) | Set the value of "Joints Connectivity Line Width". | +| [`SetJointsConnectivityProperty`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityProperty)(value) | Set the values of "Joints Connectivity GridFunction". | +| [`SetJointsConnectivityVisible`](#generated.RAJointsDataMeshColoring.SetJointsConnectivityVisible)(value) | Set the value of "Joints Connectivity Visible". | +| [`SetJointsPointSize`](#generated.RAJointsDataMeshColoring.SetJointsPointSize)(value) | Set the value of "Joints Point Size". | +| [`SetJointsProperty`](#generated.RAJointsDataMeshColoring.SetJointsProperty)(value) | Set the values of "Joints Property". | +| [`SetJointsVisible`](#generated.RAJointsDataMeshColoring.SetJointsVisible)(value) | Set the value of "Joints Visible". | + + + +#### GetAvailableGridFunctions() + +Get a list of all possible values for “GridFunctions”. + +* **Returns:** + The returned set contains the SemanticAssociation of the available Grid Functions. + + + +#### GetAvailableGridFunctionsNames() + +Get a list of all possible values for “GridFunctions” names. + +* **Returns:** + The returned set contains the names of the available Grid Functions. + + + +#### GetJointsColor() + +Get the value of “Node Color”. + + + +#### GetJointsConnectivityColor() + +Get the value of “Joints Connectivity Color”. + + + +#### GetJointsConnectivityLineWidth() + +Get the value of “Joints Connectivity Line Width”. + + + +#### GetJointsConnectivityProperty() + +Get the value of “Joints Connectivity GridFunction”. + + + +#### GetJointsConnectivityVisible() + +Get the value of “Joints Connectivity Visible”. + + + +#### GetJointsPointSize() + +Get the value of “Joints Point Size”. + + + +#### GetJointsProperty() + +Get the value of “Joints Property”. + + + +#### GetJointsVisible() + +Get the value of “Joints Visible”. + + + +#### GetValidColoringModes() + +Get a list with all possible coloring modes names. + +* **Returns:** + The returned values will be a combination of [‘Joints’, ‘Joints Connectivity’] + + + +#### SetJointsColor(values: tuple[float, float, float]) + +Set the values of “Joints Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. + + + +#### SetJointsConnectivityColor(values: tuple[float, float, float]) + +Set the values of “Joints Connectivity Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. + + + +#### SetJointsConnectivityLineWidth(value: float) + +Set the value of “Joints Connectivity Line Width”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetJointsConnectivityProperty(value: type[SemanticAssociation] | str | None) + +Set the values of “Joints Connectivity GridFunction”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. + + + +#### SetJointsConnectivityVisible(value: bool) + +Set the value of “Joints Connectivity Visible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetJointsPointSize(value: float) + +Set the value of “Joints Point Size”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetJointsProperty(value: type[SemanticAssociation] | str | None) + +Set the values of “Joints Property”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. + + + +#### SetJointsVisible(value: bool) + +Set the value of “Joints Visible”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableForce.md b/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableForce.md index a4a42430cc..21ba9f4c86 100644 --- a/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableForce.md +++ b/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableForce.md @@ -1,76 +1,77 @@ - - -# RALinearTimeVariableForce - - - - - - -### *class* RALinearTimeVariableForce - -Rocky PrePost Scripting wrapper representing an Linear Time Variable Force motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Linear Time Variable Force') -additional_force = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetInitialForceValue`](#generated.RALinearTimeVariableForce.GetInitialForceValue)([unit]) | Get the value of "Initial Force Value". | -|-----------------------------------------------------------------------------------------------------|-------------------------------------------| -| [`GetTimeCoefficients`](#generated.RALinearTimeVariableForce.GetTimeCoefficients)([unit]) | Get the value of "Time Coefficients". | -| [`SetInitialForceValue`](#generated.RALinearTimeVariableForce.SetInitialForceValue)(values[, unit]) | Set the values of "Initial Force Value". | -| [`SetTimeCoefficients`](#generated.RALinearTimeVariableForce.SetTimeCoefficients)(values[, unit]) | Set the values of "Time Coefficients". | - - - -#### GetInitialForceValue(unit: str | None = None) - -Get the value of “Initial Force Value”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N”. - - - -#### GetTimeCoefficients(unit: str | None = None) - -Get the value of “Time Coefficients”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N/s”. - - - -#### SetInitialForceValue(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Initial Force Value”. - -* **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 “N”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetTimeCoefficients(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Time Coefficients”. - -* **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 “N/s”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. + + +# RALinearTimeVariableForce + + + + + + +### *class* RALinearTimeVariableForce + +Rocky PrePost Scripting wrapper representing an Linear Time Variable Force motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Linear Time Variable Force') +additional_force = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------|-------------------------------------------| +| [`GetInitialForceValue`](#generated.RALinearTimeVariableForce.GetInitialForceValue)([unit]) | Get the value of "Initial Force Value". | +| [`GetTimeCoefficients`](#generated.RALinearTimeVariableForce.GetTimeCoefficients)([unit]) | Get the value of "Time Coefficients". | +| [`SetInitialForceValue`](#generated.RALinearTimeVariableForce.SetInitialForceValue)(values[, unit]) | Set the values of "Initial Force Value". | +| [`SetTimeCoefficients`](#generated.RALinearTimeVariableForce.SetTimeCoefficients)(values[, unit]) | Set the values of "Time Coefficients". | + + + +#### GetInitialForceValue(unit: str | None = None) + +Get the value of “Initial Force Value”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N”. + + + +#### GetTimeCoefficients(unit: str | None = None) + +Get the value of “Time Coefficients”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N/s”. + + + +#### SetInitialForceValue(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Initial Force Value”. + +* **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 “N”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetTimeCoefficients(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Time Coefficients”. + +* **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 “N/s”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. diff --git a/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableMoment.md b/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableMoment.md index 95008ef4ff..a0acb7ee2a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableMoment.md +++ b/2025R2/rocky-prepost-scripting-manual/RALinearTimeVariableMoment.md @@ -1,76 +1,77 @@ - - -# RALinearTimeVariableMoment - - - - - - -### *class* RALinearTimeVariableMoment - -Rocky PrePost Scripting wrapper representing an Linear Time Variable Moment motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Linear Time Variable Moment') -additional_force = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetInitialMomentValue`](#generated.RALinearTimeVariableMoment.GetInitialMomentValue)([unit]) | Get the value of "Initial Moment Value". | -|--------------------------------------------------------------------------------------------------------|--------------------------------------------| -| [`GetTimeCoefficients`](#generated.RALinearTimeVariableMoment.GetTimeCoefficients)([unit]) | Get the value of "Time Coefficients". | -| [`SetInitialMomentValue`](#generated.RALinearTimeVariableMoment.SetInitialMomentValue)(values[, unit]) | Set the values of "Initial Moment Value". | -| [`SetTimeCoefficients`](#generated.RALinearTimeVariableMoment.SetTimeCoefficients)(values[, unit]) | Set the values of "Time Coefficients". | - - - -#### GetInitialMomentValue(unit: str | None = None) - -Get the value of “Initial Moment Value”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m”. - - - -#### GetTimeCoefficients(unit: str | None = None) - -Get the value of “Time Coefficients”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m/s”. - - - -#### SetInitialMomentValue(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Initial Moment Value”. - -* **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 “N.m”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetTimeCoefficients(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Time Coefficients”. - -* **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 “N.m/s”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. + + +# RALinearTimeVariableMoment + + + + + + +### *class* RALinearTimeVariableMoment + +Rocky PrePost Scripting wrapper representing an Linear Time Variable Moment motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Linear Time Variable Moment') +additional_force = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------|--------------------------------------------| +| [`GetInitialMomentValue`](#generated.RALinearTimeVariableMoment.GetInitialMomentValue)([unit]) | Get the value of "Initial Moment Value". | +| [`GetTimeCoefficients`](#generated.RALinearTimeVariableMoment.GetTimeCoefficients)([unit]) | Get the value of "Time Coefficients". | +| [`SetInitialMomentValue`](#generated.RALinearTimeVariableMoment.SetInitialMomentValue)(values[, unit]) | Set the values of "Initial Moment Value". | +| [`SetTimeCoefficients`](#generated.RALinearTimeVariableMoment.SetTimeCoefficients)(values[, unit]) | Set the values of "Time Coefficients". | + + + +#### GetInitialMomentValue(unit: str | None = None) + +Get the value of “Initial Moment Value”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m”. + + + +#### GetTimeCoefficients(unit: str | None = None) + +Get the value of “Time Coefficients”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m/s”. + + + +#### SetInitialMomentValue(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Initial Moment Value”. + +* **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 “N.m”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetTimeCoefficients(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Time Coefficients”. + +* **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 “N.m/s”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMaterialCollection.md b/2025R2/rocky-prepost-scripting-manual/RAMaterialCollection.md index efb1224b56..7311db808d 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMaterialCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMaterialCollection.md @@ -1,117 +1,118 @@ - - -# RAMaterialCollection - - - - - - -### *class* RAMaterialCollection - -Rocky PrePost Scripting wrapper for the collection of materials in a project. - -This wrapper corresponds to the “Materials” item on the project’s data tree. Retrieve the -[`RAMaterialCollection`](#generated.RAMaterialCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: - -```python -material_collection = study.GetMaterialCollection() -``` - -Instances of the [`RAMaterialCollection`](#generated.RAMaterialCollection) class act as regular Python lists and can be -iterated on, individual materials accessed and deleted via index, etc: - -```python -material_1 = material_collection.AddSolidMaterial() -material_2 = material_collection.AddFluidMaterial() -material_2 = material_collection[3] -del material_collection[2] -``` - -Items in this list are of type [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) and [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial). - -**Methods:** - -| [`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() - -Remove all items from the list. - - - -#### GetBulkSolidFraction() - -Get the value of “Bulk Solid Fraction”. - - - -#### GetDefaultMaterials() - -Deprecated: Use [`GetDefaultSolidMaterials()`](#generated.RAMaterialCollection.GetDefaultSolidMaterials) instead. - - - -#### GetDefaultSolidMaterials() - -Get a list with the default solid materials, in order of Particle, Belt and Boundary. - - - -#### GetFluidMaterial(material_name: str) - -Get the fluid material with the given name. - - - -#### GetMaterial(material_name: str) - -Deprecated: Use [`GetSolidMaterial()`](#generated.RAMaterialCollection.GetSolidMaterial) instead. - - - -#### GetMaterialsInteractionCollection() - -Get the study’s Materials Interaction Collection. - - - -#### GetSolidMaterial(material_name: str) - -Get the solid material with the given name. - - - -#### New() - -Deprecated: Use `Add{Solid, Fluid}Material()` instead. - - - -#### Remove(item: T) - -Remove an item from the list. - - - -#### SetBulkSolidFraction(value: str | float) - -Set the value of “Bulk Solid Fraction”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. + + +# RAMaterialCollection + + + + + + +### *class* RAMaterialCollection + +Rocky PrePost Scripting wrapper for the collection of materials in a project. + +This wrapper corresponds to the “Materials” item on the project’s data tree. Retrieve the +[`RAMaterialCollection`](#generated.RAMaterialCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: + +```python +material_collection = study.GetMaterialCollection() +``` + +Instances of the [`RAMaterialCollection`](#generated.RAMaterialCollection) class act as regular Python lists and can be +iterated on, individual materials accessed and deleted via index, etc: + +```python +material_1 = material_collection.AddSolidMaterial() +material_2 = material_collection.AddFluidMaterial() +material_2 = material_collection[3] +del material_collection[2] +``` + +Items in this list are of type [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) and [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial). + +**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() + +Remove all items from the list. + + + +#### GetBulkSolidFraction() + +Get the value of “Bulk Solid Fraction”. + + + +#### GetDefaultMaterials() + +Deprecated: Use [`GetDefaultSolidMaterials()`](#generated.RAMaterialCollection.GetDefaultSolidMaterials) instead. + + + +#### GetDefaultSolidMaterials() + +Get a list with the default solid materials, in order of Particle, Belt and Boundary. + + + +#### GetFluidMaterial(material_name: str) + +Get the fluid material with the given name. + + + +#### GetMaterial(material_name: str) + +Deprecated: Use [`GetSolidMaterial()`](#generated.RAMaterialCollection.GetSolidMaterial) instead. + + + +#### GetMaterialsInteractionCollection() + +Get the study’s Materials Interaction Collection. + + + +#### GetSolidMaterial(material_name: str) + +Get the solid material with the given name. + + + +#### New() + +Deprecated: Use `Add{Solid, Fluid}Material()` instead. + + + +#### Remove(item: T) + +Remove an item from the list. + + + +#### SetBulkSolidFraction(value: str | float) + +Set the value of “Bulk Solid Fraction”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteraction.md b/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteraction.md index 96a9efccf2..ac26a3e3a9 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteraction.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteraction.md @@ -1,312 +1,313 @@ - - -# RAMaterialsInteraction - - - - - - -### *class* RAMaterialsInteraction - -Rocky PrePost Scripting wrapper for the interaction between two materials. - -Retrieve a [`RAMaterialsInteraction`](#generated.RAMaterialsInteraction) from a [`RAMaterialsInteractionCollection`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection) and -two [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial): - -```python -material_1 = study.GetElement('Default Particles') -material_2 = study.GetElement('Default Boundaries') -interaction_collection = RAMaterialCollection.GetMaterialsInteractionCollection() -interaction = interaction_collection.GetMaterialsInteraction(material_1, material_2) -``` - -Note that the materials to which a [`RAMaterialsInteraction`](#generated.RAMaterialsInteraction) refers are fixed - while they -can be retrieved with [`GetFirstMaterial()`](#generated.RAMaterialsInteraction.GetFirstMaterial) and [`GetSecondMaterial()`](#generated.RAMaterialsInteraction.GetSecondMaterial), they can’t -be set. - -**Methods:** - -| [`GetAdhesiveDistance`](#generated.RAMaterialsInteraction.GetAdhesiveDistance)([unit]) | Get the value of "Adhesive Distance". | -|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| -| [`GetAdhesiveFraction`](#generated.RAMaterialsInteraction.GetAdhesiveFraction)([unit]) | Get the value of "Adhesive Fraction". | -| [`GetContactStiffnessMultiplier`](#generated.RAMaterialsInteraction.GetContactStiffnessMultiplier)([unit]) | Get the value of "Contact Stiffness Multiplier". | -| [`GetDynamicFriction`](#generated.RAMaterialsInteraction.GetDynamicFriction)([unit]) | Get the value of "Dynamic Friction". | -| [`GetFirstMaterial`](#generated.RAMaterialsInteraction.GetFirstMaterial)() | Get this interaction's first material. | -| [`GetModuleProperties`](#generated.RAMaterialsInteraction.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RAMaterialsInteraction.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetRestitutionCoefficient`](#generated.RAMaterialsInteraction.GetRestitutionCoefficient)([unit]) | Get the value of "Restitution Coefficient". | -| [`GetSecondMaterial`](#generated.RAMaterialsInteraction.GetSecondMaterial)() | Get this interaction's second material. | -| [`GetStaticFriction`](#generated.RAMaterialsInteraction.GetStaticFriction)([unit]) | Get the value of "Static Friction". | -| [`GetSurfaceEnergy`](#generated.RAMaterialsInteraction.GetSurfaceEnergy)([unit]) | Get the value of "Surface Energy". | -| [`GetTangentialStiffnessRatio`](#generated.RAMaterialsInteraction.GetTangentialStiffnessRatio)([unit]) | Get the value of "Tangential Stiffness Ratio". | -| [`GetValidOptionsForModuleProperty`](#generated.RAMaterialsInteraction.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`GetVelocityExponent`](#generated.RAMaterialsInteraction.GetVelocityExponent)([unit]) | Get the value of "Velocity Exponent". | -| [`GetVelocityLimit`](#generated.RAMaterialsInteraction.GetVelocityLimit)([unit]) | Get the value of "Velocity Limit". | -| [`SetAdhesiveDistance`](#generated.RAMaterialsInteraction.SetAdhesiveDistance)(value[, unit]) | Set the value of "Adhesive Distance". | -| [`SetAdhesiveFraction`](#generated.RAMaterialsInteraction.SetAdhesiveFraction)(value[, unit]) | Set the value of "Adhesive Fraction". | -| [`SetContactStiffnessMultiplier`](#generated.RAMaterialsInteraction.SetContactStiffnessMultiplier)(value[, unit]) | Set the value of "Contact Stiffness Multiplier". | -| [`SetDynamicFriction`](#generated.RAMaterialsInteraction.SetDynamicFriction)(value[, unit]) | Set the value of "Dynamic Friction". | -| [`SetModuleProperty`](#generated.RAMaterialsInteraction.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetRestitutionCoefficient`](#generated.RAMaterialsInteraction.SetRestitutionCoefficient)(value[, unit]) | Set the value of "Restitution Coefficient". | -| [`SetStaticFriction`](#generated.RAMaterialsInteraction.SetStaticFriction)(value[, unit]) | Set the value of "Static Friction". | -| [`SetSurfaceEnergy`](#generated.RAMaterialsInteraction.SetSurfaceEnergy)(value[, unit]) | Set the value of "Surface Energy". | -| [`SetTangentialStiffnessRatio`](#generated.RAMaterialsInteraction.SetTangentialStiffnessRatio)(value[, unit]) | Set the value of "Tangential Stiffness Ratio". | -| [`SetVelocityExponent`](#generated.RAMaterialsInteraction.SetVelocityExponent)(value[, unit]) | Set the value of "Velocity Exponent". | -| [`SetVelocityLimit`](#generated.RAMaterialsInteraction.SetVelocityLimit)(value[, unit]) | Set the value of "Velocity Limit". | - - - -#### GetAdhesiveDistance(unit: str | None = None) - -Get the value of “Adhesive Distance”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetAdhesiveFraction(unit: str | None = None) - -Get the value of “Adhesive Fraction”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetContactStiffnessMultiplier(unit: str | None = None) - -Get the value of “Contact Stiffness Multiplier”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetDynamicFriction(unit: str | None = None) - -Get the value of “Dynamic Friction”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetFirstMaterial() - -Get this interaction’s first material. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetRestitutionCoefficient(unit: str | None = None) - -Get the value of “Restitution Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetSecondMaterial() - -Get this interaction’s second material. - - - -#### GetStaticFriction(unit: str | None = None) - -Get the value of “Static Friction”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetSurfaceEnergy(unit: str | None = None) - -Get the value of “Surface Energy”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/m2”. - - - -#### GetTangentialStiffnessRatio(unit: str | None = None) - -Get the value of “Tangential Stiffness Ratio”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### GetVelocityExponent(unit: str | None = None) - -Get the value of “Velocity Exponent”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetVelocityLimit(unit: str | None = None) - -Get the value of “Velocity Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### SetAdhesiveDistance(value: str | float, unit: str | None = None) - -Set the value of “Adhesive 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”. - - - -#### SetAdhesiveFraction(value: str | float, unit: str | None = None) - -Set the value of “Adhesive Fraction”. - -* **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 “-“. - - - -#### SetContactStiffnessMultiplier(value: str | float, unit: str | None = None) - -Set the value of “Contact Stiffness Multiplier”. - -* **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 “-“. - - - -#### SetDynamicFriction(value: str | float, unit: str | None = None) - -Set the value of “Dynamic Friction”. - -* **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 “-“. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetRestitutionCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Restitution Coefficient”. - -* **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 “-“. - - - -#### SetStaticFriction(value: str | float, unit: str | None = None) - -Set the value of “Static Friction”. - -* **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 “-“. - - - -#### SetSurfaceEnergy(value: str | float, unit: str | None = None) - -Set the value of “Surface Energy”. - -* **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 “J/m2”. - - - -#### SetTangentialStiffnessRatio(value: str | float, unit: str | None = None) - -Set the value of “Tangential Stiffness Ratio”. - -* **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 “-“. - - - -#### SetVelocityExponent(value: str | float, unit: str | None = None) - -Set the value of “Velocity Exponent”. - -* **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 “-“. - - - -#### SetVelocityLimit(value: str | float, unit: str | None = None) - -Set the value of “Velocity Limit”. - -* **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/s”. + + +# RAMaterialsInteraction + + + + + + +### *class* RAMaterialsInteraction + +Rocky PrePost Scripting wrapper for the interaction between two materials. + +Retrieve a [`RAMaterialsInteraction`](#generated.RAMaterialsInteraction) from a [`RAMaterialsInteractionCollection`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection) and +two [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial): + +```python +material_1 = study.GetElement('Default Particles') +material_2 = study.GetElement('Default Boundaries') +interaction_collection = RAMaterialCollection.GetMaterialsInteractionCollection() +interaction = interaction_collection.GetMaterialsInteraction(material_1, material_2) +``` + +Note that the materials to which a [`RAMaterialsInteraction`](#generated.RAMaterialsInteraction) refers are fixed - while they +can be retrieved with [`GetFirstMaterial()`](#generated.RAMaterialsInteraction.GetFirstMaterial) and [`GetSecondMaterial()`](#generated.RAMaterialsInteraction.GetSecondMaterial), they can’t +be set. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [`GetAdhesiveDistance`](#generated.RAMaterialsInteraction.GetAdhesiveDistance)([unit]) | Get the value of "Adhesive Distance". | +| [`GetAdhesiveFraction`](#generated.RAMaterialsInteraction.GetAdhesiveFraction)([unit]) | Get the value of "Adhesive Fraction". | +| [`GetContactStiffnessMultiplier`](#generated.RAMaterialsInteraction.GetContactStiffnessMultiplier)([unit]) | Get the value of "Contact Stiffness Multiplier". | +| [`GetDynamicFriction`](#generated.RAMaterialsInteraction.GetDynamicFriction)([unit]) | Get the value of "Dynamic Friction". | +| [`GetFirstMaterial`](#generated.RAMaterialsInteraction.GetFirstMaterial)() | Get this interaction's first material. | +| [`GetModuleProperties`](#generated.RAMaterialsInteraction.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAMaterialsInteraction.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetRestitutionCoefficient`](#generated.RAMaterialsInteraction.GetRestitutionCoefficient)([unit]) | Get the value of "Restitution Coefficient". | +| [`GetSecondMaterial`](#generated.RAMaterialsInteraction.GetSecondMaterial)() | Get this interaction's second material. | +| [`GetStaticFriction`](#generated.RAMaterialsInteraction.GetStaticFriction)([unit]) | Get the value of "Static Friction". | +| [`GetSurfaceEnergy`](#generated.RAMaterialsInteraction.GetSurfaceEnergy)([unit]) | Get the value of "Surface Energy". | +| [`GetTangentialStiffnessRatio`](#generated.RAMaterialsInteraction.GetTangentialStiffnessRatio)([unit]) | Get the value of "Tangential Stiffness Ratio". | +| [`GetValidOptionsForModuleProperty`](#generated.RAMaterialsInteraction.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`GetVelocityExponent`](#generated.RAMaterialsInteraction.GetVelocityExponent)([unit]) | Get the value of "Velocity Exponent". | +| [`GetVelocityLimit`](#generated.RAMaterialsInteraction.GetVelocityLimit)([unit]) | Get the value of "Velocity Limit". | +| [`SetAdhesiveDistance`](#generated.RAMaterialsInteraction.SetAdhesiveDistance)(value[, unit]) | Set the value of "Adhesive Distance". | +| [`SetAdhesiveFraction`](#generated.RAMaterialsInteraction.SetAdhesiveFraction)(value[, unit]) | Set the value of "Adhesive Fraction". | +| [`SetContactStiffnessMultiplier`](#generated.RAMaterialsInteraction.SetContactStiffnessMultiplier)(value[, unit]) | Set the value of "Contact Stiffness Multiplier". | +| [`SetDynamicFriction`](#generated.RAMaterialsInteraction.SetDynamicFriction)(value[, unit]) | Set the value of "Dynamic Friction". | +| [`SetModuleProperty`](#generated.RAMaterialsInteraction.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetRestitutionCoefficient`](#generated.RAMaterialsInteraction.SetRestitutionCoefficient)(value[, unit]) | Set the value of "Restitution Coefficient". | +| [`SetStaticFriction`](#generated.RAMaterialsInteraction.SetStaticFriction)(value[, unit]) | Set the value of "Static Friction". | +| [`SetSurfaceEnergy`](#generated.RAMaterialsInteraction.SetSurfaceEnergy)(value[, unit]) | Set the value of "Surface Energy". | +| [`SetTangentialStiffnessRatio`](#generated.RAMaterialsInteraction.SetTangentialStiffnessRatio)(value[, unit]) | Set the value of "Tangential Stiffness Ratio". | +| [`SetVelocityExponent`](#generated.RAMaterialsInteraction.SetVelocityExponent)(value[, unit]) | Set the value of "Velocity Exponent". | +| [`SetVelocityLimit`](#generated.RAMaterialsInteraction.SetVelocityLimit)(value[, unit]) | Set the value of "Velocity Limit". | + + + +#### GetAdhesiveDistance(unit: str | None = None) + +Get the value of “Adhesive Distance”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetAdhesiveFraction(unit: str | None = None) + +Get the value of “Adhesive Fraction”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetContactStiffnessMultiplier(unit: str | None = None) + +Get the value of “Contact Stiffness Multiplier”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetDynamicFriction(unit: str | None = None) + +Get the value of “Dynamic Friction”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetFirstMaterial() + +Get this interaction’s first material. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetRestitutionCoefficient(unit: str | None = None) + +Get the value of “Restitution Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetSecondMaterial() + +Get this interaction’s second material. + + + +#### GetStaticFriction(unit: str | None = None) + +Get the value of “Static Friction”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetSurfaceEnergy(unit: str | None = None) + +Get the value of “Surface Energy”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/m2”. + + + +#### GetTangentialStiffnessRatio(unit: str | None = None) + +Get the value of “Tangential Stiffness Ratio”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### GetVelocityExponent(unit: str | None = None) + +Get the value of “Velocity Exponent”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetVelocityLimit(unit: str | None = None) + +Get the value of “Velocity Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### SetAdhesiveDistance(value: str | float, unit: str | None = None) + +Set the value of “Adhesive 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”. + + + +#### SetAdhesiveFraction(value: str | float, unit: str | None = None) + +Set the value of “Adhesive Fraction”. + +* **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 “-“. + + + +#### SetContactStiffnessMultiplier(value: str | float, unit: str | None = None) + +Set the value of “Contact Stiffness Multiplier”. + +* **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 “-“. + + + +#### SetDynamicFriction(value: str | float, unit: str | None = None) + +Set the value of “Dynamic Friction”. + +* **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 “-“. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetRestitutionCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Restitution Coefficient”. + +* **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 “-“. + + + +#### SetStaticFriction(value: str | float, unit: str | None = None) + +Set the value of “Static Friction”. + +* **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 “-“. + + + +#### SetSurfaceEnergy(value: str | float, unit: str | None = None) + +Set the value of “Surface Energy”. + +* **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 “J/m2”. + + + +#### SetTangentialStiffnessRatio(value: str | float, unit: str | None = None) + +Set the value of “Tangential Stiffness Ratio”. + +* **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 “-“. + + + +#### SetVelocityExponent(value: str | float, unit: str | None = None) + +Set the value of “Velocity Exponent”. + +* **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 “-“. + + + +#### SetVelocityLimit(value: str | float, unit: str | None = None) + +Set the value of “Velocity Limit”. + +* **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/s”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteractionCollection.md b/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteractionCollection.md index 342331d978..e3402015f5 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteractionCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMaterialsInteractionCollection.md @@ -1,71 +1,72 @@ - - -# RAMaterialsInteractionCollection - - - - - - -### *class* RAMaterialsInteractionCollection - -Rocky PrePost Scripting wrapper for the collection of materials interactions in a project. - -This wrapper corresponds to the “Materials Interactions” item on the project’s data tree. Retrieve -the [`RAMaterialsInteractionCollection`](#generated.RAMaterialsInteractionCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: - -```python -interaction_collection = RAMaterialCollection.GetMaterialsInteractionCollection() -``` - -Instances of the [`RAMaterialsInteractionCollection`](#generated.RAMaterialsInteractionCollection) class act as regular Python lists and can be -iterated on, individual materials accessed via index, etc: - -```python -interaction_1 = interaction_collection[3] -for interaction in interaction_collection: - interaction.SetAdhesiveFraction(80, '%') -interaction_2 = interaction_collection.GetMaterialsInteraction('Default Particles', 'Default Boundaries') -``` - -Note that individual interactions can’t be created or removed by the user: they are created and -removed as necessary as new materials are created or removed. - -Items in this list are of type [`RAMaterialsInteraction`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction). - -**Methods:** - -| [`Clear`](#generated.RAMaterialsInteractionCollection.Clear)() | Unused: Materials Interactions are automatically deleted when Materials are created. | -|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| -| [`GetMaterialsInteraction`](#generated.RAMaterialsInteractionCollection.GetMaterialsInteraction)(material_1, material_2) | Get the materials interaction for the given pair of materials. | -| [`New`](#generated.RAMaterialsInteractionCollection.New)() | Unused: Materials Interactions are automatically created when Materials are created. | -| [`Remove`](#generated.RAMaterialsInteractionCollection.Remove)(item) | Unused: Materials Interactions are automatically deleted when Materials are created. | - - - -#### Clear() - -Unused: Materials Interactions are automatically deleted when Materials are created. - - - -#### GetMaterialsInteraction(material_1, material_2) - -Get the materials interaction for the given pair of materials. - -For both material_1 and material_2 parameters, the parameter can be either an instance -of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) or the material’s name. - - - -#### New() - -Unused: Materials Interactions are automatically created when Materials are created. - - - -#### Remove(item) - -Unused: Materials Interactions are automatically deleted when Materials are created. + + +# RAMaterialsInteractionCollection + + + + + + +### *class* RAMaterialsInteractionCollection + +Rocky PrePost Scripting wrapper for the collection of materials interactions in a project. + +This wrapper corresponds to the “Materials Interactions” item on the project’s data tree. Retrieve +the [`RAMaterialsInteractionCollection`](#generated.RAMaterialsInteractionCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: + +```python +interaction_collection = RAMaterialCollection.GetMaterialsInteractionCollection() +``` + +Instances of the [`RAMaterialsInteractionCollection`](#generated.RAMaterialsInteractionCollection) class act as regular Python lists and can be +iterated on, individual materials accessed via index, etc: + +```python +interaction_1 = interaction_collection[3] +for interaction in interaction_collection: + interaction.SetAdhesiveFraction(80, '%') +interaction_2 = interaction_collection.GetMaterialsInteraction('Default Particles', 'Default Boundaries') +``` + +Note that individual interactions can’t be created or removed by the user: they are created and +removed as necessary as new materials are created or removed. + +Items in this list are of type [`RAMaterialsInteraction`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction). + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| [`Clear`](#generated.RAMaterialsInteractionCollection.Clear)() | Unused: Materials Interactions are automatically deleted when Materials are created. | +| [`GetMaterialsInteraction`](#generated.RAMaterialsInteractionCollection.GetMaterialsInteraction)(material_1, material_2) | Get the materials interaction for the given pair of materials. | +| [`New`](#generated.RAMaterialsInteractionCollection.New)() | Unused: Materials Interactions are automatically created when Materials are created. | +| [`Remove`](#generated.RAMaterialsInteractionCollection.Remove)(item) | Unused: Materials Interactions are automatically deleted when Materials are created. | + + + +#### Clear() + +Unused: Materials Interactions are automatically deleted when Materials are created. + + + +#### GetMaterialsInteraction(material_1, material_2) + +Get the materials interaction for the given pair of materials. + +For both material_1 and material_2 parameters, the parameter can be either an instance +of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) or the material’s name. + + + +#### New() + +Unused: Materials Interactions are automatically created when Materials are created. + + + +#### Remove(item) + +Unused: Materials Interactions are automatically deleted when Materials are created. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMeshColoring.md b/2025R2/rocky-prepost-scripting-manual/RAMeshColoring.md index d20ef2ca98..3fc26d66d7 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMeshColoring.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMeshColoring.md @@ -1,574 +1,575 @@ - - -# RAMeshColoring - - - - - - -### *class* RAMeshColoring - -Rocky PrePost Scripting wrapper to manipulate Mesh Colorings. - -This wrapper can be accessed via the project’s classes `GetMeshColoring` that allow -coloring: - -```python -window = app.Create3DWindow('Win 01') -particles = study.GetParticles() -particles_coloring = particles.GetMeshColoring('Win 01') -particles_coloring.SetNodeVisible(True) -``` - -Valid coloring modes, i.e. Node, Edges, Faces or Vectors can be accessed via -[`GetValidColoringModes`](#generated.RAMeshColoring.GetValidColoringModes). The property being shown can be additionally modified: - -```python -particles_coloring.SetNodeGridFunction(None) # for solid colors -particles_coloring.SetNodeColor((1.0, 1.0, 1.0)) -particles_coloring.SetNodeGridFunction('Absolute Rotational Velocity') # for properties -``` - -**Methods:** - -| [`GetAvailableGridFunctions`](#generated.RAMeshColoring.GetAvailableGridFunctions)() | Get a list of all possible values for "GridFunctions". | -|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| -| [`GetAvailableGridFunctionsNames`](#generated.RAMeshColoring.GetAvailableGridFunctionsNames)() | Get a list of all possible values for "GridFunctions" names. | -| [`GetAvailableVectorGridFunctions`](#generated.RAMeshColoring.GetAvailableVectorGridFunctions)() | Get a list of all possible values for Vector "GridFunctions". | -| [`GetAvailableVectorGridFunctionsNames`](#generated.RAMeshColoring.GetAvailableVectorGridFunctionsNames)() | Get a list of all possible values for Vector "GridFunctions" names. | -| [`GetEdgeColor`](#generated.RAMeshColoring.GetEdgeColor)() | Get the value of "Edge Color". | -| [`GetEdgeGridFunction`](#generated.RAMeshColoring.GetEdgeGridFunction)() | Get the value of "Edge GridFunction". | -| [`GetEdgeLineWidth`](#generated.RAMeshColoring.GetEdgeLineWidth)() | Get the value of "Edge Line Width". | -| [`GetEdgeVisible`](#generated.RAMeshColoring.GetEdgeVisible)() | Get the value of "Edge Visible". | -| [`GetFaceColor`](#generated.RAMeshColoring.GetFaceColor)() | Get the value of "Face Color". | -| [`GetFaceCustomStructuredPartitions`](#generated.RAMeshColoring.GetFaceCustomStructuredPartitions)() | Get the value of "Face Custom Structured Partitions". | -| [`GetFaceGridFunction`](#generated.RAMeshColoring.GetFaceGridFunction)() | Get the value of "Face GridFunction". | -| [`GetFaceScope`](#generated.RAMeshColoring.GetFaceScope)() | Get "Face Scope" as a string. | -| [`GetFaceShowOnNode`](#generated.RAMeshColoring.GetFaceShowOnNode)() | Get the value of "Show On Node". | -| [`GetFaceStructuredPartitions`](#generated.RAMeshColoring.GetFaceStructuredPartitions)() | Get "Face Structured Partitions" as a string. | -| [`GetFaceVisible`](#generated.RAMeshColoring.GetFaceVisible)() | Get the value of "Face Visible". | -| [`GetLevelOfDetail`](#generated.RAMeshColoring.GetLevelOfDetail)() | Get "Level of Detail" as a string. | -| [`GetNodeColor`](#generated.RAMeshColoring.GetNodeColor)() | Get the value of "Node Color". | -| [`GetNodeGridFunction`](#generated.RAMeshColoring.GetNodeGridFunction)() | Get the value of "Node GridFunction". | -| [`GetNodePointSize`](#generated.RAMeshColoring.GetNodePointSize)() | Get the value of "Node Point Size". | -| [`GetNodeVisible`](#generated.RAMeshColoring.GetNodeVisible)() | Get the value of "Node Visible". | -| [`GetNormalizedVectorsEnabled`](#generated.RAMeshColoring.GetNormalizedVectorsEnabled)() | Get the value of "Normalized Vector". | -| [`GetStride`](#generated.RAMeshColoring.GetStride)() | Get the value of "Stride". | -| [`GetTransparency`](#generated.RAMeshColoring.GetTransparency)() | Get the value of "Transparency". | -| [`GetTransparencyEnabled`](#generated.RAMeshColoring.GetTransparencyEnabled)() | Get the value of "Transparency". | -| [`GetValidColoringModes`](#generated.RAMeshColoring.GetValidColoringModes)() | Get a list with all possible coloring modes names. | -| [`GetValidFaceCustomStructuredPartitions`](#generated.RAMeshColoring.GetValidFaceCustomStructuredPartitions)() | Get a list of all possible values for "Face Custom Structured Partitions". | -| [`GetValidFaceScopes`](#generated.RAMeshColoring.GetValidFaceScopes)() | Get a list of all possible values for "Face Scope". | -| [`GetValidFaceStructuredPartitionsValues`](#generated.RAMeshColoring.GetValidFaceStructuredPartitionsValues)() | Get a list of all possible values for "Face Structured Partitions". | -| [`GetValidLevelOfDetailValues`](#generated.RAMeshColoring.GetValidLevelOfDetailValues)() | Get a list of all possible values for "Level of Detail". | -| [`GetVectorGridFunction`](#generated.RAMeshColoring.GetVectorGridFunction)() | Get the value of "Vector GridFunction". | -| [`GetVectorScale`](#generated.RAMeshColoring.GetVectorScale)() | Get the value of "Vector Scale". | -| [`GetVectorVisible`](#generated.RAMeshColoring.GetVectorVisible)() | Get the value of "Vector Visible". | -| [`GetVisible`](#generated.RAMeshColoring.GetVisible)() | Get the value of "Visible". | -| [`SetEdgeColor`](#generated.RAMeshColoring.SetEdgeColor)(values) | Set the values of "Edge Color". | -| [`SetEdgeGridFunction`](#generated.RAMeshColoring.SetEdgeGridFunction)(value) | Set the values of "Edge GridFunction". | -| [`SetEdgeLineWidth`](#generated.RAMeshColoring.SetEdgeLineWidth)(value) | Set the value of "Edge Line Width". | -| [`SetEdgeVisible`](#generated.RAMeshColoring.SetEdgeVisible)(value) | Set the value of "Edge Visible". | -| [`SetFaceColor`](#generated.RAMeshColoring.SetFaceColor)(values) | Set the values of "Face Color". | -| [`SetFaceCustomStructuredPartitions`](#generated.RAMeshColoring.SetFaceCustomStructuredPartitions)(values) | Set the value of "Face Custom Structured Partitions". | -| [`SetFaceGridFunction`](#generated.RAMeshColoring.SetFaceGridFunction)(value) | Set the values of "Face GridFunction". | -| [`SetFaceScope`](#generated.RAMeshColoring.SetFaceScope)(value) | Set the value of "Face Scope". | -| [`SetFaceShowOnNode`](#generated.RAMeshColoring.SetFaceShowOnNode)(value) | Set the value of "Show On Node". | -| [`SetFaceStructuredPartitions`](#generated.RAMeshColoring.SetFaceStructuredPartitions)(value) | Set the value of "Face Structured Partitions". | -| [`SetFaceVisible`](#generated.RAMeshColoring.SetFaceVisible)(value) | Set the value of "Face Visible". | -| [`SetLevelOfDetail`](#generated.RAMeshColoring.SetLevelOfDetail)(value) | Set the value of "Level of Detail". | -| [`SetNodeColor`](#generated.RAMeshColoring.SetNodeColor)(values) | Set the values of "Node Color". | -| [`SetNodeGridFunction`](#generated.RAMeshColoring.SetNodeGridFunction)(value) | Set the values of "Node GridFunction". | -| [`SetNodePointSize`](#generated.RAMeshColoring.SetNodePointSize)(value) | Set the value of "Node Point Size". | -| [`SetNodeVisible`](#generated.RAMeshColoring.SetNodeVisible)(value) | Set the value of "Node Visible". | -| [`SetNormalizedVectorsEnabled`](#generated.RAMeshColoring.SetNormalizedVectorsEnabled)(value) | Set the value of "Normalized Vectors". | -| [`SetStride`](#generated.RAMeshColoring.SetStride)(value) | Set the value of "Stride". | -| [`SetTransparency`](#generated.RAMeshColoring.SetTransparency)(value) | Set the value of "Transparency". | -| [`SetTransparencyEnabled`](#generated.RAMeshColoring.SetTransparencyEnabled)(value) | Set the value of "Transparency". | -| [`SetVectorGridFunction`](#generated.RAMeshColoring.SetVectorGridFunction)(value) | Set the values of "Vector GridFunction". | -| [`SetVectorScale`](#generated.RAMeshColoring.SetVectorScale)(value) | Set the value of "Vector Scale". | -| [`SetVectorVisible`](#generated.RAMeshColoring.SetVectorVisible)(value) | Set the value of "Vector Visible". | -| [`SetVisible`](#generated.RAMeshColoring.SetVisible)(value) | Set the value of "Visible". | - - - -#### GetAvailableGridFunctions() - -Get a list of all possible values for “GridFunctions”. - -* **Returns:** - The returned set contains the SemanticAssociation of the available Grid Functions. - - - -#### GetAvailableGridFunctionsNames() - -Get a list of all possible values for “GridFunctions” names. - -* **Returns:** - The returned set contains the names of the available Grid Functions. - - - -#### GetAvailableVectorGridFunctions() - -Get a list of all possible values for Vector “GridFunctions”. - -* **Returns:** - The returned set contains the SemanticAssociation of the available Vector Grid - Functions. - - - -#### GetAvailableVectorGridFunctionsNames() - -Get a list of all possible values for Vector “GridFunctions” names. - -* **Returns:** - The returned set contains the names of the available Vector Grid Functions. - - - -#### GetEdgeColor() - -Get the value of “Edge Color”. - - - -#### GetEdgeGridFunction() - -Get the value of “Edge GridFunction”. - - - -#### GetEdgeLineWidth() - -Get the value of “Edge Line Width”. - - - -#### GetEdgeVisible() - -Get the value of “Edge Visible”. - - - -#### GetFaceColor() - -Get the value of “Face Color”. - - - -#### GetFaceCustomStructuredPartitions() - -> Get the value of “Face Custom Structured Partitions”. -* **Returns:** - The returned value will be a combination of [‘Top’, ‘Bottom’, ‘North’, ‘South’, ‘East’, - ‘West’]. - - - -#### GetFaceGridFunction() - -Get the value of “Face GridFunction”. - - - -#### GetFaceScope() - -Get “Face Scope” as a string. - -* **Returns:** - The return will be one of the “GetValidFaceScopes” values. - - - -#### GetFaceShowOnNode() - -Get the value of “Show On Node”. - - - -#### GetFaceStructuredPartitions() - -Get “Face Structured Partitions” as a string. - -* **Returns:** - The returned value will be one of [‘All’, ‘Custom…’]. - - - -#### GetFaceVisible() - -Get the value of “Face Visible”. - - - -#### GetLevelOfDetail() - -Get “Level of Detail” as a string. - -* **Returns:** - The returned value will be one of [‘Rich’, ‘Automatic’, ‘Simple’]. - - - -#### GetNodeColor() - -Get the value of “Node Color”. - - - -#### GetNodeGridFunction() - -Get the value of “Node GridFunction”. - - - -#### GetNodePointSize() - -Get the value of “Node Point Size”. - - - -#### GetNodeVisible() - -Get the value of “Node Visible”. - - - -#### GetNormalizedVectorsEnabled() - -Get the value of “Normalized Vector”. - - - -#### GetStride() - -Get the value of “Stride”. - - - -#### GetTransparency() - -Get the value of “Transparency”. - - - -#### GetTransparencyEnabled() - -Get the value of “Transparency”. - - - -#### GetValidColoringModes() - -Get a list with all possible coloring modes names. - -* **Returns:** - The returned values will be a combination of [‘Node’, ‘Edge’, ‘Face’, ‘Vector’] - - - -#### GetValidFaceCustomStructuredPartitions() - -Get a list of all possible values for “Face Custom Structured Partitions”. - -> * **return:** -> The returned list is [‘Top’, ‘Bottom’, ‘North’, ‘South’, ‘East’, ‘West’]. - - - -#### GetValidFaceScopes() - -Get a list of all possible values for “Face Scope”. - -* **Returns:** - The returned list with the valid scope options. - - - -#### GetValidFaceStructuredPartitionsValues() - -Get a list of all possible values for “Face Structured Partitions”. - -* **Returns:** - The returned list is [‘All’, ‘Custom…’]. - - - -#### GetValidLevelOfDetailValues() - -Get a list of all possible values for “Level of Detail”. - -* **Returns:** - The returned list is [‘Rich’, ‘Automatic’, ‘Simple’]. - - - -#### GetVectorGridFunction() - -Get the value of “Vector GridFunction”. - - - -#### GetVectorScale() - -Get the value of “Vector Scale”. - - - -#### GetVectorVisible() - -Get the value of “Vector Visible”. - - - -#### GetVisible() - -Get the value of “Visible”. - - - -#### SetEdgeColor(values: tuple[float, float, float]) - -Set the values of “Edge Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements or values is not a tuple. - - - -#### SetEdgeGridFunction(value: SemanticAssociation | str | None) - -Set the values of “Edge GridFunction”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. -* **Raises:** - **RockyApiError** – If value is not a valid type or is not available for the current coloring. - - - -#### SetEdgeLineWidth(value: float) - -Set the value of “Edge Line Width”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetEdgeVisible(value: bool) - -Set the value of “Edge Visible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFaceColor(values: tuple[float, float, float]) - -Set the values of “Face Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements or values is not a tuple. - - - -#### SetFaceCustomStructuredPartitions(values: list[str]) - -Set the value of “Face Custom Structured Partitions”. - -* **Parameters:** - **values** – A list containing all the custom partitions. -* **Raises:** - **RockyApiError** – If any of values is not a valid “Face Custom Structured Partitions” option. - - - -#### SetFaceGridFunction(value: SemanticAssociation | str | None) - -Set the values of “Face GridFunction”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. -* **Raises:** - **RockyApiError** – If value is not a valid type or is not available for the current coloring. - - - -#### SetFaceScope(value: str) - -Set the value of “Face Scope”. - -* **Parameters:** - **value** – The value to set. -* **Raises:** - **RockyApiError** – If value is not a valid “Face Scope” option. - - - -#### SetFaceShowOnNode(value: bool) - -Set the value of “Show On Node”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFaceStructuredPartitions(value: str) - -Set the value of “Face Structured Partitions”. - -* **Parameters:** - **value** – The value to set. -* **Raises:** - **RockyApiError** – If value is not a valid “Face Structured Partitions” option. - - - -#### SetFaceVisible(value: bool) - -Set the value of “Face Visible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetLevelOfDetail(value: str) - -Set the value of “Level of Detail”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘Rich’, ‘Automatic’, ‘Simple’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Level of Detail” option. - - - -#### SetNodeColor(values: tuple[float, float, float]) - -Set the values of “Node Color”. - -* **Parameters:** - **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements or values is not a tuple. - - - -#### SetNodeGridFunction(value: SemanticAssociation | str | None) - -Set the values of “Node GridFunction”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. -* **Raises:** - **RockyApiError** – If value is not a valid type or is not available for the current coloring. - - - -#### SetNodePointSize(value: float) - -Set the value of “Node Point Size”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetNodeVisible(value: bool) - -Set the value of “Node Visible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetNormalizedVectorsEnabled(value: bool) - -Set the value of “Normalized Vectors”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetStride(value: int) - -Set the value of “Stride”. - -* **Parameters:** - **value** – The value to set. This value must be an int type. - - - -#### SetTransparency(value: float) - -Set the value of “Transparency”. - -* **Parameters:** - **value** – The value to set. This value must be a float type between 0 and 100. - - - -#### SetTransparencyEnabled(value: bool) - -Set the value of “Transparency”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetVectorGridFunction(value: SemanticAssociation | str | None) - -Set the values of “Vector GridFunction”. - -* **Parameters:** - **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str - of its name or None for solid colors. -* **Raises:** - **RockyApiError** – If value is not a valid type or is not available for the current coloring. - - - -#### SetVectorScale(value: float) - -Set the value of “Vector Scale”. - -* **Parameters:** - **value** – The value to set. This value must be a float type. - - - -#### SetVectorVisible(value: bool) - -Set the value of “Vector Visible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetVisible(value: bool) - -Set the value of “Visible”. - -* **Parameters:** - **value** – The value to set. + + +# RAMeshColoring + + + + + + +### *class* RAMeshColoring + +Rocky PrePost Scripting wrapper to manipulate Mesh Colorings. + +This wrapper can be accessed via the project’s classes `GetMeshColoring` that allow +coloring: + +```python +window = app.Create3DWindow('Win 01') +particles = study.GetParticles() +particles_coloring = particles.GetMeshColoring('Win 01') +particles_coloring.SetNodeVisible(True) +``` + +Valid coloring modes, i.e. Node, Edges, Faces or Vectors can be accessed via +[`GetValidColoringModes`](#generated.RAMeshColoring.GetValidColoringModes). The property being shown can be additionally modified: + +```python +particles_coloring.SetNodeGridFunction(None) # for solid colors +particles_coloring.SetNodeColor((1.0, 1.0, 1.0)) +particles_coloring.SetNodeGridFunction('Absolute Rotational Velocity') # for properties +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| +| [`GetAvailableGridFunctions`](#generated.RAMeshColoring.GetAvailableGridFunctions)() | Get a list of all possible values for "GridFunctions". | +| [`GetAvailableGridFunctionsNames`](#generated.RAMeshColoring.GetAvailableGridFunctionsNames)() | Get a list of all possible values for "GridFunctions" names. | +| [`GetAvailableVectorGridFunctions`](#generated.RAMeshColoring.GetAvailableVectorGridFunctions)() | Get a list of all possible values for Vector "GridFunctions". | +| [`GetAvailableVectorGridFunctionsNames`](#generated.RAMeshColoring.GetAvailableVectorGridFunctionsNames)() | Get a list of all possible values for Vector "GridFunctions" names. | +| [`GetEdgeColor`](#generated.RAMeshColoring.GetEdgeColor)() | Get the value of "Edge Color". | +| [`GetEdgeGridFunction`](#generated.RAMeshColoring.GetEdgeGridFunction)() | Get the value of "Edge GridFunction". | +| [`GetEdgeLineWidth`](#generated.RAMeshColoring.GetEdgeLineWidth)() | Get the value of "Edge Line Width". | +| [`GetEdgeVisible`](#generated.RAMeshColoring.GetEdgeVisible)() | Get the value of "Edge Visible". | +| [`GetFaceColor`](#generated.RAMeshColoring.GetFaceColor)() | Get the value of "Face Color". | +| [`GetFaceCustomStructuredPartitions`](#generated.RAMeshColoring.GetFaceCustomStructuredPartitions)() | Get the value of "Face Custom Structured Partitions". | +| [`GetFaceGridFunction`](#generated.RAMeshColoring.GetFaceGridFunction)() | Get the value of "Face GridFunction". | +| [`GetFaceScope`](#generated.RAMeshColoring.GetFaceScope)() | Get "Face Scope" as a string. | +| [`GetFaceShowOnNode`](#generated.RAMeshColoring.GetFaceShowOnNode)() | Get the value of "Show On Node". | +| [`GetFaceStructuredPartitions`](#generated.RAMeshColoring.GetFaceStructuredPartitions)() | Get "Face Structured Partitions" as a string. | +| [`GetFaceVisible`](#generated.RAMeshColoring.GetFaceVisible)() | Get the value of "Face Visible". | +| [`GetLevelOfDetail`](#generated.RAMeshColoring.GetLevelOfDetail)() | Get "Level of Detail" as a string. | +| [`GetNodeColor`](#generated.RAMeshColoring.GetNodeColor)() | Get the value of "Node Color". | +| [`GetNodeGridFunction`](#generated.RAMeshColoring.GetNodeGridFunction)() | Get the value of "Node GridFunction". | +| [`GetNodePointSize`](#generated.RAMeshColoring.GetNodePointSize)() | Get the value of "Node Point Size". | +| [`GetNodeVisible`](#generated.RAMeshColoring.GetNodeVisible)() | Get the value of "Node Visible". | +| [`GetNormalizedVectorsEnabled`](#generated.RAMeshColoring.GetNormalizedVectorsEnabled)() | Get the value of "Normalized Vector". | +| [`GetStride`](#generated.RAMeshColoring.GetStride)() | Get the value of "Stride". | +| [`GetTransparency`](#generated.RAMeshColoring.GetTransparency)() | Get the value of "Transparency". | +| [`GetTransparencyEnabled`](#generated.RAMeshColoring.GetTransparencyEnabled)() | Get the value of "Transparency". | +| [`GetValidColoringModes`](#generated.RAMeshColoring.GetValidColoringModes)() | Get a list with all possible coloring modes names. | +| [`GetValidFaceCustomStructuredPartitions`](#generated.RAMeshColoring.GetValidFaceCustomStructuredPartitions)() | Get a list of all possible values for "Face Custom Structured Partitions". | +| [`GetValidFaceScopes`](#generated.RAMeshColoring.GetValidFaceScopes)() | Get a list of all possible values for "Face Scope". | +| [`GetValidFaceStructuredPartitionsValues`](#generated.RAMeshColoring.GetValidFaceStructuredPartitionsValues)() | Get a list of all possible values for "Face Structured Partitions". | +| [`GetValidLevelOfDetailValues`](#generated.RAMeshColoring.GetValidLevelOfDetailValues)() | Get a list of all possible values for "Level of Detail". | +| [`GetVectorGridFunction`](#generated.RAMeshColoring.GetVectorGridFunction)() | Get the value of "Vector GridFunction". | +| [`GetVectorScale`](#generated.RAMeshColoring.GetVectorScale)() | Get the value of "Vector Scale". | +| [`GetVectorVisible`](#generated.RAMeshColoring.GetVectorVisible)() | Get the value of "Vector Visible". | +| [`GetVisible`](#generated.RAMeshColoring.GetVisible)() | Get the value of "Visible". | +| [`SetEdgeColor`](#generated.RAMeshColoring.SetEdgeColor)(values) | Set the values of "Edge Color". | +| [`SetEdgeGridFunction`](#generated.RAMeshColoring.SetEdgeGridFunction)(value) | Set the values of "Edge GridFunction". | +| [`SetEdgeLineWidth`](#generated.RAMeshColoring.SetEdgeLineWidth)(value) | Set the value of "Edge Line Width". | +| [`SetEdgeVisible`](#generated.RAMeshColoring.SetEdgeVisible)(value) | Set the value of "Edge Visible". | +| [`SetFaceColor`](#generated.RAMeshColoring.SetFaceColor)(values) | Set the values of "Face Color". | +| [`SetFaceCustomStructuredPartitions`](#generated.RAMeshColoring.SetFaceCustomStructuredPartitions)(values) | Set the value of "Face Custom Structured Partitions". | +| [`SetFaceGridFunction`](#generated.RAMeshColoring.SetFaceGridFunction)(value) | Set the values of "Face GridFunction". | +| [`SetFaceScope`](#generated.RAMeshColoring.SetFaceScope)(value) | Set the value of "Face Scope". | +| [`SetFaceShowOnNode`](#generated.RAMeshColoring.SetFaceShowOnNode)(value) | Set the value of "Show On Node". | +| [`SetFaceStructuredPartitions`](#generated.RAMeshColoring.SetFaceStructuredPartitions)(value) | Set the value of "Face Structured Partitions". | +| [`SetFaceVisible`](#generated.RAMeshColoring.SetFaceVisible)(value) | Set the value of "Face Visible". | +| [`SetLevelOfDetail`](#generated.RAMeshColoring.SetLevelOfDetail)(value) | Set the value of "Level of Detail". | +| [`SetNodeColor`](#generated.RAMeshColoring.SetNodeColor)(values) | Set the values of "Node Color". | +| [`SetNodeGridFunction`](#generated.RAMeshColoring.SetNodeGridFunction)(value) | Set the values of "Node GridFunction". | +| [`SetNodePointSize`](#generated.RAMeshColoring.SetNodePointSize)(value) | Set the value of "Node Point Size". | +| [`SetNodeVisible`](#generated.RAMeshColoring.SetNodeVisible)(value) | Set the value of "Node Visible". | +| [`SetNormalizedVectorsEnabled`](#generated.RAMeshColoring.SetNormalizedVectorsEnabled)(value) | Set the value of "Normalized Vectors". | +| [`SetStride`](#generated.RAMeshColoring.SetStride)(value) | Set the value of "Stride". | +| [`SetTransparency`](#generated.RAMeshColoring.SetTransparency)(value) | Set the value of "Transparency". | +| [`SetTransparencyEnabled`](#generated.RAMeshColoring.SetTransparencyEnabled)(value) | Set the value of "Transparency". | +| [`SetVectorGridFunction`](#generated.RAMeshColoring.SetVectorGridFunction)(value) | Set the values of "Vector GridFunction". | +| [`SetVectorScale`](#generated.RAMeshColoring.SetVectorScale)(value) | Set the value of "Vector Scale". | +| [`SetVectorVisible`](#generated.RAMeshColoring.SetVectorVisible)(value) | Set the value of "Vector Visible". | +| [`SetVisible`](#generated.RAMeshColoring.SetVisible)(value) | Set the value of "Visible". | + + + +#### GetAvailableGridFunctions() + +Get a list of all possible values for “GridFunctions”. + +* **Returns:** + The returned set contains the SemanticAssociation of the available Grid Functions. + + + +#### GetAvailableGridFunctionsNames() + +Get a list of all possible values for “GridFunctions” names. + +* **Returns:** + The returned set contains the names of the available Grid Functions. + + + +#### GetAvailableVectorGridFunctions() + +Get a list of all possible values for Vector “GridFunctions”. + +* **Returns:** + The returned set contains the SemanticAssociation of the available Vector Grid + Functions. + + + +#### GetAvailableVectorGridFunctionsNames() + +Get a list of all possible values for Vector “GridFunctions” names. + +* **Returns:** + The returned set contains the names of the available Vector Grid Functions. + + + +#### GetEdgeColor() + +Get the value of “Edge Color”. + + + +#### GetEdgeGridFunction() + +Get the value of “Edge GridFunction”. + + + +#### GetEdgeLineWidth() + +Get the value of “Edge Line Width”. + + + +#### GetEdgeVisible() + +Get the value of “Edge Visible”. + + + +#### GetFaceColor() + +Get the value of “Face Color”. + + + +#### GetFaceCustomStructuredPartitions() + +> Get the value of “Face Custom Structured Partitions”. +* **Returns:** + The returned value will be a combination of [‘Top’, ‘Bottom’, ‘North’, ‘South’, ‘East’, + ‘West’]. + + + +#### GetFaceGridFunction() + +Get the value of “Face GridFunction”. + + + +#### GetFaceScope() + +Get “Face Scope” as a string. + +* **Returns:** + The return will be one of the “GetValidFaceScopes” values. + + + +#### GetFaceShowOnNode() + +Get the value of “Show On Node”. + + + +#### GetFaceStructuredPartitions() + +Get “Face Structured Partitions” as a string. + +* **Returns:** + The returned value will be one of [‘All’, ‘Custom…’]. + + + +#### GetFaceVisible() + +Get the value of “Face Visible”. + + + +#### GetLevelOfDetail() + +Get “Level of Detail” as a string. + +* **Returns:** + The returned value will be one of [‘Rich’, ‘Automatic’, ‘Simple’]. + + + +#### GetNodeColor() + +Get the value of “Node Color”. + + + +#### GetNodeGridFunction() + +Get the value of “Node GridFunction”. + + + +#### GetNodePointSize() + +Get the value of “Node Point Size”. + + + +#### GetNodeVisible() + +Get the value of “Node Visible”. + + + +#### GetNormalizedVectorsEnabled() + +Get the value of “Normalized Vector”. + + + +#### GetStride() + +Get the value of “Stride”. + + + +#### GetTransparency() + +Get the value of “Transparency”. + + + +#### GetTransparencyEnabled() + +Get the value of “Transparency”. + + + +#### GetValidColoringModes() + +Get a list with all possible coloring modes names. + +* **Returns:** + The returned values will be a combination of [‘Node’, ‘Edge’, ‘Face’, ‘Vector’] + + + +#### GetValidFaceCustomStructuredPartitions() + +Get a list of all possible values for “Face Custom Structured Partitions”. + +> * **return:** +> The returned list is [‘Top’, ‘Bottom’, ‘North’, ‘South’, ‘East’, ‘West’]. + + + +#### GetValidFaceScopes() + +Get a list of all possible values for “Face Scope”. + +* **Returns:** + The returned list with the valid scope options. + + + +#### GetValidFaceStructuredPartitionsValues() + +Get a list of all possible values for “Face Structured Partitions”. + +* **Returns:** + The returned list is [‘All’, ‘Custom…’]. + + + +#### GetValidLevelOfDetailValues() + +Get a list of all possible values for “Level of Detail”. + +* **Returns:** + The returned list is [‘Rich’, ‘Automatic’, ‘Simple’]. + + + +#### GetVectorGridFunction() + +Get the value of “Vector GridFunction”. + + + +#### GetVectorScale() + +Get the value of “Vector Scale”. + + + +#### GetVectorVisible() + +Get the value of “Vector Visible”. + + + +#### GetVisible() + +Get the value of “Visible”. + + + +#### SetEdgeColor(values: tuple[float, float, float]) + +Set the values of “Edge Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements or values is not a tuple. + + + +#### SetEdgeGridFunction(value: SemanticAssociation | str | None) + +Set the values of “Edge GridFunction”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. +* **Raises:** + **RockyApiError** – If value is not a valid type or is not available for the current coloring. + + + +#### SetEdgeLineWidth(value: float) + +Set the value of “Edge Line Width”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetEdgeVisible(value: bool) + +Set the value of “Edge Visible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFaceColor(values: tuple[float, float, float]) + +Set the values of “Face Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements or values is not a tuple. + + + +#### SetFaceCustomStructuredPartitions(values: list[str]) + +Set the value of “Face Custom Structured Partitions”. + +* **Parameters:** + **values** – A list containing all the custom partitions. +* **Raises:** + **RockyApiError** – If any of values is not a valid “Face Custom Structured Partitions” option. + + + +#### SetFaceGridFunction(value: SemanticAssociation | str | None) + +Set the values of “Face GridFunction”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. +* **Raises:** + **RockyApiError** – If value is not a valid type or is not available for the current coloring. + + + +#### SetFaceScope(value: str) + +Set the value of “Face Scope”. + +* **Parameters:** + **value** – The value to set. +* **Raises:** + **RockyApiError** – If value is not a valid “Face Scope” option. + + + +#### SetFaceShowOnNode(value: bool) + +Set the value of “Show On Node”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFaceStructuredPartitions(value: str) + +Set the value of “Face Structured Partitions”. + +* **Parameters:** + **value** – The value to set. +* **Raises:** + **RockyApiError** – If value is not a valid “Face Structured Partitions” option. + + + +#### SetFaceVisible(value: bool) + +Set the value of “Face Visible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetLevelOfDetail(value: str) + +Set the value of “Level of Detail”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘Rich’, ‘Automatic’, ‘Simple’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Level of Detail” option. + + + +#### SetNodeColor(values: tuple[float, float, float]) + +Set the values of “Node Color”. + +* **Parameters:** + **values** – The values to set. The values must be a tuple of floats. Must have exactly 3 elements. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements or values is not a tuple. + + + +#### SetNodeGridFunction(value: SemanticAssociation | str | None) + +Set the values of “Node GridFunction”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. +* **Raises:** + **RockyApiError** – If value is not a valid type or is not available for the current coloring. + + + +#### SetNodePointSize(value: float) + +Set the value of “Node Point Size”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetNodeVisible(value: bool) + +Set the value of “Node Visible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetNormalizedVectorsEnabled(value: bool) + +Set the value of “Normalized Vectors”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetStride(value: int) + +Set the value of “Stride”. + +* **Parameters:** + **value** – The value to set. This value must be an int type. + + + +#### SetTransparency(value: float) + +Set the value of “Transparency”. + +* **Parameters:** + **value** – The value to set. This value must be a float type between 0 and 100. + + + +#### SetTransparencyEnabled(value: bool) + +Set the value of “Transparency”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetVectorGridFunction(value: SemanticAssociation | str | None) + +Set the values of “Vector GridFunction”. + +* **Parameters:** + **value** – The value to set. The value can be heterogeneous, it can be a SemanticAssociation, a str + of its name or None for solid colors. +* **Raises:** + **RockyApiError** – If value is not a valid type or is not available for the current coloring. + + + +#### SetVectorScale(value: float) + +Set the value of “Vector Scale”. + +* **Parameters:** + **value** – The value to set. This value must be a float type. + + + +#### SetVectorVisible(value: bool) + +Set the value of “Vector Visible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetVisible(value: bool) + +Set the value of “Visible”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RAModule.md b/2025R2/rocky-prepost-scripting-manual/RAModule.md index 6c603607f6..b9fe67a4e3 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAModule.md +++ b/2025R2/rocky-prepost-scripting-manual/RAModule.md @@ -1,124 +1,125 @@ - - -# RAModule - - - - - - -### *class* RAModule - -Rocky PrePost Scripting wrapper for an individual module in a project, below the “Modules” -item. Retrieve individual module from the [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) via: - -```python -module_collection = study.GetModuleCollection() -module = module_collection.GetModule('Module Name') -``` - -**Methods:** - -| [`DisableModule`](#generated.RAModule.DisableModule)() | Disable the module. | -|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| -| [`EnableModule`](#generated.RAModule.EnableModule)() | Enable the module. | -| [`GetModuleProperties`](#generated.RAModule.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RAModule.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetOutputObject`](#generated.RAModule.GetOutputObject)() | Get the API object that represents this module's unique simulation results, if it exists. | -| [`GetValidOptionsForModuleProperty`](#generated.RAModule.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`IsModuleEnabled`](#generated.RAModule.IsModuleEnabled)() | Check if the module is enabled. | -| [`SetModuleEnabled`](#generated.RAModule.SetModuleEnabled)(enabled) | Enable or disable the module. | -| [`SetModuleProperty`](#generated.RAModule.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | - - - -#### DisableModule() - -Disable the module. - - - -#### EnableModule() - -Enable the module. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetOutputObject() - -Get the API object that represents this module’s unique simulation results, if it exists. - -Note that only modules that declare that they generate “unique” results (as opposed to new -properties/curves on existing items) will have an output object. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### IsModuleEnabled() - -Check if the module is enabled. - -* **Return type:** - bool - - - -#### SetModuleEnabled(enabled) - -Enable or disable the module. - -* **Parameters:** - **enabled** (*bool*) – Whether the module should be enabled (True) or disabled (False). - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. + + +# RAModule + + + + + + +### *class* RAModule + +Rocky PrePost Scripting wrapper for an individual module in a project, below the “Modules” +item. Retrieve individual module from the [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) via: + +```python +module_collection = study.GetModuleCollection() +module = module_collection.GetModule('Module Name') +``` + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| [`DisableModule`](#generated.RAModule.DisableModule)() | Disable the module. | +| [`EnableModule`](#generated.RAModule.EnableModule)() | Enable the module. | +| [`GetModuleProperties`](#generated.RAModule.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAModule.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetOutputObject`](#generated.RAModule.GetOutputObject)() | Get the API object that represents this module's unique simulation results, if it exists. | +| [`GetValidOptionsForModuleProperty`](#generated.RAModule.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`IsModuleEnabled`](#generated.RAModule.IsModuleEnabled)() | Check if the module is enabled. | +| [`SetModuleEnabled`](#generated.RAModule.SetModuleEnabled)(enabled) | Enable or disable the module. | +| [`SetModuleProperty`](#generated.RAModule.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | + + + +#### DisableModule() + +Disable the module. + + + +#### EnableModule() + +Enable the module. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetOutputObject() + +Get the API object that represents this module’s unique simulation results, if it exists. + +Note that only modules that declare that they generate “unique” results (as opposed to new +properties/curves on existing items) will have an output object. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### IsModuleEnabled() + +Check if the module is enabled. + +* **Return type:** + bool + + + +#### SetModuleEnabled(enabled) + +Enable or disable the module. + +* **Parameters:** + **enabled** (*bool*) – Whether the module should be enabled (True) or disabled (False). + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. diff --git a/2025R2/rocky-prepost-scripting-manual/RAModuleCollection.md b/2025R2/rocky-prepost-scripting-manual/RAModuleCollection.md index 46fcbe0d73..8b48c57b59 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAModuleCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAModuleCollection.md @@ -1,49 +1,50 @@ - - -# RAModuleCollection - - - - - - -### *class* RAModuleCollection - -Rocky PrePost Scripting wrapper for the collection of module in a project. - -This wrapper corresponds to the “Modules” item on the project’s data tree. Retrieve the -[`RAModuleCollection`](#generated.RAModuleCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: - -```python -module_collection = study.GetModuleCollection() -``` - -**Methods:** - -| [`GetEnabledModules`](#generated.RAModuleCollection.GetEnabledModules)() | Get the names of the enabled modules in project. | -|----------------------------------------------------------------------------|----------------------------------------------------| -| [`GetModule`](#generated.RAModuleCollection.GetModule)(module_name) | Get a module given its name. | -| [`GetModuleNames`](#generated.RAModuleCollection.GetModuleNames)() | Get the names of the modules in project. | - - - -#### GetEnabledModules() - -Get the names of the enabled modules in project. - - - -#### GetModule(module_name: str) - -Get a module given its name. - -* **Parameters:** - **module_name** – The name of the module to get. - - - -#### GetModuleNames() - -Get the names of the modules in project. + + +# RAModuleCollection + + + + + + +### *class* RAModuleCollection + +Rocky PrePost Scripting wrapper for the collection of module in a project. + +This wrapper corresponds to the “Modules” item on the project’s data tree. Retrieve the +[`RAModuleCollection`](#generated.RAModuleCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: + +```python +module_collection = study.GetModuleCollection() +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------|----------------------------------------------------| +| [`GetEnabledModules`](#generated.RAModuleCollection.GetEnabledModules)() | Get the names of the enabled modules in project. | +| [`GetModule`](#generated.RAModuleCollection.GetModule)(module_name) | Get a module given its name. | +| [`GetModuleNames`](#generated.RAModuleCollection.GetModuleNames)() | Get the names of the modules in project. | + + + +#### GetEnabledModules() + +Get the names of the enabled modules in project. + + + +#### GetModule(module_name: str) + +Get a module given its name. + +* **Parameters:** + **module_name** – The name of the module to get. + + + +#### GetModuleNames() + +Get the names of the modules in project. diff --git a/2025R2/rocky-prepost-scripting-manual/RAModuleOutput.md b/2025R2/rocky-prepost-scripting-manual/RAModuleOutput.md index ae0f1b7a7f..2bc7130773 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAModuleOutput.md +++ b/2025R2/rocky-prepost-scripting-manual/RAModuleOutput.md @@ -1,942 +1,943 @@ - - -# RAModuleOutput - - - - - - -### *class* RAModuleOutput - -Wrapper class for the object that represents a Module’s unique output. - -**Methods:** - -| [`AddCurve`](#generated.RAModuleOutput.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAModuleOutput.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.RAModuleOutput.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAModuleOutput.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAModuleOutput.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.RAModuleOutput.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAModuleOutput.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAModuleOutput.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.RAModuleOutput.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.RAModuleOutput.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.RAModuleOutput.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.RAModuleOutput.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAModuleOutput.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAModuleOutput.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAModuleOutput.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAModuleOutput.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAModuleOutput.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAModuleOutput.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAModuleOutput.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAModuleOutput.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAModuleOutput.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAModuleOutput.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAModuleOutput.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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). | -| [`GetNumpyCurve`](#generated.RAModuleOutput.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAModuleOutput.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RAModuleOutput.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RAModuleOutput.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAModuleOutput.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAModuleOutput.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAModuleOutput.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAModuleOutput.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAModuleOutput.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAModuleOutput.SetCurrentTimeStep)(time_step) | Sets the current time step. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + +# RAModuleOutput + + + + + + +### *class* RAModuleOutput + +Wrapper class for the object that represents a Module’s unique output. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAModuleOutput.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAModuleOutput.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.RAModuleOutput.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAModuleOutput.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAModuleOutput.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.RAModuleOutput.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAModuleOutput.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAModuleOutput.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.RAModuleOutput.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.RAModuleOutput.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.RAModuleOutput.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.RAModuleOutput.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAModuleOutput.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAModuleOutput.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAModuleOutput.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAModuleOutput.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAModuleOutput.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAModuleOutput.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAModuleOutput.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAModuleOutput.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAModuleOutput.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAModuleOutput.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAModuleOutput.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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). | +| [`GetNumpyCurve`](#generated.RAModuleOutput.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAModuleOutput.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RAModuleOutput.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RAModuleOutput.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAModuleOutput.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAModuleOutput.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAModuleOutput.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAModuleOutput.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAModuleOutput.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAModuleOutput.SetCurrentTimeStep)(time_step) | Sets the current time step. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. diff --git a/2025R2/rocky-prepost-scripting-manual/RAModulePropertyList.md b/2025R2/rocky-prepost-scripting-manual/RAModulePropertyList.md index a30957f31e..2eb4c6dc8d 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAModulePropertyList.md +++ b/2025R2/rocky-prepost-scripting-manual/RAModulePropertyList.md @@ -1,52 +1,53 @@ - - -# RAModulePropertyList - - - - - - -### *class* RAModulePropertyList - -Rocky PrePost Scripting wrapper for a Module property that is a list of other Modules properties. - -The wrapper corresponds to a table of module properties inside the editor of an individual -Module or a simulation entity. Such a list can be obtained via the PrePost Scripting wrapper for the object -that contains it (that is, a Module or simulation entity), via: - -```python -my_module = study.GetElement('My Module') -module_list = my_module.GetModuleProperty('List of Items') -``` - -The RAModulePropertyList supports iteration like regular lists and item manipulation via -[`New()`](#generated.RAModulePropertyList.New), [`Remove()`](#generated.RAModulePropertyList.Remove) and [`Clear()`](#generated.RAModulePropertyList.Clear). It contains items of type -[`RAModulePropertyListItem`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem). - -**Methods:** - -| [`Clear`](#generated.RAModulePropertyList.Clear)() | Remove all items from the list. | -|----------------------------------------------------------|-----------------------------------| -| [`New`](#generated.RAModulePropertyList.New)() | Add a new item. | -| [`Remove`](#generated.RAModulePropertyList.Remove)(item) | Remove an item from the list. | - - - -#### Clear() - -Remove all items from the list. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAModulePropertyList + + + + + + +### *class* RAModulePropertyList + +Rocky PrePost Scripting wrapper for a Module property that is a list of other Modules properties. + +The wrapper corresponds to a table of module properties inside the editor of an individual +Module or a simulation entity. Such a list can be obtained via the PrePost Scripting wrapper for the object +that contains it (that is, a Module or simulation entity), via: + +```python +my_module = study.GetElement('My Module') +module_list = my_module.GetModuleProperty('List of Items') +``` + +The RAModulePropertyList supports iteration like regular lists and item manipulation via +[`New()`](#generated.RAModulePropertyList.New), [`Remove()`](#generated.RAModulePropertyList.Remove) and [`Clear()`](#generated.RAModulePropertyList.Clear). It contains items of type +[`RAModulePropertyListItem`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem). + +**Methods:** + +| Name | Description | +|----------------------------------------------------------|-----------------------------------| +| [`Clear`](#generated.RAModulePropertyList.Clear)() | Remove all items from the list. | +| [`New`](#generated.RAModulePropertyList.New)() | Add a new item. | +| [`Remove`](#generated.RAModulePropertyList.Remove)(item) | Remove an item from the list. | + + + +#### Clear() + +Remove all items from the list. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAModulePropertyListItem.md b/2025R2/rocky-prepost-scripting-manual/RAModulePropertyListItem.md index 8f0936436a..de2841f464 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAModulePropertyListItem.md +++ b/2025R2/rocky-prepost-scripting-manual/RAModulePropertyListItem.md @@ -1,83 +1,84 @@ - - -# RAModulePropertyListItem - - - - - - -### *class* RAModulePropertyListItem - -Rocky PrePost Scripting wrapper for an item inside a [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - -The wrapper corresponds to a single row in a table of module properties inside the editor of -an individual Module or simulation entity. It is retrieved from its containing list, via: - -```python -my_module = study.GetElement('My Module') -module_list = my_module.GetModuleProperty('List of Items') -module_item = module_list.New() -``` - -**Methods:** - -| [`GetModuleProperties`](#generated.RAModulePropertyListItem.GetModuleProperties)() | Get the names of the module properties. | -|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| -| [`GetModuleProperty`](#generated.RAModulePropertyListItem.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetValidOptionsForModuleProperty`](#generated.RAModulePropertyListItem.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`SetModuleProperty`](#generated.RAModulePropertyListItem.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. + + +# RAModulePropertyListItem + + + + + + +### *class* RAModulePropertyListItem + +Rocky PrePost Scripting wrapper for an item inside a [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + +The wrapper corresponds to a single row in a table of module properties inside the editor of +an individual Module or simulation entity. It is retrieved from its containing list, via: + +```python +my_module = study.GetElement('My Module') +module_list = my_module.GetModuleProperty('List of Items') +module_item = module_list.New() +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [`GetModuleProperties`](#generated.RAModulePropertyListItem.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAModulePropertyListItem.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetValidOptionsForModuleProperty`](#generated.RAModulePropertyListItem.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`SetModuleProperty`](#generated.RAModulePropertyListItem.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMotion.md b/2025R2/rocky-prepost-scripting-manual/RAMotion.md index 2f7efccaef..9a09858644 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMotion.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMotion.md @@ -1,147 +1,148 @@ - - -# RAMotion - - - - - - -### *class* RAMotion - -Rocky PrePost Scripting wrapper representing a single Motion in a Motion Frame. - -Access individual motions via a [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame)’s motion list: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions[0] -motion_2 = motions.New() -``` - -Every [`RAMotion`](#generated.RAMotion) contains properties that are common to all motions (such as start -and stop times) and properties that are specific to the motion’s type (translation, vibration, -etc). These latter properties must be accessed by a “sub-object” that is retrieved via -[`GetTypeObject()`](#generated.RAMotion.GetTypeObject) after the specific motion type is configured via [`SetType()`](#generated.RAMotion.SetType). - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Translation') -translation = motion_1.GetTypeObject() -# `translation` is a RATranslation -translation.SetVelocity([1.0, 0.0, 0.0], 'm/s') -``` - -Refer to the specific PrePost Scripting wrappers for documentation on the individual motion types: - -* [`RATranslation`](RATranslation.md#generated.RATranslation) -* [`RARotation`](RARotation.md#generated.RARotation) -* [`RAPendulum`](RAPendulum.md#generated.RAPendulum) -* [`RAVibration`](RAVibration.md#generated.RAVibration) -* [`RAFreeBodyRotation`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation) -* [`RAFreeBodyTranslation`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation) -* [`RAPrescribedForce`](RAPrescribedForce.md#generated.RAPrescribedForce) -* [`RAPrescribedMoment`](RAPrescribedMoment.md#generated.RAPrescribedMoment) -* [`RASpringDashpotForce`](RASpringDashpotForce.md#generated.RASpringDashpotForce) -* [`RASpringDashpotMoment`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment) -* [`RALinearTimeVariableForce`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce) -* [`RALinearTimeVariableMoment`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment) -* [`RATimeSeriesTranslation`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation) -* [`RATimeSeriesRotation`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation) - -**Methods:** - -| [`GetStartTime`](#generated.RAMotion.GetStartTime)([unit]) | Get the value of "Start Time". | -|-------------------------------------------------------------------|---------------------------------------------------------------| -| [`GetStopTime`](#generated.RAMotion.GetStopTime)([unit]) | Get the value of "Stop Time". | -| [`GetType`](#generated.RAMotion.GetType)() | Get the concrete type of motion. | -| [`GetTypeObject`](#generated.RAMotion.GetTypeObject)() | Get the API object that wraps the specific motion type. | -| [`GetValidTypes`](#generated.RAMotion.GetValidTypes)() | Return a list with the possible values for the motion's type. | -| [`SetStartTime`](#generated.RAMotion.SetStartTime)(value[, unit]) | Set the value of "Start Time". | -| [`SetStopTime`](#generated.RAMotion.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | -| [`SetType`](#generated.RAMotion.SetType)(motion_type) | Set the concrete type of motion. | - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetStopTime(unit: str | None = None) - -Get the value of “Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetType() - -Get the concrete type of motion. - -* **Return type:** - unicode -* **Returns:** - A string describing the type of motion. The returned value will be one of the strings - in the “Type” drop-down menu in the UI. - - - -#### GetTypeObject() - -Get the API object that wraps the specific motion type. - -* **Return type:** - ApiElementItem - - - -#### GetValidTypes() - -Return a list with the possible values for the motion’s type. - -* **Return type:** - list(unicode) -* **Returns:** - A list of accepted values for SetType(). - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetStopTime(value: str | float, unit: str | None = None) - -Set the value of “Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetType(motion_type) - -Set the concrete type of motion. - -* **Parameters:** - **motion_type** (*unicode*) – The concrete motion type. Accepted values are the strings in the “Type” drop-down menu - in the UI. -* **Returns:** - The PrePost Scripting wrapper representing the concrete motion type. + + +# RAMotion + + + + + + +### *class* RAMotion + +Rocky PrePost Scripting wrapper representing a single Motion in a Motion Frame. + +Access individual motions via a [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame)’s motion list: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions[0] +motion_2 = motions.New() +``` + +Every [`RAMotion`](#generated.RAMotion) contains properties that are common to all motions (such as start +and stop times) and properties that are specific to the motion’s type (translation, vibration, +etc). These latter properties must be accessed by a “sub-object” that is retrieved via +[`GetTypeObject()`](#generated.RAMotion.GetTypeObject) after the specific motion type is configured via [`SetType()`](#generated.RAMotion.SetType). + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Translation') +translation = motion_1.GetTypeObject() +# `translation` is a RATranslation +translation.SetVelocity([1.0, 0.0, 0.0], 'm/s') +``` + +Refer to the specific PrePost Scripting wrappers for documentation on the individual motion types: + +* [`RATranslation`](RATranslation.md#generated.RATranslation) +* [`RARotation`](RARotation.md#generated.RARotation) +* [`RAPendulum`](RAPendulum.md#generated.RAPendulum) +* [`RAVibration`](RAVibration.md#generated.RAVibration) +* [`RAFreeBodyRotation`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation) +* [`RAFreeBodyTranslation`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation) +* [`RAPrescribedForce`](RAPrescribedForce.md#generated.RAPrescribedForce) +* [`RAPrescribedMoment`](RAPrescribedMoment.md#generated.RAPrescribedMoment) +* [`RASpringDashpotForce`](RASpringDashpotForce.md#generated.RASpringDashpotForce) +* [`RASpringDashpotMoment`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment) +* [`RALinearTimeVariableForce`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce) +* [`RALinearTimeVariableMoment`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment) +* [`RATimeSeriesTranslation`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation) +* [`RATimeSeriesRotation`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation) + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------|---------------------------------------------------------------| +| [`GetStartTime`](#generated.RAMotion.GetStartTime)([unit]) | Get the value of "Start Time". | +| [`GetStopTime`](#generated.RAMotion.GetStopTime)([unit]) | Get the value of "Stop Time". | +| [`GetType`](#generated.RAMotion.GetType)() | Get the concrete type of motion. | +| [`GetTypeObject`](#generated.RAMotion.GetTypeObject)() | Get the API object that wraps the specific motion type. | +| [`GetValidTypes`](#generated.RAMotion.GetValidTypes)() | Return a list with the possible values for the motion's type. | +| [`SetStartTime`](#generated.RAMotion.SetStartTime)(value[, unit]) | Set the value of "Start Time". | +| [`SetStopTime`](#generated.RAMotion.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | +| [`SetType`](#generated.RAMotion.SetType)(motion_type) | Set the concrete type of motion. | + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetStopTime(unit: str | None = None) + +Get the value of “Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetType() + +Get the concrete type of motion. + +* **Return type:** + unicode +* **Returns:** + A string describing the type of motion. The returned value will be one of the strings + in the “Type” drop-down menu in the UI. + + + +#### GetTypeObject() + +Get the API object that wraps the specific motion type. + +* **Return type:** + ApiElementItem + + + +#### GetValidTypes() + +Return a list with the possible values for the motion’s type. + +* **Return type:** + list(unicode) +* **Returns:** + A list of accepted values for SetType(). + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetStopTime(value: str | float, unit: str | None = None) + +Set the value of “Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetType(motion_type) + +Set the concrete type of motion. + +* **Parameters:** + **motion_type** (*unicode*) – The concrete motion type. Accepted values are the strings in the “Type” drop-down menu + in the UI. +* **Returns:** + The PrePost Scripting wrapper representing the concrete motion type. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMotionFrame.md b/2025R2/rocky-prepost-scripting-manual/RAMotionFrame.md index 8798b5a33c..688d50ca5d 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMotionFrame.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMotionFrame.md @@ -1,1484 +1,1485 @@ - - -# RAMotionFrame - - - - - - -### *class* RAMotionFrame - -Rocky PrePost Scripting wrapper for a motion frame. - -The class contains methods to configure a motion frame and its motions. There are some options -to retrieve a specific [`RAMotionFrame`](#generated.RAMotionFrame) in a project from a [`RAStudy`](RAStudy.md#generated.RAStudy), a -[`RAMotionFrameSource`](RAMotionFrameSource.md#generated.RAMotionFrameSource) or another [`RAMotionFrame`](#generated.RAMotionFrame): - -```python -# From the RAStudy -motion_frame = study.GetElement('') - -# From the RAMotionFrameSource -frame_source = study.GetMotionFrameSource() -motion_frame = frame_source.GetMotionFrame('') - -# From a "parent" motion frame -frame_1 = study.GetElement('') -frame_2 = frame_1.GetMotionFrame('') -``` - -A motion frame comprises frame properties (relative position, rotation angle, free body limits, -etc) and a list of motions. The properties are manipulated via direct Get\*() and Set\*() -methods, while the motions are accessed separately via the list returned by [`GetMotions()`](#generated.RAMotionFrame.GetMotions). - -Motion frames can be created on the “root” of the project’s motion frames (the source returned -in [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource)), or as a ‘child’ frame of a pre-existing motion frame: - -```python -frame_source = study.GetMotionFrameSource() - -# Create a motion frame with no parent frame -frame_1 = frame_source.NewFrame() -# Configure this new frame frame_1 -frame_1.SetRelativePosition(...) -frame_1.SetEnablePeriodicMotion(...) -# ... configure motions, etc. - -# Create a new frame, as a child of `frame_1` -frame_2 = frame_1.NewFrame() -# Configure this new frame frame_2 -frame_2.SetRelativePosition(...) -# ... configure motions, etc. -``` - -**Methods:** - -| [`AddCurve`](#generated.RAMotionFrame.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAMotionFrame.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.RAMotionFrame.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAMotionFrame.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`AddPendulumMotion`](#generated.RAMotionFrame.AddPendulumMotion)([start_time, stop_time, ...]) | Adds a pendulum motion to the frame. | -| [`AddRotationMotion`](#generated.RAMotionFrame.AddRotationMotion)([start_time, stop_time, ...]) | Adds a rotation motion to the frame. | -| [`AddTranslationMotion`](#generated.RAMotionFrame.AddTranslationMotion)([start_time, ...]) | Adds a translation motion to the frame. | -| [`AddVibrationMotion`](#generated.RAMotionFrame.AddVibrationMotion)([start_time, stop_time, ...]) | Adds a vibration motion to the frame. | -| [`ApplyTo`](#generated.RAMotionFrame.ApplyTo)(obj) | Link this motion frame to the given geometry. | -| [`CreateCurveOutputVariable`](#generated.RAMotionFrame.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.RAMotionFrame.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAMotionFrame.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAMotionFrame.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.RAMotionFrame.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.RAMotionFrame.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.RAMotionFrame.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.RAMotionFrame.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAMotionFrame.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAMotionFrame.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAMotionFrame.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAMotionFrame.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAMotionFrame.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAMotionFrame.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAMotionFrame.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAMotionFrame.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAMotionFrame.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAMotionFrame.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAMotionFrame.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAMotionFrame.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetElementCurve`](#generated.RAMotionFrame.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetEnableFbmAngularLimits`](#generated.RAMotionFrame.GetEnableFbmAngularLimits)() | Get the value of "Enable Fbm Angular Limits". | -| [`GetEnableFbmLinearLimits`](#generated.RAMotionFrame.GetEnableFbmLinearLimits)() | Get the value of "Enable Fbm Linear Limits". | -| [`GetEnablePeriodicMotion`](#generated.RAMotionFrame.GetEnablePeriodicMotion)() | Get the value of "Enable Periodic Motion". | -| [`GetFbmMaxAngularLimits`](#generated.RAMotionFrame.GetFbmMaxAngularLimits)([unit]) | Get the value of "Fbm Max Angular Limits". | -| [`GetFbmMaxLinearLimits`](#generated.RAMotionFrame.GetFbmMaxLinearLimits)([unit]) | Get the value of "Fbm Max Linear Limits". | -| [`GetFbmMinAngularLimits`](#generated.RAMotionFrame.GetFbmMinAngularLimits)([unit]) | Get the value of "Fbm Min Angular Limits". | -| [`GetFbmMinLinearLimits`](#generated.RAMotionFrame.GetFbmMinLinearLimits)([unit]) | Get the value of "Fbm Min Linear Limits". | -| [`GetGeometryQuantity`](#generated.RAMotionFrame.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`GetGeometryUnit`](#generated.RAMotionFrame.GetGeometryUnit)() | Get the grid's geometry's unit. | -| [`GetGridFunction`](#generated.RAMotionFrame.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAMotionFrame.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | -| [`GetKeepInPlace`](#generated.RAMotionFrame.GetKeepInPlace)() | Get the value of "Keep In Place". | -| [`GetMeshColoring`](#generated.RAMotionFrame.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMotionFrame`](#generated.RAMotionFrame.GetMotionFrame)(frame_name) | Get a specific motion frame given its name. | -| [`GetMotions`](#generated.RAMotionFrame.GetMotions)() | Get the list of motions in the motion frame. | -| [`GetNumberOfCells`](#generated.RAMotionFrame.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAMotionFrame.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAMotionFrame.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RAMotionFrame.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RAMotionFrame.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RAMotionFrame.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RAMotionFrame.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetParentMotionFrame`](#generated.RAMotionFrame.GetParentMotionFrame)() | Gets the parent motion frame. | -| [`GetPeriodicMotionPeriod`](#generated.RAMotionFrame.GetPeriodicMotionPeriod)([unit]) | Get the value of "Periodic Motion Period". | -| [`GetPeriodicMotionStartTime`](#generated.RAMotionFrame.GetPeriodicMotionStartTime)([unit]) | Get the value of "Periodic Motion Start Time". | -| [`GetPeriodicMotionStopTime`](#generated.RAMotionFrame.GetPeriodicMotionStopTime)([unit]) | Get the value of "Periodic Motion Stop Time". | -| [`GetRelativePosition`](#generated.RAMotionFrame.GetRelativePosition)([unit]) | Get the value of "Relative Position". | -| [`GetRelativeRotationVector`](#generated.RAMotionFrame.GetRelativeRotationVector)([unit]) | Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. | -| [`GetRotationAngle`](#generated.RAMotionFrame.GetRotationAngle)([unit]) | Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. | -| [`GetTimeSet`](#generated.RAMotionFrame.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAMotionFrame.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAMotionFrame.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAMotionFrame.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`HasGridFunction`](#generated.RAMotionFrame.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | -| [`IsCellActive`](#generated.RAMotionFrame.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IterCellVertices`](#generated.RAMotionFrame.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAMotionFrame.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterMotionFrames`](#generated.RAMotionFrame.IterMotionFrames)() | Iterates over all the motion frames available (recursively). | -| [`Modified`](#generated.RAMotionFrame.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`NewConeCrusherFrame`](#generated.RAMotionFrame.NewConeCrusherFrame)() | Creates a new cone crusher frame. | -| [`NewFrame`](#generated.RAMotionFrame.NewFrame)() | Creates a new motion frame. | -| [`RemoveCustomCurve`](#generated.RAMotionFrame.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAMotionFrame.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveFrame`](#generated.RAMotionFrame.RemoveFrame)(motion_frame) | Removes a previously-created motion frame. | -| [`RemoveOutputVariable`](#generated.RAMotionFrame.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAMotionFrame.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAMotionFrame.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetEnableFbmAngularLimits`](#generated.RAMotionFrame.SetEnableFbmAngularLimits)(value) | Set the value of "Enable Fbm Angular Limits". | -| [`SetEnableFbmLinearLimits`](#generated.RAMotionFrame.SetEnableFbmLinearLimits)(value) | Set the value of "Enable Fbm Linear Limits". | -| [`SetEnablePeriodicMotion`](#generated.RAMotionFrame.SetEnablePeriodicMotion)(value) | Set the value of "Enable Periodic Motion". | -| [`SetFbmMaxAngularLimits`](#generated.RAMotionFrame.SetFbmMaxAngularLimits)(values[, unit]) | Set the values of "Fbm Max Angular Limits". | -| [`SetFbmMaxLinearLimits`](#generated.RAMotionFrame.SetFbmMaxLinearLimits)(values[, unit]) | Set the values of "Fbm Max Linear Limits". | -| [`SetFbmMinAngularLimits`](#generated.RAMotionFrame.SetFbmMinAngularLimits)(values[, unit]) | Set the values of "Fbm Min Angular Limits". | -| [`SetFbmMinLinearLimits`](#generated.RAMotionFrame.SetFbmMinLinearLimits)(values[, unit]) | Set the values of "Fbm Min Linear Limits". | -| [`SetKeepInPlace`](#generated.RAMotionFrame.SetKeepInPlace)(value) | Set the value of "Keep In Place". | -| [`SetOrientation`](#generated.RAMotionFrame.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RAMotionFrame.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RAMotionFrame.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetPeriodicMotionPeriod`](#generated.RAMotionFrame.SetPeriodicMotionPeriod)(value[, unit]) | Set the value of "Periodic Motion Period". | -| [`SetPeriodicMotionStartTime`](#generated.RAMotionFrame.SetPeriodicMotionStartTime)(value[, unit]) | Set the value of "Periodic Motion Start Time". | -| [`SetPeriodicMotionStopTime`](#generated.RAMotionFrame.SetPeriodicMotionStopTime)(value[, unit]) | Set the value of "Periodic Motion Stop Time". | -| [`SetRelativePosition`](#generated.RAMotionFrame.SetRelativePosition)(values[, unit]) | Set the values of "Relative Position". | -| [`SetRelativeRotationVector`](#generated.RAMotionFrame.SetRelativeRotationVector)(values[, unit]) | Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. | -| [`SetRotationAngle`](#generated.RAMotionFrame.SetRotationAngle)(value[, unit]) | Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### AddPendulumMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), initial_frequency=(0.0, 'Hz'), angular_initial_amplitude=(0.0, 'rad'), direction=((0.0, 0.0, 0.0), 'm'), angular_initial_phase=(0.0, 'rad'), frequency_variation=(0.0, 'Hz/s'), angular_amplitude_variation=(0.0, 'rad/s')) - -Adds a pendulum motion to the frame. - -* **Parameters:** - * **start_time** (*float*) – The start time for the motion. - * **stop_time** (*float*) – The end time for the motion. - * **initial_frequency** (*float*) – The initial frequency of the rotation (in Hz). - * **angular_initial_amplitude** (*float*) – The initial angular amplitude of the rotation (in rad). - * **direction** (*list* *(**float* *)*) – The direction of the rotation (in m). - * **angular_initial_phase** (*list* *(**float* *)*) – The initial angular phase of the rotation (in rad). - * **frequency_variation** (*float*) – The variation of the frequency (in Hz/s). - * **angular_amplitude_variation** (*float*) – The angular amplitude variation (in rad/s). - - - -#### AddRotationMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), angular_velocity=((0.0, 0.0, 0.0), 'rad/s'), angular_acceleration=((0.0, 0.0, 0.0), 'rad/s2')) - -Adds a rotation motion to the frame. - -* **Parameters:** - * **start_time** (*float*) – The start time for the motion. - * **stop_time** (*float*) – The end time for the motion. - * **angular_velocity** (*list* *(**float* *)*) – The motion angular velocity (x, y, z). - * **angular_acceleration** (*list* *(**float* *)*) – The motion angular acceleration (x, y, z). -* **Return RAMotion:** - Returns the motion created. - - - -#### AddTranslationMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), velocity=((0.0, 0.0, 0.0), 'm/s'), acceleration=((0.0, 0.0, 0.0), 'm/s2'), define_as='fixed_velocity', final_velocity=((0.0, 0.0, 0.0), 'm/s')) - -Adds a translation motion to the frame. - -* **Parameters:** - * **start_time** (*float*) – The start time for the motion. - * **stop_time** (*float*) – The end time for the motion. - * **velocity** (*list* *(**float* *,**float* *,**float* *)*) – The motion velocity (x, y, z) in m/s. - * **acceleration** (*list* *(**float* *,**float* *,**float* *)*) – The motion acceleration (x, y, z) in m/s2 - * **displace_geometry** (*bool*) – Whether the geometry should be displaced with the movement or not. - * **define_as** (*unicode*) – - - How it should be defined. Valid values are: - : ’fixed_velocity’ - ‘initial_and_final_velocity’ - ‘initial_velocity_and_acceleration’ - * **final_velocity** (*list* *(**float* *,**float* *,**float* *)*) – - - The final motion velocity (x, y, z) in m/2. - - Used only if define_as == ‘initial_and_final_velocity’, in which case - the initial velocity is given by the velocity parameter. -* **Return RAMotion:** - Returns the motion created. - - - -#### AddVibrationMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), initial_frequency=(0.0, 'Hz'), initial_amplitude=(0.0, 'm'), direction=((0.0, 0.0, 0.0), 'm'), frequency_variation=(0.0, 'Hz/s'), amplitude_variation=(0.0, 'm/s')) - -Adds a vibration motion to the frame. - -* **Parameters:** - * **start_time** (*float*) – The start time for the motion. - * **stop_time** (*float*) – The end time for the motion. - * **initial_frequency** (*float*) – The initial frequency of the vibration (in Hz). - * **initial_amplitude** (*float*) – The initial amplitude of the vibration (in m). - * **direction** (*list* *(**float* *)*) – The direction of the vibration (in m). - * **frequency_variation** (*float*) – The variation of the frequency (in Hz/s). - * **amplitude_variation** (*float*) – The amplitude variation (in m/s). - - - -#### ApplyTo(obj) - -Link this motion frame to the given geometry. - -* **Parameters:** - **obj** (*Subject* *|**ScriptingWrapper*) – Either the actual object or the wrapper in the scripting for the object. - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetEnableFbmAngularLimits() - -Get the value of “Enable Fbm Angular Limits”. - - - -#### GetEnableFbmLinearLimits() - -Get the value of “Enable Fbm Linear Limits”. - - - -#### GetEnablePeriodicMotion() - -Get the value of “Enable Periodic Motion”. - - - -#### GetFbmMaxAngularLimits(unit: str | None = None) - -Get the value of “Fbm Max Angular Limits”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “dega”. - - - -#### GetFbmMaxLinearLimits(unit: str | None = None) - -Get the value of “Fbm Max Linear Limits”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetFbmMinAngularLimits(unit: str | None = None) - -Get the value of “Fbm Min Angular Limits”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “dega”. - - - -#### GetFbmMinLinearLimits(unit: str | None = None) - -Get the value of “Fbm Min Linear Limits”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetKeepInPlace() - -Get the value of “Keep In Place”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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(frame_name) - -Get a specific motion frame given its name. - -* **Parameters:** - **frame_name** (*unicode*) -* **Return type:** - [RAMotionFrame](#generated.RAMotionFrame) - - - -#### GetMotions() - -Get the list of motions in the motion frame. - -* **Returns:** - Returns a list with the motions configured. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetParentMotionFrame() - -Gets the parent motion frame. -If the Motion Frame is a RAMotionFrameSource it returns None. - -* **Return type:** - [RAMotionFrame](#generated.RAMotionFrame) - - - -#### GetPeriodicMotionPeriod(unit: str | None = None) - -Get the value of “Periodic Motion Period”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetPeriodicMotionStartTime(unit: str | None = None) - -Get the value of “Periodic Motion Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetPeriodicMotionStopTime(unit: str | None = None) - -Get the value of “Periodic Motion Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetRelativePosition(unit: str | None = None) - -Get the value of “Relative Position”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetRelativeRotationVector(unit: str | None = None) - -Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetRotationAngle(unit: str | None = None) - -Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterMotionFrames() - -Iterates over all the motion frames available (recursively). - -* **Return iter(RAMotionFrame):** - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### NewConeCrusherFrame() - -Creates a new cone crusher frame. - -* **Return type:** - [RAConeCrusherFrame](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) - - - -#### NewFrame() - -Creates a new motion frame. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveFrame(motion_frame) - -Removes a previously-created motion frame. - -* **Parameters:** - **motion_frame** ([*RAMotionFrame*](#generated.RAMotionFrame) *or* [*RAConeCrusherFrame*](RAConeCrusherFrame.md#generated.RAConeCrusherFrame)) - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetEnableFbmAngularLimits(value: bool) - -Set the value of “Enable Fbm Angular Limits”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetEnableFbmLinearLimits(value: bool) - -Set the value of “Enable Fbm Linear Limits”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetEnablePeriodicMotion(value: bool) - -Set the value of “Enable Periodic Motion”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFbmMaxAngularLimits(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Fbm Max Angular Limits”. - -* **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 “dega”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetFbmMaxLinearLimits(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Fbm Max Linear Limits”. - -* **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. - - - -#### SetFbmMinAngularLimits(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Fbm Min Angular Limits”. - -* **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 “dega”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetFbmMinLinearLimits(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Fbm Min Linear Limits”. - -* **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. - - - -#### SetKeepInPlace(value: str | int) - -Set the value of “Keep In Place”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### 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. - - - -#### SetPeriodicMotionPeriod(value: str | float, unit: str | None = None) - -Set the value of “Periodic Motion 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”. - - - -#### SetPeriodicMotionStartTime(value: str | float, unit: str | None = None) - -Set the value of “Periodic Motion Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetPeriodicMotionStopTime(value: str | float, unit: str | None = None) - -Set the value of “Periodic Motion Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetRelativePosition(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Relative Position”. - -* **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. - - - -#### SetRelativeRotationVector(values: Sequence[str | float], unit: str | None = None) - -Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. - - - -#### SetRotationAngle(value: str | float, unit: str | None = None) - -Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. + + +# RAMotionFrame + + + + + + +### *class* RAMotionFrame + +Rocky PrePost Scripting wrapper for a motion frame. + +The class contains methods to configure a motion frame and its motions. There are some options +to retrieve a specific [`RAMotionFrame`](#generated.RAMotionFrame) in a project from a [`RAStudy`](RAStudy.md#generated.RAStudy), a +[`RAMotionFrameSource`](RAMotionFrameSource.md#generated.RAMotionFrameSource) or another [`RAMotionFrame`](#generated.RAMotionFrame): + +```python +# From the RAStudy +motion_frame = study.GetElement('') + +# From the RAMotionFrameSource +frame_source = study.GetMotionFrameSource() +motion_frame = frame_source.GetMotionFrame('') + +# From a "parent" motion frame +frame_1 = study.GetElement('') +frame_2 = frame_1.GetMotionFrame('') +``` + +A motion frame comprises frame properties (relative position, rotation angle, free body limits, +etc) and a list of motions. The properties are manipulated via direct Get\*() and Set\*() +methods, while the motions are accessed separately via the list returned by [`GetMotions()`](#generated.RAMotionFrame.GetMotions). + +Motion frames can be created on the “root” of the project’s motion frames (the source returned +in [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource)), or as a ‘child’ frame of a pre-existing motion frame: + +```python +frame_source = study.GetMotionFrameSource() + +# Create a motion frame with no parent frame +frame_1 = frame_source.NewFrame() +# Configure this new frame frame_1 +frame_1.SetRelativePosition(...) +frame_1.SetEnablePeriodicMotion(...) +# ... configure motions, etc. + +# Create a new frame, as a child of `frame_1` +frame_2 = frame_1.NewFrame() +# Configure this new frame frame_2 +frame_2.SetRelativePosition(...) +# ... configure motions, etc. +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAMotionFrame.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAMotionFrame.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.RAMotionFrame.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAMotionFrame.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`AddPendulumMotion`](#generated.RAMotionFrame.AddPendulumMotion)([start_time, stop_time, ...]) | Adds a pendulum motion to the frame. | +| [`AddRotationMotion`](#generated.RAMotionFrame.AddRotationMotion)([start_time, stop_time, ...]) | Adds a rotation motion to the frame. | +| [`AddTranslationMotion`](#generated.RAMotionFrame.AddTranslationMotion)([start_time, ...]) | Adds a translation motion to the frame. | +| [`AddVibrationMotion`](#generated.RAMotionFrame.AddVibrationMotion)([start_time, stop_time, ...]) | Adds a vibration motion to the frame. | +| [`ApplyTo`](#generated.RAMotionFrame.ApplyTo)(obj) | Link this motion frame to the given geometry. | +| [`CreateCurveOutputVariable`](#generated.RAMotionFrame.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.RAMotionFrame.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAMotionFrame.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAMotionFrame.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.RAMotionFrame.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.RAMotionFrame.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.RAMotionFrame.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.RAMotionFrame.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAMotionFrame.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAMotionFrame.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAMotionFrame.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAMotionFrame.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAMotionFrame.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAMotionFrame.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAMotionFrame.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAMotionFrame.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAMotionFrame.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAMotionFrame.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAMotionFrame.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RAMotionFrame.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetElementCurve`](#generated.RAMotionFrame.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetEnableFbmAngularLimits`](#generated.RAMotionFrame.GetEnableFbmAngularLimits)() | Get the value of "Enable Fbm Angular Limits". | +| [`GetEnableFbmLinearLimits`](#generated.RAMotionFrame.GetEnableFbmLinearLimits)() | Get the value of "Enable Fbm Linear Limits". | +| [`GetEnablePeriodicMotion`](#generated.RAMotionFrame.GetEnablePeriodicMotion)() | Get the value of "Enable Periodic Motion". | +| [`GetFbmMaxAngularLimits`](#generated.RAMotionFrame.GetFbmMaxAngularLimits)([unit]) | Get the value of "Fbm Max Angular Limits". | +| [`GetFbmMaxLinearLimits`](#generated.RAMotionFrame.GetFbmMaxLinearLimits)([unit]) | Get the value of "Fbm Max Linear Limits". | +| [`GetFbmMinAngularLimits`](#generated.RAMotionFrame.GetFbmMinAngularLimits)([unit]) | Get the value of "Fbm Min Angular Limits". | +| [`GetFbmMinLinearLimits`](#generated.RAMotionFrame.GetFbmMinLinearLimits)([unit]) | Get the value of "Fbm Min Linear Limits". | +| [`GetGeometryQuantity`](#generated.RAMotionFrame.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryUnit`](#generated.RAMotionFrame.GetGeometryUnit)() | Get the grid's geometry's unit. | +| [`GetGridFunction`](#generated.RAMotionFrame.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | +| [`GetGridFunctionNames`](#generated.RAMotionFrame.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetKeepInPlace`](#generated.RAMotionFrame.GetKeepInPlace)() | Get the value of "Keep In Place". | +| [`GetMeshColoring`](#generated.RAMotionFrame.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMotionFrame`](#generated.RAMotionFrame.GetMotionFrame)(frame_name) | Get a specific motion frame given its name. | +| [`GetMotions`](#generated.RAMotionFrame.GetMotions)() | Get the list of motions in the motion frame. | +| [`GetNumberOfCells`](#generated.RAMotionFrame.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAMotionFrame.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAMotionFrame.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RAMotionFrame.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RAMotionFrame.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RAMotionFrame.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RAMotionFrame.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetParentMotionFrame`](#generated.RAMotionFrame.GetParentMotionFrame)() | Gets the parent motion frame. | +| [`GetPeriodicMotionPeriod`](#generated.RAMotionFrame.GetPeriodicMotionPeriod)([unit]) | Get the value of "Periodic Motion Period". | +| [`GetPeriodicMotionStartTime`](#generated.RAMotionFrame.GetPeriodicMotionStartTime)([unit]) | Get the value of "Periodic Motion Start Time". | +| [`GetPeriodicMotionStopTime`](#generated.RAMotionFrame.GetPeriodicMotionStopTime)([unit]) | Get the value of "Periodic Motion Stop Time". | +| [`GetRelativePosition`](#generated.RAMotionFrame.GetRelativePosition)([unit]) | Get the value of "Relative Position". | +| [`GetRelativeRotationVector`](#generated.RAMotionFrame.GetRelativeRotationVector)([unit]) | Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. | +| [`GetRotationAngle`](#generated.RAMotionFrame.GetRotationAngle)([unit]) | Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. | +| [`GetTimeSet`](#generated.RAMotionFrame.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAMotionFrame.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAMotionFrame.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAMotionFrame.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`HasGridFunction`](#generated.RAMotionFrame.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | +| [`IsCellActive`](#generated.RAMotionFrame.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IterCellVertices`](#generated.RAMotionFrame.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAMotionFrame.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterMotionFrames`](#generated.RAMotionFrame.IterMotionFrames)() | Iterates over all the motion frames available (recursively). | +| [`Modified`](#generated.RAMotionFrame.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`NewConeCrusherFrame`](#generated.RAMotionFrame.NewConeCrusherFrame)() | Creates a new cone crusher frame. | +| [`NewFrame`](#generated.RAMotionFrame.NewFrame)() | Creates a new motion frame. | +| [`RemoveCustomCurve`](#generated.RAMotionFrame.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAMotionFrame.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveFrame`](#generated.RAMotionFrame.RemoveFrame)(motion_frame) | Removes a previously-created motion frame. | +| [`RemoveOutputVariable`](#generated.RAMotionFrame.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAMotionFrame.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAMotionFrame.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetEnableFbmAngularLimits`](#generated.RAMotionFrame.SetEnableFbmAngularLimits)(value) | Set the value of "Enable Fbm Angular Limits". | +| [`SetEnableFbmLinearLimits`](#generated.RAMotionFrame.SetEnableFbmLinearLimits)(value) | Set the value of "Enable Fbm Linear Limits". | +| [`SetEnablePeriodicMotion`](#generated.RAMotionFrame.SetEnablePeriodicMotion)(value) | Set the value of "Enable Periodic Motion". | +| [`SetFbmMaxAngularLimits`](#generated.RAMotionFrame.SetFbmMaxAngularLimits)(values[, unit]) | Set the values of "Fbm Max Angular Limits". | +| [`SetFbmMaxLinearLimits`](#generated.RAMotionFrame.SetFbmMaxLinearLimits)(values[, unit]) | Set the values of "Fbm Max Linear Limits". | +| [`SetFbmMinAngularLimits`](#generated.RAMotionFrame.SetFbmMinAngularLimits)(values[, unit]) | Set the values of "Fbm Min Angular Limits". | +| [`SetFbmMinLinearLimits`](#generated.RAMotionFrame.SetFbmMinLinearLimits)(values[, unit]) | Set the values of "Fbm Min Linear Limits". | +| [`SetKeepInPlace`](#generated.RAMotionFrame.SetKeepInPlace)(value) | Set the value of "Keep In Place". | +| [`SetOrientation`](#generated.RAMotionFrame.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RAMotionFrame.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RAMotionFrame.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetPeriodicMotionPeriod`](#generated.RAMotionFrame.SetPeriodicMotionPeriod)(value[, unit]) | Set the value of "Periodic Motion Period". | +| [`SetPeriodicMotionStartTime`](#generated.RAMotionFrame.SetPeriodicMotionStartTime)(value[, unit]) | Set the value of "Periodic Motion Start Time". | +| [`SetPeriodicMotionStopTime`](#generated.RAMotionFrame.SetPeriodicMotionStopTime)(value[, unit]) | Set the value of "Periodic Motion Stop Time". | +| [`SetRelativePosition`](#generated.RAMotionFrame.SetRelativePosition)(values[, unit]) | Set the values of "Relative Position". | +| [`SetRelativeRotationVector`](#generated.RAMotionFrame.SetRelativeRotationVector)(values[, unit]) | Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. | +| [`SetRotationAngle`](#generated.RAMotionFrame.SetRotationAngle)(value[, unit]) | Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### AddPendulumMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), initial_frequency=(0.0, 'Hz'), angular_initial_amplitude=(0.0, 'rad'), direction=((0.0, 0.0, 0.0), 'm'), angular_initial_phase=(0.0, 'rad'), frequency_variation=(0.0, 'Hz/s'), angular_amplitude_variation=(0.0, 'rad/s')) + +Adds a pendulum motion to the frame. + +* **Parameters:** + * **start_time** (*float*) – The start time for the motion. + * **stop_time** (*float*) – The end time for the motion. + * **initial_frequency** (*float*) – The initial frequency of the rotation (in Hz). + * **angular_initial_amplitude** (*float*) – The initial angular amplitude of the rotation (in rad). + * **direction** (*list* *(**float* *)*) – The direction of the rotation (in m). + * **angular_initial_phase** (*list* *(**float* *)*) – The initial angular phase of the rotation (in rad). + * **frequency_variation** (*float*) – The variation of the frequency (in Hz/s). + * **angular_amplitude_variation** (*float*) – The angular amplitude variation (in rad/s). + + + +#### AddRotationMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), angular_velocity=((0.0, 0.0, 0.0), 'rad/s'), angular_acceleration=((0.0, 0.0, 0.0), 'rad/s2')) + +Adds a rotation motion to the frame. + +* **Parameters:** + * **start_time** (*float*) – The start time for the motion. + * **stop_time** (*float*) – The end time for the motion. + * **angular_velocity** (*list* *(**float* *)*) – The motion angular velocity (x, y, z). + * **angular_acceleration** (*list* *(**float* *)*) – The motion angular acceleration (x, y, z). +* **Return RAMotion:** + Returns the motion created. + + + +#### AddTranslationMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), velocity=((0.0, 0.0, 0.0), 'm/s'), acceleration=((0.0, 0.0, 0.0), 'm/s2'), define_as='fixed_velocity', final_velocity=((0.0, 0.0, 0.0), 'm/s')) + +Adds a translation motion to the frame. + +* **Parameters:** + * **start_time** (*float*) – The start time for the motion. + * **stop_time** (*float*) – The end time for the motion. + * **velocity** (*list* *(**float* *,**float* *,**float* *)*) – The motion velocity (x, y, z) in m/s. + * **acceleration** (*list* *(**float* *,**float* *,**float* *)*) – The motion acceleration (x, y, z) in m/s2 + * **displace_geometry** (*bool*) – Whether the geometry should be displaced with the movement or not. + * **define_as** (*unicode*) – + + How it should be defined. Valid values are: + : ’fixed_velocity’ + ‘initial_and_final_velocity’ + ‘initial_velocity_and_acceleration’ + * **final_velocity** (*list* *(**float* *,**float* *,**float* *)*) – + + The final motion velocity (x, y, z) in m/2. + + Used only if define_as == ‘initial_and_final_velocity’, in which case + the initial velocity is given by the velocity parameter. +* **Return RAMotion:** + Returns the motion created. + + + +#### AddVibrationMotion(start_time=(0.0, 's'), stop_time=(1000.0, 's'), initial_frequency=(0.0, 'Hz'), initial_amplitude=(0.0, 'm'), direction=((0.0, 0.0, 0.0), 'm'), frequency_variation=(0.0, 'Hz/s'), amplitude_variation=(0.0, 'm/s')) + +Adds a vibration motion to the frame. + +* **Parameters:** + * **start_time** (*float*) – The start time for the motion. + * **stop_time** (*float*) – The end time for the motion. + * **initial_frequency** (*float*) – The initial frequency of the vibration (in Hz). + * **initial_amplitude** (*float*) – The initial amplitude of the vibration (in m). + * **direction** (*list* *(**float* *)*) – The direction of the vibration (in m). + * **frequency_variation** (*float*) – The variation of the frequency (in Hz/s). + * **amplitude_variation** (*float*) – The amplitude variation (in m/s). + + + +#### ApplyTo(obj) + +Link this motion frame to the given geometry. + +* **Parameters:** + **obj** (*Subject* *|**ScriptingWrapper*) – Either the actual object or the wrapper in the scripting for the object. + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetEnableFbmAngularLimits() + +Get the value of “Enable Fbm Angular Limits”. + + + +#### GetEnableFbmLinearLimits() + +Get the value of “Enable Fbm Linear Limits”. + + + +#### GetEnablePeriodicMotion() + +Get the value of “Enable Periodic Motion”. + + + +#### GetFbmMaxAngularLimits(unit: str | None = None) + +Get the value of “Fbm Max Angular Limits”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “dega”. + + + +#### GetFbmMaxLinearLimits(unit: str | None = None) + +Get the value of “Fbm Max Linear Limits”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetFbmMinAngularLimits(unit: str | None = None) + +Get the value of “Fbm Min Angular Limits”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “dega”. + + + +#### GetFbmMinLinearLimits(unit: str | None = None) + +Get the value of “Fbm Min Linear Limits”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetKeepInPlace() + +Get the value of “Keep In Place”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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(frame_name) + +Get a specific motion frame given its name. + +* **Parameters:** + **frame_name** (*unicode*) +* **Return type:** + [RAMotionFrame](#generated.RAMotionFrame) + + + +#### GetMotions() + +Get the list of motions in the motion frame. + +* **Returns:** + Returns a list with the motions configured. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetParentMotionFrame() + +Gets the parent motion frame. +If the Motion Frame is a RAMotionFrameSource it returns None. + +* **Return type:** + [RAMotionFrame](#generated.RAMotionFrame) + + + +#### GetPeriodicMotionPeriod(unit: str | None = None) + +Get the value of “Periodic Motion Period”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetPeriodicMotionStartTime(unit: str | None = None) + +Get the value of “Periodic Motion Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetPeriodicMotionStopTime(unit: str | None = None) + +Get the value of “Periodic Motion Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetRelativePosition(unit: str | None = None) + +Get the value of “Relative Position”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetRelativeRotationVector(unit: str | None = None) + +Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetRotationAngle(unit: str | None = None) + +Deprecated: Use [`GetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.GetOrientationFromAngleAndVector) instead. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterMotionFrames() + +Iterates over all the motion frames available (recursively). + +* **Return iter(RAMotionFrame):** + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### NewConeCrusherFrame() + +Creates a new cone crusher frame. + +* **Return type:** + [RAConeCrusherFrame](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) + + + +#### NewFrame() + +Creates a new motion frame. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveFrame(motion_frame) + +Removes a previously-created motion frame. + +* **Parameters:** + **motion_frame** ([*RAMotionFrame*](#generated.RAMotionFrame) *or* [*RAConeCrusherFrame*](RAConeCrusherFrame.md#generated.RAConeCrusherFrame)) + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetEnableFbmAngularLimits(value: bool) + +Set the value of “Enable Fbm Angular Limits”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetEnableFbmLinearLimits(value: bool) + +Set the value of “Enable Fbm Linear Limits”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetEnablePeriodicMotion(value: bool) + +Set the value of “Enable Periodic Motion”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFbmMaxAngularLimits(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Fbm Max Angular Limits”. + +* **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 “dega”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetFbmMaxLinearLimits(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Fbm Max Linear Limits”. + +* **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. + + + +#### SetFbmMinAngularLimits(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Fbm Min Angular Limits”. + +* **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 “dega”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetFbmMinLinearLimits(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Fbm Min Linear Limits”. + +* **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. + + + +#### SetKeepInPlace(value: str | int) + +Set the value of “Keep In Place”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### 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. + + + +#### SetPeriodicMotionPeriod(value: str | float, unit: str | None = None) + +Set the value of “Periodic Motion 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”. + + + +#### SetPeriodicMotionStartTime(value: str | float, unit: str | None = None) + +Set the value of “Periodic Motion Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetPeriodicMotionStopTime(value: str | float, unit: str | None = None) + +Set the value of “Periodic Motion Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetRelativePosition(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Relative Position”. + +* **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. + + + +#### SetRelativeRotationVector(values: Sequence[str | float], unit: str | None = None) + +Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. + + + +#### SetRotationAngle(value: str | float, unit: str | None = None) + +Deprecated: Use [`SetOrientationFromAngleAndVector()`](#generated.RAMotionFrame.SetOrientationFromAngleAndVector) instead. diff --git a/2025R2/rocky-prepost-scripting-manual/RAMotionFrameSource.md b/2025R2/rocky-prepost-scripting-manual/RAMotionFrameSource.md index d0df6a47c1..e12519408a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMotionFrameSource.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMotionFrameSource.md @@ -1,94 +1,95 @@ - - -# RAMotionFrameSource - - - - - - -### *class* RAMotionFrameSource - -Rocky PrePost Scripting wrapper for the root element for Motion Frames - -This class represents the “Motion Frame” item on the project’s data tree. Get the [`RAMotionFrameSource`](#generated.RAMotionFrameSource) -from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: - -```python -motion_frame_source = study.GetMotionFrameSource() -``` - -This is the element through which motion frames with no parent frames can be created, and through -which all motion frames can be directly accessed: - -```python -motion_frame_1 = motion_frame_source.NewFrame() -motion_frame_2 = motion_frame.GetMotionFrame('My Frame') -for motion_frame in motion_frame.IterMotionFrames(): - motion_frame.SetRelativePosition([1.0, 2.0, 3.0], 'm') -``` - -**Methods:** - -| [`GetMotionFrame`](#generated.RAMotionFrameSource.GetMotionFrame)(frame_name) | Get a specific motion frame given its name. | -|---------------------------------------------------------------------------------|--------------------------------------------------------------| -| [`GetParentMotionFrame`](#generated.RAMotionFrameSource.GetParentMotionFrame)() | Gets the parent motion frame. | -| [`IterMotionFrames`](#generated.RAMotionFrameSource.IterMotionFrames)() | Iterates over all the motion frames available (recursively). | -| [`NewConeCrusherFrame`](#generated.RAMotionFrameSource.NewConeCrusherFrame)() | Creates a new cone crusher frame. | -| [`NewFrame`](#generated.RAMotionFrameSource.NewFrame)() | Creates a new motion frame. | -| [`RemoveFrame`](#generated.RAMotionFrameSource.RemoveFrame)(motion_frame) | Removes a previously-created motion frame. | - - - -#### GetMotionFrame(frame_name) - -Get a specific motion frame given its name. - -* **Parameters:** - **frame_name** (*unicode*) -* **Return type:** - [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) - - - -#### GetParentMotionFrame() - -Gets the parent motion frame. -If the Motion Frame is a RAMotionFrameSource it returns None. - -* **Return type:** - [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) - - - -#### IterMotionFrames() - -Iterates over all the motion frames available (recursively). - -* **Return iter(RAMotionFrame):** - - - -#### NewConeCrusherFrame() - -Creates a new cone crusher frame. - -* **Return type:** - [RAConeCrusherFrame](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) - - - -#### NewFrame() - -Creates a new motion frame. - - - -#### RemoveFrame(motion_frame) - -Removes a previously-created motion frame. - -* **Parameters:** - **motion_frame** ([*RAMotionFrame*](RAMotionFrame.md#generated.RAMotionFrame) *or* [*RAConeCrusherFrame*](RAConeCrusherFrame.md#generated.RAConeCrusherFrame)) + + +# RAMotionFrameSource + + + + + + +### *class* RAMotionFrameSource + +Rocky PrePost Scripting wrapper for the root element for Motion Frames + +This class represents the “Motion Frame” item on the project’s data tree. Get the [`RAMotionFrameSource`](#generated.RAMotionFrameSource) +from a [`RAStudy`](RAStudy.md#generated.RAStudy) via: + +```python +motion_frame_source = study.GetMotionFrameSource() +``` + +This is the element through which motion frames with no parent frames can be created, and through +which all motion frames can be directly accessed: + +```python +motion_frame_1 = motion_frame_source.NewFrame() +motion_frame_2 = motion_frame.GetMotionFrame('My Frame') +for motion_frame in motion_frame.IterMotionFrames(): + motion_frame.SetRelativePosition([1.0, 2.0, 3.0], 'm') +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------|--------------------------------------------------------------| +| [`GetMotionFrame`](#generated.RAMotionFrameSource.GetMotionFrame)(frame_name) | Get a specific motion frame given its name. | +| [`GetParentMotionFrame`](#generated.RAMotionFrameSource.GetParentMotionFrame)() | Gets the parent motion frame. | +| [`IterMotionFrames`](#generated.RAMotionFrameSource.IterMotionFrames)() | Iterates over all the motion frames available (recursively). | +| [`NewConeCrusherFrame`](#generated.RAMotionFrameSource.NewConeCrusherFrame)() | Creates a new cone crusher frame. | +| [`NewFrame`](#generated.RAMotionFrameSource.NewFrame)() | Creates a new motion frame. | +| [`RemoveFrame`](#generated.RAMotionFrameSource.RemoveFrame)(motion_frame) | Removes a previously-created motion frame. | + + + +#### GetMotionFrame(frame_name) + +Get a specific motion frame given its name. + +* **Parameters:** + **frame_name** (*unicode*) +* **Return type:** + [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) + + + +#### GetParentMotionFrame() + +Gets the parent motion frame. +If the Motion Frame is a RAMotionFrameSource it returns None. + +* **Return type:** + [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) + + + +#### IterMotionFrames() + +Iterates over all the motion frames available (recursively). + +* **Return iter(RAMotionFrame):** + + + +#### NewConeCrusherFrame() + +Creates a new cone crusher frame. + +* **Return type:** + [RAConeCrusherFrame](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) + + + +#### NewFrame() + +Creates a new motion frame. + + + +#### RemoveFrame(motion_frame) + +Removes a previously-created motion frame. + +* **Parameters:** + **motion_frame** ([*RAMotionFrame*](RAMotionFrame.md#generated.RAMotionFrame) *or* [*RAConeCrusherFrame*](RAConeCrusherFrame.md#generated.RAConeCrusherFrame)) diff --git a/2025R2/rocky-prepost-scripting-manual/RAMotionList.md b/2025R2/rocky-prepost-scripting-manual/RAMotionList.md index be5aa4cdfa..255b8859da 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAMotionList.md +++ b/2025R2/rocky-prepost-scripting-manual/RAMotionList.md @@ -1,61 +1,62 @@ - - -# RAMotionList - - - - - - -### *class* RAMotionList - -Rocky PrePost Scripting wrapper to manipulate the motions in a single Motion Frame. - -To get the [`RAMotionList`](#generated.RAMotionList) from a [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame), use: - -```python -motions = motion_frame.GetMotions() -``` - -The [`RAMotionList`](#generated.RAMotionList) class acts as a regular Python list, with the usual methods to iterate -and access individual motions: - -```python -motion_1 = motions.New() -motion_2 = motions.New() - -for motion in motions: - motion.SetStartTime(1, 's') - -del motions[0] -motions.Clear() -``` - -The items in the motion list are of type [`RAMotion`](RAMotion.md#generated.RAMotion). - -**Methods:** - -| [`Clear`](#generated.RAMotionList.Clear)() | Remove all items from the list. | -|--------------------------------------------------|-----------------------------------| -| [`New`](#generated.RAMotionList.New)() | Add a new item. | -| [`Remove`](#generated.RAMotionList.Remove)(item) | Remove an item from the list. | - - - -#### Clear() - -Remove all items from the list. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAMotionList + + + + + + +### *class* RAMotionList + +Rocky PrePost Scripting wrapper to manipulate the motions in a single Motion Frame. + +To get the [`RAMotionList`](#generated.RAMotionList) from a [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame), use: + +```python +motions = motion_frame.GetMotions() +``` + +The [`RAMotionList`](#generated.RAMotionList) class acts as a regular Python list, with the usual methods to iterate +and access individual motions: + +```python +motion_1 = motions.New() +motion_2 = motions.New() + +for motion in motions: + motion.SetStartTime(1, 's') + +del motions[0] +motions.Clear() +``` + +The items in the motion list are of type [`RAMotion`](RAMotion.md#generated.RAMotion). + +**Methods:** + +| Name | Description | +|--------------------------------------------------|-----------------------------------| +| [`Clear`](#generated.RAMotionList.Clear)() | Remove all items from the list. | +| [`New`](#generated.RAMotionList.New)() | Add a new item. | +| [`Remove`](#generated.RAMotionList.Remove)(item) | Remove an item from the list. | + + + +#### Clear() + +Remove all items from the list. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAOneRollBeltProfile.md b/2025R2/rocky-prepost-scripting-manual/RAOneRollBeltProfile.md index 8f479f5e8a..df58cbb387 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAOneRollBeltProfile.md +++ b/2025R2/rocky-prepost-scripting-manual/RAOneRollBeltProfile.md @@ -1,49 +1,50 @@ - - -# RAOneRollBeltProfile - - - - - - -### *class* RAOneRollBeltProfile - -Rocky API for a One Roll Belt Profile model. - -**Methods:** - -| [`GetAvailableMaterials`](#generated.RAOneRollBeltProfile.GetAvailableMaterials)() | Get all available Materials. | -|--------------------------------------------------------------------------------------|--------------------------------| -| [`GetMaterial`](#generated.RAOneRollBeltProfile.GetMaterial)() | Get the "Material". | -| [`SetMaterial`](#generated.RAOneRollBeltProfile.SetMaterial)(value) | Set the "Material". | - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. + + +# RAOneRollBeltProfile + + + + + + +### *class* RAOneRollBeltProfile + +Rocky API for a One Roll Belt Profile model. + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------|--------------------------------| +| [`GetAvailableMaterials`](#generated.RAOneRollBeltProfile.GetAvailableMaterials)() | Get all available Materials. | +| [`GetMaterial`](#generated.RAOneRollBeltProfile.GetMaterial)() | Get the "Material". | +| [`SetMaterial`](#generated.RAOneRollBeltProfile.SetMaterial)(value) | Set the "Material". | + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. diff --git a/2025R2/rocky-prepost-scripting-manual/RAOutlet.md b/2025R2/rocky-prepost-scripting-manual/RAOutlet.md index 05a1cfe71c..d620e4d108 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAOutlet.md +++ b/2025R2/rocky-prepost-scripting-manual/RAOutlet.md @@ -1,149 +1,150 @@ - - -# RAOutlet - - - - - - -### *class* RAOutlet - -Rocky PrePost Scripting wrapper for a single Outlet. - -This wrapper class corresponds to an individual entry under the “Inlets and Outlets” item on -the project’s data tree. It can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) via: - -```python -input_1 = study.GetElement('Outlet <1>') -``` - -**Methods:** - -| [`DisablePrescribedPressure`](#generated.RAOutlet.DisablePrescribedPressure)() | Set the value of "Prescribed Pressure" to False. | -|-------------------------------------------------------------------------------------------|----------------------------------------------------| -| [`EnablePrescribedPressure`](#generated.RAOutlet.EnablePrescribedPressure)() | Set the value of "Prescribed Pressure" to True. | -| [`GetAvailableExitPoints`](#generated.RAOutlet.GetAvailableExitPoints)() | Get all available Exit Points. | -| [`GetEnabledForParticles`](#generated.RAOutlet.GetEnabledForParticles)() | Get the value of "Enabled For Particles". | -| [`GetEnabledForSph`](#generated.RAOutlet.GetEnabledForSph)() | Get the value of "Enabled For Sph". | -| [`GetExitPoint`](#generated.RAOutlet.GetExitPoint)() | Get the "Exit Point". | -| [`GetPrescribedPressureEnabled`](#generated.RAOutlet.GetPrescribedPressureEnabled)() | Get the value of "Prescribed Pressure Enabled". | -| [`GetPressure`](#generated.RAOutlet.GetPressure)([unit]) | Get the value of "Pressure". | -| [`IsPrescribedPressureEnabled`](#generated.RAOutlet.IsPrescribedPressureEnabled)() | Check if the "Prescribed Pressure" is enabled. | -| [`SetEnabledForParticles`](#generated.RAOutlet.SetEnabledForParticles)(value) | Set the value of "Enabled For Particles". | -| [`SetEnabledForSph`](#generated.RAOutlet.SetEnabledForSph)(value) | Set the value of "Enabled For Sph". | -| [`SetExitPoint`](#generated.RAOutlet.SetExitPoint)(value) | Set the "Exit Point". | -| [`SetPrescribedPressureEnabled`](#generated.RAOutlet.SetPrescribedPressureEnabled)(value) | Set the value of "Prescribed Pressure Enabled". | -| [`SetPressure`](#generated.RAOutlet.SetPressure)(value[, unit]) | Set the value of "Pressure". | - - - -#### DisablePrescribedPressure() - -Set the value of “Prescribed Pressure” to False. - - - -#### EnablePrescribedPressure() - -Set the value of “Prescribed Pressure” to True. - - - -#### GetAvailableExitPoints() - -Get all available Exit Points. - -* **Return type:** - List[[`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface)] - A list of [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface). - - - -#### GetEnabledForParticles() - -Get the value of “Enabled For Particles”. - - - -#### GetEnabledForSph() - -Get the value of “Enabled For Sph”. - - - -#### GetExitPoint() - -Get the “Exit Point”. - -* **Return type:** - [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface) - - - -#### GetPrescribedPressureEnabled() - -Get the value of “Prescribed Pressure Enabled”. - - - -#### GetPressure(unit: str | None = None) - -Get the value of “Pressure”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa”. - - - -#### IsPrescribedPressureEnabled() - -Check if the “Prescribed Pressure” is enabled. - - - -#### SetEnabledForParticles(value: bool) - -Set the value of “Enabled For Particles”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetEnabledForSph(value: bool) - -Set the value of “Enabled For Sph”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetExitPoint(value) - -Set the “Exit Point”. - -:param unicode, [`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. - - - -#### SetPrescribedPressureEnabled(value: bool) - -Set the value of “Prescribed Pressure Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetPressure(value: str | float, unit: str | None = None) - -Set the value of “Pressure”. - -* **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 “Pa”. + + +# RAOutlet + + + + + + +### *class* RAOutlet + +Rocky PrePost Scripting wrapper for a single Outlet. + +This wrapper class corresponds to an individual entry under the “Inlets and Outlets” item on +the project’s data tree. It can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) via: + +```python +input_1 = study.GetElement('Outlet <1>') +``` + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------|----------------------------------------------------| +| [`DisablePrescribedPressure`](#generated.RAOutlet.DisablePrescribedPressure)() | Set the value of "Prescribed Pressure" to False. | +| [`EnablePrescribedPressure`](#generated.RAOutlet.EnablePrescribedPressure)() | Set the value of "Prescribed Pressure" to True. | +| [`GetAvailableExitPoints`](#generated.RAOutlet.GetAvailableExitPoints)() | Get all available Exit Points. | +| [`GetEnabledForParticles`](#generated.RAOutlet.GetEnabledForParticles)() | Get the value of "Enabled For Particles". | +| [`GetEnabledForSph`](#generated.RAOutlet.GetEnabledForSph)() | Get the value of "Enabled For Sph". | +| [`GetExitPoint`](#generated.RAOutlet.GetExitPoint)() | Get the "Exit Point". | +| [`GetPrescribedPressureEnabled`](#generated.RAOutlet.GetPrescribedPressureEnabled)() | Get the value of "Prescribed Pressure Enabled". | +| [`GetPressure`](#generated.RAOutlet.GetPressure)([unit]) | Get the value of "Pressure". | +| [`IsPrescribedPressureEnabled`](#generated.RAOutlet.IsPrescribedPressureEnabled)() | Check if the "Prescribed Pressure" is enabled. | +| [`SetEnabledForParticles`](#generated.RAOutlet.SetEnabledForParticles)(value) | Set the value of "Enabled For Particles". | +| [`SetEnabledForSph`](#generated.RAOutlet.SetEnabledForSph)(value) | Set the value of "Enabled For Sph". | +| [`SetExitPoint`](#generated.RAOutlet.SetExitPoint)(value) | Set the "Exit Point". | +| [`SetPrescribedPressureEnabled`](#generated.RAOutlet.SetPrescribedPressureEnabled)(value) | Set the value of "Prescribed Pressure Enabled". | +| [`SetPressure`](#generated.RAOutlet.SetPressure)(value[, unit]) | Set the value of "Pressure". | + + + +#### DisablePrescribedPressure() + +Set the value of “Prescribed Pressure” to False. + + + +#### EnablePrescribedPressure() + +Set the value of “Prescribed Pressure” to True. + + + +#### GetAvailableExitPoints() + +Get all available Exit Points. + +* **Return type:** + List[[`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface)] + A list of [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface). + + + +#### GetEnabledForParticles() + +Get the value of “Enabled For Particles”. + + + +#### GetEnabledForSph() + +Get the value of “Enabled For Sph”. + + + +#### GetExitPoint() + +Get the “Exit Point”. + +* **Return type:** + [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface) + + + +#### GetPrescribedPressureEnabled() + +Get the value of “Prescribed Pressure Enabled”. + + + +#### GetPressure(unit: str | None = None) + +Get the value of “Pressure”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa”. + + + +#### IsPrescribedPressureEnabled() + +Check if the “Prescribed Pressure” is enabled. + + + +#### SetEnabledForParticles(value: bool) + +Set the value of “Enabled For Particles”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetEnabledForSph(value: bool) + +Set the value of “Enabled For Sph”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetExitPoint(value) + +Set the “Exit Point”. + +:param unicode, [`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. + + + +#### SetPrescribedPressureEnabled(value: bool) + +Set the value of “Prescribed Pressure Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetPressure(value: str | float, unit: str | None = None) + +Set the value of “Pressure”. + +* **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 “Pa”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParametricVar.md b/2025R2/rocky-prepost-scripting-manual/RAParametricVar.md index ed7ee63acd..587224226d 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParametricVar.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParametricVar.md @@ -1,43 +1,44 @@ - - -# RAParametricVar - - - - - - -### *class* RAParametricVar - -Rocky PrePost Scripting wrapper for a parametric input variable. - -Parametric input variables can be retrieved via a project’s [`RAInputVariables`](RAInputVariables.md#generated.RAInputVariables). This -wrapper provides methods to rename the variable and change its value. Example usage: - -```python -input_variables = project.GetInputVariables() -variable = input_variables.CreateVariable('a') - -variable.SetName('b') -variable.SetValue(100) -``` - -**Methods:** - -| [`GetValue`](#generated.RAParametricVar.GetValue)() | Get the variable's current value. | -|----------------------------------------------------------|-------------------------------------| -| [`SetValue`](#generated.RAParametricVar.SetValue)(value) | Set the variable's current value. | - - - -#### GetValue() - -Get the variable’s current value. - - - -#### SetValue(value: float) - -Set the variable’s current value. + + +# RAParametricVar + + + + + + +### *class* RAParametricVar + +Rocky PrePost Scripting wrapper for a parametric input variable. + +Parametric input variables can be retrieved via a project’s [`RAInputVariables`](RAInputVariables.md#generated.RAInputVariables). This +wrapper provides methods to rename the variable and change its value. Example usage: + +```python +input_variables = project.GetInputVariables() +variable = input_variables.CreateVariable('a') + +variable.SetName('b') +variable.SetValue(100) +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------|-------------------------------------| +| [`GetValue`](#generated.RAParametricVar.GetValue)() | Get the variable's current value. | +| [`SetValue`](#generated.RAParametricVar.SetValue)(value) | Set the variable's current value. | + + + +#### GetValue() + +Get the variable’s current value. + + + +#### SetValue(value: float) + +Set the variable’s current value. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParametricVariables.md b/2025R2/rocky-prepost-scripting-manual/RAParametricVariables.md index 2ee704bf11..ac9c7de3ea 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParametricVariables.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParametricVariables.md @@ -1,30 +1,31 @@ - - -# RAParametricVariables - - - - - - -### *class* RAParametricVariables - -Rocky PrePost Scripting wrapper for the parametric variables (both input and output) in a project. - -Currently the wrapper only provides a project’s input variables via [`GetInputVariables()`](#generated.RAParametricVariables.GetInputVariables). - -**Methods:** - -| [`GetInputVariables`](#generated.RAParametricVariables.GetInputVariables)() | Get the PrePost Scripting wrapper that handles the Input Variables in the project. | -|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| - - - -#### GetInputVariables() - -Get the PrePost Scripting wrapper that handles the Input Variables in the project. - -* **Return type:** - [RAInputVariables](RAInputVariables.md#generated.RAInputVariables) + + +# RAParametricVariables + + + + + + +### *class* RAParametricVariables + +Rocky PrePost Scripting wrapper for the parametric variables (both input and output) in a project. + +Currently the wrapper only provides a project’s input variables via [`GetInputVariables()`](#generated.RAParametricVariables.GetInputVariables). + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| [`GetInputVariables`](#generated.RAParametricVariables.GetInputVariables)() | Get the PrePost Scripting wrapper that handles the Input Variables in the project. | + + + +#### GetInputVariables() + +Get the PrePost Scripting wrapper that handles the Input Variables in the project. + +* **Return type:** + [RAInputVariables](RAInputVariables.md#generated.RAInputVariables) diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticle.md b/2025R2/rocky-prepost-scripting-manual/RAParticle.md index 015813ed7d..44f2412b41 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticle.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticle.md @@ -1,2800 +1,2801 @@ - - -# RAParticle - - - - - - -### *class* RAParticle - -Rocky PrePost Scripting wrapper for a particle in the project. - -The wrapper corresponds to an individual Particle entry in the project’s data tree, below the -“Particles” item. Particles can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RAParticleCollection`](RAParticleCollection.md#generated.RAParticleCollection) via: - -```python -particle_1 = study.GetElement('Particle 1') -particle_2 = particle_collection[1] -particle_3 = particle_collection.GetParticle('Particle 3') -``` - -Most particle properties, such as name, shape, aspect ratios, etc can be set directly via methods -in this wrapper class. An exception is size-related methods, which must be configured via the -[`RASizeDistributionList`](RASizeDistributionList.md#generated.RASizeDistributionList) returned in [`GetSizeDistributionList()`](#generated.RAParticle.GetSizeDistributionList). - -**Methods:** - -| [`AddCurve`](#generated.RAParticle.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAParticle.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.RAParticle.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAParticle.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAParticle.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.RAParticle.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAParticle.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAParticle.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.RAParticle.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). | -| [`DisableBreakage`](#generated.RAParticle.DisableBreakage)() | Set the value of "Breakage" to False. | -| [`DisableIncludeRotationalDeformations`](#generated.RAParticle.DisableIncludeRotationalDeformations)() | Set the value of "Include Rotational Deformations" to False. | -| [`DisableRandomOrientation`](#generated.RAParticle.DisableRandomOrientation)() | Set the value of "Random Orientation" to False. | -| [`EditCustomCurve`](#generated.RAParticle.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.RAParticle.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. | -| [`EnableBreakage`](#generated.RAParticle.EnableBreakage)() | Set the value of "Breakage" to True. | -| [`EnableIncludeRotationalDeformations`](#generated.RAParticle.EnableIncludeRotationalDeformations)() | Set the value of "Include Rotational Deformations" to True. | -| [`EnableRandomOrientation`](#generated.RAParticle.EnableRandomOrientation)() | Set the value of "Random Orientation" to True. | -| [`GetAbt10MaximumT10Value`](#generated.RAParticle.GetAbt10MaximumT10Value)([unit]) | Get the value of "Abt10 Maximum T10 Value". | -| [`GetAbt10MinimumSpecificEnergy`](#generated.RAParticle.GetAbt10MinimumSpecificEnergy)([unit]) | Deprecated: Use [`GetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) instead. | -| [`GetAbt10ReferenceMinimumSpecificEnergy`](#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy)([unit]) | Get the value of "Abt10 Reference Minimum Specific Energy". | -| [`GetAbt10ReferenceSize`](#generated.RAParticle.GetAbt10ReferenceSize)([unit]) | Get the value of "Abt10 Reference Size". | -| [`GetAbt10SelectFunctionCoefficient`](#generated.RAParticle.GetAbt10SelectFunctionCoefficient)([unit]) | Get the value of "Abt10 Select Function Coefficient". | -| [`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. | -| [`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. | -| [`GetBreakageModel`](#generated.RAParticle.GetBreakageModel)() | Get "Breakage Model" as a string. | -| [`GetCellAreaAsArray`](#generated.RAParticle.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAParticle.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAParticle.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAParticle.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAParticle.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAParticle.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAParticle.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAParticle.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenterOfMassOffset`](#generated.RAParticle.GetCenterOfMassOffset)([unit]) | Get the value of "Center of Mass Offset". | -| [`GetCgmScaleFactor`](#generated.RAParticle.GetCgmScaleFactor)() | Get the value of "Cgm Scale Factor". | -| [`GetChangeMassProperties`](#generated.RAParticle.GetChangeMassProperties)() | Get the value of "Change Mass Properties". | -| [`GetCurve`](#generated.RAParticle.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAParticle.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAParticle.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetDeformationModel`](#generated.RAParticle.GetDeformationModel)() | Get "Deformation Model" as a string. | -| [`GetDistributionModel`](#generated.RAParticle.GetDistributionModel)() | Get "Distribution Model" as a string. | -| [`GetEdgeAngle`](#generated.RAParticle.GetEdgeAngle)([unit]) | Get the value of "Edge Angle". | -| [`GetElasticRatioBending`](#generated.RAParticle.GetElasticRatioBending)() | Get the value of "Elastic Ratio Bending". | -| [`GetElasticRatioNormal`](#generated.RAParticle.GetElasticRatioNormal)() | Get the value of "Elastic Ratio Normal". | -| [`GetElasticRatioTangential`](#generated.RAParticle.GetElasticRatioTangential)() | Get the value of "Elastic Ratio Tangential". | -| [`GetElasticRatioTorsion`](#generated.RAParticle.GetElasticRatioTorsion)() | Get the value of "Elastic Ratio Torsion". | -| [`GetElasticity`](#generated.RAParticle.GetElasticity)() | Get "Elasticity" as a string. | -| [`GetElementCurve`](#generated.RAParticle.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetElementDampingRatio`](#generated.RAParticle.GetElementDampingRatio)() | Get the value of "Element Damping Ratio". | -| [`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". | -| [`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. | -| [`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. | -| [`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". | -| [`GetJointDampingRatio`](#generated.RAParticle.GetJointDampingRatio)() | Get the value of "Joint Damping Ratio". | -| [`GetJointElasticRatio`](#generated.RAParticle.GetJointElasticRatio)() | Get the value of "Joint Elastic Ratio". | -| [`GetJointThermalRatio`](#generated.RAParticle.GetJointThermalRatio)() | Get the value of "Joint Thermal Ratio". | -| [`GetMaterial`](#generated.RAParticle.GetMaterial)() | Get the "Material". | -| [`GetMeshColoring`](#generated.RAParticle.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMinimumSize`](#generated.RAParticle.GetMinimumSize)([unit]) | Get the value of "Minimum Size". | -| [`GetMinimumSizeRatio`](#generated.RAParticle.GetMinimumSizeRatio)() | Get the value of "Minimum Size Ratio". | -| [`GetMinimumVolumeFractionForFragmentDisabling`](#generated.RAParticle.GetMinimumVolumeFractionForFragmentDisabling)() | Get the value of "Minimum Volume Fraction For Fragment Disabling". | -| [`GetModuleProperties`](#generated.RAParticle.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RAParticle.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetNumberOfCells`](#generated.RAParticle.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfCorners`](#generated.RAParticle.GetNumberOfCorners)() | Get the value of "Number of Corners". | -| [`GetNumberOfNodes`](#generated.RAParticle.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAParticle.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RAParticle.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RAParticle.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RAParticle.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RAParticle.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RAParticle.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetPlasticLimit`](#generated.RAParticle.GetPlasticLimit)([unit]) | Get the value of "Plastic Limit". | -| [`GetPlasticRatio`](#generated.RAParticle.GetPlasticRatio)() | Get the value of "Plastic Ratio". | -| [`GetPlasticityModel`](#generated.RAParticle.GetPlasticityModel)() | Get "Plasticity Model" as a string. | -| [`GetPorosity`](#generated.RAParticle.GetPorosity)([unit]) | Get the value of "Porosity". | -| [`GetPrincipalMomentOfInertia`](#generated.RAParticle.GetPrincipalMomentOfInertia)([unit]) | Get the value of "Principal Moment of Inertia". | -| [`GetRandomAnglesHalfRange`](#generated.RAParticle.GetRandomAnglesHalfRange)([unit]) | Get the value of "Random Angles Half Range". | -| [`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". | -| [`GetSideAngle`](#generated.RAParticle.GetSideAngle)() | Get the value of "Side Angle". | -| [`GetSizeDistributionList`](#generated.RAParticle.GetSizeDistributionList)() | Get a list of size distribution entries | -| [`GetSizeType`](#generated.RAParticle.GetSizeType)() | Get "Size Type" as a string. | -| [`GetSmoothness`](#generated.RAParticle.GetSmoothness)() | Get the value of "Smoothness". | -| [`GetSuperquadricDegree`](#generated.RAParticle.GetSuperquadricDegree)() | Get the value of "Superquadric Degree". | -| [`GetSurfaceEnergy`](#generated.RAParticle.GetSurfaceEnergy)([unit]) | Get the value of "Surface Energy". | -| [`GetT10Formula`](#generated.RAParticle.GetT10Formula)() | Get "T10 Formula" as a string. | -| [`GetTargetNumberOfElements`](#generated.RAParticle.GetTargetNumberOfElements)() | Get the value of "Target Number of Elements". | -| [`GetTavaresA`](#generated.RAParticle.GetTavaresA)([unit]) | Get the value of "Tavares A". | -| [`GetTavaresB`](#generated.RAParticle.GetTavaresB)([unit]) | Get the value of "Tavares B". | -| [`GetTavaresD0`](#generated.RAParticle.GetTavaresD0)([unit]) | Get the value of "Tavares D0". | -| [`GetTavaresEInf`](#generated.RAParticle.GetTavaresEInf)([unit]) | Get the value of "Tavares E Inf". | -| [`GetTavaresGamma`](#generated.RAParticle.GetTavaresGamma)([unit]) | Get the value of "Tavares Gamma". | -| [`GetTavaresMinimumEnergy`](#generated.RAParticle.GetTavaresMinimumEnergy)([unit]) | Get the value of "Tavares Minimum Energy". | -| [`GetTavaresPhi`](#generated.RAParticle.GetTavaresPhi)([unit]) | Get the value of "Tavares Phi". | -| [`GetTavaresRatioEmax`](#generated.RAParticle.GetTavaresRatioEmax)([unit]) | Get the value of "Tavares Ratio Emax". | -| [`GetTavaresSigmaSquared`](#generated.RAParticle.GetTavaresSigmaSquared)([unit]) | Get the value of "Tavares Sigma Squared". | -| [`GetTensileStressLimit`](#generated.RAParticle.GetTensileStressLimit)([unit]) | Get the value of "Tensile Stress Limit". | -| [`GetThickness`](#generated.RAParticle.GetThickness)([unit]) | Get the value of "Thickness". | -| [`GetTimeSet`](#generated.RAParticle.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAParticle.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAParticle.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAParticle.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTorsionAngleLimit`](#generated.RAParticle.GetTorsionAngleLimit)([unit]) | Get the value of "Torsion Angle Limit". | -| [`GetUseMultipleElements`](#generated.RAParticle.GetUseMultipleElements)() | Whether the particle's Composition is "Multiple Elements". | -| [`GetValidBreakageModelValues`](#generated.RAParticle.GetValidBreakageModelValues)() | Get a list of all possible values for "Breakage Model". | -| [`GetValidDeformationModelValues`](#generated.RAParticle.GetValidDeformationModelValues)() | Get a list of all possible values for "Deformation Model". | -| [`GetValidDistributionModelValues`](#generated.RAParticle.GetValidDistributionModelValues)() | Get a list of all possible values for "Distribution Model". | -| [`GetValidElasticityValues`](#generated.RAParticle.GetValidElasticityValues)() | Get a list of all possible values for "Elasticity". | -| [`GetValidOptionsForModuleProperty`](#generated.RAParticle.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`GetValidPlasticityModelValues`](#generated.RAParticle.GetValidPlasticityModelValues)() | Get a list of all possible values for "Plasticity Model". | -| [`GetValidShapeValues`](#generated.RAParticle.GetValidShapeValues)() | Get a list of all possible values for "Shape". | -| [`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". | -| [`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". | -| [`GetYDirection`](#generated.RAParticle.GetYDirection)([unit]) | Get the value of "Y Direction". | -| [`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 | -| [`IsConcave`](#generated.RAParticle.IsConcave)() | Returns True if the particle is a concave custom polyhedron, and False otherwise. | -| [`IsIncludeRotationalDeformationsEnabled`](#generated.RAParticle.IsIncludeRotationalDeformationsEnabled)() | Check if the "Include Rotational Deformations" is enabled. | -| [`IsRandomOrientationEnabled`](#generated.RAParticle.IsRandomOrientationEnabled)() | Check if the "Random Orientation" is enabled. | -| [`IterCellVertices`](#generated.RAParticle.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAParticle.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAParticle.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAParticle.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAParticle.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAParticle.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAParticle.RemoveProcess)() | Removes the process from the project. | -| [`SetAbt10MaximumT10Value`](#generated.RAParticle.SetAbt10MaximumT10Value)(value[, unit]) | Set the value of "Abt10 Maximum T10 Value". | -| [`SetAbt10MinimumSpecificEnergy`](#generated.RAParticle.SetAbt10MinimumSpecificEnergy)(value[, unit]) | Deprecated: Use [`SetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) instead. | -| [`SetAbt10ReferenceMinimumSpecificEnergy`](#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy)(value) | Set the value of "Abt10 Reference Minimum Specific Energy". | -| [`SetAbt10ReferenceSize`](#generated.RAParticle.SetAbt10ReferenceSize)(value[, unit]) | Set the value of "Abt10 Reference Size". | -| [`SetAbt10SelectFunctionCoefficient`](#generated.RAParticle.SetAbt10SelectFunctionCoefficient)(value[, unit]) | Set the value of "Abt10 Select Function Coefficient". | -| [`SetAllowSelfContacts`](#generated.RAParticle.SetAllowSelfContacts)(value) | Set the value of "Allow Self Contacts". | -| [`SetAnisotropic`](#generated.RAParticle.SetAnisotropic)(value) | Set the value of "Anisotropic". | -| [`SetBendingAngleLimit`](#generated.RAParticle.SetBendingAngleLimit)(value[, unit]) | Set the value of "Bending Angle Limit". | -| [`SetBreakageModel`](#generated.RAParticle.SetBreakageModel)(value) | Set the value of "Breakage Model". | -| [`SetCenterOfMassOffset`](#generated.RAParticle.SetCenterOfMassOffset)(values[, unit]) | Set the values of "Center of Mass Offset". | -| [`SetCgmScaleFactor`](#generated.RAParticle.SetCgmScaleFactor)(value) | Set the value of "Cgm Scale Factor". | -| [`SetChangeMassProperties`](#generated.RAParticle.SetChangeMassProperties)(value) | Set the value of "Change Mass Properties". | -| [`SetCurrentTimeStep`](#generated.RAParticle.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDeformationModel`](#generated.RAParticle.SetDeformationModel)(value) | Set the value of "Deformation Model". | -| [`SetDistributionModel`](#generated.RAParticle.SetDistributionModel)(value) | Set the value of "Distribution Model". | -| [`SetEdgeAngle`](#generated.RAParticle.SetEdgeAngle)(value[, unit]) | Set the value of "Edge Angle". | -| [`SetElasticRatioBending`](#generated.RAParticle.SetElasticRatioBending)(value) | Set the value of "Elastic Ratio Bending". | -| [`SetElasticRatioNormal`](#generated.RAParticle.SetElasticRatioNormal)(value) | Set the value of "Elastic Ratio Normal". | -| [`SetElasticRatioTangential`](#generated.RAParticle.SetElasticRatioTangential)(value) | Set the value of "Elastic Ratio Tangential". | -| [`SetElasticRatioTorsion`](#generated.RAParticle.SetElasticRatioTorsion)(value) | Set the value of "Elastic Ratio Torsion". | -| [`SetElasticity`](#generated.RAParticle.SetElasticity)(value) | Set the value of "Elasticity". | -| [`SetElementDampingRatio`](#generated.RAParticle.SetElementDampingRatio)(value) | Set the value of "Element Damping Ratio". | -| [`SetEnableBreakage`](#generated.RAParticle.SetEnableBreakage)(value) | Set the value of "Enable Breakage". | -| [`SetEnableRandomAngle`](#generated.RAParticle.SetEnableRandomAngle)(value) | Set the value of "Enable Random Angle". | -| [`SetEnableRotations`](#generated.RAParticle.SetEnableRotations)(value) | Set the value of "Enable Rotations". | -| [`SetFailureRatio`](#generated.RAParticle.SetFailureRatio)(value) | Set the value of "Failure Ratio". | -| [`SetFlexible`](#generated.RAParticle.SetFlexible)(value) | Set the value of "Flexible". | -| [`SetHorizontalAspectRatio`](#generated.RAParticle.SetHorizontalAspectRatio)(value) | Set the value of "Horizontal Aspect Ratio". | -| [`SetIncludeRotationalDeformations`](#generated.RAParticle.SetIncludeRotationalDeformations)(value) | Set the value of "Include Rotational Deformations". | -| [`SetInternalFriction`](#generated.RAParticle.SetInternalFriction)(value) | Set the value of "Internal Friction". | -| [`SetJointDampingRatio`](#generated.RAParticle.SetJointDampingRatio)(value) | Set the value of "Joint Damping Ratio". | -| [`SetJointElasticRatio`](#generated.RAParticle.SetJointElasticRatio)(value) | Set the value of "Joint Elastic Ratio". | -| [`SetJointThermalRatio`](#generated.RAParticle.SetJointThermalRatio)(value) | Set the value of "Joint Thermal Ratio". | -| [`SetMaterial`](#generated.RAParticle.SetMaterial)(value) | Set the "Material". | -| [`SetMinimumSize`](#generated.RAParticle.SetMinimumSize)(value[, unit]) | Set the value of "Minimum Size". | -| [`SetMinimumSizeRatio`](#generated.RAParticle.SetMinimumSizeRatio)(value) | Set the value of "Minimum Size Ratio". | -| [`SetMinimumVolumeFractionForFragmentDisabling`](#generated.RAParticle.SetMinimumVolumeFractionForFragmentDisabling)(value) | Set the value of "Minimum Volume Fraction For Fragment Disabling". | -| [`SetModuleProperty`](#generated.RAParticle.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetNumberOfCorners`](#generated.RAParticle.SetNumberOfCorners)(value) | Set the value of "Number of Corners". | -| [`SetOrientation`](#generated.RAParticle.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RAParticle.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RAParticle.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RAParticle.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetPlasticLimit`](#generated.RAParticle.SetPlasticLimit)(value[, unit]) | Set the value of "Plastic Limit". | -| [`SetPlasticRatio`](#generated.RAParticle.SetPlasticRatio)(value) | Set the value of "Plastic Ratio". | -| [`SetPlasticityModel`](#generated.RAParticle.SetPlasticityModel)(value) | Set the value of "Plasticity Model". | -| [`SetPorosity`](#generated.RAParticle.SetPorosity)(value[, unit]) | Set the value of "Porosity". | -| [`SetPrincipalMomentOfInertia`](#generated.RAParticle.SetPrincipalMomentOfInertia)(values[, unit]) | Set the values of "Principal Moment of Inertia". | -| [`SetRandomAnglesHalfRange`](#generated.RAParticle.SetRandomAnglesHalfRange)(values[, unit]) | Set the values of "Random Angles Half Range". | -| [`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". | -| [`SetSideAngle`](#generated.RAParticle.SetSideAngle)(value) | Set the value of "Side Angle". | -| [`SetSizeType`](#generated.RAParticle.SetSizeType)(value) | Set the value of "Size Type". | -| [`SetSmoothness`](#generated.RAParticle.SetSmoothness)(value) | Set the value of "Smoothness". | -| [`SetSuperquadricDegree`](#generated.RAParticle.SetSuperquadricDegree)(value) | Set the value of "Superquadric Degree". | -| [`SetSurfaceEnergy`](#generated.RAParticle.SetSurfaceEnergy)(value[, unit]) | Set the value of "Surface Energy". | -| [`SetT10Formula`](#generated.RAParticle.SetT10Formula)(value) | Set the value of "T10 Formula". | -| [`SetTargetNumberOfElements`](#generated.RAParticle.SetTargetNumberOfElements)(value) | Set the value of "Target Number of Elements". | -| [`SetTavaresA`](#generated.RAParticle.SetTavaresA)(value[, unit]) | Set the value of "Tavares A". | -| [`SetTavaresB`](#generated.RAParticle.SetTavaresB)(value[, unit]) | Set the value of "Tavares B". | -| [`SetTavaresD0`](#generated.RAParticle.SetTavaresD0)(value[, unit]) | Set the value of "Tavares D0". | -| [`SetTavaresEInf`](#generated.RAParticle.SetTavaresEInf)(value[, unit]) | Set the value of "Tavares E Inf". | -| [`SetTavaresGamma`](#generated.RAParticle.SetTavaresGamma)(value[, unit]) | Set the value of "Tavares Gamma". | -| [`SetTavaresMinimumEnergy`](#generated.RAParticle.SetTavaresMinimumEnergy)(value[, unit]) | Set the value of "Tavares Minimum Energy". | -| [`SetTavaresPhi`](#generated.RAParticle.SetTavaresPhi)(value[, unit]) | Set the value of "Tavares Phi". | -| [`SetTavaresRatioEmax`](#generated.RAParticle.SetTavaresRatioEmax)(value[, unit]) | Set the value of "Tavares Ratio Emax". | -| [`SetTavaresSigmaSquared`](#generated.RAParticle.SetTavaresSigmaSquared)(value[, unit]) | Set the value of "Tavares Sigma Squared". | -| [`SetTensileStressLimit`](#generated.RAParticle.SetTensileStressLimit)(value[, unit]) | Set the value of "Tensile Stress Limit". | -| [`SetThickness`](#generated.RAParticle.SetThickness)(value[, unit]) | Set the value of "Thickness". | -| [`SetTorsionAngleLimit`](#generated.RAParticle.SetTorsionAngleLimit)(value[, unit]) | Set the value of "Torsion Angle Limit". | -| [`SetUseMultipleElements`](#generated.RAParticle.SetUseMultipleElements)(value) | Set the particle's Composition to "Multiple Elements" (True) or "Single Elements" (False). | -| [`SetVerticalAspectRatio`](#generated.RAParticle.SetVerticalAspectRatio)(value) | Set the value of "Vertical Aspect Ratio". | -| [`SetVonMisesStressLimit`](#generated.RAParticle.SetVonMisesStressLimit)(value[, unit]) | Set the value of "Von Mises Stress Limit". | -| [`SetWithFailure`](#generated.RAParticle.SetWithFailure)(value) | Set the value of "With Failure". | -| [`SetXDirection`](#generated.RAParticle.SetXDirection)(values[, unit]) | Set the values of "X Direction". | -| [`SetYDirection`](#generated.RAParticle.SetYDirection)(values[, unit]) | Set the values of "Y Direction". | -| [`SetZDirection`](#generated.RAParticle.SetZDirection)(values[, unit]) | Set the values of "Z Direction". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableBreakage() - -Set the value of “Breakage” to False. - - - -#### DisableIncludeRotationalDeformations() - -Set the value of “Include Rotational Deformations” to False. - - - -#### DisableRandomOrientation() - -Set the value of “Random Orientation” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableBreakage() - -Set the value of “Breakage” to True. - - - -#### EnableIncludeRotationalDeformations() - -Set the value of “Include Rotational Deformations” to True. - - - -#### EnableRandomOrientation() - -Set the value of “Random Orientation” to True. - - - -#### GetAbt10MaximumT10Value(unit: str | None = None) - -Get the value of “Abt10 Maximum T10 Value”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “%”. - - - -#### GetAbt10MinimumSpecificEnergy(unit: str | None = None) - -Deprecated: Use [`GetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) instead. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. - - - -#### GetAbt10ReferenceMinimumSpecificEnergy(unit: str | None = None) - -Get the value of “Abt10 Reference Minimum Specific Energy”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. - - - -#### GetAbt10ReferenceSize(unit: str | None = None) - -Get the value of “Abt10 Reference Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetAbt10SelectFunctionCoefficient(unit: str | None = None) - -Get the value of “Abt10 Select Function Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/J”. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAllowSelfContacts() - -Get the value of “Allow Self Contacts”. - - - -#### GetAnisotropic() - -Deprecated: Use [`GetElasticity()`](#generated.RAParticle.GetElasticity) instead. - -* **Return type:** - bool - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetBendingAngleLimit(unit: str | None = None) - -Get the value of “Bending Angle Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetBreakageModel() - -Get “Breakage Model” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘ab_t10’, ‘professor_tavares’, ‘instantaneous_custom’, ‘griffith_surface_energy’, ‘shear_stress_criterion’, ‘tensile_stress_criterion’, ‘tensile_or_shear_criterion’, ‘von_mises_stress_criterion’, ‘discrete_custom’]. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenterOfMassOffset(unit: str | None = None) - -Get the value of “Center of Mass Offset”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “%”. - - - -#### GetCgmScaleFactor() - -Get the value of “Cgm Scale Factor”. - - - -#### GetChangeMassProperties() - -Get the value of “Change Mass Properties”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDeformationModel() - -Get “Deformation Model” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘elastic’, ‘plastic’]. - - - -#### GetDistributionModel() - -Get “Distribution Model” as a string. - -* **Returns:** - The returned value will be one of [‘gaudin_schumann’, ‘incomplete_beta’, ‘custom’]. - - - -#### GetEdgeAngle(unit: str | None = None) - -Get the value of “Edge Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetElasticRatioBending() - -Get the value of “Elastic Ratio Bending”. - - - -#### GetElasticRatioNormal() - -Get the value of “Elastic Ratio Normal”. - - - -#### GetElasticRatioTangential() - -Get the value of “Elastic Ratio Tangential”. - - - -#### GetElasticRatioTorsion() - -Get the value of “Elastic Ratio Torsion”. - - - -#### GetElasticity() - -Get “Elasticity” as a string. - -* **Returns:** - The returned value will be one of [‘isotropic’, ‘anisotropic’]. - - - -#### 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. - - - -#### GetElementDampingRatio() - -Get the value of “Element Damping Ratio”. - - - -#### GetEnableBreakage() - -Get the value of “Enable Breakage”. - - - -#### GetEnableRandomAngle() - -Get the value of “Enable Random Angle”. - - - -#### GetEnableRotations() - -Get the value of “Enable Rotations”. - - - -#### GetFailureRatio() - -Get the value of “Failure Ratio”. - - - -#### GetFlexible() - -Get the value of “Flexible”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetHorizontalAspectRatio() - -Get the value of “Horizontal Aspect Ratio”. - - - -#### GetIncludeRotationalDeformations() - -Get the value of “Include Rotational Deformations”. - - - -#### GetInternalFriction() - -Get the value of “Internal Friction”. - - - -#### GetJointDampingRatio() - -Get the value of “Joint Damping Ratio”. - - - -#### GetJointElasticRatio() - -Get the value of “Joint Elastic Ratio”. - - - -#### GetJointThermalRatio() - -Get the value of “Joint Thermal Ratio”. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinimumSize(unit: str | None = None) - -Get the value of “Minimum Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMinimumSizeRatio() - -Get the value of “Minimum Size Ratio”. - - - -#### GetMinimumVolumeFractionForFragmentDisabling() - -Get the value of “Minimum Volume Fraction For Fragment Disabling”. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfCorners() - -Get the value of “Number of Corners”. - - - -#### GetNumberOfNodes(time_step='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 - 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetPlasticLimit(unit: str | None = None) - -Get the value of “Plastic Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa”. - - - -#### GetPlasticRatio() - -Get the value of “Plastic Ratio”. - - - -#### GetPlasticityModel() - -Get “Plasticity Model” as a string. - -* **Returns:** - The returned value will be one of [‘LinearElastic’, ‘BilinearElastoplastic’, ‘Custom’]. - - - -#### GetPorosity(unit: str | None = None) - -Get the value of “Porosity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “”. - - - -#### GetPrincipalMomentOfInertia(unit: str | None = None) - -Get the value of “Principal Moment of Inertia”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m5”. - - - -#### GetRandomAnglesHalfRange(unit: str | None = None) - -Get the value of “Random Angles Half Range”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “rad”. - - - -#### GetRatioEnergyAfterBreakage(unit: str | None = None) - -Get the value of “Ratio Energy After Breakage”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetRemeshToTarget() - -Get the value of “Remesh To Target”. - - - -#### GetRollingResistance() - -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) - -Get the value of “Second Bending Angle Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetShape() - -Get “Shape” as a string. - -* **Returns:** - The returned value will be one of [‘sphere’, ‘polyhedron’, ‘sphero_cylinder’, ‘sphero_polygon’, ‘sphero_polyhedron’, ‘briquete’, ‘faceted_cylinder’, ‘assembly’, ‘straight_fiber’, ‘custom_fiber’, ‘custom_shell’, ‘custom_polyhedron’]. - - - -#### GetShearStressLimit(unit: str | None = None) - -Get the value of “Shear Stress Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. - - - -#### GetSideAngle() - -Get the value of “Side Angle”. - - - -#### GetSizeDistributionList() - -Get a list of size distribution entries - - - -#### GetSizeType() - -Get “Size Type” as a string. - -* **Returns:** - The returned value will be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. - - - -#### GetSmoothness() - -Get the value of “Smoothness”. - - - -#### GetSuperquadricDegree() - -Get the value of “Superquadric Degree”. - - - -#### GetSurfaceEnergy(unit: str | None = None) - -Get the value of “Surface Energy”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/m2”. - - - -#### GetT10Formula() - -Get “T10 Formula” as a string. - -* **Returns:** - The returned value will be one of [‘it10E_50b’, ‘it10E_fract’]. - - - -#### GetTargetNumberOfElements() - -Get the value of “Target Number of Elements”. - - - -#### GetTavaresA(unit: str | None = None) - -Get the value of “Tavares A”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “%”. - - - -#### GetTavaresB(unit: str | None = None) - -Get the value of “Tavares B”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetTavaresD0(unit: str | None = None) - -Get the value of “Tavares D0”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetTavaresEInf(unit: str | None = None) - -Get the value of “Tavares E Inf”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. - - - -#### GetTavaresGamma(unit: str | None = None) - -Get the value of “Tavares Gamma”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetTavaresMinimumEnergy(unit: str | None = None) - -Get the value of “Tavares Minimum Energy”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. - - - -#### GetTavaresPhi(unit: str | None = None) - -Get the value of “Tavares Phi”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetTavaresRatioEmax(unit: str | None = None) - -Get the value of “Tavares Ratio Emax”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetTavaresSigmaSquared(unit: str | None = None) - -Get the value of “Tavares Sigma Squared”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetTensileStressLimit(unit: str | None = None) - -Get the value of “Tensile Stress Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. - - - -#### GetThickness(unit: str | None = None) - -Get the value of “Thickness”. - -* **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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTorsionAngleLimit(unit: str | None = None) - -Get the value of “Torsion Angle Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetUseMultipleElements() - -Whether the particle’s Composition is “Multiple Elements”. - - - -#### GetValidBreakageModelValues() - -Get a list of all possible values for “Breakage Model”. - -* **Returns:** - The returned list is [‘none’, ‘ab_t10’, ‘professor_tavares’, ‘instantaneous_custom’, ‘griffith_surface_energy’, ‘shear_stress_criterion’, ‘tensile_stress_criterion’, ‘tensile_or_shear_criterion’, ‘von_mises_stress_criterion’, ‘discrete_custom’]. - - - -#### GetValidDeformationModelValues() - -Get a list of all possible values for “Deformation Model”. - -* **Returns:** - The returned list is [‘none’, ‘elastic’, ‘plastic’]. - - - -#### GetValidDistributionModelValues() - -Get a list of all possible values for “Distribution Model”. - -* **Returns:** - The returned list is [‘gaudin_schumann’, ‘incomplete_beta’, ‘custom’]. - - - -#### GetValidElasticityValues() - -Get a list of all possible values for “Elasticity”. - -* **Returns:** - The returned list is [‘isotropic’, ‘anisotropic’]. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### GetValidPlasticityModelValues() - -Get a list of all possible values for “Plasticity Model”. - -* **Returns:** - The returned list is [‘LinearElastic’, ‘BilinearElastoplastic’, ‘Custom’]. - - - -#### GetValidShapeValues() - -Get a list of all possible values for “Shape”. - -* **Returns:** - The returned list is [‘sphere’, ‘polyhedron’, ‘sphero_cylinder’, ‘sphero_polygon’, ‘sphero_polyhedron’, ‘briquete’, ‘faceted_cylinder’, ‘assembly’, ‘straight_fiber’, ‘custom_fiber’, ‘custom_shell’, ‘custom_polyhedron’]. - - - -#### GetValidSizeTypeValues() - -Get a list of all possible values for “Size Type”. - -* **Returns:** - The returned list is [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. - - - -#### GetValidT10FormulaValues() - -Get a list of all possible values for “T10 Formula”. - -* **Returns:** - The returned list is [‘it10E_50b’, ‘it10E_fract’]. - - - -#### GetVerticalAspectRatio() - -Get the value of “Vertical Aspect Ratio”. - - - -#### GetVonMisesStressLimit(unit: str | None = None) - -Get the value of “Von Mises Stress Limit”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. - - - -#### GetWithFailure() - -Get the value of “With Failure”. - - - -#### GetXDirection(unit: str | None = None) - -Get the value of “X Direction”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “-“. - - - -#### GetYDirection(unit: str | None = None) - -Get the value of “Y Direction”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “-“. - - - -#### GetZDirection(unit: str | None = None) - -Get the value of “Z Direction”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “-“. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### ImportCustomFiber(filename: str) - -Import a custom fiber shape from the given filename into this particle. - -* **Parameters:** - **filename** – The full path to the TXT/CSV/Excel file. -* **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) - -Import a custom shape from the given stl filename into this particle. - -* **Parameters:** - * **stl_filename** – The full path to the STL file. - * **as_concave** – True whether the particle should be treated as Concave, or False otherwise - * **is_open** – True whether the stl is an open one -* **Returns:** - Possible return values: - \* True if everything went fine with the import process. - \* False if the import process failed. - - - -#### IsBreakageEnabled() - -Check if the “Breakage” is enabled. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsConcave() - -Returns True if the particle is a concave custom polyhedron, and False otherwise. - -* **Return type:** - bool - - - -#### IsIncludeRotationalDeformationsEnabled() - -Check if the “Include Rotational Deformations” is enabled. - - - -#### IsRandomOrientationEnabled() - -Check if the “Random Orientation” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetAbt10MaximumT10Value(value: str | float, unit: str | None = None) - -Set the value of “Abt10 Maximum T10 Value”. - -* **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 “%”. - - - -#### SetAbt10MinimumSpecificEnergy(value: float, unit: str | None = None) - -Deprecated: Use [`SetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) instead. - -* **Parameters:** - * **value** – The value to set. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “J/kg”. - - - -#### SetAbt10ReferenceMinimumSpecificEnergy(value: str | float, unit: str | None = None) - -Set the value of “Abt10 Reference Minimum Specific Energy”. - -* **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 “J/kg”. - - - -#### SetAbt10ReferenceSize(value: str | float, unit: str | None = None) - -Set the value of “Abt10 Reference Size”. - -* **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”. - - - -#### SetAbt10SelectFunctionCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Abt10 Select Function Coefficient”. - -* **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 “kg/J”. - - - -#### SetAllowSelfContacts(value: bool) - -Set the value of “Allow Self Contacts”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetAnisotropic(value: bool) - -Set the value of “Anisotropic”. - -* **Parameters:** - **value** (*bool*) – The value to set. - - - -#### SetBendingAngleLimit(value: str | float, unit: str | None = None) - -Set the value of “Bending Angle Limit”. - -* **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 “dega”. - - - -#### SetBreakageModel(value: str) - -Set the value of “Breakage Model”. -If the particle is not flexible, setting the model to any value other than “none” also enables breakage. - -* **Parameters:** - **value** (*str*) – The value to set. Must be one of [‘none’, ‘ab_t10’, ‘professor_tavares’, ‘instantaneous_custom’, ‘griffith_surface_energy’, ‘shear_stress_criterion’, ‘tensile_stress_criterion’, ‘tensile_or_shear_criterion’, ‘von_mises_stress_criterion’, ‘discrete_custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Breakage Model” option. - - - -#### SetCenterOfMassOffset(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Center of Mass Offset”. - -* **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 “%”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetCgmScaleFactor(value: str | float) - -Set the value of “Cgm Scale Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetChangeMassProperties(value: bool) - -Set the value of “Change Mass Properties”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDeformationModel(value: str) - -Set the value of “Deformation Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘elastic’, ‘plastic’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Deformation Model” option. - - - -#### SetDistributionModel(value: str) - -Set the value of “Distribution Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘gaudin_schumann’, ‘incomplete_beta’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Distribution Model” option. - - - -#### SetEdgeAngle(value: str | float, unit: str | None = None) - -Set the value of “Edge 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 “dega”. - - - -#### SetElasticRatioBending(value: str | float) - -Set the value of “Elastic Ratio Bending”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetElasticRatioNormal(value: str | float) - -Set the value of “Elastic Ratio Normal”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetElasticRatioTangential(value: str | float) - -Set the value of “Elastic Ratio Tangential”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetElasticRatioTorsion(value: str | float) - -Set the value of “Elastic Ratio Torsion”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetElasticity(value: str) - -Set the value of “Elasticity”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘isotropic’, ‘anisotropic’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Elasticity” option. - - - -#### SetElementDampingRatio(value: str | float) - -Set the value of “Element Damping Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetEnableBreakage(value: bool) - -Set the value of “Enable Breakage”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetEnableRandomAngle(value: bool) - -Set the value of “Enable Random Angle”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetEnableRotations(value: bool) - -Set the value of “Enable Rotations”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFailureRatio(value: str | float) - -Set the value of “Failure Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetFlexible(value: bool) - -Set the value of “Flexible”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetHorizontalAspectRatio(value: str | float) - -Set the value of “Horizontal Aspect Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetIncludeRotationalDeformations(value: bool) - -Set the value of “Include Rotational Deformations”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetInternalFriction(value: str | float) - -Set the value of “Internal Friction”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetJointDampingRatio(value: str | float) - -Set the value of “Joint Damping Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetJointElasticRatio(value: str | float) - -Set the value of “Joint Elastic Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetJointThermalRatio(value: str | float) - -Set the value of “Joint Thermal Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetMinimumSize(value: str | float, unit: str | None = None) - -Set the value of “Minimum Size”. - -* **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”. - - - -#### SetMinimumSizeRatio(value: str | float) - -Set the value of “Minimum Size Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetMinimumVolumeFractionForFragmentDisabling(value: str | float) - -Set the value of “Minimum Volume Fraction For Fragment Disabling”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetNumberOfCorners(value: str | int) - -Set the value of “Number of Corners”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### 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. - - - -#### SetPlasticLimit(value: str | float, unit: str | None = None) - -Set the value of “Plastic Limit”. - -* **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 “Pa”. - - - -#### SetPlasticRatio(value: str | float) - -Set the value of “Plastic Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetPlasticityModel(value: str) - -Set the value of “Plasticity Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘LinearElastic’, ‘BilinearElastoplastic’, ‘Custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Plasticity Model” option. - - - -#### SetPorosity(value: str | float, unit: str | None = None) - -Set the value of “Porosity”. - -* **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 “”. - - - -#### SetPrincipalMomentOfInertia(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Principal Moment of Inertia”. - -* **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 “m5”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetRandomAnglesHalfRange(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Random Angles Half Range”. - -* **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 “rad”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetRatioEnergyAfterBreakage(value: str | float, unit: str | None = None) - -Set the value of “Ratio Energy After Breakage”. - -* **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 “-“. - - - -#### SetRemeshToTarget(value: bool) - -Set the value of “Remesh To Target”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetRollingResistance(value: str | float) - -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) - -Set the value of “Second Bending Angle Limit”. - -* **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 “dega”. - - - -#### SetShape(value: str) - -Set the value of “Shape”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘sphere’, ‘polyhedron’, ‘sphero_cylinder’, ‘sphero_polygon’, ‘sphero_polyhedron’, ‘briquete’, ‘faceted_cylinder’, ‘assembly’, ‘straight_fiber’, ‘custom_fiber’, ‘custom_shell’, ‘custom_polyhedron’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Shape” option. - - - -#### SetShearStressLimit(value: str | float, unit: str | None = None) - -Set the value of “Shear Stress Limit”. - -* **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 “N/m2”. - - - -#### SetSideAngle(value: str | float) - -Set the value of “Side Angle”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSizeType(value: str) - -Set the value of “Size Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Size Type” option. - - - -#### SetSmoothness(value: str | float) - -Set the value of “Smoothness”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSuperquadricDegree(value: str | float) - -Set the value of “Superquadric Degree”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSurfaceEnergy(value: str | float, unit: str | None = None) - -Set the value of “Surface Energy”. - -* **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 “J/m2”. - - - -#### SetT10Formula(value: str) - -Set the value of “T10 Formula”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘it10E_50b’, ‘it10E_fract’]. -* **Raises:** - **RockyApiError** – If value is not a valid “T10 Formula” option. - - - -#### SetTargetNumberOfElements(value: str | int) - -Set the value of “Target Number of Elements”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetTavaresA(value: str | float, unit: str | None = None) - -Set the value of “Tavares A”. - -* **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 “%”. - - - -#### SetTavaresB(value: str | float, unit: str | None = None) - -Set the value of “Tavares B”. - -* **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 “-“. - - - -#### SetTavaresD0(value: str | float, unit: str | None = None) - -Set the value of “Tavares D0”. - -* **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”. - - - -#### SetTavaresEInf(value: str | float, unit: str | None = None) - -Set the value of “Tavares E Inf”. - -* **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 “J/kg”. - - - -#### SetTavaresGamma(value: str | float, unit: str | None = None) - -Set the value of “Tavares Gamma”. - -* **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 “-“. - - - -#### SetTavaresMinimumEnergy(value: str | float, unit: str | None = None) - -Set the value of “Tavares Minimum Energy”. - -* **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 “J/kg”. - - - -#### SetTavaresPhi(value: str | float, unit: str | None = None) - -Set the value of “Tavares Phi”. - -* **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 “-“. - - - -#### SetTavaresRatioEmax(value: str | float, unit: str | None = None) - -Set the value of “Tavares Ratio Emax”. - -* **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 “-“. - - - -#### SetTavaresSigmaSquared(value: str | float, unit: str | None = None) - -Set the value of “Tavares Sigma Squared”. - -* **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 “-“. - - - -#### SetTensileStressLimit(value: str | float, unit: str | None = None) - -Set the value of “Tensile Stress Limit”. - -* **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 “N/m2”. - - - -#### SetThickness(value: str | float, unit: str | None = None) - -Set the value of “Thickness”. - -* **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”. - - - -#### SetTorsionAngleLimit(value: str | float, unit: str | None = None) - -Set the value of “Torsion Angle Limit”. - -* **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 “dega”. - - - -#### SetUseMultipleElements(value) - -Set the particle’s Composition to “Multiple Elements” (True) or “Single Elements” (False). - -* **Parameters:** - **value** (*bool*) - - - -#### SetVerticalAspectRatio(value: str | float) - -Set the value of “Vertical Aspect Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetVonMisesStressLimit(value: str | float, unit: str | None = None) - -Set the value of “Von Mises Stress Limit”. - -* **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 “N/m2”. - - - -#### SetWithFailure(value: bool) - -Set the value of “With Failure”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetXDirection(values: Sequence[str | float], unit: str | None = None) - -Set the values of “X Direction”. - -* **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 “-“. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetYDirection(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Y Direction”. - -* **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 “-“. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetZDirection(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Z Direction”. - -* **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 “-“. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. + + +# RAParticle + + + + + + +### *class* RAParticle + +Rocky PrePost Scripting wrapper for a particle in the project. + +The wrapper corresponds to an individual Particle entry in the project’s data tree, below the +“Particles” item. Particles can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RAParticleCollection`](RAParticleCollection.md#generated.RAParticleCollection) via: + +```python +particle_1 = study.GetElement('Particle 1') +particle_2 = particle_collection[1] +particle_3 = particle_collection.GetParticle('Particle 3') +``` + +Most particle properties, such as name, shape, aspect ratios, etc can be set directly via methods +in this wrapper class. An exception is size-related methods, which must be configured via the +[`RASizeDistributionList`](RASizeDistributionList.md#generated.RASizeDistributionList) returned in [`GetSizeDistributionList()`](#generated.RAParticle.GetSizeDistributionList). + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAParticle.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAParticle.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.RAParticle.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAParticle.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAParticle.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.RAParticle.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAParticle.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAParticle.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.RAParticle.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). | +| [`DisableBreakage`](#generated.RAParticle.DisableBreakage)() | Set the value of "Breakage" to False. | +| [`DisableIncludeRotationalDeformations`](#generated.RAParticle.DisableIncludeRotationalDeformations)() | Set the value of "Include Rotational Deformations" to False. | +| [`DisableRandomOrientation`](#generated.RAParticle.DisableRandomOrientation)() | Set the value of "Random Orientation" to False. | +| [`EditCustomCurve`](#generated.RAParticle.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.RAParticle.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. | +| [`EnableBreakage`](#generated.RAParticle.EnableBreakage)() | Set the value of "Breakage" to True. | +| [`EnableIncludeRotationalDeformations`](#generated.RAParticle.EnableIncludeRotationalDeformations)() | Set the value of "Include Rotational Deformations" to True. | +| [`EnableRandomOrientation`](#generated.RAParticle.EnableRandomOrientation)() | Set the value of "Random Orientation" to True. | +| [`GetAbt10MaximumT10Value`](#generated.RAParticle.GetAbt10MaximumT10Value)([unit]) | Get the value of "Abt10 Maximum T10 Value". | +| [`GetAbt10MinimumSpecificEnergy`](#generated.RAParticle.GetAbt10MinimumSpecificEnergy)([unit]) | Deprecated: Use [`GetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) instead. | +| [`GetAbt10ReferenceMinimumSpecificEnergy`](#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy)([unit]) | Get the value of "Abt10 Reference Minimum Specific Energy". | +| [`GetAbt10ReferenceSize`](#generated.RAParticle.GetAbt10ReferenceSize)([unit]) | Get the value of "Abt10 Reference Size". | +| [`GetAbt10SelectFunctionCoefficient`](#generated.RAParticle.GetAbt10SelectFunctionCoefficient)([unit]) | Get the value of "Abt10 Select Function Coefficient". | +| [`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. | +| [`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. | +| [`GetBreakageModel`](#generated.RAParticle.GetBreakageModel)() | Get "Breakage Model" as a string. | +| [`GetCellAreaAsArray`](#generated.RAParticle.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAParticle.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAParticle.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAParticle.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAParticle.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAParticle.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAParticle.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAParticle.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenterOfMassOffset`](#generated.RAParticle.GetCenterOfMassOffset)([unit]) | Get the value of "Center of Mass Offset". | +| [`GetCgmScaleFactor`](#generated.RAParticle.GetCgmScaleFactor)() | Get the value of "Cgm Scale Factor". | +| [`GetChangeMassProperties`](#generated.RAParticle.GetChangeMassProperties)() | Get the value of "Change Mass Properties". | +| [`GetCurve`](#generated.RAParticle.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAParticle.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RAParticle.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetDeformationModel`](#generated.RAParticle.GetDeformationModel)() | Get "Deformation Model" as a string. | +| [`GetDistributionModel`](#generated.RAParticle.GetDistributionModel)() | Get "Distribution Model" as a string. | +| [`GetEdgeAngle`](#generated.RAParticle.GetEdgeAngle)([unit]) | Get the value of "Edge Angle". | +| [`GetElasticRatioBending`](#generated.RAParticle.GetElasticRatioBending)() | Get the value of "Elastic Ratio Bending". | +| [`GetElasticRatioNormal`](#generated.RAParticle.GetElasticRatioNormal)() | Get the value of "Elastic Ratio Normal". | +| [`GetElasticRatioTangential`](#generated.RAParticle.GetElasticRatioTangential)() | Get the value of "Elastic Ratio Tangential". | +| [`GetElasticRatioTorsion`](#generated.RAParticle.GetElasticRatioTorsion)() | Get the value of "Elastic Ratio Torsion". | +| [`GetElasticity`](#generated.RAParticle.GetElasticity)() | Get "Elasticity" as a string. | +| [`GetElementCurve`](#generated.RAParticle.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetElementDampingRatio`](#generated.RAParticle.GetElementDampingRatio)() | Get the value of "Element Damping Ratio". | +| [`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". | +| [`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. | +| [`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. | +| [`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". | +| [`GetJointDampingRatio`](#generated.RAParticle.GetJointDampingRatio)() | Get the value of "Joint Damping Ratio". | +| [`GetJointElasticRatio`](#generated.RAParticle.GetJointElasticRatio)() | Get the value of "Joint Elastic Ratio". | +| [`GetJointThermalRatio`](#generated.RAParticle.GetJointThermalRatio)() | Get the value of "Joint Thermal Ratio". | +| [`GetMaterial`](#generated.RAParticle.GetMaterial)() | Get the "Material". | +| [`GetMeshColoring`](#generated.RAParticle.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMinimumSize`](#generated.RAParticle.GetMinimumSize)([unit]) | Get the value of "Minimum Size". | +| [`GetMinimumSizeRatio`](#generated.RAParticle.GetMinimumSizeRatio)() | Get the value of "Minimum Size Ratio". | +| [`GetMinimumVolumeFractionForFragmentDisabling`](#generated.RAParticle.GetMinimumVolumeFractionForFragmentDisabling)() | Get the value of "Minimum Volume Fraction For Fragment Disabling". | +| [`GetModuleProperties`](#generated.RAParticle.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAParticle.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetNumberOfCells`](#generated.RAParticle.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfCorners`](#generated.RAParticle.GetNumberOfCorners)() | Get the value of "Number of Corners". | +| [`GetNumberOfNodes`](#generated.RAParticle.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAParticle.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RAParticle.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RAParticle.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RAParticle.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RAParticle.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RAParticle.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetPlasticLimit`](#generated.RAParticle.GetPlasticLimit)([unit]) | Get the value of "Plastic Limit". | +| [`GetPlasticRatio`](#generated.RAParticle.GetPlasticRatio)() | Get the value of "Plastic Ratio". | +| [`GetPlasticityModel`](#generated.RAParticle.GetPlasticityModel)() | Get "Plasticity Model" as a string. | +| [`GetPorosity`](#generated.RAParticle.GetPorosity)([unit]) | Get the value of "Porosity". | +| [`GetPrincipalMomentOfInertia`](#generated.RAParticle.GetPrincipalMomentOfInertia)([unit]) | Get the value of "Principal Moment of Inertia". | +| [`GetRandomAnglesHalfRange`](#generated.RAParticle.GetRandomAnglesHalfRange)([unit]) | Get the value of "Random Angles Half Range". | +| [`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". | +| [`GetSideAngle`](#generated.RAParticle.GetSideAngle)() | Get the value of "Side Angle". | +| [`GetSizeDistributionList`](#generated.RAParticle.GetSizeDistributionList)() | Get a list of size distribution entries | +| [`GetSizeType`](#generated.RAParticle.GetSizeType)() | Get "Size Type" as a string. | +| [`GetSmoothness`](#generated.RAParticle.GetSmoothness)() | Get the value of "Smoothness". | +| [`GetSuperquadricDegree`](#generated.RAParticle.GetSuperquadricDegree)() | Get the value of "Superquadric Degree". | +| [`GetSurfaceEnergy`](#generated.RAParticle.GetSurfaceEnergy)([unit]) | Get the value of "Surface Energy". | +| [`GetT10Formula`](#generated.RAParticle.GetT10Formula)() | Get "T10 Formula" as a string. | +| [`GetTargetNumberOfElements`](#generated.RAParticle.GetTargetNumberOfElements)() | Get the value of "Target Number of Elements". | +| [`GetTavaresA`](#generated.RAParticle.GetTavaresA)([unit]) | Get the value of "Tavares A". | +| [`GetTavaresB`](#generated.RAParticle.GetTavaresB)([unit]) | Get the value of "Tavares B". | +| [`GetTavaresD0`](#generated.RAParticle.GetTavaresD0)([unit]) | Get the value of "Tavares D0". | +| [`GetTavaresEInf`](#generated.RAParticle.GetTavaresEInf)([unit]) | Get the value of "Tavares E Inf". | +| [`GetTavaresGamma`](#generated.RAParticle.GetTavaresGamma)([unit]) | Get the value of "Tavares Gamma". | +| [`GetTavaresMinimumEnergy`](#generated.RAParticle.GetTavaresMinimumEnergy)([unit]) | Get the value of "Tavares Minimum Energy". | +| [`GetTavaresPhi`](#generated.RAParticle.GetTavaresPhi)([unit]) | Get the value of "Tavares Phi". | +| [`GetTavaresRatioEmax`](#generated.RAParticle.GetTavaresRatioEmax)([unit]) | Get the value of "Tavares Ratio Emax". | +| [`GetTavaresSigmaSquared`](#generated.RAParticle.GetTavaresSigmaSquared)([unit]) | Get the value of "Tavares Sigma Squared". | +| [`GetTensileStressLimit`](#generated.RAParticle.GetTensileStressLimit)([unit]) | Get the value of "Tensile Stress Limit". | +| [`GetThickness`](#generated.RAParticle.GetThickness)([unit]) | Get the value of "Thickness". | +| [`GetTimeSet`](#generated.RAParticle.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAParticle.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAParticle.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAParticle.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTorsionAngleLimit`](#generated.RAParticle.GetTorsionAngleLimit)([unit]) | Get the value of "Torsion Angle Limit". | +| [`GetUseMultipleElements`](#generated.RAParticle.GetUseMultipleElements)() | Whether the particle's Composition is "Multiple Elements". | +| [`GetValidBreakageModelValues`](#generated.RAParticle.GetValidBreakageModelValues)() | Get a list of all possible values for "Breakage Model". | +| [`GetValidDeformationModelValues`](#generated.RAParticle.GetValidDeformationModelValues)() | Get a list of all possible values for "Deformation Model". | +| [`GetValidDistributionModelValues`](#generated.RAParticle.GetValidDistributionModelValues)() | Get a list of all possible values for "Distribution Model". | +| [`GetValidElasticityValues`](#generated.RAParticle.GetValidElasticityValues)() | Get a list of all possible values for "Elasticity". | +| [`GetValidOptionsForModuleProperty`](#generated.RAParticle.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`GetValidPlasticityModelValues`](#generated.RAParticle.GetValidPlasticityModelValues)() | Get a list of all possible values for "Plasticity Model". | +| [`GetValidShapeValues`](#generated.RAParticle.GetValidShapeValues)() | Get a list of all possible values for "Shape". | +| [`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". | +| [`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". | +| [`GetYDirection`](#generated.RAParticle.GetYDirection)([unit]) | Get the value of "Y Direction". | +| [`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 | +| [`IsConcave`](#generated.RAParticle.IsConcave)() | Returns True if the particle is a concave custom polyhedron, and False otherwise. | +| [`IsIncludeRotationalDeformationsEnabled`](#generated.RAParticle.IsIncludeRotationalDeformationsEnabled)() | Check if the "Include Rotational Deformations" is enabled. | +| [`IsRandomOrientationEnabled`](#generated.RAParticle.IsRandomOrientationEnabled)() | Check if the "Random Orientation" is enabled. | +| [`IterCellVertices`](#generated.RAParticle.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAParticle.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAParticle.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAParticle.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAParticle.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAParticle.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAParticle.RemoveProcess)() | Removes the process from the project. | +| [`SetAbt10MaximumT10Value`](#generated.RAParticle.SetAbt10MaximumT10Value)(value[, unit]) | Set the value of "Abt10 Maximum T10 Value". | +| [`SetAbt10MinimumSpecificEnergy`](#generated.RAParticle.SetAbt10MinimumSpecificEnergy)(value[, unit]) | Deprecated: Use [`SetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) instead. | +| [`SetAbt10ReferenceMinimumSpecificEnergy`](#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy)(value) | Set the value of "Abt10 Reference Minimum Specific Energy". | +| [`SetAbt10ReferenceSize`](#generated.RAParticle.SetAbt10ReferenceSize)(value[, unit]) | Set the value of "Abt10 Reference Size". | +| [`SetAbt10SelectFunctionCoefficient`](#generated.RAParticle.SetAbt10SelectFunctionCoefficient)(value[, unit]) | Set the value of "Abt10 Select Function Coefficient". | +| [`SetAllowSelfContacts`](#generated.RAParticle.SetAllowSelfContacts)(value) | Set the value of "Allow Self Contacts". | +| [`SetAnisotropic`](#generated.RAParticle.SetAnisotropic)(value) | Set the value of "Anisotropic". | +| [`SetBendingAngleLimit`](#generated.RAParticle.SetBendingAngleLimit)(value[, unit]) | Set the value of "Bending Angle Limit". | +| [`SetBreakageModel`](#generated.RAParticle.SetBreakageModel)(value) | Set the value of "Breakage Model". | +| [`SetCenterOfMassOffset`](#generated.RAParticle.SetCenterOfMassOffset)(values[, unit]) | Set the values of "Center of Mass Offset". | +| [`SetCgmScaleFactor`](#generated.RAParticle.SetCgmScaleFactor)(value) | Set the value of "Cgm Scale Factor". | +| [`SetChangeMassProperties`](#generated.RAParticle.SetChangeMassProperties)(value) | Set the value of "Change Mass Properties". | +| [`SetCurrentTimeStep`](#generated.RAParticle.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDeformationModel`](#generated.RAParticle.SetDeformationModel)(value) | Set the value of "Deformation Model". | +| [`SetDistributionModel`](#generated.RAParticle.SetDistributionModel)(value) | Set the value of "Distribution Model". | +| [`SetEdgeAngle`](#generated.RAParticle.SetEdgeAngle)(value[, unit]) | Set the value of "Edge Angle". | +| [`SetElasticRatioBending`](#generated.RAParticle.SetElasticRatioBending)(value) | Set the value of "Elastic Ratio Bending". | +| [`SetElasticRatioNormal`](#generated.RAParticle.SetElasticRatioNormal)(value) | Set the value of "Elastic Ratio Normal". | +| [`SetElasticRatioTangential`](#generated.RAParticle.SetElasticRatioTangential)(value) | Set the value of "Elastic Ratio Tangential". | +| [`SetElasticRatioTorsion`](#generated.RAParticle.SetElasticRatioTorsion)(value) | Set the value of "Elastic Ratio Torsion". | +| [`SetElasticity`](#generated.RAParticle.SetElasticity)(value) | Set the value of "Elasticity". | +| [`SetElementDampingRatio`](#generated.RAParticle.SetElementDampingRatio)(value) | Set the value of "Element Damping Ratio". | +| [`SetEnableBreakage`](#generated.RAParticle.SetEnableBreakage)(value) | Set the value of "Enable Breakage". | +| [`SetEnableRandomAngle`](#generated.RAParticle.SetEnableRandomAngle)(value) | Set the value of "Enable Random Angle". | +| [`SetEnableRotations`](#generated.RAParticle.SetEnableRotations)(value) | Set the value of "Enable Rotations". | +| [`SetFailureRatio`](#generated.RAParticle.SetFailureRatio)(value) | Set the value of "Failure Ratio". | +| [`SetFlexible`](#generated.RAParticle.SetFlexible)(value) | Set the value of "Flexible". | +| [`SetHorizontalAspectRatio`](#generated.RAParticle.SetHorizontalAspectRatio)(value) | Set the value of "Horizontal Aspect Ratio". | +| [`SetIncludeRotationalDeformations`](#generated.RAParticle.SetIncludeRotationalDeformations)(value) | Set the value of "Include Rotational Deformations". | +| [`SetInternalFriction`](#generated.RAParticle.SetInternalFriction)(value) | Set the value of "Internal Friction". | +| [`SetJointDampingRatio`](#generated.RAParticle.SetJointDampingRatio)(value) | Set the value of "Joint Damping Ratio". | +| [`SetJointElasticRatio`](#generated.RAParticle.SetJointElasticRatio)(value) | Set the value of "Joint Elastic Ratio". | +| [`SetJointThermalRatio`](#generated.RAParticle.SetJointThermalRatio)(value) | Set the value of "Joint Thermal Ratio". | +| [`SetMaterial`](#generated.RAParticle.SetMaterial)(value) | Set the "Material". | +| [`SetMinimumSize`](#generated.RAParticle.SetMinimumSize)(value[, unit]) | Set the value of "Minimum Size". | +| [`SetMinimumSizeRatio`](#generated.RAParticle.SetMinimumSizeRatio)(value) | Set the value of "Minimum Size Ratio". | +| [`SetMinimumVolumeFractionForFragmentDisabling`](#generated.RAParticle.SetMinimumVolumeFractionForFragmentDisabling)(value) | Set the value of "Minimum Volume Fraction For Fragment Disabling". | +| [`SetModuleProperty`](#generated.RAParticle.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetNumberOfCorners`](#generated.RAParticle.SetNumberOfCorners)(value) | Set the value of "Number of Corners". | +| [`SetOrientation`](#generated.RAParticle.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RAParticle.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RAParticle.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RAParticle.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetPlasticLimit`](#generated.RAParticle.SetPlasticLimit)(value[, unit]) | Set the value of "Plastic Limit". | +| [`SetPlasticRatio`](#generated.RAParticle.SetPlasticRatio)(value) | Set the value of "Plastic Ratio". | +| [`SetPlasticityModel`](#generated.RAParticle.SetPlasticityModel)(value) | Set the value of "Plasticity Model". | +| [`SetPorosity`](#generated.RAParticle.SetPorosity)(value[, unit]) | Set the value of "Porosity". | +| [`SetPrincipalMomentOfInertia`](#generated.RAParticle.SetPrincipalMomentOfInertia)(values[, unit]) | Set the values of "Principal Moment of Inertia". | +| [`SetRandomAnglesHalfRange`](#generated.RAParticle.SetRandomAnglesHalfRange)(values[, unit]) | Set the values of "Random Angles Half Range". | +| [`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". | +| [`SetSideAngle`](#generated.RAParticle.SetSideAngle)(value) | Set the value of "Side Angle". | +| [`SetSizeType`](#generated.RAParticle.SetSizeType)(value) | Set the value of "Size Type". | +| [`SetSmoothness`](#generated.RAParticle.SetSmoothness)(value) | Set the value of "Smoothness". | +| [`SetSuperquadricDegree`](#generated.RAParticle.SetSuperquadricDegree)(value) | Set the value of "Superquadric Degree". | +| [`SetSurfaceEnergy`](#generated.RAParticle.SetSurfaceEnergy)(value[, unit]) | Set the value of "Surface Energy". | +| [`SetT10Formula`](#generated.RAParticle.SetT10Formula)(value) | Set the value of "T10 Formula". | +| [`SetTargetNumberOfElements`](#generated.RAParticle.SetTargetNumberOfElements)(value) | Set the value of "Target Number of Elements". | +| [`SetTavaresA`](#generated.RAParticle.SetTavaresA)(value[, unit]) | Set the value of "Tavares A". | +| [`SetTavaresB`](#generated.RAParticle.SetTavaresB)(value[, unit]) | Set the value of "Tavares B". | +| [`SetTavaresD0`](#generated.RAParticle.SetTavaresD0)(value[, unit]) | Set the value of "Tavares D0". | +| [`SetTavaresEInf`](#generated.RAParticle.SetTavaresEInf)(value[, unit]) | Set the value of "Tavares E Inf". | +| [`SetTavaresGamma`](#generated.RAParticle.SetTavaresGamma)(value[, unit]) | Set the value of "Tavares Gamma". | +| [`SetTavaresMinimumEnergy`](#generated.RAParticle.SetTavaresMinimumEnergy)(value[, unit]) | Set the value of "Tavares Minimum Energy". | +| [`SetTavaresPhi`](#generated.RAParticle.SetTavaresPhi)(value[, unit]) | Set the value of "Tavares Phi". | +| [`SetTavaresRatioEmax`](#generated.RAParticle.SetTavaresRatioEmax)(value[, unit]) | Set the value of "Tavares Ratio Emax". | +| [`SetTavaresSigmaSquared`](#generated.RAParticle.SetTavaresSigmaSquared)(value[, unit]) | Set the value of "Tavares Sigma Squared". | +| [`SetTensileStressLimit`](#generated.RAParticle.SetTensileStressLimit)(value[, unit]) | Set the value of "Tensile Stress Limit". | +| [`SetThickness`](#generated.RAParticle.SetThickness)(value[, unit]) | Set the value of "Thickness". | +| [`SetTorsionAngleLimit`](#generated.RAParticle.SetTorsionAngleLimit)(value[, unit]) | Set the value of "Torsion Angle Limit". | +| [`SetUseMultipleElements`](#generated.RAParticle.SetUseMultipleElements)(value) | Set the particle's Composition to "Multiple Elements" (True) or "Single Elements" (False). | +| [`SetVerticalAspectRatio`](#generated.RAParticle.SetVerticalAspectRatio)(value) | Set the value of "Vertical Aspect Ratio". | +| [`SetVonMisesStressLimit`](#generated.RAParticle.SetVonMisesStressLimit)(value[, unit]) | Set the value of "Von Mises Stress Limit". | +| [`SetWithFailure`](#generated.RAParticle.SetWithFailure)(value) | Set the value of "With Failure". | +| [`SetXDirection`](#generated.RAParticle.SetXDirection)(values[, unit]) | Set the values of "X Direction". | +| [`SetYDirection`](#generated.RAParticle.SetYDirection)(values[, unit]) | Set the values of "Y Direction". | +| [`SetZDirection`](#generated.RAParticle.SetZDirection)(values[, unit]) | Set the values of "Z Direction". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableBreakage() + +Set the value of “Breakage” to False. + + + +#### DisableIncludeRotationalDeformations() + +Set the value of “Include Rotational Deformations” to False. + + + +#### DisableRandomOrientation() + +Set the value of “Random Orientation” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableBreakage() + +Set the value of “Breakage” to True. + + + +#### EnableIncludeRotationalDeformations() + +Set the value of “Include Rotational Deformations” to True. + + + +#### EnableRandomOrientation() + +Set the value of “Random Orientation” to True. + + + +#### GetAbt10MaximumT10Value(unit: str | None = None) + +Get the value of “Abt10 Maximum T10 Value”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “%”. + + + +#### GetAbt10MinimumSpecificEnergy(unit: str | None = None) + +Deprecated: Use [`GetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) instead. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. + + + +#### GetAbt10ReferenceMinimumSpecificEnergy(unit: str | None = None) + +Get the value of “Abt10 Reference Minimum Specific Energy”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. + + + +#### GetAbt10ReferenceSize(unit: str | None = None) + +Get the value of “Abt10 Reference Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetAbt10SelectFunctionCoefficient(unit: str | None = None) + +Get the value of “Abt10 Select Function Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/J”. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAllowSelfContacts() + +Get the value of “Allow Self Contacts”. + + + +#### GetAnisotropic() + +Deprecated: Use [`GetElasticity()`](#generated.RAParticle.GetElasticity) instead. + +* **Return type:** + bool + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetBendingAngleLimit(unit: str | None = None) + +Get the value of “Bending Angle Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetBreakageModel() + +Get “Breakage Model” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘ab_t10’, ‘professor_tavares’, ‘instantaneous_custom’, ‘griffith_surface_energy’, ‘shear_stress_criterion’, ‘tensile_stress_criterion’, ‘tensile_or_shear_criterion’, ‘von_mises_stress_criterion’, ‘discrete_custom’]. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenterOfMassOffset(unit: str | None = None) + +Get the value of “Center of Mass Offset”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “%”. + + + +#### GetCgmScaleFactor() + +Get the value of “Cgm Scale Factor”. + + + +#### GetChangeMassProperties() + +Get the value of “Change Mass Properties”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDeformationModel() + +Get “Deformation Model” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘elastic’, ‘plastic’]. + + + +#### GetDistributionModel() + +Get “Distribution Model” as a string. + +* **Returns:** + The returned value will be one of [‘gaudin_schumann’, ‘incomplete_beta’, ‘custom’]. + + + +#### GetEdgeAngle(unit: str | None = None) + +Get the value of “Edge Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetElasticRatioBending() + +Get the value of “Elastic Ratio Bending”. + + + +#### GetElasticRatioNormal() + +Get the value of “Elastic Ratio Normal”. + + + +#### GetElasticRatioTangential() + +Get the value of “Elastic Ratio Tangential”. + + + +#### GetElasticRatioTorsion() + +Get the value of “Elastic Ratio Torsion”. + + + +#### GetElasticity() + +Get “Elasticity” as a string. + +* **Returns:** + The returned value will be one of [‘isotropic’, ‘anisotropic’]. + + + +#### 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. + + + +#### GetElementDampingRatio() + +Get the value of “Element Damping Ratio”. + + + +#### GetEnableBreakage() + +Get the value of “Enable Breakage”. + + + +#### GetEnableRandomAngle() + +Get the value of “Enable Random Angle”. + + + +#### GetEnableRotations() + +Get the value of “Enable Rotations”. + + + +#### GetFailureRatio() + +Get the value of “Failure Ratio”. + + + +#### GetFlexible() + +Get the value of “Flexible”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetHorizontalAspectRatio() + +Get the value of “Horizontal Aspect Ratio”. + + + +#### GetIncludeRotationalDeformations() + +Get the value of “Include Rotational Deformations”. + + + +#### GetInternalFriction() + +Get the value of “Internal Friction”. + + + +#### GetJointDampingRatio() + +Get the value of “Joint Damping Ratio”. + + + +#### GetJointElasticRatio() + +Get the value of “Joint Elastic Ratio”. + + + +#### GetJointThermalRatio() + +Get the value of “Joint Thermal Ratio”. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinimumSize(unit: str | None = None) + +Get the value of “Minimum Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMinimumSizeRatio() + +Get the value of “Minimum Size Ratio”. + + + +#### GetMinimumVolumeFractionForFragmentDisabling() + +Get the value of “Minimum Volume Fraction For Fragment Disabling”. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfCorners() + +Get the value of “Number of Corners”. + + + +#### GetNumberOfNodes(time_step='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 + 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetPlasticLimit(unit: str | None = None) + +Get the value of “Plastic Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Pa”. + + + +#### GetPlasticRatio() + +Get the value of “Plastic Ratio”. + + + +#### GetPlasticityModel() + +Get “Plasticity Model” as a string. + +* **Returns:** + The returned value will be one of [‘LinearElastic’, ‘BilinearElastoplastic’, ‘Custom’]. + + + +#### GetPorosity(unit: str | None = None) + +Get the value of “Porosity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “”. + + + +#### GetPrincipalMomentOfInertia(unit: str | None = None) + +Get the value of “Principal Moment of Inertia”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m5”. + + + +#### GetRandomAnglesHalfRange(unit: str | None = None) + +Get the value of “Random Angles Half Range”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “rad”. + + + +#### GetRatioEnergyAfterBreakage(unit: str | None = None) + +Get the value of “Ratio Energy After Breakage”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetRemeshToTarget() + +Get the value of “Remesh To Target”. + + + +#### GetRollingResistance() + +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) + +Get the value of “Second Bending Angle Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetShape() + +Get “Shape” as a string. + +* **Returns:** + The returned value will be one of [‘sphere’, ‘polyhedron’, ‘sphero_cylinder’, ‘sphero_polygon’, ‘sphero_polyhedron’, ‘briquete’, ‘faceted_cylinder’, ‘assembly’, ‘straight_fiber’, ‘custom_fiber’, ‘custom_shell’, ‘custom_polyhedron’]. + + + +#### GetShearStressLimit(unit: str | None = None) + +Get the value of “Shear Stress Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. + + + +#### GetSideAngle() + +Get the value of “Side Angle”. + + + +#### GetSizeDistributionList() + +Get a list of size distribution entries + + + +#### GetSizeType() + +Get “Size Type” as a string. + +* **Returns:** + The returned value will be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. + + + +#### GetSmoothness() + +Get the value of “Smoothness”. + + + +#### GetSuperquadricDegree() + +Get the value of “Superquadric Degree”. + + + +#### GetSurfaceEnergy(unit: str | None = None) + +Get the value of “Surface Energy”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/m2”. + + + +#### GetT10Formula() + +Get “T10 Formula” as a string. + +* **Returns:** + The returned value will be one of [‘it10E_50b’, ‘it10E_fract’]. + + + +#### GetTargetNumberOfElements() + +Get the value of “Target Number of Elements”. + + + +#### GetTavaresA(unit: str | None = None) + +Get the value of “Tavares A”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “%”. + + + +#### GetTavaresB(unit: str | None = None) + +Get the value of “Tavares B”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetTavaresD0(unit: str | None = None) + +Get the value of “Tavares D0”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetTavaresEInf(unit: str | None = None) + +Get the value of “Tavares E Inf”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. + + + +#### GetTavaresGamma(unit: str | None = None) + +Get the value of “Tavares Gamma”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetTavaresMinimumEnergy(unit: str | None = None) + +Get the value of “Tavares Minimum Energy”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg”. + + + +#### GetTavaresPhi(unit: str | None = None) + +Get the value of “Tavares Phi”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetTavaresRatioEmax(unit: str | None = None) + +Get the value of “Tavares Ratio Emax”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetTavaresSigmaSquared(unit: str | None = None) + +Get the value of “Tavares Sigma Squared”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetTensileStressLimit(unit: str | None = None) + +Get the value of “Tensile Stress Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. + + + +#### GetThickness(unit: str | None = None) + +Get the value of “Thickness”. + +* **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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTorsionAngleLimit(unit: str | None = None) + +Get the value of “Torsion Angle Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetUseMultipleElements() + +Whether the particle’s Composition is “Multiple Elements”. + + + +#### GetValidBreakageModelValues() + +Get a list of all possible values for “Breakage Model”. + +* **Returns:** + The returned list is [‘none’, ‘ab_t10’, ‘professor_tavares’, ‘instantaneous_custom’, ‘griffith_surface_energy’, ‘shear_stress_criterion’, ‘tensile_stress_criterion’, ‘tensile_or_shear_criterion’, ‘von_mises_stress_criterion’, ‘discrete_custom’]. + + + +#### GetValidDeformationModelValues() + +Get a list of all possible values for “Deformation Model”. + +* **Returns:** + The returned list is [‘none’, ‘elastic’, ‘plastic’]. + + + +#### GetValidDistributionModelValues() + +Get a list of all possible values for “Distribution Model”. + +* **Returns:** + The returned list is [‘gaudin_schumann’, ‘incomplete_beta’, ‘custom’]. + + + +#### GetValidElasticityValues() + +Get a list of all possible values for “Elasticity”. + +* **Returns:** + The returned list is [‘isotropic’, ‘anisotropic’]. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### GetValidPlasticityModelValues() + +Get a list of all possible values for “Plasticity Model”. + +* **Returns:** + The returned list is [‘LinearElastic’, ‘BilinearElastoplastic’, ‘Custom’]. + + + +#### GetValidShapeValues() + +Get a list of all possible values for “Shape”. + +* **Returns:** + The returned list is [‘sphere’, ‘polyhedron’, ‘sphero_cylinder’, ‘sphero_polygon’, ‘sphero_polyhedron’, ‘briquete’, ‘faceted_cylinder’, ‘assembly’, ‘straight_fiber’, ‘custom_fiber’, ‘custom_shell’, ‘custom_polyhedron’]. + + + +#### GetValidSizeTypeValues() + +Get a list of all possible values for “Size Type”. + +* **Returns:** + The returned list is [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. + + + +#### GetValidT10FormulaValues() + +Get a list of all possible values for “T10 Formula”. + +* **Returns:** + The returned list is [‘it10E_50b’, ‘it10E_fract’]. + + + +#### GetVerticalAspectRatio() + +Get the value of “Vertical Aspect Ratio”. + + + +#### GetVonMisesStressLimit(unit: str | None = None) + +Get the value of “Von Mises Stress Limit”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. + + + +#### GetWithFailure() + +Get the value of “With Failure”. + + + +#### GetXDirection(unit: str | None = None) + +Get the value of “X Direction”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “-“. + + + +#### GetYDirection(unit: str | None = None) + +Get the value of “Y Direction”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “-“. + + + +#### GetZDirection(unit: str | None = None) + +Get the value of “Z Direction”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “-“. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### ImportCustomFiber(filename: str) + +Import a custom fiber shape from the given filename into this particle. + +* **Parameters:** + **filename** – The full path to the TXT/CSV/Excel file. +* **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) + +Import a custom shape from the given stl filename into this particle. + +* **Parameters:** + * **stl_filename** – The full path to the STL file. + * **as_concave** – True whether the particle should be treated as Concave, or False otherwise + * **is_open** – True whether the stl is an open one +* **Returns:** + Possible return values: + \* True if everything went fine with the import process. + \* False if the import process failed. + + + +#### IsBreakageEnabled() + +Check if the “Breakage” is enabled. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsConcave() + +Returns True if the particle is a concave custom polyhedron, and False otherwise. + +* **Return type:** + bool + + + +#### IsIncludeRotationalDeformationsEnabled() + +Check if the “Include Rotational Deformations” is enabled. + + + +#### IsRandomOrientationEnabled() + +Check if the “Random Orientation” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetAbt10MaximumT10Value(value: str | float, unit: str | None = None) + +Set the value of “Abt10 Maximum T10 Value”. + +* **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 “%”. + + + +#### SetAbt10MinimumSpecificEnergy(value: float, unit: str | None = None) + +Deprecated: Use [`SetAbt10ReferenceMinimumSpecificEnergy()`](#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) instead. + +* **Parameters:** + * **value** – The value to set. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “J/kg”. + + + +#### SetAbt10ReferenceMinimumSpecificEnergy(value: str | float, unit: str | None = None) + +Set the value of “Abt10 Reference Minimum Specific Energy”. + +* **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 “J/kg”. + + + +#### SetAbt10ReferenceSize(value: str | float, unit: str | None = None) + +Set the value of “Abt10 Reference Size”. + +* **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”. + + + +#### SetAbt10SelectFunctionCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Abt10 Select Function Coefficient”. + +* **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 “kg/J”. + + + +#### SetAllowSelfContacts(value: bool) + +Set the value of “Allow Self Contacts”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetAnisotropic(value: bool) + +Set the value of “Anisotropic”. + +* **Parameters:** + **value** (*bool*) – The value to set. + + + +#### SetBendingAngleLimit(value: str | float, unit: str | None = None) + +Set the value of “Bending Angle Limit”. + +* **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 “dega”. + + + +#### SetBreakageModel(value: str) + +Set the value of “Breakage Model”. +If the particle is not flexible, setting the model to any value other than “none” also enables breakage. + +* **Parameters:** + **value** (*str*) – The value to set. Must be one of [‘none’, ‘ab_t10’, ‘professor_tavares’, ‘instantaneous_custom’, ‘griffith_surface_energy’, ‘shear_stress_criterion’, ‘tensile_stress_criterion’, ‘tensile_or_shear_criterion’, ‘von_mises_stress_criterion’, ‘discrete_custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Breakage Model” option. + + + +#### SetCenterOfMassOffset(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Center of Mass Offset”. + +* **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 “%”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetCgmScaleFactor(value: str | float) + +Set the value of “Cgm Scale Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetChangeMassProperties(value: bool) + +Set the value of “Change Mass Properties”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDeformationModel(value: str) + +Set the value of “Deformation Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘elastic’, ‘plastic’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Deformation Model” option. + + + +#### SetDistributionModel(value: str) + +Set the value of “Distribution Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘gaudin_schumann’, ‘incomplete_beta’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Distribution Model” option. + + + +#### SetEdgeAngle(value: str | float, unit: str | None = None) + +Set the value of “Edge 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 “dega”. + + + +#### SetElasticRatioBending(value: str | float) + +Set the value of “Elastic Ratio Bending”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetElasticRatioNormal(value: str | float) + +Set the value of “Elastic Ratio Normal”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetElasticRatioTangential(value: str | float) + +Set the value of “Elastic Ratio Tangential”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetElasticRatioTorsion(value: str | float) + +Set the value of “Elastic Ratio Torsion”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetElasticity(value: str) + +Set the value of “Elasticity”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘isotropic’, ‘anisotropic’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Elasticity” option. + + + +#### SetElementDampingRatio(value: str | float) + +Set the value of “Element Damping Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetEnableBreakage(value: bool) + +Set the value of “Enable Breakage”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetEnableRandomAngle(value: bool) + +Set the value of “Enable Random Angle”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetEnableRotations(value: bool) + +Set the value of “Enable Rotations”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFailureRatio(value: str | float) + +Set the value of “Failure Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetFlexible(value: bool) + +Set the value of “Flexible”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetHorizontalAspectRatio(value: str | float) + +Set the value of “Horizontal Aspect Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetIncludeRotationalDeformations(value: bool) + +Set the value of “Include Rotational Deformations”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetInternalFriction(value: str | float) + +Set the value of “Internal Friction”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetJointDampingRatio(value: str | float) + +Set the value of “Joint Damping Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetJointElasticRatio(value: str | float) + +Set the value of “Joint Elastic Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetJointThermalRatio(value: str | float) + +Set the value of “Joint Thermal Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetMinimumSize(value: str | float, unit: str | None = None) + +Set the value of “Minimum Size”. + +* **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”. + + + +#### SetMinimumSizeRatio(value: str | float) + +Set the value of “Minimum Size Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetMinimumVolumeFractionForFragmentDisabling(value: str | float) + +Set the value of “Minimum Volume Fraction For Fragment Disabling”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetNumberOfCorners(value: str | int) + +Set the value of “Number of Corners”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### 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. + + + +#### SetPlasticLimit(value: str | float, unit: str | None = None) + +Set the value of “Plastic Limit”. + +* **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 “Pa”. + + + +#### SetPlasticRatio(value: str | float) + +Set the value of “Plastic Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetPlasticityModel(value: str) + +Set the value of “Plasticity Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘LinearElastic’, ‘BilinearElastoplastic’, ‘Custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Plasticity Model” option. + + + +#### SetPorosity(value: str | float, unit: str | None = None) + +Set the value of “Porosity”. + +* **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 “”. + + + +#### SetPrincipalMomentOfInertia(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Principal Moment of Inertia”. + +* **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 “m5”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetRandomAnglesHalfRange(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Random Angles Half Range”. + +* **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 “rad”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetRatioEnergyAfterBreakage(value: str | float, unit: str | None = None) + +Set the value of “Ratio Energy After Breakage”. + +* **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 “-“. + + + +#### SetRemeshToTarget(value: bool) + +Set the value of “Remesh To Target”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetRollingResistance(value: str | float) + +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) + +Set the value of “Second Bending Angle Limit”. + +* **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 “dega”. + + + +#### SetShape(value: str) + +Set the value of “Shape”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘sphere’, ‘polyhedron’, ‘sphero_cylinder’, ‘sphero_polygon’, ‘sphero_polyhedron’, ‘briquete’, ‘faceted_cylinder’, ‘assembly’, ‘straight_fiber’, ‘custom_fiber’, ‘custom_shell’, ‘custom_polyhedron’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Shape” option. + + + +#### SetShearStressLimit(value: str | float, unit: str | None = None) + +Set the value of “Shear Stress Limit”. + +* **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 “N/m2”. + + + +#### SetSideAngle(value: str | float) + +Set the value of “Side Angle”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSizeType(value: str) + +Set the value of “Size Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Size Type” option. + + + +#### SetSmoothness(value: str | float) + +Set the value of “Smoothness”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSuperquadricDegree(value: str | float) + +Set the value of “Superquadric Degree”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSurfaceEnergy(value: str | float, unit: str | None = None) + +Set the value of “Surface Energy”. + +* **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 “J/m2”. + + + +#### SetT10Formula(value: str) + +Set the value of “T10 Formula”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘it10E_50b’, ‘it10E_fract’]. +* **Raises:** + **RockyApiError** – If value is not a valid “T10 Formula” option. + + + +#### SetTargetNumberOfElements(value: str | int) + +Set the value of “Target Number of Elements”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetTavaresA(value: str | float, unit: str | None = None) + +Set the value of “Tavares A”. + +* **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 “%”. + + + +#### SetTavaresB(value: str | float, unit: str | None = None) + +Set the value of “Tavares B”. + +* **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 “-“. + + + +#### SetTavaresD0(value: str | float, unit: str | None = None) + +Set the value of “Tavares D0”. + +* **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”. + + + +#### SetTavaresEInf(value: str | float, unit: str | None = None) + +Set the value of “Tavares E Inf”. + +* **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 “J/kg”. + + + +#### SetTavaresGamma(value: str | float, unit: str | None = None) + +Set the value of “Tavares Gamma”. + +* **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 “-“. + + + +#### SetTavaresMinimumEnergy(value: str | float, unit: str | None = None) + +Set the value of “Tavares Minimum Energy”. + +* **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 “J/kg”. + + + +#### SetTavaresPhi(value: str | float, unit: str | None = None) + +Set the value of “Tavares Phi”. + +* **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 “-“. + + + +#### SetTavaresRatioEmax(value: str | float, unit: str | None = None) + +Set the value of “Tavares Ratio Emax”. + +* **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 “-“. + + + +#### SetTavaresSigmaSquared(value: str | float, unit: str | None = None) + +Set the value of “Tavares Sigma Squared”. + +* **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 “-“. + + + +#### SetTensileStressLimit(value: str | float, unit: str | None = None) + +Set the value of “Tensile Stress Limit”. + +* **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 “N/m2”. + + + +#### SetThickness(value: str | float, unit: str | None = None) + +Set the value of “Thickness”. + +* **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”. + + + +#### SetTorsionAngleLimit(value: str | float, unit: str | None = None) + +Set the value of “Torsion Angle Limit”. + +* **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 “dega”. + + + +#### SetUseMultipleElements(value) + +Set the particle’s Composition to “Multiple Elements” (True) or “Single Elements” (False). + +* **Parameters:** + **value** (*bool*) + + + +#### SetVerticalAspectRatio(value: str | float) + +Set the value of “Vertical Aspect Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetVonMisesStressLimit(value: str | float, unit: str | None = None) + +Set the value of “Von Mises Stress Limit”. + +* **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 “N/m2”. + + + +#### SetWithFailure(value: bool) + +Set the value of “With Failure”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetXDirection(values: Sequence[str | float], unit: str | None = None) + +Set the values of “X Direction”. + +* **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 “-“. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetYDirection(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Y Direction”. + +* **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 “-“. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetZDirection(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Z Direction”. + +* **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 “-“. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPart.md b/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPart.md index 879deaba2f..68e230c008 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPart.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPart.md @@ -1,226 +1,227 @@ - - -# RAParticleAssemblyPart - - - - - - -### *class* RAParticleAssemblyPart - -Rocky PrePost Scripting wrapper for a single entry in a single Particle Assembly’s part list. - -Access this wrapper from a given `RAParticleAssembly` with: - -```python -assembly_parts = particle_assembly.GetAssemblyParts() -assembly_part_1 = assembly_parts.New() -assembly_part_1.SetParticle('Particle 1') -assembly_part_1.SetPositionX(0.75, 'm') -``` - -**Methods:** - -| [`GetAngle`](#generated.RAParticleAssemblyPart.GetAngle)([unit]) | Get the value of "Angle". | -|--------------------------------------------------------------------------------------|--------------------------------| -| [`GetAvailableParticles`](#generated.RAParticleAssemblyPart.GetAvailableParticles)() | Get all available Particles. | -| [`GetParticle`](#generated.RAParticleAssemblyPart.GetParticle)() | Get the "Particle". | -| [`GetPositionX`](#generated.RAParticleAssemblyPart.GetPositionX)([unit]) | Get the value of "Position X". | -| [`GetPositionY`](#generated.RAParticleAssemblyPart.GetPositionY)([unit]) | Get the value of "Position Y". | -| [`GetPositionZ`](#generated.RAParticleAssemblyPart.GetPositionZ)([unit]) | Get the value of "Position Z". | -| [`GetRotationX`](#generated.RAParticleAssemblyPart.GetRotationX)([unit]) | Get the value of "Rotation X". | -| [`GetRotationY`](#generated.RAParticleAssemblyPart.GetRotationY)([unit]) | Get the value of "Rotation Y". | -| [`GetRotationZ`](#generated.RAParticleAssemblyPart.GetRotationZ)([unit]) | Get the value of "Rotation Z". | -| [`GetScale`](#generated.RAParticleAssemblyPart.GetScale)([unit]) | Get the value of "Scale". | -| [`SetAngle`](#generated.RAParticleAssemblyPart.SetAngle)(value[, unit]) | Set the value of "Angle". | -| [`SetParticle`](#generated.RAParticleAssemblyPart.SetParticle)(value) | Set the "Particle". | -| [`SetPositionX`](#generated.RAParticleAssemblyPart.SetPositionX)(value[, unit]) | Set the value of "Position X". | -| [`SetPositionY`](#generated.RAParticleAssemblyPart.SetPositionY)(value[, unit]) | Set the value of "Position Y". | -| [`SetPositionZ`](#generated.RAParticleAssemblyPart.SetPositionZ)(value[, unit]) | Set the value of "Position Z". | -| [`SetRotationX`](#generated.RAParticleAssemblyPart.SetRotationX)(value[, unit]) | Set the value of "Rotation X". | -| [`SetRotationY`](#generated.RAParticleAssemblyPart.SetRotationY)(value[, unit]) | Set the value of "Rotation Y". | -| [`SetRotationZ`](#generated.RAParticleAssemblyPart.SetRotationZ)(value[, unit]) | Set the value of "Rotation Z". | -| [`SetScale`](#generated.RAParticleAssemblyPart.SetScale)(value[, unit]) | Set the value of "Scale". | - - - -#### GetAngle(unit: str | None = None) - -Get the value of “Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetAvailableParticles() - -Get all available Particles. - -* **Return type:** - List[[`RAParticle`](RAParticle.md#generated.RAParticle)] - A list of [`RAParticle`](RAParticle.md#generated.RAParticle). - - - -#### GetParticle() - -Get the “Particle”. - -* **Return type:** - [`RAParticle`](RAParticle.md#generated.RAParticle) - - - -#### GetPositionX(unit: str | None = None) - -Get the value of “Position X”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetPositionY(unit: str | None = None) - -Get the value of “Position Y”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetPositionZ(unit: str | None = None) - -Get the value of “Position Z”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetRotationX(unit: str | None = None) - -Get the value of “Rotation X”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetRotationY(unit: str | None = None) - -Get the value of “Rotation Y”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetRotationZ(unit: str | None = None) - -Get the value of “Rotation Z”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetScale(unit: str | None = None) - -Get the value of “Scale”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### SetAngle(value: str | float, unit: str | None = None) - -Set the value of “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 “dega”. - - - -#### SetParticle(value) - -Set the “Particle”. - -:param unicode, [`RAParticle`](RAParticle.md#generated.RAParticle) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetPositionX(value: str | float, unit: str | None = None) - -Set the value of “Position X”. - -* **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”. - - - -#### SetPositionY(value: str | float, unit: str | None = None) - -Set the value of “Position Y”. - -* **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”. - - - -#### SetPositionZ(value: str | float, unit: str | None = None) - -Set the value of “Position Z”. - -* **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”. - - - -#### SetRotationX(value: str | float, unit: str | None = None) - -Set the value of “Rotation X”. - -* **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”. - - - -#### SetRotationY(value: str | float, unit: str | None = None) - -Set the value of “Rotation Y”. - -* **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”. - - - -#### SetRotationZ(value: str | float, unit: str | None = None) - -Set the value of “Rotation Z”. - -* **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”. - - - -#### SetScale(value: str | float, unit: str | None = None) - -Set the value of “Scale”. - -* **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 “-“. + + +# RAParticleAssemblyPart + + + + + + +### *class* RAParticleAssemblyPart + +Rocky PrePost Scripting wrapper for a single entry in a single Particle Assembly’s part list. + +Access this wrapper from a given `RAParticleAssembly` with: + +```python +assembly_parts = particle_assembly.GetAssemblyParts() +assembly_part_1 = assembly_parts.New() +assembly_part_1.SetParticle('Particle 1') +assembly_part_1.SetPositionX(0.75, 'm') +``` + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------|--------------------------------| +| [`GetAngle`](#generated.RAParticleAssemblyPart.GetAngle)([unit]) | Get the value of "Angle". | +| [`GetAvailableParticles`](#generated.RAParticleAssemblyPart.GetAvailableParticles)() | Get all available Particles. | +| [`GetParticle`](#generated.RAParticleAssemblyPart.GetParticle)() | Get the "Particle". | +| [`GetPositionX`](#generated.RAParticleAssemblyPart.GetPositionX)([unit]) | Get the value of "Position X". | +| [`GetPositionY`](#generated.RAParticleAssemblyPart.GetPositionY)([unit]) | Get the value of "Position Y". | +| [`GetPositionZ`](#generated.RAParticleAssemblyPart.GetPositionZ)([unit]) | Get the value of "Position Z". | +| [`GetRotationX`](#generated.RAParticleAssemblyPart.GetRotationX)([unit]) | Get the value of "Rotation X". | +| [`GetRotationY`](#generated.RAParticleAssemblyPart.GetRotationY)([unit]) | Get the value of "Rotation Y". | +| [`GetRotationZ`](#generated.RAParticleAssemblyPart.GetRotationZ)([unit]) | Get the value of "Rotation Z". | +| [`GetScale`](#generated.RAParticleAssemblyPart.GetScale)([unit]) | Get the value of "Scale". | +| [`SetAngle`](#generated.RAParticleAssemblyPart.SetAngle)(value[, unit]) | Set the value of "Angle". | +| [`SetParticle`](#generated.RAParticleAssemblyPart.SetParticle)(value) | Set the "Particle". | +| [`SetPositionX`](#generated.RAParticleAssemblyPart.SetPositionX)(value[, unit]) | Set the value of "Position X". | +| [`SetPositionY`](#generated.RAParticleAssemblyPart.SetPositionY)(value[, unit]) | Set the value of "Position Y". | +| [`SetPositionZ`](#generated.RAParticleAssemblyPart.SetPositionZ)(value[, unit]) | Set the value of "Position Z". | +| [`SetRotationX`](#generated.RAParticleAssemblyPart.SetRotationX)(value[, unit]) | Set the value of "Rotation X". | +| [`SetRotationY`](#generated.RAParticleAssemblyPart.SetRotationY)(value[, unit]) | Set the value of "Rotation Y". | +| [`SetRotationZ`](#generated.RAParticleAssemblyPart.SetRotationZ)(value[, unit]) | Set the value of "Rotation Z". | +| [`SetScale`](#generated.RAParticleAssemblyPart.SetScale)(value[, unit]) | Set the value of "Scale". | + + + +#### GetAngle(unit: str | None = None) + +Get the value of “Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetAvailableParticles() + +Get all available Particles. + +* **Return type:** + List[[`RAParticle`](RAParticle.md#generated.RAParticle)] + A list of [`RAParticle`](RAParticle.md#generated.RAParticle). + + + +#### GetParticle() + +Get the “Particle”. + +* **Return type:** + [`RAParticle`](RAParticle.md#generated.RAParticle) + + + +#### GetPositionX(unit: str | None = None) + +Get the value of “Position X”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetPositionY(unit: str | None = None) + +Get the value of “Position Y”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetPositionZ(unit: str | None = None) + +Get the value of “Position Z”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetRotationX(unit: str | None = None) + +Get the value of “Rotation X”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetRotationY(unit: str | None = None) + +Get the value of “Rotation Y”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetRotationZ(unit: str | None = None) + +Get the value of “Rotation Z”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetScale(unit: str | None = None) + +Get the value of “Scale”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### SetAngle(value: str | float, unit: str | None = None) + +Set the value of “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 “dega”. + + + +#### SetParticle(value) + +Set the “Particle”. + +:param unicode, [`RAParticle`](RAParticle.md#generated.RAParticle) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetPositionX(value: str | float, unit: str | None = None) + +Set the value of “Position X”. + +* **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”. + + + +#### SetPositionY(value: str | float, unit: str | None = None) + +Set the value of “Position Y”. + +* **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”. + + + +#### SetPositionZ(value: str | float, unit: str | None = None) + +Set the value of “Position Z”. + +* **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”. + + + +#### SetRotationX(value: str | float, unit: str | None = None) + +Set the value of “Rotation X”. + +* **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”. + + + +#### SetRotationY(value: str | float, unit: str | None = None) + +Set the value of “Rotation Y”. + +* **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”. + + + +#### SetRotationZ(value: str | float, unit: str | None = None) + +Set the value of “Rotation Z”. + +* **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”. + + + +#### SetScale(value: str | float, unit: str | None = None) + +Set the value of “Scale”. + +* **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 “-“. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPartList.md b/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPartList.md index d1b7dd3cd1..192ff61528 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPartList.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleAssemblyPartList.md @@ -1,67 +1,68 @@ - - -# RAParticleAssemblyPartList - - - - - - -### *class* RAParticleAssemblyPartList - -Rocky PrePost Scripting wrapper for the parts list in a single Particle Assembly. - -To get the [`RAParticleAssemblyPartList`](#generated.RAParticleAssemblyPartList) from a `RAParticleAssembly`, use: - -```python -assembly_parts = particle_assembly.GetAssemblyParts() -``` - -[`RAParticleAssemblyPartList`](#generated.RAParticleAssemblyPartList) contains methods to add, remove and retrieve individual -assembly parts. It corresponds to the list of entries on a Particle Assembly’s “Shape” tab -on the Rocky UI. - -The following examples add, remove and access individual entries in the assembly parts list: - -```python -# Add new items -assembly_part_1 = assembly_parts.New() - -# Access and modify items -assembly_part_2 = assembly_parts[0] -assembly_part_2.SetParticle('Particle 1') - -# Remove items -assembly_parts.Remove(assembly_part_2) -del assembly_parts[0] -assembly_parts.Clear() -``` - -The [`RAParticleAssemblyPartList`](#generated.RAParticleAssemblyPartList) is a list of [`RAParticleAssemblyPart`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart). - -**Methods:** - -| [`Clear`](#generated.RAParticleAssemblyPartList.Clear)() | Remove all items from the list. | -|----------------------------------------------------------------|-----------------------------------| -| [`New`](#generated.RAParticleAssemblyPartList.New)() | Add a new item. | -| [`Remove`](#generated.RAParticleAssemblyPartList.Remove)(item) | Remove an item from the list. | - - - -#### Clear() - -Remove all items from the list. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAParticleAssemblyPartList + + + + + + +### *class* RAParticleAssemblyPartList + +Rocky PrePost Scripting wrapper for the parts list in a single Particle Assembly. + +To get the [`RAParticleAssemblyPartList`](#generated.RAParticleAssemblyPartList) from a `RAParticleAssembly`, use: + +```python +assembly_parts = particle_assembly.GetAssemblyParts() +``` + +[`RAParticleAssemblyPartList`](#generated.RAParticleAssemblyPartList) contains methods to add, remove and retrieve individual +assembly parts. It corresponds to the list of entries on a Particle Assembly’s “Shape” tab +on the Rocky UI. + +The following examples add, remove and access individual entries in the assembly parts list: + +```python +# Add new items +assembly_part_1 = assembly_parts.New() + +# Access and modify items +assembly_part_2 = assembly_parts[0] +assembly_part_2.SetParticle('Particle 1') + +# Remove items +assembly_parts.Remove(assembly_part_2) +del assembly_parts[0] +assembly_parts.Clear() +``` + +The [`RAParticleAssemblyPartList`](#generated.RAParticleAssemblyPartList) is a list of [`RAParticleAssemblyPart`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart). + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------|-----------------------------------| +| [`Clear`](#generated.RAParticleAssemblyPartList.Clear)() | Remove all items from the list. | +| [`New`](#generated.RAParticleAssemblyPartList.New)() | Add a new item. | +| [`Remove`](#generated.RAParticleAssemblyPartList.Remove)(item) | Remove an item from the list. | + + + +#### Clear() + +Remove all items from the list. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticleCollection.md b/2025R2/rocky-prepost-scripting-manual/RAParticleCollection.md index e32cff67b3..5402172ae0 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleCollection.md @@ -1,76 +1,77 @@ - - -# RAParticleCollection - - - - - - -### *class* RAParticleCollection - -Rocky PrePost Scripting wrapper for the collection of particles in a project. - -This wrapper corresponds to the “Particles” item in the project’s data tree. To retrieve the -[`RAParticleCollection`](#generated.RAParticleCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: - -```python -particle_collection = study.GetParticleCollection() -``` - -Instances of the [`RAParticleCollection`](#generated.RAParticleCollection) class act as regular Python lists, and can be -iterated on, accessed via index, etc: - -```python -particle_1 = particle_collection.New() -particle_2 = particle_collection[1] -del particle_collection[0] -for particle in particle_collection: - particle.SetMaterial('My Particle Material') -``` - -Items in this list are of type [`RAParticle`](RAParticle.md#generated.RAParticle). - -**Methods:** - -| [`Clear`](#generated.RAParticleCollection.Clear)() | Remove all items from the list. | -|-----------------------------------------------------------------------------|------------------------------------------------------------------| -| [`GetParticle`](#generated.RAParticleCollection.GetParticle)(particle_name) | Get a particle given its name. | -| [`GetParticleNames`](#generated.RAParticleCollection.GetParticleNames)() | Get a list of the names of all the particles in this collection. | -| [`New`](#generated.RAParticleCollection.New)() | Add a new item. | -| [`Remove`](#generated.RAParticleCollection.Remove)(item) | Remove an item from the list. | - - - -#### Clear() - -Remove all items from the list. - - - -#### GetParticle(particle_name: str) - -Get a particle given its name. - - - -#### GetParticleNames() - -Get a list of the names of all the particles in this collection. - -* **Return type:** - list - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAParticleCollection + + + + + + +### *class* RAParticleCollection + +Rocky PrePost Scripting wrapper for the collection of particles in a project. + +This wrapper corresponds to the “Particles” item in the project’s data tree. To retrieve the +[`RAParticleCollection`](#generated.RAParticleCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: + +```python +particle_collection = study.GetParticleCollection() +``` + +Instances of the [`RAParticleCollection`](#generated.RAParticleCollection) class act as regular Python lists, and can be +iterated on, accessed via index, etc: + +```python +particle_1 = particle_collection.New() +particle_2 = particle_collection[1] +del particle_collection[0] +for particle in particle_collection: + particle.SetMaterial('My Particle Material') +``` + +Items in this list are of type [`RAParticle`](RAParticle.md#generated.RAParticle). + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------|------------------------------------------------------------------| +| [`Clear`](#generated.RAParticleCollection.Clear)() | Remove all items from the list. | +| [`GetParticle`](#generated.RAParticleCollection.GetParticle)(particle_name) | Get a particle given its name. | +| [`GetParticleNames`](#generated.RAParticleCollection.GetParticleNames)() | Get a list of the names of all the particles in this collection. | +| [`New`](#generated.RAParticleCollection.New)() | Add a new item. | +| [`Remove`](#generated.RAParticleCollection.Remove)(item) | Remove an item from the list. | + + + +#### Clear() + +Remove all items from the list. + + + +#### GetParticle(particle_name: str) + +Get a particle given its name. + + + +#### GetParticleNames() + +Get a list of the names of all the particles in this collection. + +* **Return type:** + list + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticleInlet.md b/2025R2/rocky-prepost-scripting-manual/RAParticleInlet.md index b7f4b5423c..b7bd2fb031 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleInlet.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleInlet.md @@ -1,474 +1,475 @@ - - -# RAParticleInlet - - - - - - -### *class* RAParticleInlet - -Rocky PrePost Scripting wrapper for a single Continuous Injection input. - -This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s -data tree. Particle inputs can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) via: - -```python -input_1 = study.GetElement('Continuous Injection <1>') -input_2 = input_collection.GetParticleInput('Continuous Injection <2>') -``` - -Instances of [`RAParticleInlet`](#generated.RAParticleInlet) comprise two parts: Properties that can be manipulated -directly, such as the input’s name and the particle entry point, and the input properties list -that describe which particles enter via this input and with each mass flow rate, temperature, etc. -This list must be manipulated via the `RAParticleInputPropertiesList` returned by -[`GetInputPropertiesList()`](#generated.RAParticleInlet.GetInputPropertiesList). - -**Methods:** - -| [`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". | - - - -#### DisableForcePacking() - -Set the value of “Force Packing” to False. - - - -#### DisablePeriodic() - -Set the value of “Periodic” to False. - - - -#### DisablePeriodicDischarge() - -Deprecated: Use [`DisablePeriodic()`](#generated.RAParticleInlet.DisablePeriodic) instead. - - - -#### DisableStopAllAtStopTime() - -Set the value of “Stop All At Stop Time” to False. - - - -#### DisableUseTargetNormalVelocity() - -Set the value of “Use Target Normal Velocity” to False. - - - -#### EnableForcePacking() - -Set the value of “Force Packing” to True. - - - -#### EnablePeriodic() - -Set the value of “Periodic” to True. - - - -#### EnablePeriodicDischarge() - -Deprecated: Use [`EnablePeriodic()`](#generated.RAParticleInlet.EnablePeriodic) instead. - - - -#### EnableStopAllAtStopTime() - -Set the value of “Stop All At Stop Time” to True. - - - -#### EnableUseTargetNormalVelocity() - -Set the value of “Use Target Normal Velocity” to True. - - - -#### GetAvailableEntryPoints() - -Get all available Entry Points. - -* **Return type:** - 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() - -Get the “Entry Point”. - -* **Return type:** - [`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) - - - -#### GetForcePacking() - -Get the value of “Force Packing”. - - - -#### 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”. - - - -#### GetInputPropertiesList() - -Return a list of input properties - - - -#### 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”. - - - -#### GetPeriodicDischarge() - -Deprecated: Use [`GetPeriodic()`](#generated.RAParticleInlet.GetPeriodic) instead. - - - -#### GetSphInjectionEnabled() - -Get the value of “Sph Injection Enabled”. - - - -#### GetSphTemperature(unit: str | None = None) - -Get the value of “Sph Temperature”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “K”. - - - -#### GetStartTime(unit: str | None = None) - -Get the value of “Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetStopAllAtStopTime() - -Get the value of “Stop All At Stop Time”. - - - -#### GetStopTime(unit: str | None = None) - -Get the value of “Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetTargetNormalVelocity(unit: str | None = None) - -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() - -Get the value of “Use Target Normal Velocity”. - - - -#### GetUxLocal(unit: str | None = None) - -Get the value of “Ux Local”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### GetUzLocal(unit: str | None = None) - -Get the value of “Uz Local”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### IsForcePackingEnabled() - -Check if the “Force Packing” is enabled. - - - -#### IsPeriodicDischargeEnabled() - -Deprecated: Use [`IsPeriodicEnabled()`](#generated.RAParticleInlet.IsPeriodicEnabled) instead. - - - -#### IsPeriodicEnabled() - -Check if the “Periodic” is enabled. - - - -#### IsStopAllAtStopTimeEnabled() - -Check if the “Stop All At Stop Time” is enabled. - - - -#### IsUseTargetNormalVelocityEnabled() - -Check if the “Use Target Normal Velocity” is enabled. - - - -#### SetDischargeTime(value: float, unit: str | None = None) - -Deprecated: Use [`SetInjectionDuration()`](#generated.RAParticleInlet.SetInjectionDuration) instead. - -* **Parameters:** - * **value** – The value to set. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetEntryPoint(value) - -Set the “Entry Point”. - -:param unicode, [`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) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetForcePacking(value: bool) - -Set the value of “Force Packing”. - -* **Parameters:** - **value** – The value to set. - - - -#### 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”. - - - -#### 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. - - - -#### SetPeriodicDischarge(value) - -Deprecated: Use [`SetPeriodic()`](#generated.RAParticleInlet.SetPeriodic) instead. - -* **Return type:** - bool - - - -#### SetSphInjectionEnabled(value: bool) - -Set the value of “Sph Injection Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetSphTemperature(value: str | float, unit: str | None = None) - -Set the value of “Sph 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”. - - - -#### SetStartTime(value: str | float, unit: str | None = None) - -Set the value of “Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetStopAllAtStopTime(value: bool) - -Set the value of “Stop All At Stop Time”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetStopTime(value: str | float, unit: str | None = None) - -Set the value of “Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetTargetNormalVelocity(value: str | float, unit: str | None = None) - -Set the value of “Target Normal Velocity”. - -* **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/s”. - - - -#### SetUseTargetNormalVelocity(value: bool) - -Set the value of “Use Target Normal Velocity”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUxLocal(value: str | float, unit: str | None = None) - -Set the value of “Ux Local”. - -* **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/s”. - - - -#### SetUzLocal(value: str | float, unit: str | None = None) - -Set the value of “Uz Local”. - -* **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/s”. + + +# RAParticleInlet + + + + + + +### *class* RAParticleInlet + +Rocky PrePost Scripting wrapper for a single Continuous Injection input. + +This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s +data tree. Particle inputs can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) via: + +```python +input_1 = study.GetElement('Continuous Injection <1>') +input_2 = input_collection.GetParticleInput('Continuous Injection <2>') +``` + +Instances of [`RAParticleInlet`](#generated.RAParticleInlet) comprise two parts: Properties that can be manipulated +directly, such as the input’s name and the particle entry point, and the input properties list +that describe which particles enter via this input and with each mass flow rate, temperature, etc. +This list must be manipulated via the `RAParticleInputPropertiesList` returned by +[`GetInputPropertiesList()`](#generated.RAParticleInlet.GetInputPropertiesList). + +**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". | + + + +#### DisableForcePacking() + +Set the value of “Force Packing” to False. + + + +#### DisablePeriodic() + +Set the value of “Periodic” to False. + + + +#### DisablePeriodicDischarge() + +Deprecated: Use [`DisablePeriodic()`](#generated.RAParticleInlet.DisablePeriodic) instead. + + + +#### DisableStopAllAtStopTime() + +Set the value of “Stop All At Stop Time” to False. + + + +#### DisableUseTargetNormalVelocity() + +Set the value of “Use Target Normal Velocity” to False. + + + +#### EnableForcePacking() + +Set the value of “Force Packing” to True. + + + +#### EnablePeriodic() + +Set the value of “Periodic” to True. + + + +#### EnablePeriodicDischarge() + +Deprecated: Use [`EnablePeriodic()`](#generated.RAParticleInlet.EnablePeriodic) instead. + + + +#### EnableStopAllAtStopTime() + +Set the value of “Stop All At Stop Time” to True. + + + +#### EnableUseTargetNormalVelocity() + +Set the value of “Use Target Normal Velocity” to True. + + + +#### GetAvailableEntryPoints() + +Get all available Entry Points. + +* **Return type:** + 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() + +Get the “Entry Point”. + +* **Return type:** + [`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) + + + +#### GetForcePacking() + +Get the value of “Force Packing”. + + + +#### 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”. + + + +#### GetInputPropertiesList() + +Return a list of input properties + + + +#### 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”. + + + +#### GetPeriodicDischarge() + +Deprecated: Use [`GetPeriodic()`](#generated.RAParticleInlet.GetPeriodic) instead. + + + +#### GetSphInjectionEnabled() + +Get the value of “Sph Injection Enabled”. + + + +#### GetSphTemperature(unit: str | None = None) + +Get the value of “Sph Temperature”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “K”. + + + +#### GetStartTime(unit: str | None = None) + +Get the value of “Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetStopAllAtStopTime() + +Get the value of “Stop All At Stop Time”. + + + +#### GetStopTime(unit: str | None = None) + +Get the value of “Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetTargetNormalVelocity(unit: str | None = None) + +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() + +Get the value of “Use Target Normal Velocity”. + + + +#### GetUxLocal(unit: str | None = None) + +Get the value of “Ux Local”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### GetUzLocal(unit: str | None = None) + +Get the value of “Uz Local”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### IsForcePackingEnabled() + +Check if the “Force Packing” is enabled. + + + +#### IsPeriodicDischargeEnabled() + +Deprecated: Use [`IsPeriodicEnabled()`](#generated.RAParticleInlet.IsPeriodicEnabled) instead. + + + +#### IsPeriodicEnabled() + +Check if the “Periodic” is enabled. + + + +#### IsStopAllAtStopTimeEnabled() + +Check if the “Stop All At Stop Time” is enabled. + + + +#### IsUseTargetNormalVelocityEnabled() + +Check if the “Use Target Normal Velocity” is enabled. + + + +#### SetDischargeTime(value: float, unit: str | None = None) + +Deprecated: Use [`SetInjectionDuration()`](#generated.RAParticleInlet.SetInjectionDuration) instead. + +* **Parameters:** + * **value** – The value to set. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetEntryPoint(value) + +Set the “Entry Point”. + +:param unicode, [`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) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetForcePacking(value: bool) + +Set the value of “Force Packing”. + +* **Parameters:** + **value** – The value to set. + + + +#### 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”. + + + +#### 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. + + + +#### SetPeriodicDischarge(value) + +Deprecated: Use [`SetPeriodic()`](#generated.RAParticleInlet.SetPeriodic) instead. + +* **Return type:** + bool + + + +#### SetSphInjectionEnabled(value: bool) + +Set the value of “Sph Injection Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetSphTemperature(value: str | float, unit: str | None = None) + +Set the value of “Sph 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”. + + + +#### SetStartTime(value: str | float, unit: str | None = None) + +Set the value of “Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetStopAllAtStopTime(value: bool) + +Set the value of “Stop All At Stop Time”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetStopTime(value: str | float, unit: str | None = None) + +Set the value of “Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetTargetNormalVelocity(value: str | float, unit: str | None = None) + +Set the value of “Target Normal Velocity”. + +* **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/s”. + + + +#### SetUseTargetNormalVelocity(value: bool) + +Set the value of “Use Target Normal Velocity”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUxLocal(value: str | float, unit: str | None = None) + +Set the value of “Ux Local”. + +* **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/s”. + + + +#### SetUzLocal(value: str | float, unit: str | None = None) + +Set the value of “Uz Local”. + +* **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/s”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticleInletProperties.md b/2025R2/rocky-prepost-scripting-manual/RAParticleInletProperties.md index c8cf6c06f8..45214b36c3 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleInletProperties.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleInletProperties.md @@ -1,177 +1,178 @@ - - -# RAParticleInletProperties - - - - - - -### *class* RAParticleInletProperties - -Rocky PrePost Scripting wrapper for a single entry in a single Particle Input’s input list. - -Access this wrapper from a given [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) with: - -```python -input_properties_list = particle_input.GetInputPropertiesList() -input_properties_1 = input_properties_list.New() -input_properties_1.SetParticle('Particle 1') -input_properties_1.SetMassFlowRate(100, 't/h') -``` - -**Methods:** - -| [`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() - -Get all available Particles. - -* **Return type:** - List[[`RAParticle`](RAParticle.md#generated.RAParticle)] - A list of [`RAParticle`](RAParticle.md#generated.RAParticle). - - - -#### GetMassFlowRate(unit: str | None = None) - -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”. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetParticle() - -Get the “Particle”. - -* **Return type:** - [`RAParticle`](RAParticle.md#generated.RAParticle) - - - -#### GetTemperature(unit: str | None = None) - -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) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### SetMassFlowRate(value: str | float, unit: str | None = None) - -Set the value of “Mass Flow Rate”. - -* **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 “t/h”. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetParticle(value) - -Set the “Particle”. - -:param unicode, [`RAParticle`](RAParticle.md#generated.RAParticle) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetTemperature(value: str | float, unit: str | None = None) - -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”. + + +# RAParticleInletProperties + + + + + + +### *class* RAParticleInletProperties + +Rocky PrePost Scripting wrapper for a single entry in a single Particle Input’s input list. + +Access this wrapper from a given [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) with: + +```python +input_properties_list = particle_input.GetInputPropertiesList() +input_properties_1 = input_properties_list.New() +input_properties_1.SetParticle('Particle 1') +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() + +Get all available Particles. + +* **Return type:** + List[[`RAParticle`](RAParticle.md#generated.RAParticle)] + A list of [`RAParticle`](RAParticle.md#generated.RAParticle). + + + +#### GetMassFlowRate(unit: str | None = None) + +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”. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetParticle() + +Get the “Particle”. + +* **Return type:** + [`RAParticle`](RAParticle.md#generated.RAParticle) + + + +#### GetTemperature(unit: str | None = None) + +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) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### SetMassFlowRate(value: str | float, unit: str | None = None) + +Set the value of “Mass Flow Rate”. + +* **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 “t/h”. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetParticle(value) + +Set the “Particle”. + +:param unicode, [`RAParticle`](RAParticle.md#generated.RAParticle) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetTemperature(value: str | float, unit: str | None = None) + +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/2025R2/rocky-prepost-scripting-manual/RAParticleInletPropertiesList.md b/2025R2/rocky-prepost-scripting-manual/RAParticleInletPropertiesList.md index 677b340d89..af4a8af920 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleInletPropertiesList.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleInletPropertiesList.md @@ -1,67 +1,68 @@ - - -# RAParticleInletPropertiesList - - - - - - -### *class* RAParticleInletPropertiesList - -Rocky PrePost Scripting wrapper for the input entries list in a single Particle Input. - -To get the [`RAParticleInletPropertiesList`](#generated.RAParticleInletPropertiesList) from a [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet), use: - -```python -input_properties_list = particle_input.GetInputPropertiesList() -``` - -[`RAParticleInletPropertiesList`](#generated.RAParticleInletPropertiesList) contains methods to add, remove and retrieve individual -input property entries. It corresponds to the list of entries on a Particle Input’s “Input” tab -on the Rocky UI. - -The following examples add, remove and access individual entries in the input properties list: - -```python -# Add new items -input_properties_1 = input_properties_list.New() - -# Access and modify items -input_properties_2 = input_properties_list[0] -input_properties_2.SetParticle('Particle 1') - -# Remove items -input_properties_list.Remove(input_properties_2) -del input_properties_list[0] -input_properties_list.Clear() -``` - -The [`RAParticleInletPropertiesList`](#generated.RAParticleInletPropertiesList) is a list of [`RAParticleInletProperties`](RAParticleInletProperties.md#generated.RAParticleInletProperties). - -**Methods:** - -| [`Clear`](#generated.RAParticleInletPropertiesList.Clear)() | Remove all items from the list. | -|-------------------------------------------------------------------|-----------------------------------| -| [`New`](#generated.RAParticleInletPropertiesList.New)() | Add a new item. | -| [`Remove`](#generated.RAParticleInletPropertiesList.Remove)(item) | Remove an item from the list. | - - - -#### Clear() - -Remove all items from the list. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAParticleInletPropertiesList + + + + + + +### *class* RAParticleInletPropertiesList + +Rocky PrePost Scripting wrapper for the input entries list in a single Particle Input. + +To get the [`RAParticleInletPropertiesList`](#generated.RAParticleInletPropertiesList) from a [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet), use: + +```python +input_properties_list = particle_input.GetInputPropertiesList() +``` + +[`RAParticleInletPropertiesList`](#generated.RAParticleInletPropertiesList) contains methods to add, remove and retrieve individual +input property entries. It corresponds to the list of entries on a Particle Input’s “Input” tab +on the Rocky UI. + +The following examples add, remove and access individual entries in the input properties list: + +```python +# Add new items +input_properties_1 = input_properties_list.New() + +# Access and modify items +input_properties_2 = input_properties_list[0] +input_properties_2.SetParticle('Particle 1') + +# Remove items +input_properties_list.Remove(input_properties_2) +del input_properties_list[0] +input_properties_list.Clear() +``` + +The [`RAParticleInletPropertiesList`](#generated.RAParticleInletPropertiesList) is a list of [`RAParticleInletProperties`](RAParticleInletProperties.md#generated.RAParticleInletProperties). + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------|-----------------------------------| +| [`Clear`](#generated.RAParticleInletPropertiesList.Clear)() | Remove all items from the list. | +| [`New`](#generated.RAParticleInletPropertiesList.New)() | Add a new item. | +| [`Remove`](#generated.RAParticleInletPropertiesList.Remove)(item) | Remove an item from the list. | + + + +#### Clear() + +Remove all items from the list. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAParticleJointsData.md b/2025R2/rocky-prepost-scripting-manual/RAParticleJointsData.md index 4a671fcd6a..b5ce55b0a5 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAParticleJointsData.md +++ b/2025R2/rocky-prepost-scripting-manual/RAParticleJointsData.md @@ -1,978 +1,979 @@ - - -# RAParticleJointsData - - - - - - -### *class* RAParticleJointsData - -**Methods:** - -| [`AddCurve`](#generated.RAParticleJointsData.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAParticleJointsData.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.RAParticleJointsData.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAParticleJointsData.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAParticleJointsData.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.RAParticleJointsData.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAParticleJointsData.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAParticleJointsData.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.RAParticleJointsData.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). | -| [`DisableCollectJointData`](#generated.RAParticleJointsData.DisableCollectJointData)() | Set the value of "Collect Joint Data" to False. | -| [`EditCustomCurve`](#generated.RAParticleJointsData.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.RAParticleJointsData.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. | -| [`EnableCollectJointData`](#generated.RAParticleJointsData.EnableCollectJointData)() | Set the value of "Collect Joint Data" to True. | -| [`GetActivesArray`](#generated.RAParticleJointsData.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAParticleJointsData.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAParticleJointsData.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAParticleJointsData.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAParticleJointsData.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAParticleJointsData.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAParticleJointsData.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAParticleJointsData.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAParticleJointsData.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAParticleJointsData.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCollectJointData`](#generated.RAParticleJointsData.GetCollectJointData)() | Get the value of "Collect Joint Data". | -| [`GetCurve`](#generated.RAParticleJointsData.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAParticleJointsData.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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). | -| [`GetNumpyCurve`](#generated.RAParticleJointsData.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAParticleJointsData.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RAParticleJointsData.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCellVertices`](#generated.RAParticleJointsData.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAParticleJointsData.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAParticleJointsData.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAParticleJointsData.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAParticleJointsData.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAParticleJointsData.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAParticleJointsData.RemoveProcess)() | It is not possible to remove the item "Joints" from the project. | -| [`SetCollectJointData`](#generated.RAParticleJointsData.SetCollectJointData)(value) | Set the value of "Collect Joint Data". | -| [`SetCurrentTimeStep`](#generated.RAParticleJointsData.SetCurrentTimeStep)(time_step) | Sets the current time step. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableCollectJointData() - -Set the value of “Collect Joint Data” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableCollectJointData() - -Set the value of “Collect Joint Data” to True. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCollectJointData() - -Get the value of “Collect Joint Data”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsCollectJointDataEnabled() - -Check if the “Collect Joint Data” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -It is not possible to remove the item “Joints” from the project. - - - -#### SetCollectJointData(value: bool) - -Set the value of “Collect Joint Data”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + +# RAParticleJointsData + + + + + + +### *class* RAParticleJointsData + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAParticleJointsData.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAParticleJointsData.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.RAParticleJointsData.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAParticleJointsData.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAParticleJointsData.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.RAParticleJointsData.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAParticleJointsData.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAParticleJointsData.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.RAParticleJointsData.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). | +| [`DisableCollectJointData`](#generated.RAParticleJointsData.DisableCollectJointData)() | Set the value of "Collect Joint Data" to False. | +| [`EditCustomCurve`](#generated.RAParticleJointsData.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.RAParticleJointsData.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. | +| [`EnableCollectJointData`](#generated.RAParticleJointsData.EnableCollectJointData)() | Set the value of "Collect Joint Data" to True. | +| [`GetActivesArray`](#generated.RAParticleJointsData.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAParticleJointsData.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAParticleJointsData.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAParticleJointsData.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAParticleJointsData.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAParticleJointsData.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAParticleJointsData.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAParticleJointsData.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAParticleJointsData.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAParticleJointsData.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCollectJointData`](#generated.RAParticleJointsData.GetCollectJointData)() | Get the value of "Collect Joint Data". | +| [`GetCurve`](#generated.RAParticleJointsData.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAParticleJointsData.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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). | +| [`GetNumpyCurve`](#generated.RAParticleJointsData.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAParticleJointsData.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RAParticleJointsData.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCellVertices`](#generated.RAParticleJointsData.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAParticleJointsData.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAParticleJointsData.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAParticleJointsData.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAParticleJointsData.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAParticleJointsData.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAParticleJointsData.RemoveProcess)() | It is not possible to remove the item "Joints" from the project. | +| [`SetCollectJointData`](#generated.RAParticleJointsData.SetCollectJointData)(value) | Set the value of "Collect Joint Data". | +| [`SetCurrentTimeStep`](#generated.RAParticleJointsData.SetCurrentTimeStep)(time_step) | Sets the current time step. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableCollectJointData() + +Set the value of “Collect Joint Data” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableCollectJointData() + +Set the value of “Collect Joint Data” to True. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCollectJointData() + +Get the value of “Collect Joint Data”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsCollectJointDataEnabled() + +Check if the “Collect Joint Data” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +It is not possible to remove the item “Joints” from the project. + + + +#### SetCollectJointData(value: bool) + +Set the value of “Collect Joint Data”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. diff --git a/2025R2/rocky-prepost-scripting-manual/RAPhysics.md b/2025R2/rocky-prepost-scripting-manual/RAPhysics.md index 7403f49ce4..d5caa408ca 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPhysics.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPhysics.md @@ -1,539 +1,540 @@ - - -# RAPhysics - - - - - - -### *class* RAPhysics - -Rocky PrePost Scripting wrapper to manipulate physics properties. - -This class represents the “Physics” item on the project data tree. To get the [`RAPhysics`](#generated.RAPhysics) -from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: - -```python -physics = study.GetPhysics() -``` - -**Methods:** - -| [`GetAdhesionModel`](#generated.RAPhysics.GetAdhesionModel)() | Get "Adhesion Model" as a string. | -|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| -| [`GetClosePackingVolumeFraction`](#generated.RAPhysics.GetClosePackingVolumeFraction)() | Get the value of "Close Packing Volume Fraction". | -| [`GetEnableCoarseGrainModeling`](#generated.RAPhysics.GetEnableCoarseGrainModeling)() | Get the value of "Enable Coarse Grain Modeling". | -| [`GetEnableThermalModel`](#generated.RAPhysics.GetEnableThermalModel)() | Get the value of "Enable Thermal Model". | -| [`GetExponentLimit`](#generated.RAPhysics.GetExponentLimit)() | Get the value of "Exponent Limit". | -| [`GetGravityStartTime`](#generated.RAPhysics.GetGravityStartTime)([unit]) | Get the value of "Gravity Start Time". | -| [`GetGravityStopTime`](#generated.RAPhysics.GetGravityStopTime)([unit]) | Get the value of "Gravity Stop Time". | -| [`GetGravityXDirection`](#generated.RAPhysics.GetGravityXDirection)([unit]) | Get the value of "Gravity X Direction". | -| [`GetGravityYDirection`](#generated.RAPhysics.GetGravityYDirection)([unit]) | Get the value of "Gravity Y Direction". | -| [`GetGravityZDirection`](#generated.RAPhysics.GetGravityZDirection)([unit]) | Get the value of "Gravity Z Direction". | -| [`GetImpactEnergyModel`](#generated.RAPhysics.GetImpactEnergyModel)() | Get "Impact Energy Model" as a string. | -| [`GetNormalForceModel`](#generated.RAPhysics.GetNormalForceModel)() | Get "Normal Force Model" as a string. | -| [`GetNumericalSofteningFactor`](#generated.RAPhysics.GetNumericalSofteningFactor)() | Get the value of "Numerical Softening Factor". | -| [`GetRestitutionModel`](#generated.RAPhysics.GetRestitutionModel)() | Get "Restitution Model" as a string. | -| [`GetRollingResistanceModel`](#generated.RAPhysics.GetRollingResistanceModel)() | Get "Rolling Resistance Model" as a string. | -| [`GetSearchDistanceMultiplier`](#generated.RAPhysics.GetSearchDistanceMultiplier)() | Get the value of "Search Distance Multiplier". | -| [`GetSphThermalTransferModel`](#generated.RAPhysics.GetSphThermalTransferModel)() | Get "Sph Thermal Transfer Model" as a string. | -| [`GetTangentialForceModel`](#generated.RAPhysics.GetTangentialForceModel)() | Get "Tangential Force Model" as a string. | -| [`GetThermalCorrectionModel`](#generated.RAPhysics.GetThermalCorrectionModel)() | Get "Thermal Correction Model" as a string. | -| [`GetUpdateDistanceMultiplier`](#generated.RAPhysics.GetUpdateDistanceMultiplier)() | Get the value of "Update Distance Multiplier". | -| [`GetUseRadlEtAl`](#generated.RAPhysics.GetUseRadlEtAl)() | Get the value of "Use Radl Et Al". | -| [`GetValidAdhesionModelValues`](#generated.RAPhysics.GetValidAdhesionModelValues)() | Get a list of all possible values for "Adhesion Model". | -| [`GetValidImpactEnergyModelValues`](#generated.RAPhysics.GetValidImpactEnergyModelValues)() | Get a list of all possible values for "Impact Energy Model". | -| [`GetValidNormalForceModelValues`](#generated.RAPhysics.GetValidNormalForceModelValues)() | Get a list of all possible values for "Normal Force Model". | -| [`GetValidRestitutionModelValues`](#generated.RAPhysics.GetValidRestitutionModelValues)() | Get a list of all possible values for "Restitution Model". | -| [`GetValidRollingResistanceModelValues`](#generated.RAPhysics.GetValidRollingResistanceModelValues)() | Get a list of all possible values for "Rolling Resistance Model". | -| [`GetValidSphThermalTransferModelValues`](#generated.RAPhysics.GetValidSphThermalTransferModelValues)() | Get a list of all possible values for "Sph Thermal Transfer Model". | -| [`GetValidTangentialForceModelValues`](#generated.RAPhysics.GetValidTangentialForceModelValues)() | Get a list of all possible values for "Tangential Force Model". | -| [`GetValidThermalCorrectionModelValues`](#generated.RAPhysics.GetValidThermalCorrectionModelValues)() | Get a list of all possible values for "Thermal Correction Model". | -| [`GetVolumeFractionLimit`](#generated.RAPhysics.GetVolumeFractionLimit)() | Get the value of "Volume Fraction Limit". | -| [`SetAdhesionModel`](#generated.RAPhysics.SetAdhesionModel)(value) | Set the value of "Adhesion Model". | -| [`SetClosePackingVolumeFraction`](#generated.RAPhysics.SetClosePackingVolumeFraction)(value) | Set the value of "Close Packing Volume Fraction". | -| [`SetEnableCoarseGrainModeling`](#generated.RAPhysics.SetEnableCoarseGrainModeling)(value) | Set the value of "Enable Coarse Grain Modeling". | -| [`SetEnableThermalModel`](#generated.RAPhysics.SetEnableThermalModel)(value) | Set the value of "Enable Thermal Model". | -| [`SetExponentLimit`](#generated.RAPhysics.SetExponentLimit)(value) | Set the value of "Exponent Limit". | -| [`SetGravityStartTime`](#generated.RAPhysics.SetGravityStartTime)(value[, unit]) | Set the value of "Gravity Start Time". | -| [`SetGravityStopTime`](#generated.RAPhysics.SetGravityStopTime)(value[, unit]) | Set the value of "Gravity Stop Time". | -| [`SetGravityXDirection`](#generated.RAPhysics.SetGravityXDirection)(value[, unit]) | Set the value of "Gravity X Direction". | -| [`SetGravityYDirection`](#generated.RAPhysics.SetGravityYDirection)(value[, unit]) | Set the value of "Gravity Y Direction". | -| [`SetGravityZDirection`](#generated.RAPhysics.SetGravityZDirection)(value[, unit]) | Set the value of "Gravity Z Direction". | -| [`SetImpactEnergyModel`](#generated.RAPhysics.SetImpactEnergyModel)(value) | Set the value of "Impact Energy Model". | -| [`SetNormalForceModel`](#generated.RAPhysics.SetNormalForceModel)(value) | Set the value of "Normal Force Model". | -| [`SetNumericalSofteningFactor`](#generated.RAPhysics.SetNumericalSofteningFactor)(value) | Set the value of "Numerical Softening Factor". | -| [`SetRestitutionModel`](#generated.RAPhysics.SetRestitutionModel)(value) | Set the value of "Restitution Model". | -| [`SetRollingResistanceModel`](#generated.RAPhysics.SetRollingResistanceModel)(value) | Set the value of "Rolling Resistance Model". | -| [`SetSearchDistanceMultiplier`](#generated.RAPhysics.SetSearchDistanceMultiplier)(value) | Set the value of "Search Distance Multiplier". | -| [`SetSphThermalTransferModel`](#generated.RAPhysics.SetSphThermalTransferModel)(value) | Set the value of "Sph Thermal Transfer Model". | -| [`SetTangentialForceModel`](#generated.RAPhysics.SetTangentialForceModel)(value) | Set the value of "Tangential Force Model". | -| [`SetThermalCorrectionModel`](#generated.RAPhysics.SetThermalCorrectionModel)(value) | Set the value of "Thermal Correction Model". | -| [`SetUpdateDistanceMultiplier`](#generated.RAPhysics.SetUpdateDistanceMultiplier)(value) | Set the value of "Update Distance Multiplier". | -| [`SetUseRadlEtAl`](#generated.RAPhysics.SetUseRadlEtAl)(value) | Set the value of "Use Radl Et Al". | -| [`SetVolumeFractionLimit`](#generated.RAPhysics.SetVolumeFractionLimit)(value) | Set the value of "Volume Fraction Limit". | - - - -#### GetAdhesionModel() - -Get “Adhesion Model” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘constant’, ‘linear’, ‘JKR’, ‘custom’]. - - - -#### GetClosePackingVolumeFraction() - -Get the value of “Close Packing Volume Fraction”. - - - -#### GetEnableCoarseGrainModeling() - -Get the value of “Enable Coarse Grain Modeling”. - - - -#### GetEnableThermalModel() - -Get the value of “Enable Thermal Model”. - - - -#### GetExponentLimit() - -Get the value of “Exponent Limit”. - - - -#### GetGravityStartTime(unit: str | None = None) - -Get the value of “Gravity Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetGravityStopTime(unit: str | None = None) - -Get the value of “Gravity Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetGravityXDirection(unit: str | None = None) - -Get the value of “Gravity X Direction”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s2”. - - - -#### GetGravityYDirection(unit: str | None = None) - -Get the value of “Gravity Y Direction”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s2”. - - - -#### GetGravityZDirection(unit: str | None = None) - -Get the value of “Gravity Z Direction”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s2”. - - - -#### GetImpactEnergyModel() - -Get “Impact Energy Model” as a string. - -* **Returns:** - The returned value will be one of [‘default’, ‘custom’]. - - - -#### GetNormalForceModel() - -Get “Normal Force Model” as a string. - -* **Returns:** - The returned value will be one of [‘linear_hysteresis’, ‘linear_elastic_viscous’, ‘damped_hertzian’, ‘custom’]. - - - -#### GetNumericalSofteningFactor() - -Get the value of “Numerical Softening Factor”. - - - -#### GetRestitutionModel() - -Get “Restitution Model” as a string. - -* **Returns:** - The returned value will be one of [‘constant’, ‘velocity_dependent’]. - - - -#### GetRollingResistanceModel() - -Get “Rolling Resistance Model” as a string. - -* **Returns:** - The returned value will be one of [‘type_1’, ‘type_3’, ‘none’, ‘custom’]. - - - -#### GetSearchDistanceMultiplier() - -Get the value of “Search Distance Multiplier”. - - - -#### GetSphThermalTransferModel() - -Get “Sph Thermal Transfer Model” as a string. - -* **Returns:** - The returned value will be one of [‘cleary’, ‘custom’]. - - - -#### GetTangentialForceModel() - -Get “Tangential Force Model” as a string. - -* **Returns:** - The returned value will be one of [‘elastic_coulomb’, ‘coulomb_limit’, ‘mindlin_deresiewicz’, ‘custom’]. - - - -#### GetThermalCorrectionModel() - -Get “Thermal Correction Model” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘morris_et_al_area’, ‘morris_et_al_area_time’]. - - - -#### GetUpdateDistanceMultiplier() - -Get the value of “Update Distance Multiplier”. - - - -#### GetUseRadlEtAl() - -Get the value of “Use Radl Et Al”. - - - -#### GetValidAdhesionModelValues() - -Get a list of all possible values for “Adhesion Model”. - -* **Returns:** - The returned list is [‘none’, ‘constant’, ‘linear’, ‘JKR’, ‘custom’]. - - - -#### GetValidImpactEnergyModelValues() - -Get a list of all possible values for “Impact Energy Model”. - -* **Returns:** - The returned list is [‘default’, ‘custom’]. - - - -#### GetValidNormalForceModelValues() - -Get a list of all possible values for “Normal Force Model”. - -* **Returns:** - The returned list is [‘linear_hysteresis’, ‘linear_elastic_viscous’, ‘damped_hertzian’, ‘custom’]. - - - -#### GetValidRestitutionModelValues() - -Get a list of all possible values for “Restitution Model”. - -* **Returns:** - The returned list is [‘constant’, ‘velocity_dependent’]. - - - -#### GetValidRollingResistanceModelValues() - -Get a list of all possible values for “Rolling Resistance Model”. - -* **Returns:** - The returned list is [‘type_1’, ‘type_3’, ‘none’, ‘custom’]. - - - -#### GetValidSphThermalTransferModelValues() - -Get a list of all possible values for “Sph Thermal Transfer Model”. - -* **Returns:** - The returned list is [‘cleary’, ‘custom’]. - - - -#### GetValidTangentialForceModelValues() - -Get a list of all possible values for “Tangential Force Model”. - -* **Returns:** - The returned list is [‘elastic_coulomb’, ‘coulomb_limit’, ‘mindlin_deresiewicz’, ‘custom’]. - - - -#### GetValidThermalCorrectionModelValues() - -Get a list of all possible values for “Thermal Correction Model”. - -* **Returns:** - The returned list is [‘none’, ‘morris_et_al_area’, ‘morris_et_al_area_time’]. - - - -#### GetVolumeFractionLimit() - -Get the value of “Volume Fraction Limit”. - - - -#### SetAdhesionModel(value: str) - -Set the value of “Adhesion Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘constant’, ‘linear’, ‘JKR’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Adhesion Model” option. - - - -#### SetClosePackingVolumeFraction(value: str | float) - -Set the value of “Close Packing Volume Fraction”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetEnableCoarseGrainModeling(value: bool) - -Set the value of “Enable Coarse Grain Modeling”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetEnableThermalModel(value: bool) - -Set the value of “Enable Thermal Model”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetExponentLimit(value: str | float) - -Set the value of “Exponent Limit”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetGravityStartTime(value: str | float, unit: str | None = None) - -Set the value of “Gravity Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetGravityStopTime(value: str | float, unit: str | None = None) - -Set the value of “Gravity Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetGravityXDirection(value: str | float, unit: str | None = None) - -Set the value of “Gravity X Direction”. - -* **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/s2”. - - - -#### SetGravityYDirection(value: str | float, unit: str | None = None) - -Set the value of “Gravity Y Direction”. - -* **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/s2”. - - - -#### SetGravityZDirection(value: str | float, unit: str | None = None) - -Set the value of “Gravity Z Direction”. - -* **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/s2”. - - - -#### SetImpactEnergyModel(value: str) - -Set the value of “Impact Energy Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘default’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Impact Energy Model” option. - - - -#### SetNormalForceModel(value: str) - -Set the value of “Normal Force Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘linear_hysteresis’, ‘linear_elastic_viscous’, ‘damped_hertzian’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Normal Force Model” option. - - - -#### SetNumericalSofteningFactor(value: str | float) - -Set the value of “Numerical Softening Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetRestitutionModel(value: str) - -Set the value of “Restitution Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘constant’, ‘velocity_dependent’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Restitution Model” option. - - - -#### SetRollingResistanceModel(value: str) - -Set the value of “Rolling Resistance Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘type_1’, ‘type_3’, ‘none’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Rolling Resistance Model” option. - - - -#### SetSearchDistanceMultiplier(value: str | float) - -Set the value of “Search Distance Multiplier”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSphThermalTransferModel(value: str) - -Set the value of “Sph Thermal Transfer Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘cleary’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Sph Thermal Transfer Model” option. - - - -#### SetTangentialForceModel(value: str) - -Set the value of “Tangential Force Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘elastic_coulomb’, ‘coulomb_limit’, ‘mindlin_deresiewicz’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Tangential Force Model” option. - - - -#### SetThermalCorrectionModel(value: str) - -Set the value of “Thermal Correction Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘morris_et_al_area’, ‘morris_et_al_area_time’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Thermal Correction Model” option. - - - -#### SetUpdateDistanceMultiplier(value: str | float) - -Set the value of “Update Distance Multiplier”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetUseRadlEtAl(value: bool) - -Set the value of “Use Radl Et Al”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetVolumeFractionLimit(value: str | float) - -Set the value of “Volume Fraction Limit”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. + + +# RAPhysics + + + + + + +### *class* RAPhysics + +Rocky PrePost Scripting wrapper to manipulate physics properties. + +This class represents the “Physics” item on the project data tree. To get the [`RAPhysics`](#generated.RAPhysics) +from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: + +```python +physics = study.GetPhysics() +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| [`GetAdhesionModel`](#generated.RAPhysics.GetAdhesionModel)() | Get "Adhesion Model" as a string. | +| [`GetClosePackingVolumeFraction`](#generated.RAPhysics.GetClosePackingVolumeFraction)() | Get the value of "Close Packing Volume Fraction". | +| [`GetEnableCoarseGrainModeling`](#generated.RAPhysics.GetEnableCoarseGrainModeling)() | Get the value of "Enable Coarse Grain Modeling". | +| [`GetEnableThermalModel`](#generated.RAPhysics.GetEnableThermalModel)() | Get the value of "Enable Thermal Model". | +| [`GetExponentLimit`](#generated.RAPhysics.GetExponentLimit)() | Get the value of "Exponent Limit". | +| [`GetGravityStartTime`](#generated.RAPhysics.GetGravityStartTime)([unit]) | Get the value of "Gravity Start Time". | +| [`GetGravityStopTime`](#generated.RAPhysics.GetGravityStopTime)([unit]) | Get the value of "Gravity Stop Time". | +| [`GetGravityXDirection`](#generated.RAPhysics.GetGravityXDirection)([unit]) | Get the value of "Gravity X Direction". | +| [`GetGravityYDirection`](#generated.RAPhysics.GetGravityYDirection)([unit]) | Get the value of "Gravity Y Direction". | +| [`GetGravityZDirection`](#generated.RAPhysics.GetGravityZDirection)([unit]) | Get the value of "Gravity Z Direction". | +| [`GetImpactEnergyModel`](#generated.RAPhysics.GetImpactEnergyModel)() | Get "Impact Energy Model" as a string. | +| [`GetNormalForceModel`](#generated.RAPhysics.GetNormalForceModel)() | Get "Normal Force Model" as a string. | +| [`GetNumericalSofteningFactor`](#generated.RAPhysics.GetNumericalSofteningFactor)() | Get the value of "Numerical Softening Factor". | +| [`GetRestitutionModel`](#generated.RAPhysics.GetRestitutionModel)() | Get "Restitution Model" as a string. | +| [`GetRollingResistanceModel`](#generated.RAPhysics.GetRollingResistanceModel)() | Get "Rolling Resistance Model" as a string. | +| [`GetSearchDistanceMultiplier`](#generated.RAPhysics.GetSearchDistanceMultiplier)() | Get the value of "Search Distance Multiplier". | +| [`GetSphThermalTransferModel`](#generated.RAPhysics.GetSphThermalTransferModel)() | Get "Sph Thermal Transfer Model" as a string. | +| [`GetTangentialForceModel`](#generated.RAPhysics.GetTangentialForceModel)() | Get "Tangential Force Model" as a string. | +| [`GetThermalCorrectionModel`](#generated.RAPhysics.GetThermalCorrectionModel)() | Get "Thermal Correction Model" as a string. | +| [`GetUpdateDistanceMultiplier`](#generated.RAPhysics.GetUpdateDistanceMultiplier)() | Get the value of "Update Distance Multiplier". | +| [`GetUseRadlEtAl`](#generated.RAPhysics.GetUseRadlEtAl)() | Get the value of "Use Radl Et Al". | +| [`GetValidAdhesionModelValues`](#generated.RAPhysics.GetValidAdhesionModelValues)() | Get a list of all possible values for "Adhesion Model". | +| [`GetValidImpactEnergyModelValues`](#generated.RAPhysics.GetValidImpactEnergyModelValues)() | Get a list of all possible values for "Impact Energy Model". | +| [`GetValidNormalForceModelValues`](#generated.RAPhysics.GetValidNormalForceModelValues)() | Get a list of all possible values for "Normal Force Model". | +| [`GetValidRestitutionModelValues`](#generated.RAPhysics.GetValidRestitutionModelValues)() | Get a list of all possible values for "Restitution Model". | +| [`GetValidRollingResistanceModelValues`](#generated.RAPhysics.GetValidRollingResistanceModelValues)() | Get a list of all possible values for "Rolling Resistance Model". | +| [`GetValidSphThermalTransferModelValues`](#generated.RAPhysics.GetValidSphThermalTransferModelValues)() | Get a list of all possible values for "Sph Thermal Transfer Model". | +| [`GetValidTangentialForceModelValues`](#generated.RAPhysics.GetValidTangentialForceModelValues)() | Get a list of all possible values for "Tangential Force Model". | +| [`GetValidThermalCorrectionModelValues`](#generated.RAPhysics.GetValidThermalCorrectionModelValues)() | Get a list of all possible values for "Thermal Correction Model". | +| [`GetVolumeFractionLimit`](#generated.RAPhysics.GetVolumeFractionLimit)() | Get the value of "Volume Fraction Limit". | +| [`SetAdhesionModel`](#generated.RAPhysics.SetAdhesionModel)(value) | Set the value of "Adhesion Model". | +| [`SetClosePackingVolumeFraction`](#generated.RAPhysics.SetClosePackingVolumeFraction)(value) | Set the value of "Close Packing Volume Fraction". | +| [`SetEnableCoarseGrainModeling`](#generated.RAPhysics.SetEnableCoarseGrainModeling)(value) | Set the value of "Enable Coarse Grain Modeling". | +| [`SetEnableThermalModel`](#generated.RAPhysics.SetEnableThermalModel)(value) | Set the value of "Enable Thermal Model". | +| [`SetExponentLimit`](#generated.RAPhysics.SetExponentLimit)(value) | Set the value of "Exponent Limit". | +| [`SetGravityStartTime`](#generated.RAPhysics.SetGravityStartTime)(value[, unit]) | Set the value of "Gravity Start Time". | +| [`SetGravityStopTime`](#generated.RAPhysics.SetGravityStopTime)(value[, unit]) | Set the value of "Gravity Stop Time". | +| [`SetGravityXDirection`](#generated.RAPhysics.SetGravityXDirection)(value[, unit]) | Set the value of "Gravity X Direction". | +| [`SetGravityYDirection`](#generated.RAPhysics.SetGravityYDirection)(value[, unit]) | Set the value of "Gravity Y Direction". | +| [`SetGravityZDirection`](#generated.RAPhysics.SetGravityZDirection)(value[, unit]) | Set the value of "Gravity Z Direction". | +| [`SetImpactEnergyModel`](#generated.RAPhysics.SetImpactEnergyModel)(value) | Set the value of "Impact Energy Model". | +| [`SetNormalForceModel`](#generated.RAPhysics.SetNormalForceModel)(value) | Set the value of "Normal Force Model". | +| [`SetNumericalSofteningFactor`](#generated.RAPhysics.SetNumericalSofteningFactor)(value) | Set the value of "Numerical Softening Factor". | +| [`SetRestitutionModel`](#generated.RAPhysics.SetRestitutionModel)(value) | Set the value of "Restitution Model". | +| [`SetRollingResistanceModel`](#generated.RAPhysics.SetRollingResistanceModel)(value) | Set the value of "Rolling Resistance Model". | +| [`SetSearchDistanceMultiplier`](#generated.RAPhysics.SetSearchDistanceMultiplier)(value) | Set the value of "Search Distance Multiplier". | +| [`SetSphThermalTransferModel`](#generated.RAPhysics.SetSphThermalTransferModel)(value) | Set the value of "Sph Thermal Transfer Model". | +| [`SetTangentialForceModel`](#generated.RAPhysics.SetTangentialForceModel)(value) | Set the value of "Tangential Force Model". | +| [`SetThermalCorrectionModel`](#generated.RAPhysics.SetThermalCorrectionModel)(value) | Set the value of "Thermal Correction Model". | +| [`SetUpdateDistanceMultiplier`](#generated.RAPhysics.SetUpdateDistanceMultiplier)(value) | Set the value of "Update Distance Multiplier". | +| [`SetUseRadlEtAl`](#generated.RAPhysics.SetUseRadlEtAl)(value) | Set the value of "Use Radl Et Al". | +| [`SetVolumeFractionLimit`](#generated.RAPhysics.SetVolumeFractionLimit)(value) | Set the value of "Volume Fraction Limit". | + + + +#### GetAdhesionModel() + +Get “Adhesion Model” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘constant’, ‘linear’, ‘JKR’, ‘custom’]. + + + +#### GetClosePackingVolumeFraction() + +Get the value of “Close Packing Volume Fraction”. + + + +#### GetEnableCoarseGrainModeling() + +Get the value of “Enable Coarse Grain Modeling”. + + + +#### GetEnableThermalModel() + +Get the value of “Enable Thermal Model”. + + + +#### GetExponentLimit() + +Get the value of “Exponent Limit”. + + + +#### GetGravityStartTime(unit: str | None = None) + +Get the value of “Gravity Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetGravityStopTime(unit: str | None = None) + +Get the value of “Gravity Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetGravityXDirection(unit: str | None = None) + +Get the value of “Gravity X Direction”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s2”. + + + +#### GetGravityYDirection(unit: str | None = None) + +Get the value of “Gravity Y Direction”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s2”. + + + +#### GetGravityZDirection(unit: str | None = None) + +Get the value of “Gravity Z Direction”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s2”. + + + +#### GetImpactEnergyModel() + +Get “Impact Energy Model” as a string. + +* **Returns:** + The returned value will be one of [‘default’, ‘custom’]. + + + +#### GetNormalForceModel() + +Get “Normal Force Model” as a string. + +* **Returns:** + The returned value will be one of [‘linear_hysteresis’, ‘linear_elastic_viscous’, ‘damped_hertzian’, ‘custom’]. + + + +#### GetNumericalSofteningFactor() + +Get the value of “Numerical Softening Factor”. + + + +#### GetRestitutionModel() + +Get “Restitution Model” as a string. + +* **Returns:** + The returned value will be one of [‘constant’, ‘velocity_dependent’]. + + + +#### GetRollingResistanceModel() + +Get “Rolling Resistance Model” as a string. + +* **Returns:** + The returned value will be one of [‘type_1’, ‘type_3’, ‘none’, ‘custom’]. + + + +#### GetSearchDistanceMultiplier() + +Get the value of “Search Distance Multiplier”. + + + +#### GetSphThermalTransferModel() + +Get “Sph Thermal Transfer Model” as a string. + +* **Returns:** + The returned value will be one of [‘cleary’, ‘custom’]. + + + +#### GetTangentialForceModel() + +Get “Tangential Force Model” as a string. + +* **Returns:** + The returned value will be one of [‘elastic_coulomb’, ‘coulomb_limit’, ‘mindlin_deresiewicz’, ‘custom’]. + + + +#### GetThermalCorrectionModel() + +Get “Thermal Correction Model” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘morris_et_al_area’, ‘morris_et_al_area_time’]. + + + +#### GetUpdateDistanceMultiplier() + +Get the value of “Update Distance Multiplier”. + + + +#### GetUseRadlEtAl() + +Get the value of “Use Radl Et Al”. + + + +#### GetValidAdhesionModelValues() + +Get a list of all possible values for “Adhesion Model”. + +* **Returns:** + The returned list is [‘none’, ‘constant’, ‘linear’, ‘JKR’, ‘custom’]. + + + +#### GetValidImpactEnergyModelValues() + +Get a list of all possible values for “Impact Energy Model”. + +* **Returns:** + The returned list is [‘default’, ‘custom’]. + + + +#### GetValidNormalForceModelValues() + +Get a list of all possible values for “Normal Force Model”. + +* **Returns:** + The returned list is [‘linear_hysteresis’, ‘linear_elastic_viscous’, ‘damped_hertzian’, ‘custom’]. + + + +#### GetValidRestitutionModelValues() + +Get a list of all possible values for “Restitution Model”. + +* **Returns:** + The returned list is [‘constant’, ‘velocity_dependent’]. + + + +#### GetValidRollingResistanceModelValues() + +Get a list of all possible values for “Rolling Resistance Model”. + +* **Returns:** + The returned list is [‘type_1’, ‘type_3’, ‘none’, ‘custom’]. + + + +#### GetValidSphThermalTransferModelValues() + +Get a list of all possible values for “Sph Thermal Transfer Model”. + +* **Returns:** + The returned list is [‘cleary’, ‘custom’]. + + + +#### GetValidTangentialForceModelValues() + +Get a list of all possible values for “Tangential Force Model”. + +* **Returns:** + The returned list is [‘elastic_coulomb’, ‘coulomb_limit’, ‘mindlin_deresiewicz’, ‘custom’]. + + + +#### GetValidThermalCorrectionModelValues() + +Get a list of all possible values for “Thermal Correction Model”. + +* **Returns:** + The returned list is [‘none’, ‘morris_et_al_area’, ‘morris_et_al_area_time’]. + + + +#### GetVolumeFractionLimit() + +Get the value of “Volume Fraction Limit”. + + + +#### SetAdhesionModel(value: str) + +Set the value of “Adhesion Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘constant’, ‘linear’, ‘JKR’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Adhesion Model” option. + + + +#### SetClosePackingVolumeFraction(value: str | float) + +Set the value of “Close Packing Volume Fraction”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetEnableCoarseGrainModeling(value: bool) + +Set the value of “Enable Coarse Grain Modeling”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetEnableThermalModel(value: bool) + +Set the value of “Enable Thermal Model”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetExponentLimit(value: str | float) + +Set the value of “Exponent Limit”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetGravityStartTime(value: str | float, unit: str | None = None) + +Set the value of “Gravity Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetGravityStopTime(value: str | float, unit: str | None = None) + +Set the value of “Gravity Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetGravityXDirection(value: str | float, unit: str | None = None) + +Set the value of “Gravity X Direction”. + +* **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/s2”. + + + +#### SetGravityYDirection(value: str | float, unit: str | None = None) + +Set the value of “Gravity Y Direction”. + +* **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/s2”. + + + +#### SetGravityZDirection(value: str | float, unit: str | None = None) + +Set the value of “Gravity Z Direction”. + +* **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/s2”. + + + +#### SetImpactEnergyModel(value: str) + +Set the value of “Impact Energy Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘default’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Impact Energy Model” option. + + + +#### SetNormalForceModel(value: str) + +Set the value of “Normal Force Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘linear_hysteresis’, ‘linear_elastic_viscous’, ‘damped_hertzian’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Normal Force Model” option. + + + +#### SetNumericalSofteningFactor(value: str | float) + +Set the value of “Numerical Softening Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetRestitutionModel(value: str) + +Set the value of “Restitution Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘constant’, ‘velocity_dependent’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Restitution Model” option. + + + +#### SetRollingResistanceModel(value: str) + +Set the value of “Rolling Resistance Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘type_1’, ‘type_3’, ‘none’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Rolling Resistance Model” option. + + + +#### SetSearchDistanceMultiplier(value: str | float) + +Set the value of “Search Distance Multiplier”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSphThermalTransferModel(value: str) + +Set the value of “Sph Thermal Transfer Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘cleary’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Sph Thermal Transfer Model” option. + + + +#### SetTangentialForceModel(value: str) + +Set the value of “Tangential Force Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘elastic_coulomb’, ‘coulomb_limit’, ‘mindlin_deresiewicz’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Tangential Force Model” option. + + + +#### SetThermalCorrectionModel(value: str) + +Set the value of “Thermal Correction Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘morris_et_al_area’, ‘morris_et_al_area_time’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Thermal Correction Model” option. + + + +#### SetUpdateDistanceMultiplier(value: str | float) + +Set the value of “Update Distance Multiplier”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetUseRadlEtAl(value: bool) + +Set the value of “Use Radl Et Al”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetVolumeFractionLimit(value: str | float) + +Set the value of “Volume Fraction Limit”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. diff --git a/2025R2/rocky-prepost-scripting-manual/RAPlaneProcess.md b/2025R2/rocky-prepost-scripting-manual/RAPlaneProcess.md index 763734fbe7..8ad1b86af9 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPlaneProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPlaneProcess.md @@ -1,1130 +1,1131 @@ - - -# RAPlaneProcess - - - - - - -### *class* RAPlaneProcess - -**Methods:** - -| [`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) | | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMode() - -* **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### 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() - -* **Returns:** - Returns the X, Y and Z plane origin - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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 - - - -#### GetPlaneOrigin() - -Deprecated: Use GetOrigin instead - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetType() - -* **Returns:** - ‘Cut’ or ‘Clip’, whether the plane process is cutting or clipping the input process. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### 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 - - - -#### 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') - -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** - - - -#### SetPlaneNormal(x: float, y: float, z: float) - -Deprecated: Use SetNormal instead - - - -#### SetPlaneOrigin(x: float, y: float, z: float) - -Deprecated: Use SetOrigin instead - - - -#### SetType(plane_type: str) - -* **Parameters:** - **plane_type** – ‘Cut’ or ‘Clip’, sets whether the plane process is cutting or clipping the input process. + + +# RAPlaneProcess + + + + + + +### *class* RAPlaneProcess + +**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) | | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMode() + +* **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### 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() + +* **Returns:** + Returns the X, Y and Z plane origin + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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 + + + +#### GetPlaneOrigin() + +Deprecated: Use GetOrigin instead + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetType() + +* **Returns:** + ‘Cut’ or ‘Clip’, whether the plane process is cutting or clipping the input process. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### 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 + + + +#### 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') + +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** + + + +#### SetPlaneNormal(x: float, y: float, z: float) + +Deprecated: Use SetNormal instead + + + +#### SetPlaneOrigin(x: float, y: float, z: float) + +Deprecated: Use SetOrigin instead + + + +#### 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/2025R2/rocky-prepost-scripting-manual/RAPointCloud.md b/2025R2/rocky-prepost-scripting-manual/RAPointCloud.md index 241dc14060..fd35b7876a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPointCloud.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPointCloud.md @@ -1,1146 +1,1147 @@ - - -# RAPointCloud - - - - - - -### *class* RAPointCloud - -Rocky PrePost Scripting wrapper for a point cloud in the project. - -The wrapper corresponds to an individual PointCloud in the project’s data tree, below the -“Point Clouds” item. PointCloud can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) via: - -```python -point_cloud_1 = study.GetElement('Point Cloud 1') -point_cloud_2 = point_cloud_collection[1] -``` - -**Methods:** - -| [`AddCurve`](#generated.RAPointCloud.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAPointCloud.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.RAPointCloud.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAPointCloud.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAPointCloud.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.RAPointCloud.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAPointCloud.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAPointCloud.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.RAPointCloud.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). | -| [`DisablePeriodic`](#generated.RAPointCloud.DisablePeriodic)() | Set the value of "Periodic" to False. | -| [`EditCustomCurve`](#generated.RAPointCloud.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.RAPointCloud.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. | -| [`EnablePeriodic`](#generated.RAPointCloud.EnablePeriodic)() | Set the value of "Periodic" to True. | -| [`GetActivesArray`](#generated.RAPointCloud.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAPointCloud.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAPointCloud.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAPointCloud.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAPointCloud.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAPointCloud.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAPointCloud.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAPointCloud.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAPointCloud.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAPointCloud.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAPointCloud.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAPointCloud.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`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". | -| [`GetFilePath`](#generated.RAPointCloud.GetFilePath)() | Get the value of "File Path". | -| [`GetGeometryQuantity`](#generated.RAPointCloud.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetMotionFrame`](#generated.RAPointCloud.GetMotionFrame)() | | -| [`GetNumberOfCells`](#generated.RAPointCloud.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAPointCloud.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAPointCloud.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAPointCloud.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`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". | -| [`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. | -| [`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. | -| [`IsTransient`](#generated.RAPointCloud.IsTransient)() | Returns True if the Point Cloud is transient, False otherwise. | -| [`IterCellVertices`](#generated.RAPointCloud.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAPointCloud.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAPointCloud.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAPointCloud.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAPointCloud.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAPointCloud.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAPointCloud.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAPointCloud.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetEnablePeriodic`](#generated.RAPointCloud.SetEnablePeriodic)(value) | Set the value of "Enable Periodic". | -| [`SetFilePath`](#generated.RAPointCloud.SetFilePath)(file_path) | Set the path of the file that will be used to generate the point cloud described on the content of the file. | -| [`SetModuleProperty`](#generated.RAPointCloud.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetMotionFrame`](#generated.RAPointCloud.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`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". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisablePeriodic() - -Set the value of “Periodic” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnablePeriodic() - -Set the value of “Periodic” to True. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetEnablePeriodic() - -Get the value of “Enable Periodic”. - - - -#### GetFilePath() - -Get the value of “File Path”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - 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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetPeriodicStartTime(unit: str | None = None) - -Get the value of “Periodic Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetPeriodicStopTime(unit: str | None = None) - -Get the value of “Periodic Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetSearchCutOff() - -Get the value of “Search Cut Off”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsPeriodicEnabled() - -Check if the “Periodic” is enabled. - - - -#### IsTransient() - -Returns True if the Point Cloud is transient, False otherwise. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetEnablePeriodic(value: bool) - -Set the value of “Enable Periodic”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFilePath(file_path: str | Path) - -Set the path of the file that will be used to generate the point cloud -described on the content of the file. - -The accepted file extensions is “.txt”. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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](RAMotionFrame.md#generated.RAMotionFrame) | str | None) - -Assign a Motion Frame to the process. - -* **Parameters:** - **motion_frame** – Either the API object or its name. - - - -#### SetPeriodicStartTime(value: str | float, unit: str | None = None) - -Set the value of “Periodic Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetPeriodicStopTime(value: str | float, unit: str | None = None) - -Set the value of “Periodic Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetSearchCutOff(value: bool) - -Set the value of “Search Cut Off”. - -* **Parameters:** - **value** – The value to set. + + +# RAPointCloud + + + + + + +### *class* RAPointCloud + +Rocky PrePost Scripting wrapper for a point cloud in the project. + +The wrapper corresponds to an individual PointCloud in the project’s data tree, below the +“Point Clouds” item. PointCloud can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) via: + +```python +point_cloud_1 = study.GetElement('Point Cloud 1') +point_cloud_2 = point_cloud_collection[1] +``` + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAPointCloud.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAPointCloud.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.RAPointCloud.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAPointCloud.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAPointCloud.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.RAPointCloud.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAPointCloud.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAPointCloud.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.RAPointCloud.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). | +| [`DisablePeriodic`](#generated.RAPointCloud.DisablePeriodic)() | Set the value of "Periodic" to False. | +| [`EditCustomCurve`](#generated.RAPointCloud.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.RAPointCloud.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. | +| [`EnablePeriodic`](#generated.RAPointCloud.EnablePeriodic)() | Set the value of "Periodic" to True. | +| [`GetActivesArray`](#generated.RAPointCloud.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAPointCloud.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAPointCloud.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAPointCloud.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAPointCloud.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAPointCloud.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAPointCloud.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAPointCloud.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAPointCloud.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAPointCloud.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAPointCloud.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAPointCloud.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`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". | +| [`GetFilePath`](#generated.RAPointCloud.GetFilePath)() | Get the value of "File Path". | +| [`GetGeometryQuantity`](#generated.RAPointCloud.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetMotionFrame`](#generated.RAPointCloud.GetMotionFrame)() | | +| [`GetNumberOfCells`](#generated.RAPointCloud.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAPointCloud.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAPointCloud.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAPointCloud.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`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". | +| [`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. | +| [`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. | +| [`IsTransient`](#generated.RAPointCloud.IsTransient)() | Returns True if the Point Cloud is transient, False otherwise. | +| [`IterCellVertices`](#generated.RAPointCloud.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAPointCloud.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAPointCloud.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAPointCloud.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAPointCloud.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAPointCloud.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAPointCloud.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAPointCloud.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetEnablePeriodic`](#generated.RAPointCloud.SetEnablePeriodic)(value) | Set the value of "Enable Periodic". | +| [`SetFilePath`](#generated.RAPointCloud.SetFilePath)(file_path) | Set the path of the file that will be used to generate the point cloud described on the content of the file. | +| [`SetModuleProperty`](#generated.RAPointCloud.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetMotionFrame`](#generated.RAPointCloud.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`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". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisablePeriodic() + +Set the value of “Periodic” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnablePeriodic() + +Set the value of “Periodic” to True. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetEnablePeriodic() + +Get the value of “Enable Periodic”. + + + +#### GetFilePath() + +Get the value of “File Path”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - 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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetPeriodicStartTime(unit: str | None = None) + +Get the value of “Periodic Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetPeriodicStopTime(unit: str | None = None) + +Get the value of “Periodic Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetSearchCutOff() + +Get the value of “Search Cut Off”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsPeriodicEnabled() + +Check if the “Periodic” is enabled. + + + +#### IsTransient() + +Returns True if the Point Cloud is transient, False otherwise. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetEnablePeriodic(value: bool) + +Set the value of “Enable Periodic”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFilePath(file_path: str | Path) + +Set the path of the file that will be used to generate the point cloud +described on the content of the file. + +The accepted file extensions is “.txt”. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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](RAMotionFrame.md#generated.RAMotionFrame) | str | None) + +Assign a Motion Frame to the process. + +* **Parameters:** + **motion_frame** – Either the API object or its name. + + + +#### SetPeriodicStartTime(value: str | float, unit: str | None = None) + +Set the value of “Periodic Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetPeriodicStopTime(value: str | float, unit: str | None = None) + +Set the value of “Periodic Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetSearchCutOff(value: bool) + +Set the value of “Search Cut Off”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RAPointCloudCollection.md b/2025R2/rocky-prepost-scripting-manual/RAPointCloudCollection.md index b7721c2cf0..b6a4af8eaa 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPointCloudCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPointCloudCollection.md @@ -1,57 +1,58 @@ - - -# RAPointCloudCollection - - - - - - -### *class* RAPointCloudCollection - -Rocky PrePost Scripting wrapper for the collection of point clouds in a project. - -This wrapper corresponds to the “Point Clouds” item in the project’s data tree. To retrieve the -[`RAPointCloudCollection`](#generated.RAPointCloudCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: - -```python -point_cloud_collection = study.GetPointCloudCollection() -``` - -Instances of the [`RAPointCloudCollection`](#generated.RAPointCloudCollection) class act as regular Python lists, and can be -iterated on, accessed via index, etc: - -```python -point_cloud_1 = point_cloud_collection.New() -point_cloud_2 = point_cloud_collection[1] -del point_cloud_collection[0] -``` - -Items in this list are of type [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud). - -**Methods:** - -| [`Clear`](#generated.RAPointCloudCollection.Clear)() | Remove all items from the list. | -|------------------------------------------------------------|-----------------------------------| -| [`New`](#generated.RAPointCloudCollection.New)() | Add a new item. | -| [`Remove`](#generated.RAPointCloudCollection.Remove)(item) | Remove an item from the list. | - - - -#### Clear() - -Remove all items from the list. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RAPointCloudCollection + + + + + + +### *class* RAPointCloudCollection + +Rocky PrePost Scripting wrapper for the collection of point clouds in a project. + +This wrapper corresponds to the “Point Clouds” item in the project’s data tree. To retrieve the +[`RAPointCloudCollection`](#generated.RAPointCloudCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: + +```python +point_cloud_collection = study.GetPointCloudCollection() +``` + +Instances of the [`RAPointCloudCollection`](#generated.RAPointCloudCollection) class act as regular Python lists, and can be +iterated on, accessed via index, etc: + +```python +point_cloud_1 = point_cloud_collection.New() +point_cloud_2 = point_cloud_collection[1] +del point_cloud_collection[0] +``` + +Items in this list are of type [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud). + +**Methods:** + +| Name | Description | +|------------------------------------------------------------|-----------------------------------| +| [`Clear`](#generated.RAPointCloudCollection.Clear)() | Remove all items from the list. | +| [`New`](#generated.RAPointCloudCollection.New)() | Add a new item. | +| [`Remove`](#generated.RAPointCloudCollection.Remove)(item) | Remove an item from the list. | + + + +#### Clear() + +Remove all items from the list. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RAPolyhedronProcess.md b/2025R2/rocky-prepost-scripting-manual/RAPolyhedronProcess.md index ef85222986..1347242abd 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPolyhedronProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPolyhedronProcess.md @@ -1,1163 +1,1164 @@ - - -# RAPolyhedronProcess - - - - - - -### *class* RAPolyhedronProcess - -**Methods:** - -| [`AddCurve`](#generated.RAPolyhedronProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAPolyhedronProcess.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.RAPolyhedronProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAPolyhedronProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAPolyhedronProcess.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.RAPolyhedronProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAPolyhedronProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAPolyhedronProcess.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.RAPolyhedronProcess.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.RAPolyhedronProcess.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.RAPolyhedronProcess.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.RAPolyhedronProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAPolyhedronProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAPolyhedronProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAPolyhedronProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAPolyhedronProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAPolyhedronProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAPolyhedronProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAPolyhedronProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAPolyhedronProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAPolyhedronProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RAPolyhedronProcess.GetCenter)([unit]) | | -| [`GetCenterAfterMovement`](#generated.RAPolyhedronProcess.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | -| [`GetCurve`](#generated.RAPolyhedronProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAPolyhedronProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfNodes`](#generated.RAPolyhedronProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RAPolyhedronProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAPolyhedronProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RAPolyhedronProcess.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RAPolyhedronProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RAPolyhedronProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAPolyhedronProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAPolyhedronProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAPolyhedronProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAPolyhedronProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAPolyhedronProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAPolyhedronProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCenter`](#generated.RAPolyhedronProcess.SetCenter)(x, y, z[, unit]) | Sets the Polyhedron X, Y and Z center | -| [`SetCurrentTimeStep`](#generated.RAPolyhedronProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetMotionFrame`](#generated.RAPolyhedronProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RAPolyhedronProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`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 | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit=None) - -* **Returns:** - Returns the X, Y and Z Polyhedron center - - - -#### GetCenterAfterMovement(timestep: int) - -Get the Process center position considering the assigned motion. - -* **Returns:** - Returns the X, Y and Z center - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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) - -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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(x: float, y: float, z: float, unit: str | None = None) - -Sets the Polyhedron X, Y and Z center - -* **Parameters:** - * **x** – The center X coordinate - * **y** – The center Y coordinate - * **z** – The center Z coordinate - * **unit** – The unit of the given values or None if given in meters (m) - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### 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) - -Sets the Polyhedron file - -* **Parameters:** - * **filename** – Path to the file to be used - * **mesh_unit** – unit to be used for the mesh, or None if given in meters (m) - - - -#### SetScale(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Scale”. - -* **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. - - - -#### 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) + + +# RAPolyhedronProcess + + + + + + +### *class* RAPolyhedronProcess + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAPolyhedronProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAPolyhedronProcess.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.RAPolyhedronProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAPolyhedronProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAPolyhedronProcess.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.RAPolyhedronProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAPolyhedronProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAPolyhedronProcess.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.RAPolyhedronProcess.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.RAPolyhedronProcess.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.RAPolyhedronProcess.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.RAPolyhedronProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RAPolyhedronProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAPolyhedronProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAPolyhedronProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAPolyhedronProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAPolyhedronProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAPolyhedronProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAPolyhedronProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAPolyhedronProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAPolyhedronProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RAPolyhedronProcess.GetCenter)([unit]) | | +| [`GetCenterAfterMovement`](#generated.RAPolyhedronProcess.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | +| [`GetCurve`](#generated.RAPolyhedronProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAPolyhedronProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfNodes`](#generated.RAPolyhedronProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfParticles`](#generated.RAPolyhedronProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RAPolyhedronProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RAPolyhedronProcess.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RAPolyhedronProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RAPolyhedronProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RAPolyhedronProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RAPolyhedronProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAPolyhedronProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAPolyhedronProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAPolyhedronProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAPolyhedronProcess.RemoveProcess)() | Removes the process from the project. | +| [`SetCenter`](#generated.RAPolyhedronProcess.SetCenter)(x, y, z[, unit]) | Sets the Polyhedron X, Y and Z center | +| [`SetCurrentTimeStep`](#generated.RAPolyhedronProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetMotionFrame`](#generated.RAPolyhedronProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RAPolyhedronProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`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 | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit=None) + +* **Returns:** + Returns the X, Y and Z Polyhedron center + + + +#### GetCenterAfterMovement(timestep: int) + +Get the Process center position considering the assigned motion. + +* **Returns:** + Returns the X, Y and Z center + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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) + +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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(x: float, y: float, z: float, unit: str | None = None) + +Sets the Polyhedron X, Y and Z center + +* **Parameters:** + * **x** – The center X coordinate + * **y** – The center Y coordinate + * **z** – The center Z coordinate + * **unit** – The unit of the given values or None if given in meters (m) + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### 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) + +Sets the Polyhedron file + +* **Parameters:** + * **filename** – Path to the file to be used + * **mesh_unit** – unit to be used for the mesh, or None if given in meters (m) + + + +#### SetScale(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Scale”. + +* **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. + + + +#### 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/2025R2/rocky-prepost-scripting-manual/RAPrescribedForce.md b/2025R2/rocky-prepost-scripting-manual/RAPrescribedForce.md index e57bfbdd0a..eeee422ccd 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPrescribedForce.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPrescribedForce.md @@ -1,52 +1,53 @@ - - -# RAPrescribedForce - - - - - - -### *class* RAPrescribedForce - -Rocky PrePost Scripting wrapper representing an Additional Force motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Additional Force') -additional_force = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetForceValue`](#generated.RAPrescribedForce.GetForceValue)([unit]) | Get the value of "Force Value". | -|-------------------------------------------------------------------------------|-----------------------------------| -| [`SetForceValue`](#generated.RAPrescribedForce.SetForceValue)(values[, unit]) | Set the values of "Force Value". | - - - -#### GetForceValue(unit: str | None = None) - -Get the value of “Force Value”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N”. - - - -#### SetForceValue(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Force Value”. - -* **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 “N”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. + + +# RAPrescribedForce + + + + + + +### *class* RAPrescribedForce + +Rocky PrePost Scripting wrapper representing an Additional Force motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Additional Force') +additional_force = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------|-----------------------------------| +| [`GetForceValue`](#generated.RAPrescribedForce.GetForceValue)([unit]) | Get the value of "Force Value". | +| [`SetForceValue`](#generated.RAPrescribedForce.SetForceValue)(values[, unit]) | Set the values of "Force Value". | + + + +#### GetForceValue(unit: str | None = None) + +Get the value of “Force Value”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N”. + + + +#### SetForceValue(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Force Value”. + +* **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 “N”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. diff --git a/2025R2/rocky-prepost-scripting-manual/RAPrescribedMoment.md b/2025R2/rocky-prepost-scripting-manual/RAPrescribedMoment.md index f253c466ed..39ead7b488 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAPrescribedMoment.md +++ b/2025R2/rocky-prepost-scripting-manual/RAPrescribedMoment.md @@ -1,52 +1,53 @@ - - -# RAPrescribedMoment - - - - - - -### *class* RAPrescribedMoment - -Rocky PrePost Scripting wrapper representing an Additional Moment motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Additional Moment') -additional_moment = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetMomentValue`](#generated.RAPrescribedMoment.GetMomentValue)([unit]) | Get the value of "Moment Value". | -|----------------------------------------------------------------------------------|------------------------------------| -| [`SetMomentValue`](#generated.RAPrescribedMoment.SetMomentValue)(values[, unit]) | Set the values of "Moment Value". | - - - -#### GetMomentValue(unit: str | None = None) - -Get the value of “Moment Value”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m”. - - - -#### SetMomentValue(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Moment Value”. - -* **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 “N.m”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. + + +# RAPrescribedMoment + + + + + + +### *class* RAPrescribedMoment + +Rocky PrePost Scripting wrapper representing an Additional Moment motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Additional Moment') +additional_moment = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------|------------------------------------| +| [`GetMomentValue`](#generated.RAPrescribedMoment.GetMomentValue)([unit]) | Get the value of "Moment Value". | +| [`SetMomentValue`](#generated.RAPrescribedMoment.SetMomentValue)(values[, unit]) | Set the values of "Moment Value". | + + + +#### GetMomentValue(unit: str | None = None) + +Get the value of “Moment Value”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m”. + + + +#### SetMomentValue(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Moment Value”. + +* **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 “N.m”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. diff --git a/2025R2/rocky-prepost-scripting-manual/RAProject.md b/2025R2/rocky-prepost-scripting-manual/RAProject.md index a9043c4540..17999ee748 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAProject.md +++ b/2025R2/rocky-prepost-scripting-manual/RAProject.md @@ -1,161 +1,162 @@ - - -# RAProject - - - - - - -### *class* RAProject - -Rocky PrePost Scripting wrapper for a project. - -The [`RAProject`](#generated.RAProject) class serves as the main access point for a project’s [`RAStudy`](RAStudy.md#generated.RAStudy) -and the project entities that aren’t directly related to a simulation’s configuration, such as -the time filter, the collection of user processes, etc. - -The [`RAProject`](#generated.RAProject) can be obtained directly via the app global object. Example usage: - -```python -project = app.CreateProject() -study = project.GetStudy() -user_processes = project.GetUserProcessCollection() -input_variables = project.GetInputVariables() - -project.SaveProject('my_project.rocky') -project.SaveProjectForRestart('my_restart_project.rocky', timestep_or_index=10) -``` - -**Methods:** - -| [`CloseProject`](#generated.RAProject.CloseProject)([check_save_state]) | Close the current project. | -|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| -| [`CreateStudy`](#generated.RAProject.CreateStudy)([study_name]) | Creates a new study and returns its wrapper | -| [`GetInputVariables`](#generated.RAProject.GetInputVariables)() | Get the PrePost Scripting wrapper for the project's Input Variables. | -| [`GetModelElement`](#generated.RAProject.GetModelElement)(model_element_id) | Get the model element associated with the given ID | -| [`GetModelStudy`](#generated.RAProject.GetModelStudy)(model_item) | Get the study model associated with a given model item | -| [`GetParametricVariables`](#generated.RAProject.GetParametricVariables)() | Get the PrePost Scripting wrapper for the project's Parametric Variables. | -| [`GetProjectFilename`](#generated.RAProject.GetProjectFilename)() | Get the current project's filename. | -| [`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. | -| [`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. | - - - -#### CloseProject(check_save_state: bool = True) - -Close the current project. - -* **Parameters:** - **check_save_state** – If False, it will close without asking the user to save it first. - - - -#### CreateStudy(study_name: str | None = None) - -Creates a new study and returns its wrapper - -* **Parameters:** - **study_name** – The name of the study - - - -#### GetInputVariables() - -Get the PrePost Scripting wrapper for the project’s Input Variables. - - - -#### GetModelElement(model_element_id) - -Get the model element associated with the given ID - -* **Parameters:** - **model_element_id** (*unicode*) – The element id - -@return -: The wrapped object with the given ID - - - -#### *classmethod* GetModelStudy(model_item) - -Get the study model associated with a given model item - -* **Parameters:** - **model_item** (*Subject*) – A study child - -@return RAStudy or None if no study was found for the given element - - - -#### GetParametricVariables() - -Get the PrePost Scripting wrapper for the project’s Parametric Variables. - - - -#### GetProjectFilename() - -Get the current project’s filename. - -* **Returns:** - The current project’s file name, or None if there is no current project or if the - project hasn’t been saved yet. - - - -#### GetStudy(study_name: str | None = None) - -Get the project’s Study. - -* **Parameters:** - **study_name** – The name of the study - If None is given the first model will be returned - - - -#### GetTimeFilter() - -Utility function to return the api object representing the project’s time filter - - - -#### GetUserProcessCollection() - -Get the project’s collection of User Processes. - - - -#### RemoveProcess(process: RAGridProcessElementItem | str) - -Removes the given process from the project. - -* **Parameters:** - **process** – a process or process name - - - -#### SaveProject(filename: str | None = None) - -Save the currently opened project. - -* **Parameters:** - **filename** – The name of the file to save the project or None if to update the current file - - - -#### SaveProjectForRestart(filename: str, timestep_or_index: TimeStep | int | None = None) - -Create a new restart project from the current project. - -* **Parameters:** - * **filename** – The new filename to be saved. - * **timestep_or_index** – Either the index of the timestep, or the timestep itself, in which to create the restart - project. If None is passed, the application’s current timestep will be used. + + +# RAProject + + + + + + +### *class* RAProject + +Rocky PrePost Scripting wrapper for a project. + +The [`RAProject`](#generated.RAProject) class serves as the main access point for a project’s [`RAStudy`](RAStudy.md#generated.RAStudy) +and the project entities that aren’t directly related to a simulation’s configuration, such as +the time filter, the collection of user processes, etc. + +The [`RAProject`](#generated.RAProject) can be obtained directly via the app global object. Example usage: + +```python +project = app.CreateProject() +study = project.GetStudy() +user_processes = project.GetUserProcessCollection() +input_variables = project.GetInputVariables() + +project.SaveProject('my_project.rocky') +project.SaveProjectForRestart('my_restart_project.rocky', timestep_or_index=10) +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| +| [`CloseProject`](#generated.RAProject.CloseProject)([check_save_state]) | Close the current project. | +| [`CreateStudy`](#generated.RAProject.CreateStudy)([study_name]) | Creates a new study and returns its wrapper | +| [`GetInputVariables`](#generated.RAProject.GetInputVariables)() | Get the PrePost Scripting wrapper for the project's Input Variables. | +| [`GetModelElement`](#generated.RAProject.GetModelElement)(model_element_id) | Get the model element associated with the given ID | +| [`GetModelStudy`](#generated.RAProject.GetModelStudy)(model_item) | Get the study model associated with a given model item | +| [`GetParametricVariables`](#generated.RAProject.GetParametricVariables)() | Get the PrePost Scripting wrapper for the project's Parametric Variables. | +| [`GetProjectFilename`](#generated.RAProject.GetProjectFilename)() | Get the current project's filename. | +| [`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. | +| [`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. | + + + +#### CloseProject(check_save_state: bool = True) + +Close the current project. + +* **Parameters:** + **check_save_state** – If False, it will close without asking the user to save it first. + + + +#### CreateStudy(study_name: str | None = None) + +Creates a new study and returns its wrapper + +* **Parameters:** + **study_name** – The name of the study + + + +#### GetInputVariables() + +Get the PrePost Scripting wrapper for the project’s Input Variables. + + + +#### GetModelElement(model_element_id) + +Get the model element associated with the given ID + +* **Parameters:** + **model_element_id** (*unicode*) – The element id + +@return +: The wrapped object with the given ID + + + +#### *classmethod* GetModelStudy(model_item) + +Get the study model associated with a given model item + +* **Parameters:** + **model_item** (*Subject*) – A study child + +@return RAStudy or None if no study was found for the given element + + + +#### GetParametricVariables() + +Get the PrePost Scripting wrapper for the project’s Parametric Variables. + + + +#### GetProjectFilename() + +Get the current project’s filename. + +* **Returns:** + The current project’s file name, or None if there is no current project or if the + project hasn’t been saved yet. + + + +#### GetStudy(study_name: str | None = None) + +Get the project’s Study. + +* **Parameters:** + **study_name** – The name of the study + If None is given the first model will be returned + + + +#### GetTimeFilter() + +Utility function to return the api object representing the project’s time filter + + + +#### GetUserProcessCollection() + +Get the project’s collection of User Processes. + + + +#### RemoveProcess(process: RAGridProcessElementItem | str) + +Removes the given process from the project. + +* **Parameters:** + **process** – a process or process name + + + +#### SaveProject(filename: str | None = None) + +Save the currently opened project. + +* **Parameters:** + **filename** – The name of the file to save the project or None if to update the current file + + + +#### SaveProjectForRestart(filename: str, timestep_or_index: TimeStep | int | None = None) + +Create a new restart project from the current project. + +* **Parameters:** + * **filename** – The new filename to be saved. + * **timestep_or_index** – Either the index of the timestep, or the timestep itself, in which to create the restart + project. If None is passed, the application’s current timestep will be used. diff --git a/2025R2/rocky-prepost-scripting-manual/RAReceivingConveyor.md b/2025R2/rocky-prepost-scripting-manual/RAReceivingConveyor.md index c5ecf17b22..e65d7d533a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAReceivingConveyor.md +++ b/2025R2/rocky-prepost-scripting-manual/RAReceivingConveyor.md @@ -1,1604 +1,1605 @@ - - -# RAReceivingConveyor - - - - - - -### *class* RAReceivingConveyor - -Rocky api Receiving Conveyor model. - -**Methods:** - -| [`AddCurve`](#generated.RAReceivingConveyor.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAReceivingConveyor.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.RAReceivingConveyor.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAReceivingConveyor.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAReceivingConveyor.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.RAReceivingConveyor.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAReceivingConveyor.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAReceivingConveyor.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.RAReceivingConveyor.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.RAReceivingConveyor.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.RAReceivingConveyor.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. | -| [`GetAccelerationPeriod`](#generated.RAReceivingConveyor.GetAccelerationPeriod)([unit]) | Get the value of "Acceleration Period". | -| [`GetActivesArray`](#generated.RAReceivingConveyor.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAlignmentAngle`](#generated.RAReceivingConveyor.GetAlignmentAngle)([unit]) | Get the value of "Alignment Angle". | -| [`GetAvailableMaterials`](#generated.RAReceivingConveyor.GetAvailableMaterials)() | Get all available Materials. | -| [`GetBeginningStartTime`](#generated.RAReceivingConveyor.GetBeginningStartTime)([unit]) | Get the value of "Beginning Start Time". | -| [`GetBeginningStopTime`](#generated.RAReceivingConveyor.GetBeginningStopTime)([unit]) | Get the value of "Beginning Stop Time". | -| [`GetBeltInclineAngle`](#generated.RAReceivingConveyor.GetBeltInclineAngle)([unit]) | Get the value of "Belt Incline Angle". | -| [`GetBeltProfile`](#generated.RAReceivingConveyor.GetBeltProfile)() | | -| [`GetBeltProfileName`](#generated.RAReceivingConveyor.GetBeltProfileName)() | Get the name of the belt profile. | -| [`GetBeltSpeed`](#generated.RAReceivingConveyor.GetBeltSpeed)([unit]) | Get the value of "Belt Speed". | -| [`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. | -| [`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. | -| [`GetCellFromIJK`](#generated.RAReceivingConveyor.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAReceivingConveyor.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAReceivingConveyor.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAReceivingConveyor.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAReceivingConveyor.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAReceivingConveyor.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAReceivingConveyor.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAReceivingConveyor.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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". | -| [`GetLengthOffset`](#generated.RAReceivingConveyor.GetLengthOffset)([unit]) | Get the value of "Length Offset". | -| [`GetMaterial`](#generated.RAReceivingConveyor.GetMaterial)() | Get the "Material". | -| [`GetMeshColoring`](#generated.RAReceivingConveyor.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetModuleProperties`](#generated.RAReceivingConveyor.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RAReceivingConveyor.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetNumberOfCells`](#generated.RAReceivingConveyor.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAReceivingConveyor.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RAReceivingConveyor.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutOfPlaneOffset`](#generated.RAReceivingConveyor.GetOutOfPlaneOffset)([unit]) | Get the value of "Out of Plane Offset". | -| [`GetOutputVariableValue`](#generated.RAReceivingConveyor.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetReturnBeltAngle`](#generated.RAReceivingConveyor.GetReturnBeltAngle)([unit]) | Get the value of "Return Belt Angle". | -| [`GetSkirtboardHeight`](#generated.RAReceivingConveyor.GetSkirtboardHeight)([unit]) | Get the value of "Skirtboard Height". | -| [`GetSkirtboardLength`](#generated.RAReceivingConveyor.GetSkirtboardLength)([unit]) | Get the value of "Skirtboard Length". | -| [`GetSphBoundaryType`](#generated.RAReceivingConveyor.GetSphBoundaryType)() | Get "Sph Boundary Type" as a string. | -| [`GetSurfaceTensionContactAngle`](#generated.RAReceivingConveyor.GetSurfaceTensionContactAngle)([unit]) | Get the value of "Surface Tension Contact Angle". | -| [`GetTemperature`](#generated.RAReceivingConveyor.GetTemperature)([unit]) | Get the value of "Temperature". | -| [`GetThermalBoundaryConditionType`](#generated.RAReceivingConveyor.GetThermalBoundaryConditionType)() | Get "Thermal Boundary Condition Type" as a string. | -| [`GetTimeSet`](#generated.RAReceivingConveyor.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAReceivingConveyor.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAReceivingConveyor.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAReceivingConveyor.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTriangleSize`](#generated.RAReceivingConveyor.GetTriangleSize)([unit]) | Get the value of "Triangle Size". | -| [`GetValidBeltProfileNames`](#generated.RAReceivingConveyor.GetValidBeltProfileNames)() | Return a list with possible values for belt profile. | -| [`GetValidOptionsForModuleProperty`](#generated.RAReceivingConveyor.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`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". | -| [`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 | -| [`IterCellVertices`](#generated.RAReceivingConveyor.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAReceivingConveyor.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RAReceivingConveyor.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAReceivingConveyor.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAReceivingConveyor.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAReceivingConveyor.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAReceivingConveyor.RemoveProcess)() | Removes the process from the project. | -| [`SetAccelerationPeriod`](#generated.RAReceivingConveyor.SetAccelerationPeriod)(value[, unit]) | Set the value of "Acceleration Period". | -| [`SetAlignmentAngle`](#generated.RAReceivingConveyor.SetAlignmentAngle)(value[, unit]) | Set the value of "Alignment Angle". | -| [`SetBeginningStartTime`](#generated.RAReceivingConveyor.SetBeginningStartTime)(value[, unit]) | Set the value of "Beginning Start Time". | -| [`SetBeginningStopTime`](#generated.RAReceivingConveyor.SetBeginningStopTime)(value[, unit]) | Set the value of "Beginning Stop Time". | -| [`SetBeltInclineAngle`](#generated.RAReceivingConveyor.SetBeltInclineAngle)(value[, unit]) | Set the value of "Belt Incline Angle". | -| [`SetBeltProfile`](#generated.RAReceivingConveyor.SetBeltProfile)(belt_profile_name) | Set the belt profile object through its name as shown in the UI. | -| [`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". | -| [`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". | -| [`SetHorizontalOffset`](#generated.RAReceivingConveyor.SetHorizontalOffset)(value[, unit]) | Set the value of "Horizontal Offset". | -| [`SetLength`](#generated.RAReceivingConveyor.SetLength)(value[, unit]) | Set the value of "Length". | -| [`SetLengthOffset`](#generated.RAReceivingConveyor.SetLengthOffset)(value[, unit]) | Set the value of "Length Offset". | -| [`SetMaterial`](#generated.RAReceivingConveyor.SetMaterial)(value) | Set the "Material". | -| [`SetModuleProperty`](#generated.RAReceivingConveyor.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetOutOfPlaneOffset`](#generated.RAReceivingConveyor.SetOutOfPlaneOffset)(value[, unit]) | Set the value of "Out of Plane Offset". | -| [`SetReturnBeltAngle`](#generated.RAReceivingConveyor.SetReturnBeltAngle)(value[, unit]) | Set the value of "Return Belt Angle". | -| [`SetSkirtboardHeight`](#generated.RAReceivingConveyor.SetSkirtboardHeight)(value[, unit]) | Set the value of "Skirtboard Height". | -| [`SetSkirtboardLength`](#generated.RAReceivingConveyor.SetSkirtboardLength)(value[, unit]) | Set the value of "Skirtboard Length". | -| [`SetSphBoundaryType`](#generated.RAReceivingConveyor.SetSphBoundaryType)(value) | Set the value of "Sph Boundary Type". | -| [`SetSurfaceTensionContactAngle`](#generated.RAReceivingConveyor.SetSurfaceTensionContactAngle)(value[, unit]) | Set the value of "Surface Tension Contact Angle". | -| [`SetTemperature`](#generated.RAReceivingConveyor.SetTemperature)(value[, unit]) | Set the value of "Temperature". | -| [`SetThermalBoundaryConditionType`](#generated.RAReceivingConveyor.SetThermalBoundaryConditionType)(value) | Set the value of "Thermal Boundary Condition Type". | -| [`SetTriangleSize`](#generated.RAReceivingConveyor.SetTriangleSize)(value[, unit]) | Set the value of "Triangle Size". | -| [`SetVerticalOffset`](#generated.RAReceivingConveyor.SetVerticalOffset)(value[, unit]) | Set the value of "Vertical Offset". | -| [`SetWidth`](#generated.RAReceivingConveyor.SetWidth)(value[, unit]) | Set the value of "Width". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetAccelerationPeriod(unit: str | None = None) - -Get the value of “Acceleration Period”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAlignmentAngle(unit: str | None = None) - -Get the value of “Alignment Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetBeginningStartTime(unit: str | None = None) - -Get the value of “Beginning Start Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetBeginningStopTime(unit: str | None = None) - -Get the value of “Beginning Stop Time”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetBeltInclineAngle(unit: str | None = None) - -Get the value of “Belt Incline Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. - - - -#### GetBeltProfile() - -* **Return type:** - ApiElementItem -* **Returns:** - The API object that wraps the current belt profile. - - - -#### GetBeltProfileName() - -Get the name of the belt profile. - -* **Return type:** - str -* **Returns:** - A string describing the type of belt profile. The returned value will be one of the strings - in the “Belt Profile” drop-down menu in the UI. - - - -#### GetBeltSpeed(unit: str | None = None) - -Get the value of “Belt Speed”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### GetBeltThickness(unit: str | None = None) - -Get the value of “Belt Thickness”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetBeltWidth(unit: str | None = None) - -Get the value of “Belt Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDecelerationPeriod(unit: str | None = None) - -Get the value of “Deceleration Period”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetHeightOffset(unit: str | None = None) - -Get the value of “Height Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetHorizontalOffset(unit: str | None = None) - -Get the value of “Horizontal Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetLength(unit: str | None = None) - -Get the value of “Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetLengthOffset(unit: str | None = None) - -Get the value of “Length Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutOfPlaneOffset(unit: str | None = None) - -Get the value of “Out of Plane Offset”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetReturnBeltAngle(unit: str | None = None) - -Get the value of “Return Belt Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. - - - -#### GetSkirtboardHeight(unit: str | None = None) - -Get the value of “Skirtboard Height”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetSkirtboardLength(unit: str | None = None) - -Get the value of “Skirtboard Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetSphBoundaryType() - -Get “Sph Boundary Type” as a string. - -* **Returns:** - The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. - - - -#### GetSurfaceTensionContactAngle(unit: str | None = None) - -Get the value of “Surface Tension Contact Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetTemperature(unit: str | None = None) - -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”. - - - -#### GetThermalBoundaryConditionType() - -Get “Thermal Boundary Condition Type” as a string. - -* **Returns:** - The returned value will be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTriangleSize(unit: str | None = None) - -Get the value of “Triangle Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetValidBeltProfileNames() - -Return a list with possible values for belt profile. - -* **Return type:** - list(str) -* **Returns:** - A list of accepted values for SetBeltProfile(). - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### GetValidSphBoundaryTypeValues() - -Get a list of all possible values for “Sph Boundary Type”. - -* **Returns:** - The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. - - - -#### GetValidThermalBoundaryConditionTypeValues() - -Get a list of all possible values for “Thermal Boundary Condition Type”. - -* **Returns:** - The returned list is [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. - - - -#### GetVerticalOffset(unit: str | None = None) - -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”. - - - -#### GetWidth(unit: str | None = None) - -Get the value of “Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetAccelerationPeriod(value: str | float, unit: str | None = None) - -Set the value of “Acceleration 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”. - - - -#### SetAlignmentAngle(value: str | float, unit: str | None = None) - -Set the value of “Alignment 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 “dega”. - - - -#### SetBeginningStartTime(value: str | float, unit: str | None = None) - -Set the value of “Beginning Start Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetBeginningStopTime(value: str | float, unit: str | None = None) - -Set the value of “Beginning Stop Time”. - -* **Parameters:** - * **value** – The value to set. This value can be an expression with input variables or float type. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. - - - -#### SetBeltInclineAngle(value: str | float, unit: str | None = None) - -Set the value of “Belt Incline 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”. - - - -#### SetBeltProfile(belt_profile_name) - -Set the belt profile object through its name as shown in the UI. - -* **Parameters:** - **belt_profile_name** (*str*) – Accepted values are the strings in the “Belt Profile” dropdown menu in the UI. -* **Return type:** - ApiElementItem -* **Returns:** - The PrePost Scripting wrapper representing the belt profile. - - - -#### SetBeltSpeed(value: str | float, unit: str | None = None) - -Set the value of “Belt Speed”. - -* **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/s”. - - - -#### SetBeltThickness(value: str | float, unit: str | None = None) - -Set the value of “Belt Thickness”. - -* **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”. - - - -#### SetBeltWidth(value: str | float, unit: str | None = None) - -Set the value of “Belt Width”. - -* **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”. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDecelerationPeriod(value: str | float, unit: str | None = None) - -Set the value of “Deceleration 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”. - - - -#### SetHeightOffset(value: str | float, unit: str | None = None) - -Set the value of “Height Offset”. - -* **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”. - - - -#### SetHorizontalOffset(value: str | float, unit: str | None = None) - -Set the value of “Horizontal Offset”. - -* **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”. - - - -#### SetLength(value: str | float, unit: str | None = None) - -Set the value of “Length”. - -* **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”. - - - -#### SetLengthOffset(value: str | float, unit: str | None = None) - -Set the value of “Length Offset”. - -* **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”. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetOutOfPlaneOffset(value: str | float, unit: str | None = None) - -Set the value of “Out of Plane Offset”. - -* **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”. - - - -#### SetReturnBeltAngle(value: str | float, unit: str | None = None) - -Set the value of “Return Belt 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”. - - - -#### SetSkirtboardHeight(value: str | float, unit: str | None = None) - -Set the value of “Skirtboard Height”. - -* **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”. - - - -#### SetSkirtboardLength(value: str | float, unit: str | None = None) - -Set the value of “Skirtboard Length”. - -* **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”. - - - -#### SetSphBoundaryType(value: str) - -Set the value of “Sph Boundary Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Sph Boundary Type” option. - - - -#### SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) - -Set the value of “Surface Tension Contact 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 “dega”. - - - -#### SetTemperature(value: str | float, unit: str | None = None) - -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”. - - - -#### SetThermalBoundaryConditionType(value: str) - -Set the value of “Thermal Boundary Condition Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Thermal Boundary Condition Type” option. - - - -#### SetTriangleSize(value: str | float, unit: str | None = None) - -Set the value of “Triangle Size”. - -* **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”. - - - -#### SetVerticalOffset(value: str | float, unit: str | None = None) - -Set the value of “Vertical Offset”. - -* **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”. - - - -#### SetWidth(value: str | float, unit: str | None = None) - -Set the value of “Width”. - -* **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”. + + +# RAReceivingConveyor + + + + + + +### *class* RAReceivingConveyor + +Rocky api Receiving Conveyor model. + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAReceivingConveyor.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAReceivingConveyor.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.RAReceivingConveyor.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAReceivingConveyor.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAReceivingConveyor.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.RAReceivingConveyor.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAReceivingConveyor.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAReceivingConveyor.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.RAReceivingConveyor.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.RAReceivingConveyor.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.RAReceivingConveyor.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. | +| [`GetAccelerationPeriod`](#generated.RAReceivingConveyor.GetAccelerationPeriod)([unit]) | Get the value of "Acceleration Period". | +| [`GetActivesArray`](#generated.RAReceivingConveyor.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAlignmentAngle`](#generated.RAReceivingConveyor.GetAlignmentAngle)([unit]) | Get the value of "Alignment Angle". | +| [`GetAvailableMaterials`](#generated.RAReceivingConveyor.GetAvailableMaterials)() | Get all available Materials. | +| [`GetBeginningStartTime`](#generated.RAReceivingConveyor.GetBeginningStartTime)([unit]) | Get the value of "Beginning Start Time". | +| [`GetBeginningStopTime`](#generated.RAReceivingConveyor.GetBeginningStopTime)([unit]) | Get the value of "Beginning Stop Time". | +| [`GetBeltInclineAngle`](#generated.RAReceivingConveyor.GetBeltInclineAngle)([unit]) | Get the value of "Belt Incline Angle". | +| [`GetBeltProfile`](#generated.RAReceivingConveyor.GetBeltProfile)() | | +| [`GetBeltProfileName`](#generated.RAReceivingConveyor.GetBeltProfileName)() | Get the name of the belt profile. | +| [`GetBeltSpeed`](#generated.RAReceivingConveyor.GetBeltSpeed)([unit]) | Get the value of "Belt Speed". | +| [`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. | +| [`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. | +| [`GetCellFromIJK`](#generated.RAReceivingConveyor.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAReceivingConveyor.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAReceivingConveyor.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAReceivingConveyor.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAReceivingConveyor.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAReceivingConveyor.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAReceivingConveyor.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAReceivingConveyor.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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". | +| [`GetLengthOffset`](#generated.RAReceivingConveyor.GetLengthOffset)([unit]) | Get the value of "Length Offset". | +| [`GetMaterial`](#generated.RAReceivingConveyor.GetMaterial)() | Get the "Material". | +| [`GetMeshColoring`](#generated.RAReceivingConveyor.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetModuleProperties`](#generated.RAReceivingConveyor.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAReceivingConveyor.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetNumberOfCells`](#generated.RAReceivingConveyor.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RAReceivingConveyor.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RAReceivingConveyor.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutOfPlaneOffset`](#generated.RAReceivingConveyor.GetOutOfPlaneOffset)([unit]) | Get the value of "Out of Plane Offset". | +| [`GetOutputVariableValue`](#generated.RAReceivingConveyor.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetReturnBeltAngle`](#generated.RAReceivingConveyor.GetReturnBeltAngle)([unit]) | Get the value of "Return Belt Angle". | +| [`GetSkirtboardHeight`](#generated.RAReceivingConveyor.GetSkirtboardHeight)([unit]) | Get the value of "Skirtboard Height". | +| [`GetSkirtboardLength`](#generated.RAReceivingConveyor.GetSkirtboardLength)([unit]) | Get the value of "Skirtboard Length". | +| [`GetSphBoundaryType`](#generated.RAReceivingConveyor.GetSphBoundaryType)() | Get "Sph Boundary Type" as a string. | +| [`GetSurfaceTensionContactAngle`](#generated.RAReceivingConveyor.GetSurfaceTensionContactAngle)([unit]) | Get the value of "Surface Tension Contact Angle". | +| [`GetTemperature`](#generated.RAReceivingConveyor.GetTemperature)([unit]) | Get the value of "Temperature". | +| [`GetThermalBoundaryConditionType`](#generated.RAReceivingConveyor.GetThermalBoundaryConditionType)() | Get "Thermal Boundary Condition Type" as a string. | +| [`GetTimeSet`](#generated.RAReceivingConveyor.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAReceivingConveyor.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RAReceivingConveyor.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTopologyShape`](#generated.RAReceivingConveyor.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTriangleSize`](#generated.RAReceivingConveyor.GetTriangleSize)([unit]) | Get the value of "Triangle Size". | +| [`GetValidBeltProfileNames`](#generated.RAReceivingConveyor.GetValidBeltProfileNames)() | Return a list with possible values for belt profile. | +| [`GetValidOptionsForModuleProperty`](#generated.RAReceivingConveyor.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`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". | +| [`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 | +| [`IterCellVertices`](#generated.RAReceivingConveyor.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RAReceivingConveyor.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RAReceivingConveyor.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAReceivingConveyor.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAReceivingConveyor.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAReceivingConveyor.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAReceivingConveyor.RemoveProcess)() | Removes the process from the project. | +| [`SetAccelerationPeriod`](#generated.RAReceivingConveyor.SetAccelerationPeriod)(value[, unit]) | Set the value of "Acceleration Period". | +| [`SetAlignmentAngle`](#generated.RAReceivingConveyor.SetAlignmentAngle)(value[, unit]) | Set the value of "Alignment Angle". | +| [`SetBeginningStartTime`](#generated.RAReceivingConveyor.SetBeginningStartTime)(value[, unit]) | Set the value of "Beginning Start Time". | +| [`SetBeginningStopTime`](#generated.RAReceivingConveyor.SetBeginningStopTime)(value[, unit]) | Set the value of "Beginning Stop Time". | +| [`SetBeltInclineAngle`](#generated.RAReceivingConveyor.SetBeltInclineAngle)(value[, unit]) | Set the value of "Belt Incline Angle". | +| [`SetBeltProfile`](#generated.RAReceivingConveyor.SetBeltProfile)(belt_profile_name) | Set the belt profile object through its name as shown in the UI. | +| [`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". | +| [`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". | +| [`SetHorizontalOffset`](#generated.RAReceivingConveyor.SetHorizontalOffset)(value[, unit]) | Set the value of "Horizontal Offset". | +| [`SetLength`](#generated.RAReceivingConveyor.SetLength)(value[, unit]) | Set the value of "Length". | +| [`SetLengthOffset`](#generated.RAReceivingConveyor.SetLengthOffset)(value[, unit]) | Set the value of "Length Offset". | +| [`SetMaterial`](#generated.RAReceivingConveyor.SetMaterial)(value) | Set the "Material". | +| [`SetModuleProperty`](#generated.RAReceivingConveyor.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetOutOfPlaneOffset`](#generated.RAReceivingConveyor.SetOutOfPlaneOffset)(value[, unit]) | Set the value of "Out of Plane Offset". | +| [`SetReturnBeltAngle`](#generated.RAReceivingConveyor.SetReturnBeltAngle)(value[, unit]) | Set the value of "Return Belt Angle". | +| [`SetSkirtboardHeight`](#generated.RAReceivingConveyor.SetSkirtboardHeight)(value[, unit]) | Set the value of "Skirtboard Height". | +| [`SetSkirtboardLength`](#generated.RAReceivingConveyor.SetSkirtboardLength)(value[, unit]) | Set the value of "Skirtboard Length". | +| [`SetSphBoundaryType`](#generated.RAReceivingConveyor.SetSphBoundaryType)(value) | Set the value of "Sph Boundary Type". | +| [`SetSurfaceTensionContactAngle`](#generated.RAReceivingConveyor.SetSurfaceTensionContactAngle)(value[, unit]) | Set the value of "Surface Tension Contact Angle". | +| [`SetTemperature`](#generated.RAReceivingConveyor.SetTemperature)(value[, unit]) | Set the value of "Temperature". | +| [`SetThermalBoundaryConditionType`](#generated.RAReceivingConveyor.SetThermalBoundaryConditionType)(value) | Set the value of "Thermal Boundary Condition Type". | +| [`SetTriangleSize`](#generated.RAReceivingConveyor.SetTriangleSize)(value[, unit]) | Set the value of "Triangle Size". | +| [`SetVerticalOffset`](#generated.RAReceivingConveyor.SetVerticalOffset)(value[, unit]) | Set the value of "Vertical Offset". | +| [`SetWidth`](#generated.RAReceivingConveyor.SetWidth)(value[, unit]) | Set the value of "Width". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetAccelerationPeriod(unit: str | None = None) + +Get the value of “Acceleration Period”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAlignmentAngle(unit: str | None = None) + +Get the value of “Alignment Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetBeginningStartTime(unit: str | None = None) + +Get the value of “Beginning Start Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetBeginningStopTime(unit: str | None = None) + +Get the value of “Beginning Stop Time”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetBeltInclineAngle(unit: str | None = None) + +Get the value of “Belt Incline Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. + + + +#### GetBeltProfile() + +* **Return type:** + ApiElementItem +* **Returns:** + The API object that wraps the current belt profile. + + + +#### GetBeltProfileName() + +Get the name of the belt profile. + +* **Return type:** + str +* **Returns:** + A string describing the type of belt profile. The returned value will be one of the strings + in the “Belt Profile” drop-down menu in the UI. + + + +#### GetBeltSpeed(unit: str | None = None) + +Get the value of “Belt Speed”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### GetBeltThickness(unit: str | None = None) + +Get the value of “Belt Thickness”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetBeltWidth(unit: str | None = None) + +Get the value of “Belt Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDecelerationPeriod(unit: str | None = None) + +Get the value of “Deceleration Period”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetHeightOffset(unit: str | None = None) + +Get the value of “Height Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetHorizontalOffset(unit: str | None = None) + +Get the value of “Horizontal Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetLength(unit: str | None = None) + +Get the value of “Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetLengthOffset(unit: str | None = None) + +Get the value of “Length Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutOfPlaneOffset(unit: str | None = None) + +Get the value of “Out of Plane Offset”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetReturnBeltAngle(unit: str | None = None) + +Get the value of “Return Belt Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “rad”. + + + +#### GetSkirtboardHeight(unit: str | None = None) + +Get the value of “Skirtboard Height”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetSkirtboardLength(unit: str | None = None) + +Get the value of “Skirtboard Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetSphBoundaryType() + +Get “Sph Boundary Type” as a string. + +* **Returns:** + The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + + +#### GetSurfaceTensionContactAngle(unit: str | None = None) + +Get the value of “Surface Tension Contact Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetTemperature(unit: str | None = None) + +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”. + + + +#### GetThermalBoundaryConditionType() + +Get “Thermal Boundary Condition Type” as a string. + +* **Returns:** + The returned value will be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTriangleSize(unit: str | None = None) + +Get the value of “Triangle Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetValidBeltProfileNames() + +Return a list with possible values for belt profile. + +* **Return type:** + list(str) +* **Returns:** + A list of accepted values for SetBeltProfile(). + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### GetValidSphBoundaryTypeValues() + +Get a list of all possible values for “Sph Boundary Type”. + +* **Returns:** + The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + + +#### GetValidThermalBoundaryConditionTypeValues() + +Get a list of all possible values for “Thermal Boundary Condition Type”. + +* **Returns:** + The returned list is [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. + + + +#### GetVerticalOffset(unit: str | None = None) + +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”. + + + +#### GetWidth(unit: str | None = None) + +Get the value of “Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetAccelerationPeriod(value: str | float, unit: str | None = None) + +Set the value of “Acceleration 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”. + + + +#### SetAlignmentAngle(value: str | float, unit: str | None = None) + +Set the value of “Alignment 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 “dega”. + + + +#### SetBeginningStartTime(value: str | float, unit: str | None = None) + +Set the value of “Beginning Start Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetBeginningStopTime(value: str | float, unit: str | None = None) + +Set the value of “Beginning Stop Time”. + +* **Parameters:** + * **value** – The value to set. This value can be an expression with input variables or float type. + * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + + + +#### SetBeltInclineAngle(value: str | float, unit: str | None = None) + +Set the value of “Belt Incline 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”. + + + +#### SetBeltProfile(belt_profile_name) + +Set the belt profile object through its name as shown in the UI. + +* **Parameters:** + **belt_profile_name** (*str*) – Accepted values are the strings in the “Belt Profile” dropdown menu in the UI. +* **Return type:** + ApiElementItem +* **Returns:** + The PrePost Scripting wrapper representing the belt profile. + + + +#### SetBeltSpeed(value: str | float, unit: str | None = None) + +Set the value of “Belt Speed”. + +* **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/s”. + + + +#### SetBeltThickness(value: str | float, unit: str | None = None) + +Set the value of “Belt Thickness”. + +* **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”. + + + +#### SetBeltWidth(value: str | float, unit: str | None = None) + +Set the value of “Belt Width”. + +* **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”. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDecelerationPeriod(value: str | float, unit: str | None = None) + +Set the value of “Deceleration 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”. + + + +#### SetHeightOffset(value: str | float, unit: str | None = None) + +Set the value of “Height Offset”. + +* **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”. + + + +#### SetHorizontalOffset(value: str | float, unit: str | None = None) + +Set the value of “Horizontal Offset”. + +* **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”. + + + +#### SetLength(value: str | float, unit: str | None = None) + +Set the value of “Length”. + +* **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”. + + + +#### SetLengthOffset(value: str | float, unit: str | None = None) + +Set the value of “Length Offset”. + +* **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”. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetOutOfPlaneOffset(value: str | float, unit: str | None = None) + +Set the value of “Out of Plane Offset”. + +* **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”. + + + +#### SetReturnBeltAngle(value: str | float, unit: str | None = None) + +Set the value of “Return Belt 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”. + + + +#### SetSkirtboardHeight(value: str | float, unit: str | None = None) + +Set the value of “Skirtboard Height”. + +* **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”. + + + +#### SetSkirtboardLength(value: str | float, unit: str | None = None) + +Set the value of “Skirtboard Length”. + +* **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”. + + + +#### SetSphBoundaryType(value: str) + +Set the value of “Sph Boundary Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Sph Boundary Type” option. + + + +#### SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) + +Set the value of “Surface Tension Contact 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 “dega”. + + + +#### SetTemperature(value: str | float, unit: str | None = None) + +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”. + + + +#### SetThermalBoundaryConditionType(value: str) + +Set the value of “Thermal Boundary Condition Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘adiabatic’, ‘prescribed_temperature’, ‘cfd_coupled_temperature’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Thermal Boundary Condition Type” option. + + + +#### SetTriangleSize(value: str | float, unit: str | None = None) + +Set the value of “Triangle Size”. + +* **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”. + + + +#### SetVerticalOffset(value: str | float, unit: str | None = None) + +Set the value of “Vertical Offset”. + +* **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”. + + + +#### SetWidth(value: str | float, unit: str | None = None) + +Set the value of “Width”. + +* **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/2025R2/rocky-prepost-scripting-manual/RARectangularSurface.md b/2025R2/rocky-prepost-scripting-manual/RARectangularSurface.md index c77b714396..52b9aca99b 100644 --- a/2025R2/rocky-prepost-scripting-manual/RARectangularSurface.md +++ b/2025R2/rocky-prepost-scripting-manual/RARectangularSurface.md @@ -1,1079 +1,1080 @@ - - -# RARectangularSurface - - - - - - -### *class* RARectangularSurface - -Rocky API “Rectangular Surface” model. - -**Methods:** - -| [`AddCurve`](#generated.RARectangularSurface.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RARectangularSurface.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.RARectangularSurface.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RARectangularSurface.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RARectangularSurface.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.RARectangularSurface.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RARectangularSurface.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RARectangularSurface.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.RARectangularSurface.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.RARectangularSurface.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.RARectangularSurface.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.RARectangularSurface.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RARectangularSurface.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RARectangularSurface.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RARectangularSurface.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RARectangularSurface.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RARectangularSurface.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RARectangularSurface.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RARectangularSurface.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RARectangularSurface.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RARectangularSurface.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RARectangularSurface.GetCenter)([unit]) | Get the value of "Center". | -| [`GetCurve`](#generated.RARectangularSurface.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RARectangularSurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`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. | -| [`GetOrientation`](#generated.RARectangularSurface.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RARectangularSurface.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RARectangularSurface.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RARectangularSurface.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RARectangularSurface.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetTimeSet`](#generated.RARectangularSurface.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IsCellActive`](#generated.RARectangularSurface.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IterCellVertices`](#generated.RARectangularSurface.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RARectangularSurface.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RARectangularSurface.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RARectangularSurface.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RARectangularSurface.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RARectangularSurface.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RARectangularSurface.RemoveProcess)() | Removes the process from the project. | -| [`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". | -| [`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. | -| [`SetOrientationFromBasisVector`](#generated.RARectangularSurface.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetWidth`](#generated.RARectangularSurface.SetWidth)(value[, unit]) | Set the value of "Width". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit: str | None = None) - -Get the value of “Center”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetLength(unit: str | None = None) - -Get the value of “Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetWidth(unit: str | None = None) - -Get the value of “Width”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### HasMotionFrame() - -Whether the geometry is linked to a motion frame. - -* **Returns:** - True if geometry is linked to a motion frame False otherwise - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Center”. - -* **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. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetLength(value: str | float, unit: str | None = None) - -Set the value of “Length”. - -* **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”. - - - -#### 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. - - - -#### SetWidth(value: str | float, unit: str | None = None) - -Set the value of “Width”. - -* **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”. + + +# RARectangularSurface + + + + + + +### *class* RARectangularSurface + +Rocky API “Rectangular Surface” model. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RARectangularSurface.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RARectangularSurface.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.RARectangularSurface.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RARectangularSurface.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RARectangularSurface.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.RARectangularSurface.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RARectangularSurface.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RARectangularSurface.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.RARectangularSurface.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.RARectangularSurface.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.RARectangularSurface.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.RARectangularSurface.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RARectangularSurface.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RARectangularSurface.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RARectangularSurface.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RARectangularSurface.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RARectangularSurface.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RARectangularSurface.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RARectangularSurface.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RARectangularSurface.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RARectangularSurface.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RARectangularSurface.GetCenter)([unit]) | Get the value of "Center". | +| [`GetCurve`](#generated.RARectangularSurface.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RARectangularSurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`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. | +| [`GetOrientation`](#generated.RARectangularSurface.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RARectangularSurface.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RARectangularSurface.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RARectangularSurface.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RARectangularSurface.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetTimeSet`](#generated.RARectangularSurface.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IsCellActive`](#generated.RARectangularSurface.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IterCellVertices`](#generated.RARectangularSurface.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RARectangularSurface.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RARectangularSurface.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RARectangularSurface.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RARectangularSurface.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RARectangularSurface.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RARectangularSurface.RemoveProcess)() | Removes the process from the project. | +| [`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". | +| [`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. | +| [`SetOrientationFromBasisVector`](#generated.RARectangularSurface.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetWidth`](#generated.RARectangularSurface.SetWidth)(value[, unit]) | Set the value of "Width". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit: str | None = None) + +Get the value of “Center”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetLength(unit: str | None = None) + +Get the value of “Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetWidth(unit: str | None = None) + +Get the value of “Width”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### HasMotionFrame() + +Whether the geometry is linked to a motion frame. + +* **Returns:** + True if geometry is linked to a motion frame False otherwise + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Center”. + +* **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. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetLength(value: str | float, unit: str | None = None) + +Set the value of “Length”. + +* **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”. + + + +#### 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. + + + +#### SetWidth(value: str | float, unit: str | None = None) + +Set the value of “Width”. + +* **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/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCube.md b/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCube.md index e63bcaf343..7e2ec8347b 100644 --- a/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCube.md +++ b/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCube.md @@ -1,1084 +1,1085 @@ - - -# RARegionOfInterestCube - - - - - - -### *class* RARegionOfInterestCube - -Rocky PrePost Scripting wrapper for a single Cube geometry. - -This wrapper class corresponds to an individual entry under the “Regions Of Interest” item on -the project’s data tree. Regions Of Interest can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) via: - -```python -roi_cube_1 = study.GetElement('Cube <1>') -``` - -**Methods:** - -| [`AddCurve`](#generated.RARegionOfInterestCube.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RARegionOfInterestCube.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.RARegionOfInterestCube.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RARegionOfInterestCube.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RARegionOfInterestCube.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.RARegionOfInterestCube.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RARegionOfInterestCube.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RARegionOfInterestCube.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.RARegionOfInterestCube.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.RARegionOfInterestCube.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.RARegionOfInterestCube.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.RARegionOfInterestCube.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RARegionOfInterestCube.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RARegionOfInterestCube.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RARegionOfInterestCube.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RARegionOfInterestCube.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RARegionOfInterestCube.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RARegionOfInterestCube.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RARegionOfInterestCube.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RARegionOfInterestCube.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RARegionOfInterestCube.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RARegionOfInterestCube.GetCenter)([unit]) | Get the value of "Center". | -| [`GetCenterAfterMovement`](#generated.RARegionOfInterestCube.GetCenterAfterMovement)(timestep) | Get the Region of Interest center taking motion in account. | -| [`GetCurve`](#generated.RARegionOfInterestCube.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RARegionOfInterestCube.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfNodes`](#generated.RARegionOfInterestCube.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RARegionOfInterestCube.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RARegionOfInterestCube.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCube.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RARegionOfInterestCube.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RARegionOfInterestCube.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RARegionOfInterestCube.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetSize`](#generated.RARegionOfInterestCube.GetSize)([unit]) | Get the value of "Size". | -| [`GetTimeSet`](#generated.RARegionOfInterestCube.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RARegionOfInterestCube.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RARegionOfInterestCube.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RARegionOfInterestCube.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RARegionOfInterestCube.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RARegionOfInterestCube.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RARegionOfInterestCube.RemoveProcess)() | Removes the process from the project. | -| [`SetCenter`](#generated.RARegionOfInterestCube.SetCenter)(values[, unit]) | Set the values of "Center". | -| [`SetCurrentTimeStep`](#generated.RARegionOfInterestCube.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetMotionFrame`](#generated.RARegionOfInterestCube.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RARegionOfInterestCube.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCube.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RARegionOfInterestCube.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RARegionOfInterestCube.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetSize`](#generated.RARegionOfInterestCube.SetSize)(values[, unit]) | Set the values of "Size". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit: str | None = None) - -Get the value of “Center”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCenterAfterMovement(timestep: int) - -Get the Region of Interest center taking motion in account. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetSize(unit: str | None = None) - -Get the value of “Size”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values 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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Center”. - -* **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. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetSize(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Size”. - -* **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. + + +# RARegionOfInterestCube + + + + + + +### *class* RARegionOfInterestCube + +Rocky PrePost Scripting wrapper for a single Cube geometry. + +This wrapper class corresponds to an individual entry under the “Regions Of Interest” item on +the project’s data tree. Regions Of Interest can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) via: + +```python +roi_cube_1 = study.GetElement('Cube <1>') +``` + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RARegionOfInterestCube.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RARegionOfInterestCube.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.RARegionOfInterestCube.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RARegionOfInterestCube.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RARegionOfInterestCube.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.RARegionOfInterestCube.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RARegionOfInterestCube.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RARegionOfInterestCube.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.RARegionOfInterestCube.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.RARegionOfInterestCube.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.RARegionOfInterestCube.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.RARegionOfInterestCube.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RARegionOfInterestCube.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RARegionOfInterestCube.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RARegionOfInterestCube.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RARegionOfInterestCube.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RARegionOfInterestCube.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RARegionOfInterestCube.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RARegionOfInterestCube.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RARegionOfInterestCube.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RARegionOfInterestCube.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RARegionOfInterestCube.GetCenter)([unit]) | Get the value of "Center". | +| [`GetCenterAfterMovement`](#generated.RARegionOfInterestCube.GetCenterAfterMovement)(timestep) | Get the Region of Interest center taking motion in account. | +| [`GetCurve`](#generated.RARegionOfInterestCube.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RARegionOfInterestCube.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfNodes`](#generated.RARegionOfInterestCube.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RARegionOfInterestCube.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RARegionOfInterestCube.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCube.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RARegionOfInterestCube.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RARegionOfInterestCube.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RARegionOfInterestCube.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetSize`](#generated.RARegionOfInterestCube.GetSize)([unit]) | Get the value of "Size". | +| [`GetTimeSet`](#generated.RARegionOfInterestCube.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RARegionOfInterestCube.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RARegionOfInterestCube.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RARegionOfInterestCube.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RARegionOfInterestCube.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RARegionOfInterestCube.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RARegionOfInterestCube.RemoveProcess)() | Removes the process from the project. | +| [`SetCenter`](#generated.RARegionOfInterestCube.SetCenter)(values[, unit]) | Set the values of "Center". | +| [`SetCurrentTimeStep`](#generated.RARegionOfInterestCube.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetMotionFrame`](#generated.RARegionOfInterestCube.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RARegionOfInterestCube.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCube.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RARegionOfInterestCube.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RARegionOfInterestCube.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetSize`](#generated.RARegionOfInterestCube.SetSize)(values[, unit]) | Set the values of "Size". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit: str | None = None) + +Get the value of “Center”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCenterAfterMovement(timestep: int) + +Get the Region of Interest center taking motion in account. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetSize(unit: str | None = None) + +Get the value of “Size”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values 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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Center”. + +* **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. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetSize(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Size”. + +* **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. diff --git a/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCylinder.md b/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCylinder.md index 3cb52e8d11..6f21635925 100644 --- a/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCylinder.md +++ b/2025R2/rocky-prepost-scripting-manual/RARegionOfInterestCylinder.md @@ -1,1165 +1,1166 @@ - - -# RARegionOfInterestCylinder - - - - - - -### *class* RARegionOfInterestCylinder - -Rocky PrePost Scripting wrapper for a single Cylinder geometry. - -This wrapper class corresponds to an individual entry under the “Regions Of Interest” item on -the project’s data tree. Regions Of Interest can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the -[`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) via: - -```python -roi_cylinder = study.GetElement('Cylinder <1>') -``` - -**Methods:** - -| [`AddCurve`](#generated.RARegionOfInterestCylinder.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RARegionOfInterestCylinder.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RARegionOfInterestCylinder.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RARegionOfInterestCylinder.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RARegionOfInterestCylinder.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RARegionOfInterestCylinder.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RARegionOfInterestCylinder.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RARegionOfInterestCylinder.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RARegionOfInterestCylinder.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RARegionOfInterestCylinder.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RARegionOfInterestCylinder.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RARegionOfInterestCylinder.GetCenter)([unit]) | Get the value of "Center". | -| [`GetCenterAfterMovement`](#generated.RARegionOfInterestCylinder.GetCenterAfterMovement)(timestep) | Get the Region of Interest center taking motion in account. | -| [`GetCurve`](#generated.RARegionOfInterestCylinder.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetFinalAngle`](#generated.RARegionOfInterestCylinder.GetFinalAngle)([unit]) | Get the value of "Final Angle". | -| [`GetGeometryQuantity`](#generated.RARegionOfInterestCylinder.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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". | -| [`GetMeshColoring`](#generated.RARegionOfInterestCylinder.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMotionFrame`](#generated.RARegionOfInterestCylinder.GetMotionFrame)() | | -| [`GetNumberOfCells`](#generated.RARegionOfInterestCylinder.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RARegionOfInterestCylinder.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RARegionOfInterestCylinder.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RARegionOfInterestCylinder.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCylinder.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RARegionOfInterestCylinder.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RARegionOfInterestCylinder.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RARegionOfInterestCylinder.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetRadius`](#generated.RARegionOfInterestCylinder.GetRadius)([unit]) | Get the value of "Radius". | -| [`GetTimeSet`](#generated.RARegionOfInterestCylinder.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RARegionOfInterestCylinder.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RARegionOfInterestCylinder.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RARegionOfInterestCylinder.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RARegionOfInterestCylinder.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RARegionOfInterestCylinder.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RARegionOfInterestCylinder.RemoveProcess)() | Removes the process from the project. | -| [`SetCenter`](#generated.RARegionOfInterestCylinder.SetCenter)(values[, unit]) | Set the values of "Center". | -| [`SetCurrentTimeStep`](#generated.RARegionOfInterestCylinder.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetFinalAngle`](#generated.RARegionOfInterestCylinder.SetFinalAngle)(value[, unit]) | Set the value of "Final Angle". | -| [`SetHeight`](#generated.RARegionOfInterestCylinder.SetHeight)(value[, unit]) | Set the value of "Height". | -| [`SetInitialAngle`](#generated.RARegionOfInterestCylinder.SetInitialAngle)(value[, unit]) | Set the value of "Initial Angle". | -| [`SetInternalFactor`](#generated.RARegionOfInterestCylinder.SetInternalFactor)(value[, unit]) | Set the value of "Internal Factor". | -| [`SetMotionFrame`](#generated.RARegionOfInterestCylinder.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RARegionOfInterestCylinder.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCylinder.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RARegionOfInterestCylinder.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RARegionOfInterestCylinder.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetRadius`](#generated.RARegionOfInterestCylinder.SetRadius)(value[, unit]) | Set the value of "Radius". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit: str | None = None) - -Get the value of “Center”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - - -#### GetCenterAfterMovement(timestep: int) - -Get the Region of Interest center taking motion in account. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetFinalAngle(unit: str | None = None) - -Get the value of “Final Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetHeight(unit: str | None = None) - -Get the value of “Height”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetInitialAngle(unit: str | None = None) - -Get the value of “Initial Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetInternalFactor(unit: str | None = None) - -Get the value of “Internal Factor”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetRadius(unit: str | None = None) - -Get the value of “Radius”. - -* **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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Center”. - -* **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. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetFinalAngle(value: str | float, unit: str | None = None) - -Set the value of “Final 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 “dega”. - - - -#### SetHeight(value: str | float, unit: str | None = None) - -Set the value of “Height”. - -* **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”. - - - -#### SetInitialAngle(value: str | float, unit: str | None = None) - -Set the value of “Initial 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 “dega”. - - - -#### SetInternalFactor(value: str | float, unit: str | None = None) - -Set the value of “Internal Factor”. - -* **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 “-“. - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetRadius(value: str | float, unit: str | None = None) - -Set the value of “Radius”. - -* **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”. + + +# RARegionOfInterestCylinder + + + + + + +### *class* RARegionOfInterestCylinder + +Rocky PrePost Scripting wrapper for a single Cylinder geometry. + +This wrapper class corresponds to an individual entry under the “Regions Of Interest” item on +the project’s data tree. Regions Of Interest can be retrieved from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the +[`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) via: + +```python +roi_cylinder = study.GetElement('Cylinder <1>') +``` + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RARegionOfInterestCylinder.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RARegionOfInterestCylinder.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.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.RARegionOfInterestCylinder.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RARegionOfInterestCylinder.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RARegionOfInterestCylinder.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RARegionOfInterestCylinder.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RARegionOfInterestCylinder.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RARegionOfInterestCylinder.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RARegionOfInterestCylinder.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RARegionOfInterestCylinder.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RARegionOfInterestCylinder.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RARegionOfInterestCylinder.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RARegionOfInterestCylinder.GetCenter)([unit]) | Get the value of "Center". | +| [`GetCenterAfterMovement`](#generated.RARegionOfInterestCylinder.GetCenterAfterMovement)(timestep) | Get the Region of Interest center taking motion in account. | +| [`GetCurve`](#generated.RARegionOfInterestCylinder.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetFinalAngle`](#generated.RARegionOfInterestCylinder.GetFinalAngle)([unit]) | Get the value of "Final Angle". | +| [`GetGeometryQuantity`](#generated.RARegionOfInterestCylinder.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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". | +| [`GetMeshColoring`](#generated.RARegionOfInterestCylinder.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMotionFrame`](#generated.RARegionOfInterestCylinder.GetMotionFrame)() | | +| [`GetNumberOfCells`](#generated.RARegionOfInterestCylinder.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RARegionOfInterestCylinder.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RARegionOfInterestCylinder.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RARegionOfInterestCylinder.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCylinder.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RARegionOfInterestCylinder.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RARegionOfInterestCylinder.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RARegionOfInterestCylinder.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetRadius`](#generated.RARegionOfInterestCylinder.GetRadius)([unit]) | Get the value of "Radius". | +| [`GetTimeSet`](#generated.RARegionOfInterestCylinder.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RARegionOfInterestCylinder.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RARegionOfInterestCylinder.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RARegionOfInterestCylinder.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RARegionOfInterestCylinder.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RARegionOfInterestCylinder.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RARegionOfInterestCylinder.RemoveProcess)() | Removes the process from the project. | +| [`SetCenter`](#generated.RARegionOfInterestCylinder.SetCenter)(values[, unit]) | Set the values of "Center". | +| [`SetCurrentTimeStep`](#generated.RARegionOfInterestCylinder.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetFinalAngle`](#generated.RARegionOfInterestCylinder.SetFinalAngle)(value[, unit]) | Set the value of "Final Angle". | +| [`SetHeight`](#generated.RARegionOfInterestCylinder.SetHeight)(value[, unit]) | Set the value of "Height". | +| [`SetInitialAngle`](#generated.RARegionOfInterestCylinder.SetInitialAngle)(value[, unit]) | Set the value of "Initial Angle". | +| [`SetInternalFactor`](#generated.RARegionOfInterestCylinder.SetInternalFactor)(value[, unit]) | Set the value of "Internal Factor". | +| [`SetMotionFrame`](#generated.RARegionOfInterestCylinder.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RARegionOfInterestCylinder.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RARegionOfInterestCylinder.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RARegionOfInterestCylinder.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RARegionOfInterestCylinder.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetRadius`](#generated.RARegionOfInterestCylinder.SetRadius)(value[, unit]) | Set the value of "Radius". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit: str | None = None) + +Get the value of “Center”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + + +#### GetCenterAfterMovement(timestep: int) + +Get the Region of Interest center taking motion in account. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetFinalAngle(unit: str | None = None) + +Get the value of “Final Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetHeight(unit: str | None = None) + +Get the value of “Height”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetInitialAngle(unit: str | None = None) + +Get the value of “Initial Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetInternalFactor(unit: str | None = None) + +Get the value of “Internal Factor”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetRadius(unit: str | None = None) + +Get the value of “Radius”. + +* **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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Center”. + +* **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. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetFinalAngle(value: str | float, unit: str | None = None) + +Set the value of “Final 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 “dega”. + + + +#### SetHeight(value: str | float, unit: str | None = None) + +Set the value of “Height”. + +* **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”. + + + +#### SetInitialAngle(value: str | float, unit: str | None = None) + +Set the value of “Initial 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 “dega”. + + + +#### SetInternalFactor(value: str | float, unit: str | None = None) + +Set the value of “Internal Factor”. + +* **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 “-“. + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetRadius(value: str | float, unit: str | None = None) + +Set the value of “Radius”. + +* **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/2025R2/rocky-prepost-scripting-manual/RARegionsOfInterestCollection.md b/2025R2/rocky-prepost-scripting-manual/RARegionsOfInterestCollection.md index 5c27dc644f..9ab2c4fb75 100644 --- a/2025R2/rocky-prepost-scripting-manual/RARegionsOfInterestCollection.md +++ b/2025R2/rocky-prepost-scripting-manual/RARegionsOfInterestCollection.md @@ -1,61 +1,62 @@ - - -# RARegionsOfInterestCollection - - - - - - -### *class* RARegionsOfInterestCollection - -Rocky PrePost Scripting wrapper for the collection of Regions of Interest in a project. - -This wrapper corresponds to the “Regions Of Interest” item in the project’s data tree. To -retrieve the [`RARegionsOfInterestCollection`](#generated.RARegionsOfInterestCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: - -> roi_collection = study.GetRegionsOfInterestCollection() - -Instances of the [`RARegionsOfInterestCollection`](#generated.RARegionsOfInterestCollection) class act as regular Python lists, and -can be iterated on, accessed via index, etc: - -**Methods:** - -| [`AddCube`](#generated.RARegionsOfInterestCollection.AddCube)([name]) | Add a new Cube. | -|-------------------------------------------------------------------------------|---------------------------------| -| [`AddCylinder`](#generated.RARegionsOfInterestCollection.AddCylinder)([name]) | Add a new Cylinder. | -| [`Clear`](#generated.RARegionsOfInterestCollection.Clear)() | Remove all items from the list. | -| [`New`](#generated.RARegionsOfInterestCollection.New)() | Add a new item. | -| [`Remove`](#generated.RARegionsOfInterestCollection.Remove)(item) | Remove an item from the list. | - - - -#### AddCube(name: str | None = None) - -Add a new Cube. Returns the newly created item. - - - -#### AddCylinder(name: str | None = None) - -Add a new Cylinder. Returns the newly created item. - - - -#### Clear() - -Remove all items from the list. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. + + +# RARegionsOfInterestCollection + + + + + + +### *class* RARegionsOfInterestCollection + +Rocky PrePost Scripting wrapper for the collection of Regions of Interest in a project. + +This wrapper corresponds to the “Regions Of Interest” item in the project’s data tree. To +retrieve the [`RARegionsOfInterestCollection`](#generated.RARegionsOfInterestCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: + +> roi_collection = study.GetRegionsOfInterestCollection() + +Instances of the [`RARegionsOfInterestCollection`](#generated.RARegionsOfInterestCollection) class act as regular Python lists, and +can be iterated on, accessed via index, etc: + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------|---------------------------------| +| [`AddCube`](#generated.RARegionsOfInterestCollection.AddCube)([name]) | Add a new Cube. | +| [`AddCylinder`](#generated.RARegionsOfInterestCollection.AddCylinder)([name]) | Add a new Cylinder. | +| [`Clear`](#generated.RARegionsOfInterestCollection.Clear)() | Remove all items from the list. | +| [`New`](#generated.RARegionsOfInterestCollection.New)() | Add a new item. | +| [`Remove`](#generated.RARegionsOfInterestCollection.Remove)(item) | Remove an item from the list. | + + + +#### AddCube(name: str | None = None) + +Add a new Cube. Returns the newly created item. + + + +#### AddCylinder(name: str | None = None) + +Add a new Cylinder. Returns the newly created item. + + + +#### Clear() + +Remove all items from the list. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. diff --git a/2025R2/rocky-prepost-scripting-manual/RARotation.md b/2025R2/rocky-prepost-scripting-manual/RARotation.md index b6e7ef83e5..b0916c04ff 100644 --- a/2025R2/rocky-prepost-scripting-manual/RARotation.md +++ b/2025R2/rocky-prepost-scripting-manual/RARotation.md @@ -1,76 +1,77 @@ - - -# RARotation - - - - - - -### *class* RARotation - -Rocky PrePost Scripting wrapper representing a Rotation motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Rotation') -rotation = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetAngularAcceleration`](#generated.RARotation.GetAngularAcceleration)([unit]) | Get the value of "Angular Acceleration". | -|------------------------------------------------------------------------------------------------|-----------------------------------------------| -| [`GetInitialAngularVelocity`](#generated.RARotation.GetInitialAngularVelocity)([unit]) | Get the value of "Initial Angular Velocity". | -| [`SetAngularAcceleration`](#generated.RARotation.SetAngularAcceleration)(values[, unit]) | Set the values of "Angular Acceleration". | -| [`SetInitialAngularVelocity`](#generated.RARotation.SetInitialAngularVelocity)(values[, unit]) | Set the values of "Initial Angular Velocity". | - - - -#### GetAngularAcceleration(unit: str | None = None) - -Get the value of “Angular Acceleration”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “rad/s2”. - - - -#### GetInitialAngularVelocity(unit: str | None = None) - -Get the value of “Initial Angular Velocity”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “rad/s”. - - - -#### SetAngularAcceleration(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Angular Acceleration”. - -* **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 “rad/s2”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetInitialAngularVelocity(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Initial Angular Velocity”. - -* **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 “rad/s”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. + + +# RARotation + + + + + + +### *class* RARotation + +Rocky PrePost Scripting wrapper representing a Rotation motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Rotation') +rotation = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------|-----------------------------------------------| +| [`GetAngularAcceleration`](#generated.RARotation.GetAngularAcceleration)([unit]) | Get the value of "Angular Acceleration". | +| [`GetInitialAngularVelocity`](#generated.RARotation.GetInitialAngularVelocity)([unit]) | Get the value of "Initial Angular Velocity". | +| [`SetAngularAcceleration`](#generated.RARotation.SetAngularAcceleration)(values[, unit]) | Set the values of "Angular Acceleration". | +| [`SetInitialAngularVelocity`](#generated.RARotation.SetInitialAngularVelocity)(values[, unit]) | Set the values of "Initial Angular Velocity". | + + + +#### GetAngularAcceleration(unit: str | None = None) + +Get the value of “Angular Acceleration”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “rad/s2”. + + + +#### GetInitialAngularVelocity(unit: str | None = None) + +Get the value of “Initial Angular Velocity”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “rad/s”. + + + +#### SetAngularAcceleration(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Angular Acceleration”. + +* **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 “rad/s2”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. + + + +#### SetInitialAngularVelocity(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Initial Angular Velocity”. + +* **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 “rad/s”. +* **Raises:** + **RockyApiError** – If values doesn’t have exactly 3 elements. diff --git a/2025R2/rocky-prepost-scripting-manual/RASPHEulerianSolution.md b/2025R2/rocky-prepost-scripting-manual/RASPHEulerianSolution.md index 2c28716792..5f64c8267a 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASPHEulerianSolution.md +++ b/2025R2/rocky-prepost-scripting-manual/RASPHEulerianSolution.md @@ -1,77 +1,78 @@ - - -# RASPHEulerianSolution - - - - - - -### *class* RASPHEulerianSolution - -Rocky PrePost Scripting wrapper for SPH Eulerian Solution properties. - -This wrapper corresponds to the “Eulerian Solution” item on a project’s data tree. Access it from -the [`RAStudy`](RAStudy.md#generated.RAStudy) with: - -```python -eulerian_solution = study.GetSphEulerianSolution() -``` - -**Methods:** - -| [`DisableEulerianSolution`](#generated.RASPHEulerianSolution.DisableEulerianSolution)() | Set the value of "Eulerian Solution" to False. | -|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| -| [`EnableEulerianSolution`](#generated.RASPHEulerianSolution.EnableEulerianSolution)() | Set the value of "Eulerian Solution" to True. | -| [`GetEulerianSolutionEnabled`](#generated.RASPHEulerianSolution.GetEulerianSolutionEnabled)() | Delegates the method to the project sph settings. | -| [`GetMeshColoring`](#generated.RASPHEulerianSolution.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`IsEulerianSolutionEnabled`](#generated.RASPHEulerianSolution.IsEulerianSolutionEnabled)() | Check if the "Eulerian Solution" is enabled. | -| [`SetEulerianSolutionEnabled`](#generated.RASPHEulerianSolution.SetEulerianSolutionEnabled)(value) | Delegate the method to the project sph settings. | - - - -#### DisableEulerianSolution() - -Set the value of “Eulerian Solution” to False. - - - -#### EnableEulerianSolution() - -Set the value of “Eulerian Solution” to True. - - - -#### GetEulerianSolutionEnabled() - -Delegates the method to the project sph settings. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### IsEulerianSolutionEnabled() - -Check if the “Eulerian Solution” is enabled. - - - -#### SetEulerianSolutionEnabled(value: bool) - -Delegate the method to the project sph settings. - -* **Parameters:** - **value** – The value to set. + + +# RASPHEulerianSolution + + + + + + +### *class* RASPHEulerianSolution + +Rocky PrePost Scripting wrapper for SPH Eulerian Solution properties. + +This wrapper corresponds to the “Eulerian Solution” item on a project’s data tree. Access it from +the [`RAStudy`](RAStudy.md#generated.RAStudy) with: + +```python +eulerian_solution = study.GetSphEulerianSolution() +``` + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| [`DisableEulerianSolution`](#generated.RASPHEulerianSolution.DisableEulerianSolution)() | Set the value of "Eulerian Solution" to False. | +| [`EnableEulerianSolution`](#generated.RASPHEulerianSolution.EnableEulerianSolution)() | Set the value of "Eulerian Solution" to True. | +| [`GetEulerianSolutionEnabled`](#generated.RASPHEulerianSolution.GetEulerianSolutionEnabled)() | Delegates the method to the project sph settings. | +| [`GetMeshColoring`](#generated.RASPHEulerianSolution.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`IsEulerianSolutionEnabled`](#generated.RASPHEulerianSolution.IsEulerianSolutionEnabled)() | Check if the "Eulerian Solution" is enabled. | +| [`SetEulerianSolutionEnabled`](#generated.RASPHEulerianSolution.SetEulerianSolutionEnabled)(value) | Delegate the method to the project sph settings. | + + + +#### DisableEulerianSolution() + +Set the value of “Eulerian Solution” to False. + + + +#### EnableEulerianSolution() + +Set the value of “Eulerian Solution” to True. + + + +#### GetEulerianSolutionEnabled() + +Delegates the method to the project sph settings. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### IsEulerianSolutionEnabled() + +Check if the “Eulerian Solution” is enabled. + + + +#### SetEulerianSolutionEnabled(value: bool) + +Delegate the method to the project sph settings. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/RASPHSettings.md b/2025R2/rocky-prepost-scripting-manual/RASPHSettings.md index 8c555334ab..5e54261161 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASPHSettings.md +++ b/2025R2/rocky-prepost-scripting-manual/RASPHSettings.md @@ -1,1955 +1,1956 @@ - - -# RASPHSettings - - - - - - -### *class* RASPHSettings - -Rocky PrePost Scripting wrapper for SPH Settings properties. - -This wrapper corresponds to the “SPH” item on a project’s data tree. Access it from -the [`RAStudy`](RAStudy.md#generated.RAStudy) with: - -```python -sph_settings = study.GetSphSettings() -sph_settings = study.GetElement('SPH') -``` - -**Methods:** - -| [`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(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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableEulerianSolution() - -Set the value of “Eulerian Solution” to False. - - - -#### DisableShepardFilterOnDensity() - -Set the value of “Shepard Filter On Density” to False. - - - -#### DisableShepardFilterOnPressure() - -Set the value of “Shepard Filter On Pressure” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableEulerianSolution() - -Set the value of “Eulerian Solution” to True. - - - -#### EnableShepardFilterOnDensity() - -Set the value of “Shepard Filter On Density” to True. - - - -#### EnableShepardFilterOnPressure() - -Set the value of “Shepard Filter On Pressure” to True. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableFluidMaterials() - -Get all available Fluid Materials. - -* **Return type:** - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCS() - -Get the value of “C S”. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetClearyFactor() - -Get the value of “Cleary Factor”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDensityDevMinus() - -Get the value of “Density Dev Minus”. - - - -#### GetDensityDevPlus() - -Get the value of “Density Dev Plus”. - - - -#### GetDensityRelativeErrorTolerance() - -Get the value of “Density Relative Error Tolerance”. - - - -#### GetDissFactor() - -Get the value of “Diss Factor”. - - - -#### GetDistFactorNorm() - -Get the value of “Dist Factor Norm”. - - - -#### GetDistFactorTang() - -Get the value of “Dist Factor Tang”. - - - -#### 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. - - - -#### GetEulerianSolutionEnabled() - -Get the value of “Eulerian Solution Enabled”. - - - -#### GetFluidMaterial() - -Get the “Fluid Material”. - -* **Return type:** - [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) - - - -#### GetFreeSurfaceDivergenceLimit() - -Get the value of “Free Surface Divergence Limit”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetKernelDistFactor() - -Get the value of “Kernel Dist Factor”. - - - -#### GetKernelType() - -Get “Kernel Type” as a string. - -* **Returns:** - The returned value will be one of [‘cubic’, ‘quintic’, ‘wendland’]. - - - -#### GetLimitTurbulentViscosity() - -Get the value of “Limit Turbulent Viscosity”. - - - -#### GetMaximumExpectedVelocity(unit: str | None = None) - -Get the value of “Maximum Expected Velocity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### GetMaximumNumberOfIterations() - -Get the value of “Maximum Number of Iterations”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinDistFactor() - -Get the value of “Min Dist Factor”. - - - -#### GetNegativePressureFactor() - -Get the value of “Negative Pressure Factor”. - - - -#### GetNumCellSteps() - -Get the value of “Num Cell Steps”. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfSteps() - -Get the value of “Number of Steps”. - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetPosCorrectionType() - -Get “Pos Correction Type” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘xsph’, ‘shift’]. - - - -#### GetPressureDeg() - -Get the value of “Pressure Deg”. - - - -#### GetPressureUnderRelaxationFactor() - -Get the value of “Pressure Under Relaxation Factor”. - - - -#### GetShepardFilterOnDensityEnabled() - -Get the value of “Shepard Filter On Density Enabled”. - - - -#### GetShepardFilterOnPressureEnabled() - -Get the value of “Shepard Filter On Pressure Enabled”. - - - -#### GetShiftingFactor() - -Get the value of “Shifting Factor”. - - - -#### GetSize(unit: str | None = None) - -Get the value of “Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetSolver() - -Get “Solver Model” as a string. - -* **Returns:** - The returned value will be one of [‘WCSPH’, ‘IISPH’]. - - - -#### GetSolverModel() - -Get “Solver Model” as a string. - -* **Returns:** - The returned value will be one of [‘WCSPH’, ‘IISPH’, ‘DFSPH’]. - - - -#### GetSoundSpeed(unit: str | None = None) - -Get the value of “Sound Speed”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - - -#### GetStabilityDegree() - -Get the value of “Stability Degree”. - - - -#### GetStabilityNegFactor() - -Get the value of “Stability Neg Factor”. - - - -#### GetStabilityPosFactor() - -Get the value of “Stability Pos Factor”. - - - -#### GetStiffFactor() - -Get the value of “Stiff Factor”. - - - -#### GetSurfaceTensionBoundaryAngle(unit: str | None = None) - -Get the value of “Surface Tension Boundary Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetSurfaceTensionBoundaryFraction() - -Get the value of “Surface Tension Boundary Fraction”. - - - -#### GetSurfaceTensionCoefficient(unit: str | None = None) - -Get the value of “Surface Tension Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m”. - - - -#### GetSurfaceTensionType() - -Get “Surface Tension Type” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’]. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTimestepFactor() - -Get the value of “Timestep Factor”. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTurbDistanceFraction() - -Get the value of “Turb Distance Fraction”. - - - -#### GetTurbulenceType() - -Get “Turbulence Type” as a string. - -* **Returns:** - The returned value will be one of [‘laminar’, ‘les’]. - - - -#### GetTurbulentPrandtl() - -Get the value of “Turbulent Prandtl”. - - - -#### GetTurbulentViscosityMaximumRatio() - -Get the value of “Turbulent Viscosity Maximum Ratio”. - - - -#### GetUpdateCoupledDensity() - -Get the value of “Update Coupled Density”. - - - -#### GetUseParticlesNeighborsList() - -Get the value of “Use Particles Neighbors List”. - - - -#### GetValidKernelTypeValues() - -Get a list of all possible values for “Kernel Type”. - -* **Returns:** - The returned list is [‘cubic’, ‘quintic’, ‘wendland’]. - - - -#### GetValidPosCorrectionTypeValues() - -Get a list of all possible values for “Pos Correction Type”. - -* **Returns:** - The returned list is [‘none’, ‘xsph’, ‘shift’]. - - - -#### GetValidSolverModelValues() - -Get a list of all possible values for “Solver Model”. - -* **Returns:** - The returned list is [‘WCSPH’, ‘IISPH’, ‘DFSPH’]. - - - -#### GetValidSurfaceTensionTypeValues() - -Get a list of all possible values for “Surface Tension Type”. - -* **Returns:** - The returned list is [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’]. - - - -#### GetValidTurbulenceTypeValues() - -Get a list of all possible values for “Turbulence Type”. - -* **Returns:** - The returned list is [‘laminar’, ‘les’]. - - - -#### GetValidViscosityTypeValues() - -Get a list of all possible values for “Viscosity Type”. - -* **Returns:** - The returned list is [‘cleary’, ‘morris’, ‘custom’]. - - - -#### GetViscosityType() - -Get “Viscosity Type” as a string. - -* **Returns:** - The returned value will be one of [‘cleary’, ‘morris’, ‘custom’]. - - - -#### GetXsphFactor() - -Get the value of “Xsph Factor”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsEulerianSolutionEnabled() - -Check if the “Eulerian Solution” is enabled. - - - -#### IsShepardFilterOnDensityEnabled() - -Check if the “Shepard Filter On Density” is enabled. - - - -#### IsShepardFilterOnPressureEnabled() - -Check if the “Shepard Filter On Pressure” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -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) - -Set the value of “C S”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetClearyFactor(value: str | float) - -Set the value of “Cleary Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDensityDevMinus(value: str | float) - -Set the value of “Density Dev Minus”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetDensityDevPlus(value: str | float) - -Set the value of “Density Dev Plus”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetDensityRelativeErrorTolerance(value: str | float) - -Set the value of “Density Relative Error Tolerance”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetDissFactor(value: str | float) - -Set the value of “Diss Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetDistFactorNorm(value: str | float) - -Set the value of “Dist Factor Norm”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetDistFactorTang(value: str | float) - -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. - - - -#### SetEulerianSolutionEnabled(value: bool) - -Set the value of “Eulerian Solution Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetFluidMaterial(value) - -Set the “Fluid Material”. - -:param unicode, [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetFreeSurfaceDivergenceLimit(value: str | float) - -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. - - - -#### SetKernelDistFactor(value: str | float) - -Set the value of “Kernel Dist Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetKernelType(value: str) - -Set the value of “Kernel Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘cubic’, ‘quintic’, ‘wendland’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Kernel Type” option. - - - -#### SetLimitTurbulentViscosity(value: bool) - -Set the value of “Limit Turbulent Viscosity”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetMaximumExpectedVelocity(value: str | float, unit: str | None = None) - -Set the value of “Maximum Expected Velocity”. - -* **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/s”. - - - -#### SetMaximumNumberOfIterations(value: str | int) - -Set the value of “Maximum Number of Iterations”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMinDistFactor(value: str | float) - -Set the value of “Min Dist Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetNegativePressureFactor(value: str | float) - -Set the value of “Negative Pressure Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetNumCellSteps(value: str | int) - -Set the value of “Num Cell Steps”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetNumberOfSteps(value: str | int) - -Set the value of “Number of Steps”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetPosCorrectionType(value: str) - -Set the value of “Pos Correction Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘xsph’, ‘shift’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Pos Correction Type” option. - - - -#### SetPressureDeg(value: str | int) - -Set the value of “Pressure Deg”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetPressureUnderRelaxationFactor(value: str | float) - -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. - - - -#### SetShepardFilterOnDensityEnabled(value: bool) - -Set the value of “Shepard Filter On Density Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetShepardFilterOnPressureEnabled(value: bool) - -Set the value of “Shepard Filter On Pressure Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetShiftingFactor(value: str | float) - -Set the value of “Shifting Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSize(value: str | float, unit: str | None = None) - -Set the value of “Size”. - -* **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”. - - - -#### SetSolver(value: str) - -Set the value of “Solver Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘WCSPH’, ‘IISPH’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Solver Model” option. - - - -#### SetSolverModel(value: str) - -Set the value of “Solver Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘WCSPH’, ‘IISPH’, ‘DFSPH’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Solver Model” option. - - - -#### SetSoundSpeed(value: str | float, unit: str | None = None) - -Set the value of “Sound Speed”. - -* **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/s”. - - - -#### SetStabilityDegree(value: str | int) - -Set the value of “Stability Degree”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetStabilityNegFactor(value: str | float) - -Set the value of “Stability Neg Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetStabilityPosFactor(value: str | float) - -Set the value of “Stability Pos Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetStiffFactor(value: str | float) - -Set the value of “Stiff Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSurfaceTensionBoundaryAngle(value: str | float, unit: str | None = None) - -Set the value of “Surface Tension Boundary 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 “dega”. - - - -#### SetSurfaceTensionBoundaryFraction(value: str | float) - -Set the value of “Surface Tension Boundary Fraction”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSurfaceTensionCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Surface Tension Coefficient”. - -* **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 “N/m”. - - - -#### SetSurfaceTensionType(value: str) - -Set the value of “Surface Tension Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Surface Tension Type” option. - - - -#### SetTimestepFactor(value: str | float) - -Set the value of “Timestep Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetTurbDistanceFraction(value: str | float) - -Set the value of “Turb Distance Fraction”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetTurbulenceType(value: str) - -Set the value of “Turbulence Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘laminar’, ‘les’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Turbulence Type” option. - - - -#### SetTurbulentPrandtl(value: str | float) - -Set the value of “Turbulent Prandtl”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetTurbulentViscosityMaximumRatio(value: str | float) - -Set the value of “Turbulent Viscosity Maximum Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetUpdateCoupledDensity(value: bool) - -Set the value of “Update Coupled Density”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseParticlesNeighborsList(value: bool) - -Set the value of “Use Particles Neighbors List”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetViscosityType(value: str) - -Set the value of “Viscosity Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘cleary’, ‘morris’, ‘custom’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Viscosity Type” option. - - - -#### SetXsphFactor(value: str | float) - -Set the value of “Xsph Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. + + +# RASPHSettings + + + + + + +### *class* RASPHSettings + +Rocky PrePost Scripting wrapper for SPH Settings properties. + +This wrapper corresponds to the “SPH” item on a project’s data tree. Access it from +the [`RAStudy`](RAStudy.md#generated.RAStudy) with: + +```python +sph_settings = study.GetSphSettings() +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(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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableEulerianSolution() + +Set the value of “Eulerian Solution” to False. + + + +#### DisableShepardFilterOnDensity() + +Set the value of “Shepard Filter On Density” to False. + + + +#### DisableShepardFilterOnPressure() + +Set the value of “Shepard Filter On Pressure” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableEulerianSolution() + +Set the value of “Eulerian Solution” to True. + + + +#### EnableShepardFilterOnDensity() + +Set the value of “Shepard Filter On Density” to True. + + + +#### EnableShepardFilterOnPressure() + +Set the value of “Shepard Filter On Pressure” to True. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableFluidMaterials() + +Get all available Fluid Materials. + +* **Return type:** + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCS() + +Get the value of “C S”. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetClearyFactor() + +Get the value of “Cleary Factor”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDensityDevMinus() + +Get the value of “Density Dev Minus”. + + + +#### GetDensityDevPlus() + +Get the value of “Density Dev Plus”. + + + +#### GetDensityRelativeErrorTolerance() + +Get the value of “Density Relative Error Tolerance”. + + + +#### GetDissFactor() + +Get the value of “Diss Factor”. + + + +#### GetDistFactorNorm() + +Get the value of “Dist Factor Norm”. + + + +#### GetDistFactorTang() + +Get the value of “Dist Factor Tang”. + + + +#### 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. + + + +#### GetEulerianSolutionEnabled() + +Get the value of “Eulerian Solution Enabled”. + + + +#### GetFluidMaterial() + +Get the “Fluid Material”. + +* **Return type:** + [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) + + + +#### GetFreeSurfaceDivergenceLimit() + +Get the value of “Free Surface Divergence Limit”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetKernelDistFactor() + +Get the value of “Kernel Dist Factor”. + + + +#### GetKernelType() + +Get “Kernel Type” as a string. + +* **Returns:** + The returned value will be one of [‘cubic’, ‘quintic’, ‘wendland’]. + + + +#### GetLimitTurbulentViscosity() + +Get the value of “Limit Turbulent Viscosity”. + + + +#### GetMaximumExpectedVelocity(unit: str | None = None) + +Get the value of “Maximum Expected Velocity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### GetMaximumNumberOfIterations() + +Get the value of “Maximum Number of Iterations”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinDistFactor() + +Get the value of “Min Dist Factor”. + + + +#### GetNegativePressureFactor() + +Get the value of “Negative Pressure Factor”. + + + +#### GetNumCellSteps() + +Get the value of “Num Cell Steps”. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfSteps() + +Get the value of “Number of Steps”. + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetPosCorrectionType() + +Get “Pos Correction Type” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘xsph’, ‘shift’]. + + + +#### GetPressureDeg() + +Get the value of “Pressure Deg”. + + + +#### GetPressureUnderRelaxationFactor() + +Get the value of “Pressure Under Relaxation Factor”. + + + +#### GetShepardFilterOnDensityEnabled() + +Get the value of “Shepard Filter On Density Enabled”. + + + +#### GetShepardFilterOnPressureEnabled() + +Get the value of “Shepard Filter On Pressure Enabled”. + + + +#### GetShiftingFactor() + +Get the value of “Shifting Factor”. + + + +#### GetSize(unit: str | None = None) + +Get the value of “Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetSolver() + +Get “Solver Model” as a string. + +* **Returns:** + The returned value will be one of [‘WCSPH’, ‘IISPH’]. + + + +#### GetSolverModel() + +Get “Solver Model” as a string. + +* **Returns:** + The returned value will be one of [‘WCSPH’, ‘IISPH’, ‘DFSPH’]. + + + +#### GetSoundSpeed(unit: str | None = None) + +Get the value of “Sound Speed”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + + +#### GetStabilityDegree() + +Get the value of “Stability Degree”. + + + +#### GetStabilityNegFactor() + +Get the value of “Stability Neg Factor”. + + + +#### GetStabilityPosFactor() + +Get the value of “Stability Pos Factor”. + + + +#### GetStiffFactor() + +Get the value of “Stiff Factor”. + + + +#### GetSurfaceTensionBoundaryAngle(unit: str | None = None) + +Get the value of “Surface Tension Boundary Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetSurfaceTensionBoundaryFraction() + +Get the value of “Surface Tension Boundary Fraction”. + + + +#### GetSurfaceTensionCoefficient(unit: str | None = None) + +Get the value of “Surface Tension Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m”. + + + +#### GetSurfaceTensionType() + +Get “Surface Tension Type” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’]. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTimestepFactor() + +Get the value of “Timestep Factor”. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTurbDistanceFraction() + +Get the value of “Turb Distance Fraction”. + + + +#### GetTurbulenceType() + +Get “Turbulence Type” as a string. + +* **Returns:** + The returned value will be one of [‘laminar’, ‘les’]. + + + +#### GetTurbulentPrandtl() + +Get the value of “Turbulent Prandtl”. + + + +#### GetTurbulentViscosityMaximumRatio() + +Get the value of “Turbulent Viscosity Maximum Ratio”. + + + +#### GetUpdateCoupledDensity() + +Get the value of “Update Coupled Density”. + + + +#### GetUseParticlesNeighborsList() + +Get the value of “Use Particles Neighbors List”. + + + +#### GetValidKernelTypeValues() + +Get a list of all possible values for “Kernel Type”. + +* **Returns:** + The returned list is [‘cubic’, ‘quintic’, ‘wendland’]. + + + +#### GetValidPosCorrectionTypeValues() + +Get a list of all possible values for “Pos Correction Type”. + +* **Returns:** + The returned list is [‘none’, ‘xsph’, ‘shift’]. + + + +#### GetValidSolverModelValues() + +Get a list of all possible values for “Solver Model”. + +* **Returns:** + The returned list is [‘WCSPH’, ‘IISPH’, ‘DFSPH’]. + + + +#### GetValidSurfaceTensionTypeValues() + +Get a list of all possible values for “Surface Tension Type”. + +* **Returns:** + The returned list is [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’]. + + + +#### GetValidTurbulenceTypeValues() + +Get a list of all possible values for “Turbulence Type”. + +* **Returns:** + The returned list is [‘laminar’, ‘les’]. + + + +#### GetValidViscosityTypeValues() + +Get a list of all possible values for “Viscosity Type”. + +* **Returns:** + The returned list is [‘cleary’, ‘morris’, ‘custom’]. + + + +#### GetViscosityType() + +Get “Viscosity Type” as a string. + +* **Returns:** + The returned value will be one of [‘cleary’, ‘morris’, ‘custom’]. + + + +#### GetXsphFactor() + +Get the value of “Xsph Factor”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsEulerianSolutionEnabled() + +Check if the “Eulerian Solution” is enabled. + + + +#### IsShepardFilterOnDensityEnabled() + +Check if the “Shepard Filter On Density” is enabled. + + + +#### IsShepardFilterOnPressureEnabled() + +Check if the “Shepard Filter On Pressure” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +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) + +Set the value of “C S”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetClearyFactor(value: str | float) + +Set the value of “Cleary Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDensityDevMinus(value: str | float) + +Set the value of “Density Dev Minus”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetDensityDevPlus(value: str | float) + +Set the value of “Density Dev Plus”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetDensityRelativeErrorTolerance(value: str | float) + +Set the value of “Density Relative Error Tolerance”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetDissFactor(value: str | float) + +Set the value of “Diss Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetDistFactorNorm(value: str | float) + +Set the value of “Dist Factor Norm”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetDistFactorTang(value: str | float) + +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. + + + +#### SetEulerianSolutionEnabled(value: bool) + +Set the value of “Eulerian Solution Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetFluidMaterial(value) + +Set the “Fluid Material”. + +:param unicode, [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetFreeSurfaceDivergenceLimit(value: str | float) + +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. + + + +#### SetKernelDistFactor(value: str | float) + +Set the value of “Kernel Dist Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetKernelType(value: str) + +Set the value of “Kernel Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘cubic’, ‘quintic’, ‘wendland’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Kernel Type” option. + + + +#### SetLimitTurbulentViscosity(value: bool) + +Set the value of “Limit Turbulent Viscosity”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetMaximumExpectedVelocity(value: str | float, unit: str | None = None) + +Set the value of “Maximum Expected Velocity”. + +* **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/s”. + + + +#### SetMaximumNumberOfIterations(value: str | int) + +Set the value of “Maximum Number of Iterations”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMinDistFactor(value: str | float) + +Set the value of “Min Dist Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetNegativePressureFactor(value: str | float) + +Set the value of “Negative Pressure Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetNumCellSteps(value: str | int) + +Set the value of “Num Cell Steps”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetNumberOfSteps(value: str | int) + +Set the value of “Number of Steps”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetPosCorrectionType(value: str) + +Set the value of “Pos Correction Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘xsph’, ‘shift’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Pos Correction Type” option. + + + +#### SetPressureDeg(value: str | int) + +Set the value of “Pressure Deg”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetPressureUnderRelaxationFactor(value: str | float) + +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. + + + +#### SetShepardFilterOnDensityEnabled(value: bool) + +Set the value of “Shepard Filter On Density Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetShepardFilterOnPressureEnabled(value: bool) + +Set the value of “Shepard Filter On Pressure Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetShiftingFactor(value: str | float) + +Set the value of “Shifting Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSize(value: str | float, unit: str | None = None) + +Set the value of “Size”. + +* **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”. + + + +#### SetSolver(value: str) + +Set the value of “Solver Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘WCSPH’, ‘IISPH’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Solver Model” option. + + + +#### SetSolverModel(value: str) + +Set the value of “Solver Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘WCSPH’, ‘IISPH’, ‘DFSPH’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Solver Model” option. + + + +#### SetSoundSpeed(value: str | float, unit: str | None = None) + +Set the value of “Sound Speed”. + +* **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/s”. + + + +#### SetStabilityDegree(value: str | int) + +Set the value of “Stability Degree”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetStabilityNegFactor(value: str | float) + +Set the value of “Stability Neg Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetStabilityPosFactor(value: str | float) + +Set the value of “Stability Pos Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetStiffFactor(value: str | float) + +Set the value of “Stiff Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSurfaceTensionBoundaryAngle(value: str | float, unit: str | None = None) + +Set the value of “Surface Tension Boundary 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 “dega”. + + + +#### SetSurfaceTensionBoundaryFraction(value: str | float) + +Set the value of “Surface Tension Boundary Fraction”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSurfaceTensionCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Surface Tension Coefficient”. + +* **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 “N/m”. + + + +#### SetSurfaceTensionType(value: str) + +Set the value of “Surface Tension Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘CSF’, ‘CSS’, ‘custom’, ‘pairwise_potential’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Surface Tension Type” option. + + + +#### SetTimestepFactor(value: str | float) + +Set the value of “Timestep Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetTurbDistanceFraction(value: str | float) + +Set the value of “Turb Distance Fraction”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetTurbulenceType(value: str) + +Set the value of “Turbulence Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘laminar’, ‘les’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Turbulence Type” option. + + + +#### SetTurbulentPrandtl(value: str | float) + +Set the value of “Turbulent Prandtl”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetTurbulentViscosityMaximumRatio(value: str | float) + +Set the value of “Turbulent Viscosity Maximum Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetUpdateCoupledDensity(value: bool) + +Set the value of “Update Coupled Density”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseParticlesNeighborsList(value: bool) + +Set the value of “Use Particles Neighbors List”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetViscosityType(value: str) + +Set the value of “Viscosity Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘cleary’, ‘morris’, ‘custom’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Viscosity Type” option. + + + +#### SetXsphFactor(value: str | float) + +Set the value of “Xsph Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. diff --git a/2025R2/rocky-prepost-scripting-manual/RASimulatorRun.md b/2025R2/rocky-prepost-scripting-manual/RASimulatorRun.md index 4feb6000d4..61bcae3543 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASimulatorRun.md +++ b/2025R2/rocky-prepost-scripting-manual/RASimulatorRun.md @@ -1,2420 +1,2421 @@ - - -# RASimulatorRun - - - - - - -### *class* RASimulatorRun - -Rocky PrePost Scripting wrapper for solver settings. - -This wrapper corresponds to the “Solver” item on a project’s data tree. Access it from the -[`RAStudy`](RAStudy.md#generated.RAStudy) with: - -```python -simulator_run = study.GetSimulatorRun() -``` - -**Methods:** - -| [`AddCurve`](#generated.RASimulatorRun.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RASimulatorRun.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.RASimulatorRun.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RASimulatorRun.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RASimulatorRun.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.RASimulatorRun.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RASimulatorRun.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASimulatorRun.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.RASimulatorRun.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). | -| [`DisableCompressedFile`](#generated.RASimulatorRun.DisableCompressedFile)() | Set the value of "Compressed File" to False. | -| [`DisableDpmBlockingEffectForSinglePhaseSimulations`](#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | -| [`DisableFEMForces`](#generated.RASimulatorRun.DisableFEMForces)() | Disables the "FEM Forces" calculations. | -| [`DisableHtcCalculator`](#generated.RASimulatorRun.DisableHtcCalculator)() | Disables the "HTC" calculations. | -| [`DisableMoveCfdCellsWithRockyBoundaries`](#generated.RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries)() | Set the value of "Move Cfd Cells With Rocky Boundaries" to False. | -| [`DisableNegateInitialOverlaps`](#generated.RASimulatorRun.DisableNegateInitialOverlaps)() | Set the value of "Negate Initial Overlaps" to False. | -| [`DisableSortingDistanceFactor`](#generated.RASimulatorRun.DisableSortingDistanceFactor)() | Set the value of "Sorting Distance Factor" to False. | -| [`DisableUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.DisableUse3RdPowerForCfdCgm)() | Set the value of "Use 3Rd Power For Cfd Cgm" to False. | -| [`EditCustomCurve`](#generated.RASimulatorRun.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.RASimulatorRun.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. | -| [`EnableCompressedFile`](#generated.RASimulatorRun.EnableCompressedFile)() | Set the value of "Compressed File" to True. | -| [`EnableDpmBlockingEffectForSinglePhaseSimulations`](#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | -| [`EnableFEMForces`](#generated.RASimulatorRun.EnableFEMForces)() | Enables the "FEM Forces" calculations. | -| [`EnableHtcCalculator`](#generated.RASimulatorRun.EnableHtcCalculator)() | Enables the "HTC" calculations. | -| [`EnableMoveCfdCellsWithRockyBoundaries`](#generated.RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries)() | Set the value of "Move Cfd Cells With Rocky Boundaries" to True. | -| [`EnableNegateInitialOverlaps`](#generated.RASimulatorRun.EnableNegateInitialOverlaps)() | Set the value of "Negate Initial Overlaps" to True. | -| [`EnableSortingDistanceFactor`](#generated.RASimulatorRun.EnableSortingDistanceFactor)() | Set the value of "Sorting Distance Factor" to True. | -| [`EnableUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.EnableUse3RdPowerForCfdCgm)() | Set the value of "Use 3Rd Power For Cfd Cgm" to True. | -| [`GetActivesArray`](#generated.RASimulatorRun.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetArraysGrowthRate`](#generated.RASimulatorRun.GetArraysGrowthRate)() | Get the value of "Arrays Growth Rate". | -| [`GetAvailableModulesOutputProperties`](#generated.RASimulatorRun.GetAvailableModulesOutputProperties)() | | -| [`GetAvailableOutputRootProperties`](#generated.RASimulatorRun.GetAvailableOutputRootProperties)(root_key) | Deprecated: Use GetAvailableStandardOutputProperties instead. | -| [`GetAvailableOutputRoots`](#generated.RASimulatorRun.GetAvailableOutputRoots)() | Deprecated: Use GetAvailableStandardOutputProperties instead. | -| [`GetAvailableStandardOutputProperties`](#generated.RASimulatorRun.GetAvailableStandardOutputProperties)() | | -| [`GetBoundingBox`](#generated.RASimulatorRun.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetBreakageDelayAfterRelease`](#generated.RASimulatorRun.GetBreakageDelayAfterRelease)([unit]) | Get the value of "Breakage Delay After Release". | -| [`GetBreakageOverlapFactor`](#generated.RASimulatorRun.GetBreakageOverlapFactor)() | Get the value of "Breakage Overlap Factor". | -| [`GetBreakageStart`](#generated.RASimulatorRun.GetBreakageStart)([unit]) | Get the value of "Breakage Start". | -| [`GetCellAreaAsArray`](#generated.RASimulatorRun.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RASimulatorRun.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RASimulatorRun.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RASimulatorRun.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RASimulatorRun.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`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. | -| [`GetCurveNames`](#generated.RASimulatorRun.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RASimulatorRun.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetDeformableMassMatrixType`](#generated.RASimulatorRun.GetDeformableMassMatrixType)() | Get "Deformable Mass Matrix Type" as a string. | -| [`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. | -| [`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. | -| [`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. | -| [`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". | -| [`GetMaximumNumberOfIterations`](#generated.RASimulatorRun.GetMaximumNumberOfIterations)() | Get the value of "Maximum Number of Iterations". | -| [`GetMeshColoring`](#generated.RASimulatorRun.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMinimumLengthDeformationTolerance`](#generated.RASimulatorRun.GetMinimumLengthDeformationTolerance)() | Get the value of "Minimum Length Deformation Tolerance". | -| [`GetMinimumVolumeTolerance`](#generated.RASimulatorRun.GetMinimumVolumeTolerance)() | Get the value of "Minimum Volume Tolerance". | -| [`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". | -| [`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. | -| [`GetNumberOfCells`](#generated.RASimulatorRun.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RASimulatorRun.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfProcessors`](#generated.RASimulatorRun.GetNumberOfProcessors)() | Get the value of "Number of Processors". | -| [`GetNumpyCurve`](#generated.RASimulatorRun.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputPropertyEnabled`](#generated.RASimulatorRun.GetOutputPropertyEnabled)(root_key, property_name) | Deprecated: Use GetStandardOutputPropertyEnabled instead. | -| [`GetOutputRootEnabled`](#generated.RASimulatorRun.GetOutputRootEnabled)(root_key) | Deprecated: Use GetStandardOutputPropertyEnabled instead. | -| [`GetOutputVariableValue`](#generated.RASimulatorRun.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`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". | -| [`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)() | | -| [`GetStandardOutputPropertyEnabled`](#generated.RASimulatorRun.GetStandardOutputPropertyEnabled)(...) | Retrieve enable state of given "Standard Output Property". | -| [`GetSuccessiveOverRelaxationTolerance`](#generated.RASimulatorRun.GetSuccessiveOverRelaxationTolerance)() | Get the value of "Successive Over Relaxation Tolerance". | -| [`GetTargetGpu`](#generated.RASimulatorRun.GetTargetGpu)() | Get the value of "Target Gpu". | -| [`GetTargetGpus`](#generated.RASimulatorRun.GetTargetGpus)() | | -| [`GetTimeInterval`](#generated.RASimulatorRun.GetTimeInterval)([unit]) | Get the value of "Time Interval". | -| [`GetTimeSet`](#generated.RASimulatorRun.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RASimulatorRun.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RASimulatorRun.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTimestepModel`](#generated.RASimulatorRun.GetTimestepModel)() | Get "Timestep Model" as a string. | -| [`GetTopologyShape`](#generated.RASimulatorRun.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetUse2023R2CellVolumeFractionUpdateApproach`](#generated.RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach)() | Get the value of "Use 2023 R2 Cell Volume Fraction Update Approach". | -| [`GetUse2023R2SourceTermsApproach`](#generated.RASimulatorRun.GetUse2023R2SourceTermsApproach)() | Get the value of "Use 2023 R2 Source Terms Approach". | -| [`GetUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.GetUse3RdPowerForCfdCgm)() | Get the value of "Use 3Rd Power For Cfd Cgm". | -| [`GetUseArraysGrowthRate`](#generated.RASimulatorRun.GetUseArraysGrowthRate)() | Get the value of "Use Arrays Growth Rate". | -| [`GetUseBreakageOverlapFactor`](#generated.RASimulatorRun.GetUseBreakageOverlapFactor)() | Get the value of "Use Breakage Overlap Factor". | -| [`GetUseCompressedFiles`](#generated.RASimulatorRun.GetUseCompressedFiles)() | Get the value of "Use Compressed Files". | -| [`GetUseContactNeighboringDistanceBetweenParticles`](#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles)() | Get the value of "Use Contact Neighboring Distance Between Particles". | -| [`GetUseContactNeighboringDistanceBetweenParticlesAndTriangles`](#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles)() | Get the value of "Use Contact Neighboring Distance Between Particles And Triangles". | -| [`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". | -| [`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". | -| [`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. | -| [`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. | -| [`HasGridFunction`](#generated.RASimulatorRun.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | -| [`HasHtcCalculatedData`](#generated.RASimulatorRun.HasHtcCalculatedData)() | Whether the "HTC" is being calculated. | -| [`IsCellActive`](#generated.RASimulatorRun.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IsCompressedFileEnabled`](#generated.RASimulatorRun.IsCompressedFileEnabled)() | Check if the "Compressed File" is enabled. | -| [`IsDpmBlockingEffectForSinglePhaseSimulationsEnabled`](#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | -| [`IsMoveCfdCellsWithRockyBoundariesEnabled`](#generated.RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled)() | Check if the "Move Cfd Cells With Rocky Boundaries" is enabled. | -| [`IsNegateInitialOverlapsEnabled`](#generated.RASimulatorRun.IsNegateInitialOverlapsEnabled)() | Check if the "Negate Initial Overlaps" is enabled. | -| [`IsSortingDistanceFactorEnabled`](#generated.RASimulatorRun.IsSortingDistanceFactorEnabled)() | Check if the "Sorting Distance Factor" is enabled. | -| [`IsUse3RdPowerForCfdCgmEnabled`](#generated.RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled)() | Check if the "Use 3Rd Power For Cfd Cgm" is enabled. | -| [`IterCellVertices`](#generated.RASimulatorRun.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RASimulatorRun.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RASimulatorRun.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RASimulatorRun.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RASimulatorRun.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RASimulatorRun.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RASimulatorRun.RemoveProcess)() | It is not possible to remove the item "Solver" from the project. | -| [`RestoreOutputPropertiesDefaults`](#generated.RASimulatorRun.RestoreOutputPropertiesDefaults)() | Restore default values of "Output Properties". | -| [`SetArraysGrowthRate`](#generated.RASimulatorRun.SetArraysGrowthRate)(value) | Set the value of "Arrays Growth Rate". | -| [`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. | -| [`SetDeformableMassMatrixType`](#generated.RASimulatorRun.SetDeformableMassMatrixType)(value) | Set the value of "Deformable Mass Matrix Type". | -| [`SetDisableTrianglesOnPeriodicBoundaries`](#generated.RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries)(value) | Set the value of "Disable Triangles On Periodic Boundaries". | -| [`SetDragLimiterFactor`](#generated.RASimulatorRun.SetDragLimiterFactor)(value) | Set the value of "Drag Limiter Factor". | -| [`SetFixedTimestep`](#generated.RASimulatorRun.SetFixedTimestep)(value[, unit]) | Set the value of "Fixed Timestep". | -| [`SetFluentOutputsMultiplier`](#generated.RASimulatorRun.SetFluentOutputsMultiplier)(value) | Set the value of "Fluent Outputs Multiplier". | -| [`SetJointElasticRatio`](#generated.RASimulatorRun.SetJointElasticRatio)(value) | Set the value of "Joint Elastic Ratio". | -| [`SetLinearHystDamp`](#generated.RASimulatorRun.SetLinearHystDamp)(value) | Set the value of "Linear Hyst Damp". | -| [`SetLoadingNSteps`](#generated.RASimulatorRun.SetLoadingNSteps)(value) | Set the value of "Loading N Steps". | -| [`SetMaximumNumberOfIterations`](#generated.RASimulatorRun.SetMaximumNumberOfIterations)(value) | Set the value of "Maximum Number of Iterations". | -| [`SetMinimumLengthDeformationTolerance`](#generated.RASimulatorRun.SetMinimumLengthDeformationTolerance)(value) | Set the value of "Minimum Length Deformation Tolerance". | -| [`SetMinimumVolumeTolerance`](#generated.RASimulatorRun.SetMinimumVolumeTolerance)(value) | Set the value of "Minimum Volume Tolerance". | -| [`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". | -| [`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". | -| [`SetNumberOfProcessors`](#generated.RASimulatorRun.SetNumberOfProcessors)(value) | Set the value of "Number of Processors". | -| [`SetOutputPropertyEnabled`](#generated.RASimulatorRun.SetOutputPropertyEnabled)(root_key, ...) | Deprecated: Use SetStandardOutputPropertyEnabled instead. | -| [`SetOutputRootEnabled`](#generated.RASimulatorRun.SetOutputRootEnabled)(root_key, enabled) | Deprecated: Use SetStandardOutputPropertyEnabled instead. | -| [`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". | -| [`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". | -| [`SetStandardOutputPropertyEnabled`](#generated.RASimulatorRun.SetStandardOutputPropertyEnabled)(...) | Set enable state of given "Standard Output Property". | -| [`SetSuccessiveOverRelaxationTolerance`](#generated.RASimulatorRun.SetSuccessiveOverRelaxationTolerance)(value) | Set the value of "Successive Over Relaxation Tolerance". | -| [`SetTargetGpu`](#generated.RASimulatorRun.SetTargetGpu)(value) | Set the value of "Target Gpu". | -| [`SetTargetGpus`](#generated.RASimulatorRun.SetTargetGpus)(gpus) | It will configure the IDs of GPUs that will be used in simulation based on the list of IDs or names of GPUs passed. | -| [`SetTimeConfiguration`](#generated.RASimulatorRun.SetTimeConfiguration)(duration, time_interval) | Shortcut to set both the simulation's duration and its time interval. | -| [`SetTimeInterval`](#generated.RASimulatorRun.SetTimeInterval)(value[, unit]) | Set the value of "Time Interval". | -| [`SetTimestepModel`](#generated.RASimulatorRun.SetTimestepModel)(value) | Set the value of "Timestep Model". | -| [`SetUse2023R2CellVolumeFractionUpdateApproach`](#generated.RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach)(value) | Set the value of "Use 2023 R2 Cell Volume Fraction Update Approach". | -| [`SetUse2023R2SourceTermsApproach`](#generated.RASimulatorRun.SetUse2023R2SourceTermsApproach)(value) | Set the value of "Use 2023 R2 Source Terms Approach". | -| [`SetUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.SetUse3RdPowerForCfdCgm)(value) | Set the value of "Use 3Rd Power For Cfd Cgm". | -| [`SetUseArraysGrowthRate`](#generated.RASimulatorRun.SetUseArraysGrowthRate)(value) | Set the value of "Use Arrays Growth Rate". | -| [`SetUseBreakageOverlapFactor`](#generated.RASimulatorRun.SetUseBreakageOverlapFactor)(value) | Set the value of "Use Breakage Overlap Factor". | -| [`SetUseCompressedFiles`](#generated.RASimulatorRun.SetUseCompressedFiles)(value) | Set the value of "Use Compressed Files". | -| [`SetUseContactNeighboringDistanceBetweenParticles`](#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles)(value) | Set the value of "Use Contact Neighboring Distance Between Particles". | -| [`SetUseContactNeighboringDistanceBetweenParticlesAndTriangles`](#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles)(value) | Set the value of "Use Contact Neighboring Distance Between Particles And Triangles". | -| [`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". | -| [`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". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableCompressedFile() - -Set the value of “Compressed File” to False. - - - -#### DisableDpmBlockingEffectForSinglePhaseSimulations() - -The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky -since 25R2. - - - -#### DisableFEMForces() - -Disables the “FEM Forces” calculations. - - - -#### DisableHtcCalculator() - -Disables the “HTC” calculations. - - - -#### DisableMoveCfdCellsWithRockyBoundaries() - -Set the value of “Move Cfd Cells With Rocky Boundaries” to False. - - - -#### DisableNegateInitialOverlaps() - -Set the value of “Negate Initial Overlaps” to False. - - - -#### DisableSortingDistanceFactor() - -Set the value of “Sorting Distance Factor” to False. - - - -#### DisableUse3RdPowerForCfdCgm() - -Set the value of “Use 3Rd Power For Cfd Cgm” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableCompressedFile() - -Set the value of “Compressed File” to True. - - - -#### EnableDpmBlockingEffectForSinglePhaseSimulations() - -The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky -since 25R2. - - - -#### EnableFEMForces() - -Enables the “FEM Forces” calculations. - - - -#### EnableHtcCalculator() - -Enables the “HTC” calculations. - - - -#### EnableMoveCfdCellsWithRockyBoundaries() - -Set the value of “Move Cfd Cells With Rocky Boundaries” to True. - - - -#### EnableNegateInitialOverlaps() - -Set the value of “Negate Initial Overlaps” to True. - - - -#### EnableSortingDistanceFactor() - -Set the value of “Sorting Distance Factor” to True. - - - -#### EnableUse3RdPowerForCfdCgm() - -Set the value of “Use 3Rd Power For Cfd Cgm” to True. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetArraysGrowthRate() - -Get the value of “Arrays Growth Rate”. - - - -#### *static* GetAvailableModulesOutputProperties() - -* **Returns:** - The available “Modules Output Properties”. - - - -#### GetAvailableOutputRootProperties(root_key: str) - -Deprecated: Use GetAvailableStandardOutputProperties instead. - - - -#### GetAvailableOutputRoots() - -Deprecated: Use GetAvailableStandardOutputProperties instead. - - - -#### *static* GetAvailableStandardOutputProperties() - -* **Returns:** - The available “Standard Output Properties”. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetBreakageDelayAfterRelease(unit: str | None = None) - -Get the value of “Breakage Delay After Release”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetBreakageOverlapFactor() - -Get the value of “Breakage Overlap Factor”. - - - -#### GetBreakageStart(unit: str | None = None) - -Get the value of “Breakage Start”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Get the value of “Contact Neighboring Distance Between Particles”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetContactNeighboringDistanceBetweenParticlesAndTriangles(unit: str | None = None) - -Get the value of “Contact Neighboring Distance Between Particles And Triangles”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDeformableMassMatrixType() - -Get “Deformable Mass Matrix Type” as a string. - -* **Returns:** - The returned value will be one of [‘lumped’, ‘consistent’]. - - - -#### GetDisableTrianglesOnPeriodicBoundaries() - -Get the value of “Disable Triangles On Periodic Boundaries”. - - - -#### GetDragLimiterFactor() - -Get the value of “Drag Limiter Factor”. - - - -#### 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. - - - -#### GetFixedTimestep(unit: str | None = None) - -Get the value of “Fixed Timestep”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetFluentOutputsMultiplier() - -Get the value of “Fluent Outputs Multiplier”. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetJointElasticRatio() - -Get the value of “Joint Elastic Ratio”. - - - -#### GetLinearHystDamp() - -Get the value of “Linear Hyst Damp”. - - - -#### GetLoadingNSteps() - -Get the value of “Loading N Steps”. - - - -#### GetMaximumNumberOfIterations() - -Get the value of “Maximum Number of Iterations”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetMinimumLengthDeformationTolerance() - -Get the value of “Minimum Length Deformation Tolerance”. - - - -#### GetMinimumVolumeTolerance() - -Get the value of “Minimum Volume Tolerance”. - - - -#### GetModulesOutputPropertiesData() - -* **Returns:** - The current value of “Modules Output Properties”. - - - -#### GetModulesOutputPropertyEnabled(\*output_property: str) - -Retrieve enable state of given “Modules Output Property”. - -* **Parameters:** - **output_property** – The output property name. - - - -#### GetMoveCfdCellsWithRockyBoundaries() - -Get the value of “Move Cfd Cells With Rocky Boundaries”. - - - -#### GetMultiGpuSlicingDirection() - -Get “Multi Gpu Slicing Direction” as a string. - -* **Returns:** - The returned value will be one of [‘X_Parallel’, ‘Y_Parallel’, ‘Z_Parallel’]. - - - -#### GetNegateInitialOverlaps() - -Get the value of “Negate Initial Overlaps”. - - - -#### GetNeighborSearchModel() - -Get “Neighbor Search Model” as a string. - -* **Returns:** - The returned value will be one of [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfProcessors() - -Get the value of “Number of Processors”. - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputPropertyEnabled(root_key: str, property_name: str) - -Deprecated: Use GetStandardOutputPropertyEnabled instead. - - - -#### GetOutputRootEnabled(root_key: str) - -Deprecated: Use GetStandardOutputPropertyEnabled instead. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetOverRelaxationCoefficient() - -Get the value of “Over Relaxation Coefficient”. - - - -#### GetOverlapParticlesDelay(unit: str | None = None) - -Get the value of “Overlap Particles Delay”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetParticleSizeLimitForReordering(unit: str | None = None) - -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”. - - - -#### GetRefineConcaveSearch() - -Get the value of “Refine Concave Search”. - - - -#### GetReleaseParticlesWithoutOverlapCheck() - -Get the value of “Release Particles Without Overlap Check”. - - - -#### GetResetOnlyPhysicalContactsData() - -Get the value of “Reset Only Physical Contacts Data”. - - - -#### GetResumeDataFrequency() - -Get the value of “Resume Data Frequency”. - - - -#### GetSimulationDuration(unit: str | None = None) - -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() - -Get the value of “Sorting Distance Factor”. - - - -#### GetSpecialReorderingForWidePsd() - -Get the value of “Special Reordering For Wide Psd”. - - - -#### GetStandardOutputPropertiesData() - -* **Returns:** - The current value of “Standard Output Properties”. - - - -#### GetStandardOutputPropertyEnabled(\*output_property: str) - -Retrieve enable state of given “Standard Output Property”. - -* **Parameters:** - **output_property** – The output property name. - - - -#### GetSuccessiveOverRelaxationTolerance() - -Get the value of “Successive Over Relaxation Tolerance”. - - - -#### GetTargetGpu() - -Get the value of “Target Gpu”. - - - -#### GetTargetGpus() - -* **Returns:** - A list of IDs of the GPUs currently selected for Multi GPU simulation. - - - -#### GetTimeInterval(unit: str | None = None) - -Get the value of “Time Interval”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTimestepModel() - -Get “Timestep Model” as a string. - -* **Returns:** - The returned value will be one of [‘constant’, ‘variable’]. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetUse2023R2CellVolumeFractionUpdateApproach() - -Get the value of “Use 2023 R2 Cell Volume Fraction Update Approach”. - - - -#### GetUse2023R2SourceTermsApproach() - -Get the value of “Use 2023 R2 Source Terms Approach”. - - - -#### GetUse3RdPowerForCfdCgm() - -Get the value of “Use 3Rd Power For Cfd Cgm”. - - - -#### GetUseArraysGrowthRate() - -Get the value of “Use Arrays Growth Rate”. - - - -#### GetUseBreakageOverlapFactor() - -Get the value of “Use Breakage Overlap Factor”. - - - -#### GetUseCompressedFiles() - -Get the value of “Use Compressed Files”. - - - -#### GetUseContactNeighboringDistanceBetweenParticles() - -Get the value of “Use Contact Neighboring Distance Between Particles”. - - - -#### GetUseContactNeighboringDistanceBetweenParticlesAndTriangles() - -Get the value of “Use Contact Neighboring Distance Between Particles And Triangles”. - - - -#### GetUseDpmBlockingEffectForSinglePhaseSimulations() - -The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky -since 25R2. - - - -#### GetUseDragLimiterFactor() - -Get the value of “Use Drag Limiter Factor”. - - - -#### GetUseFixedTimestep() - -Get the value of “Use Fixed Timestep”. - - - -#### GetUseNonRoundTorqueCorrection() - -Get the value of “Use Non Round Torque Correction”. - - - -#### GetUseSortingDistanceFactor() - -Get the value of “Use Sorting Distance Factor”. - - - -#### GetValidDeformableMassMatrixTypeValues() - -Get a list of all possible values for “Deformable Mass Matrix Type”. - -* **Returns:** - The returned list is [‘lumped’, ‘consistent’]. - - - -#### GetValidMultiGpuSlicingDirectionValues() - -Get a list of all possible values for “Multi Gpu Slicing Direction”. - -* **Returns:** - The returned list is [‘X_Parallel’, ‘Y_Parallel’, ‘Z_Parallel’]. - - - -#### GetValidNeighborSearchModelValues() - -Get a list of all possible values for “Neighbor Search Model”. - -* **Returns:** - The returned list is [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. - - - -#### GetValidSimulationTargetValues() - -Get a list of all possible values for “Simulation Target”. - -* **Returns:** - The returned list is [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. - - - -#### GetValidTimestepModelValues() - -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. - - - -#### GetWearEnergySpectraBreakageStart(unit: str | None = None) - -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. - - - -#### GetWearGeometryUpdateInterval(unit: str | None = None) - -Get the value of “Wear Geometry Update Interval”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### GetWearStart(unit: str | None = None) - -Get the value of “Wear Start”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - - -#### HasFEMForcesEnabled() - -Whether the simulation is configured to collect forces for FEM analysis. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### HasHtcCalculatedData() - -Whether the “HTC” is being calculated. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsCompressedFileEnabled() - -Check if the “Compressed File” is enabled. - - - -#### IsDpmBlockingEffectForSinglePhaseSimulationsEnabled() - -The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky -since 25R2. - - - -#### IsMoveCfdCellsWithRockyBoundariesEnabled() - -Check if the “Move Cfd Cells With Rocky Boundaries” is enabled. - - - -#### IsNegateInitialOverlapsEnabled() - -Check if the “Negate Initial Overlaps” is enabled. - - - -#### IsSortingDistanceFactorEnabled() - -Check if the “Sorting Distance Factor” is enabled. - - - -#### IsUse3RdPowerForCfdCgmEnabled() - -Check if the “Use 3Rd Power For Cfd Cgm” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -It is not possible to remove the item “Solver” from the project. It’s a standard Rocky -item in project. - - - -#### RestoreOutputPropertiesDefaults() - -Restore default values of “Output Properties”. - - - -#### SetArraysGrowthRate(value: str | float) - -Set the value of “Arrays Growth Rate”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetBreakageDelayAfterRelease(value: str | float, unit: str | None = None) - -Set the value of “Breakage Delay After Release”. - -* **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”. - - - -#### SetBreakageOverlapFactor(value: str | float) - -Set the value of “Breakage Overlap Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetBreakageStart(value: str | float, unit: str | None = None) - -Set the value of “Breakage Start”. - -* **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”. - - - -#### SetCollectForcesForFemAnalysis(value: bool) - -Deprecated: Use this method from RAStudy instead - - - -#### SetContactNeighboringDistanceBetweenParticles(value: str | float, unit: str | None = None) - -Set the value of “Contact Neighboring Distance Between Particles”. - -* **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”. - - - -#### SetContactNeighboringDistanceBetweenParticlesAndTriangles(value: str | float, unit: str | None = None) - -Set the value of “Contact Neighboring Distance Between Particles And Triangles”. - -* **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”. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDeformableMassMatrixType(value: str) - -Set the value of “Deformable Mass Matrix Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘lumped’, ‘consistent’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Deformable Mass Matrix Type” option. - - - -#### SetDisableTrianglesOnPeriodicBoundaries(value: bool) - -Set the value of “Disable Triangles On Periodic Boundaries”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetDragLimiterFactor(value: str | float) - -Set the value of “Drag Limiter Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetFixedTimestep(value: str | float, unit: str | None = None) - -Set the value of “Fixed Timestep”. - -* **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”. - - - -#### SetFluentOutputsMultiplier(value: int) - -Set the value of “Fluent Outputs Multiplier”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetJointElasticRatio(value: str | float) - -Set the value of “Joint Elastic Ratio”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetLinearHystDamp(value: str | float) - -Set the value of “Linear Hyst Damp”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetLoadingNSteps(value: str | int) - -Set the value of “Loading N Steps”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMaximumNumberOfIterations(value: str | int) - -Set the value of “Maximum Number of Iterations”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetMinimumLengthDeformationTolerance(value: str | float) - -Set the value of “Minimum Length Deformation Tolerance”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetMinimumVolumeTolerance(value: str | float) - -Set the value of “Minimum Volume Tolerance”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetModulesOutputPropertiesData(data_dict: dict) - -Set the current value of “Modules Output Properties”. - -* **Parameters:** - **data_dict** – The data dictionary to set. - - - -#### SetModulesOutputPropertyEnabled(\*output_property: str, enabled: bool) - -Set enable state of given “Modules Output Property”. - -* **Parameters:** - * **output_property** – The output property name. - * **enabled** – The enable state of given “Modules Output Property”. - - - -#### SetMoveCfdCellsWithRockyBoundaries(value: bool) - -Set the value of “Move Cfd Cells With Rocky Boundaries”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetMultiGpuSlicingDirection(value: str) - -Set the value of “Multi Gpu Slicing Direction”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘X_Parallel’, ‘Y_Parallel’, ‘Z_Parallel’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Multi Gpu Slicing Direction” option. - - - -#### SetNegateInitialOverlaps(value: bool) - -Set the value of “Negate Initial Overlaps”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetNeighborSearchModel(value: str) - -Set the value of “Neighbor Search Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Neighbor Search Model” option. - - - -#### SetNumberOfProcessors(value: str | int) - -Set the value of “Number of Processors”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetOutputPropertyEnabled(root_key: str, property_name: str, enabled: bool) - -Deprecated: Use SetStandardOutputPropertyEnabled instead. - - - -#### SetOutputRootEnabled(root_key: str, enabled: bool) - -Deprecated: Use SetStandardOutputPropertyEnabled instead. - - - -#### SetOverRelaxationCoefficient(value: str | float) - -Set the value of “Over Relaxation Coefficient”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetOverlapParticlesDelay(value: str | float, unit: str | None = None) - -Set the value of “Overlap Particles Delay”. - -* **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”. - - - -#### SetParticleSizeLimitForReordering(value: str | float, unit: str | None = None) - -Set the value of “Particle Size Limit For Reordering”. - -* **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”. - - - -#### SetRefineConcaveSearch(value: bool) - -Set the value of “Refine Concave Search”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetReleaseParticlesWithoutOverlapCheck(value: bool) - -Set the value of “Release Particles Without Overlap Check”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetResetOnlyPhysicalContactsData(value: bool) - -Set the value of “Reset Only Physical Contacts Data”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetResumeDataFrequency(value: str | int) - -Set the value of “Resume Data Frequency”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetSimulationDuration(value: str | float, unit: str | None = None) - -Set the value of “Simulation 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”. - - - -#### 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) - -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) - -Set the value of “Sorting Distance Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSpecialReorderingForWidePsd(value: bool) - -Set the value of “Special Reordering For Wide Psd”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetStandardOutputPropertiesData(data_dict: dict) - -Set the current value of “Standard Output Properties”. - -* **Parameters:** - **data_dict** – The data dictionary to set. - - - -#### SetStandardOutputPropertyEnabled(\*output_property: str, enabled: bool) - -Set enable state of given “Standard Output Property”. - -* **Parameters:** - * **output_property** – The output property name. - * **enabled** – The enable state of given “Standard Output Property”. - - - -#### SetSuccessiveOverRelaxationTolerance(value: str | float) - -Set the value of “Successive Over Relaxation Tolerance”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetTargetGpu(value: str | int) - -Set the value of “Target Gpu”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. - - - -#### SetTargetGpus(gpus: list[int | str]) - -It will configure the IDs of GPUs that will be used in simulation based on the list of IDs or names of GPUs -passed. - -* **Parameters:** - **gpus** – List with IDs or names of GPUs to be used in simulation. - For example in the name “1 - Geforce GTX 980”, the ID is 1 and the name is “1 - Geforce GTX 980”. - - - -#### SetTimeConfiguration(duration: float, time_interval: float) - -Shortcut to set both the simulation’s duration and its time interval. - -* **Parameters:** - * **duration** – The simulation duration (in seconds). - * **time_interval** – The simulation time interval (in seconds). - - - -#### SetTimeInterval(value: str | float, unit: str | None = None) - -Set the value of “Time Interval”. - -* **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”. - - - -#### SetTimestepModel(value: str) - -Set the value of “Timestep Model”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘constant’, ‘variable’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Timestep Model” option. - - - -#### SetUse2023R2CellVolumeFractionUpdateApproach(value: bool) - -Set the value of “Use 2023 R2 Cell Volume Fraction Update Approach”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUse2023R2SourceTermsApproach(value: bool) - -Set the value of “Use 2023 R2 Source Terms Approach”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUse3RdPowerForCfdCgm(value: bool) - -Set the value of “Use 3Rd Power For Cfd Cgm”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseArraysGrowthRate(value: bool) - -Set the value of “Use Arrays Growth Rate”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseBreakageOverlapFactor(value: bool) - -Set the value of “Use Breakage Overlap Factor”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseCompressedFiles(value: bool) - -Set the value of “Use Compressed Files”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseContactNeighboringDistanceBetweenParticles(value: bool) - -Set the value of “Use Contact Neighboring Distance Between Particles”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseContactNeighboringDistanceBetweenParticlesAndTriangles(value: bool) - -Set the value of “Use Contact Neighboring Distance Between Particles And Triangles”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseDpmBlockingEffectForSinglePhaseSimulations(value: bool) - -The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky -since 25R2. - - - -#### SetUseDragLimiterFactor(value: bool) - -Set the value of “Use Drag Limiter Factor”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseFixedTimestep(value: bool) - -Set the value of “Use Fixed Timestep”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseNonRoundTorqueCorrection(value: bool) - -Set the value of “Use Non Round Torque Correction”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetUseSortingDistanceFactor(value: bool) - -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) - -Set the value of “Wear Geometry Update Interval”. - -* **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”. - - - -#### SetWearStart(value: str | float, unit: str | None = None) - -Set the value of “Wear Start”. - -* **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”. + + +# RASimulatorRun + + + + + + +### *class* RASimulatorRun + +Rocky PrePost Scripting wrapper for solver settings. + +This wrapper corresponds to the “Solver” item on a project’s data tree. Access it from the +[`RAStudy`](RAStudy.md#generated.RAStudy) with: + +```python +simulator_run = study.GetSimulatorRun() +``` + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RASimulatorRun.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RASimulatorRun.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.RASimulatorRun.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RASimulatorRun.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RASimulatorRun.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.RASimulatorRun.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RASimulatorRun.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASimulatorRun.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.RASimulatorRun.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). | +| [`DisableCompressedFile`](#generated.RASimulatorRun.DisableCompressedFile)() | Set the value of "Compressed File" to False. | +| [`DisableDpmBlockingEffectForSinglePhaseSimulations`](#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | +| [`DisableFEMForces`](#generated.RASimulatorRun.DisableFEMForces)() | Disables the "FEM Forces" calculations. | +| [`DisableHtcCalculator`](#generated.RASimulatorRun.DisableHtcCalculator)() | Disables the "HTC" calculations. | +| [`DisableMoveCfdCellsWithRockyBoundaries`](#generated.RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries)() | Set the value of "Move Cfd Cells With Rocky Boundaries" to False. | +| [`DisableNegateInitialOverlaps`](#generated.RASimulatorRun.DisableNegateInitialOverlaps)() | Set the value of "Negate Initial Overlaps" to False. | +| [`DisableSortingDistanceFactor`](#generated.RASimulatorRun.DisableSortingDistanceFactor)() | Set the value of "Sorting Distance Factor" to False. | +| [`DisableUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.DisableUse3RdPowerForCfdCgm)() | Set the value of "Use 3Rd Power For Cfd Cgm" to False. | +| [`EditCustomCurve`](#generated.RASimulatorRun.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.RASimulatorRun.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. | +| [`EnableCompressedFile`](#generated.RASimulatorRun.EnableCompressedFile)() | Set the value of "Compressed File" to True. | +| [`EnableDpmBlockingEffectForSinglePhaseSimulations`](#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | +| [`EnableFEMForces`](#generated.RASimulatorRun.EnableFEMForces)() | Enables the "FEM Forces" calculations. | +| [`EnableHtcCalculator`](#generated.RASimulatorRun.EnableHtcCalculator)() | Enables the "HTC" calculations. | +| [`EnableMoveCfdCellsWithRockyBoundaries`](#generated.RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries)() | Set the value of "Move Cfd Cells With Rocky Boundaries" to True. | +| [`EnableNegateInitialOverlaps`](#generated.RASimulatorRun.EnableNegateInitialOverlaps)() | Set the value of "Negate Initial Overlaps" to True. | +| [`EnableSortingDistanceFactor`](#generated.RASimulatorRun.EnableSortingDistanceFactor)() | Set the value of "Sorting Distance Factor" to True. | +| [`EnableUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.EnableUse3RdPowerForCfdCgm)() | Set the value of "Use 3Rd Power For Cfd Cgm" to True. | +| [`GetActivesArray`](#generated.RASimulatorRun.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetArraysGrowthRate`](#generated.RASimulatorRun.GetArraysGrowthRate)() | Get the value of "Arrays Growth Rate". | +| [`GetAvailableModulesOutputProperties`](#generated.RASimulatorRun.GetAvailableModulesOutputProperties)() | | +| [`GetAvailableOutputRootProperties`](#generated.RASimulatorRun.GetAvailableOutputRootProperties)(root_key) | Deprecated: Use GetAvailableStandardOutputProperties instead. | +| [`GetAvailableOutputRoots`](#generated.RASimulatorRun.GetAvailableOutputRoots)() | Deprecated: Use GetAvailableStandardOutputProperties instead. | +| [`GetAvailableStandardOutputProperties`](#generated.RASimulatorRun.GetAvailableStandardOutputProperties)() | | +| [`GetBoundingBox`](#generated.RASimulatorRun.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetBreakageDelayAfterRelease`](#generated.RASimulatorRun.GetBreakageDelayAfterRelease)([unit]) | Get the value of "Breakage Delay After Release". | +| [`GetBreakageOverlapFactor`](#generated.RASimulatorRun.GetBreakageOverlapFactor)() | Get the value of "Breakage Overlap Factor". | +| [`GetBreakageStart`](#generated.RASimulatorRun.GetBreakageStart)([unit]) | Get the value of "Breakage Start". | +| [`GetCellAreaAsArray`](#generated.RASimulatorRun.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RASimulatorRun.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RASimulatorRun.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RASimulatorRun.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RASimulatorRun.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`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. | +| [`GetCurveNames`](#generated.RASimulatorRun.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RASimulatorRun.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetDeformableMassMatrixType`](#generated.RASimulatorRun.GetDeformableMassMatrixType)() | Get "Deformable Mass Matrix Type" as a string. | +| [`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. | +| [`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. | +| [`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. | +| [`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". | +| [`GetMaximumNumberOfIterations`](#generated.RASimulatorRun.GetMaximumNumberOfIterations)() | Get the value of "Maximum Number of Iterations". | +| [`GetMeshColoring`](#generated.RASimulatorRun.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMinimumLengthDeformationTolerance`](#generated.RASimulatorRun.GetMinimumLengthDeformationTolerance)() | Get the value of "Minimum Length Deformation Tolerance". | +| [`GetMinimumVolumeTolerance`](#generated.RASimulatorRun.GetMinimumVolumeTolerance)() | Get the value of "Minimum Volume Tolerance". | +| [`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". | +| [`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. | +| [`GetNumberOfCells`](#generated.RASimulatorRun.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RASimulatorRun.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfProcessors`](#generated.RASimulatorRun.GetNumberOfProcessors)() | Get the value of "Number of Processors". | +| [`GetNumpyCurve`](#generated.RASimulatorRun.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputPropertyEnabled`](#generated.RASimulatorRun.GetOutputPropertyEnabled)(root_key, property_name) | Deprecated: Use GetStandardOutputPropertyEnabled instead. | +| [`GetOutputRootEnabled`](#generated.RASimulatorRun.GetOutputRootEnabled)(root_key) | Deprecated: Use GetStandardOutputPropertyEnabled instead. | +| [`GetOutputVariableValue`](#generated.RASimulatorRun.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`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". | +| [`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)() | | +| [`GetStandardOutputPropertyEnabled`](#generated.RASimulatorRun.GetStandardOutputPropertyEnabled)(...) | Retrieve enable state of given "Standard Output Property". | +| [`GetSuccessiveOverRelaxationTolerance`](#generated.RASimulatorRun.GetSuccessiveOverRelaxationTolerance)() | Get the value of "Successive Over Relaxation Tolerance". | +| [`GetTargetGpu`](#generated.RASimulatorRun.GetTargetGpu)() | Get the value of "Target Gpu". | +| [`GetTargetGpus`](#generated.RASimulatorRun.GetTargetGpus)() | | +| [`GetTimeInterval`](#generated.RASimulatorRun.GetTimeInterval)([unit]) | Get the value of "Time Interval". | +| [`GetTimeSet`](#generated.RASimulatorRun.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RASimulatorRun.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RASimulatorRun.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTimestepModel`](#generated.RASimulatorRun.GetTimestepModel)() | Get "Timestep Model" as a string. | +| [`GetTopologyShape`](#generated.RASimulatorRun.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetUse2023R2CellVolumeFractionUpdateApproach`](#generated.RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach)() | Get the value of "Use 2023 R2 Cell Volume Fraction Update Approach". | +| [`GetUse2023R2SourceTermsApproach`](#generated.RASimulatorRun.GetUse2023R2SourceTermsApproach)() | Get the value of "Use 2023 R2 Source Terms Approach". | +| [`GetUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.GetUse3RdPowerForCfdCgm)() | Get the value of "Use 3Rd Power For Cfd Cgm". | +| [`GetUseArraysGrowthRate`](#generated.RASimulatorRun.GetUseArraysGrowthRate)() | Get the value of "Use Arrays Growth Rate". | +| [`GetUseBreakageOverlapFactor`](#generated.RASimulatorRun.GetUseBreakageOverlapFactor)() | Get the value of "Use Breakage Overlap Factor". | +| [`GetUseCompressedFiles`](#generated.RASimulatorRun.GetUseCompressedFiles)() | Get the value of "Use Compressed Files". | +| [`GetUseContactNeighboringDistanceBetweenParticles`](#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles)() | Get the value of "Use Contact Neighboring Distance Between Particles". | +| [`GetUseContactNeighboringDistanceBetweenParticlesAndTriangles`](#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles)() | Get the value of "Use Contact Neighboring Distance Between Particles And Triangles". | +| [`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". | +| [`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". | +| [`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. | +| [`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. | +| [`HasGridFunction`](#generated.RASimulatorRun.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | +| [`HasHtcCalculatedData`](#generated.RASimulatorRun.HasHtcCalculatedData)() | Whether the "HTC" is being calculated. | +| [`IsCellActive`](#generated.RASimulatorRun.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IsCompressedFileEnabled`](#generated.RASimulatorRun.IsCompressedFileEnabled)() | Check if the "Compressed File" is enabled. | +| [`IsDpmBlockingEffectForSinglePhaseSimulationsEnabled`](#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | +| [`IsMoveCfdCellsWithRockyBoundariesEnabled`](#generated.RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled)() | Check if the "Move Cfd Cells With Rocky Boundaries" is enabled. | +| [`IsNegateInitialOverlapsEnabled`](#generated.RASimulatorRun.IsNegateInitialOverlapsEnabled)() | Check if the "Negate Initial Overlaps" is enabled. | +| [`IsSortingDistanceFactorEnabled`](#generated.RASimulatorRun.IsSortingDistanceFactorEnabled)() | Check if the "Sorting Distance Factor" is enabled. | +| [`IsUse3RdPowerForCfdCgmEnabled`](#generated.RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled)() | Check if the "Use 3Rd Power For Cfd Cgm" is enabled. | +| [`IterCellVertices`](#generated.RASimulatorRun.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RASimulatorRun.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RASimulatorRun.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RASimulatorRun.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RASimulatorRun.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RASimulatorRun.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RASimulatorRun.RemoveProcess)() | It is not possible to remove the item "Solver" from the project. | +| [`RestoreOutputPropertiesDefaults`](#generated.RASimulatorRun.RestoreOutputPropertiesDefaults)() | Restore default values of "Output Properties". | +| [`SetArraysGrowthRate`](#generated.RASimulatorRun.SetArraysGrowthRate)(value) | Set the value of "Arrays Growth Rate". | +| [`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. | +| [`SetDeformableMassMatrixType`](#generated.RASimulatorRun.SetDeformableMassMatrixType)(value) | Set the value of "Deformable Mass Matrix Type". | +| [`SetDisableTrianglesOnPeriodicBoundaries`](#generated.RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries)(value) | Set the value of "Disable Triangles On Periodic Boundaries". | +| [`SetDragLimiterFactor`](#generated.RASimulatorRun.SetDragLimiterFactor)(value) | Set the value of "Drag Limiter Factor". | +| [`SetFixedTimestep`](#generated.RASimulatorRun.SetFixedTimestep)(value[, unit]) | Set the value of "Fixed Timestep". | +| [`SetFluentOutputsMultiplier`](#generated.RASimulatorRun.SetFluentOutputsMultiplier)(value) | Set the value of "Fluent Outputs Multiplier". | +| [`SetJointElasticRatio`](#generated.RASimulatorRun.SetJointElasticRatio)(value) | Set the value of "Joint Elastic Ratio". | +| [`SetLinearHystDamp`](#generated.RASimulatorRun.SetLinearHystDamp)(value) | Set the value of "Linear Hyst Damp". | +| [`SetLoadingNSteps`](#generated.RASimulatorRun.SetLoadingNSteps)(value) | Set the value of "Loading N Steps". | +| [`SetMaximumNumberOfIterations`](#generated.RASimulatorRun.SetMaximumNumberOfIterations)(value) | Set the value of "Maximum Number of Iterations". | +| [`SetMinimumLengthDeformationTolerance`](#generated.RASimulatorRun.SetMinimumLengthDeformationTolerance)(value) | Set the value of "Minimum Length Deformation Tolerance". | +| [`SetMinimumVolumeTolerance`](#generated.RASimulatorRun.SetMinimumVolumeTolerance)(value) | Set the value of "Minimum Volume Tolerance". | +| [`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". | +| [`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". | +| [`SetNumberOfProcessors`](#generated.RASimulatorRun.SetNumberOfProcessors)(value) | Set the value of "Number of Processors". | +| [`SetOutputPropertyEnabled`](#generated.RASimulatorRun.SetOutputPropertyEnabled)(root_key, ...) | Deprecated: Use SetStandardOutputPropertyEnabled instead. | +| [`SetOutputRootEnabled`](#generated.RASimulatorRun.SetOutputRootEnabled)(root_key, enabled) | Deprecated: Use SetStandardOutputPropertyEnabled instead. | +| [`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". | +| [`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". | +| [`SetStandardOutputPropertyEnabled`](#generated.RASimulatorRun.SetStandardOutputPropertyEnabled)(...) | Set enable state of given "Standard Output Property". | +| [`SetSuccessiveOverRelaxationTolerance`](#generated.RASimulatorRun.SetSuccessiveOverRelaxationTolerance)(value) | Set the value of "Successive Over Relaxation Tolerance". | +| [`SetTargetGpu`](#generated.RASimulatorRun.SetTargetGpu)(value) | Set the value of "Target Gpu". | +| [`SetTargetGpus`](#generated.RASimulatorRun.SetTargetGpus)(gpus) | It will configure the IDs of GPUs that will be used in simulation based on the list of IDs or names of GPUs passed. | +| [`SetTimeConfiguration`](#generated.RASimulatorRun.SetTimeConfiguration)(duration, time_interval) | Shortcut to set both the simulation's duration and its time interval. | +| [`SetTimeInterval`](#generated.RASimulatorRun.SetTimeInterval)(value[, unit]) | Set the value of "Time Interval". | +| [`SetTimestepModel`](#generated.RASimulatorRun.SetTimestepModel)(value) | Set the value of "Timestep Model". | +| [`SetUse2023R2CellVolumeFractionUpdateApproach`](#generated.RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach)(value) | Set the value of "Use 2023 R2 Cell Volume Fraction Update Approach". | +| [`SetUse2023R2SourceTermsApproach`](#generated.RASimulatorRun.SetUse2023R2SourceTermsApproach)(value) | Set the value of "Use 2023 R2 Source Terms Approach". | +| [`SetUse3RdPowerForCfdCgm`](#generated.RASimulatorRun.SetUse3RdPowerForCfdCgm)(value) | Set the value of "Use 3Rd Power For Cfd Cgm". | +| [`SetUseArraysGrowthRate`](#generated.RASimulatorRun.SetUseArraysGrowthRate)(value) | Set the value of "Use Arrays Growth Rate". | +| [`SetUseBreakageOverlapFactor`](#generated.RASimulatorRun.SetUseBreakageOverlapFactor)(value) | Set the value of "Use Breakage Overlap Factor". | +| [`SetUseCompressedFiles`](#generated.RASimulatorRun.SetUseCompressedFiles)(value) | Set the value of "Use Compressed Files". | +| [`SetUseContactNeighboringDistanceBetweenParticles`](#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles)(value) | Set the value of "Use Contact Neighboring Distance Between Particles". | +| [`SetUseContactNeighboringDistanceBetweenParticlesAndTriangles`](#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles)(value) | Set the value of "Use Contact Neighboring Distance Between Particles And Triangles". | +| [`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". | +| [`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". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableCompressedFile() + +Set the value of “Compressed File” to False. + + + +#### DisableDpmBlockingEffectForSinglePhaseSimulations() + +The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky +since 25R2. + + + +#### DisableFEMForces() + +Disables the “FEM Forces” calculations. + + + +#### DisableHtcCalculator() + +Disables the “HTC” calculations. + + + +#### DisableMoveCfdCellsWithRockyBoundaries() + +Set the value of “Move Cfd Cells With Rocky Boundaries” to False. + + + +#### DisableNegateInitialOverlaps() + +Set the value of “Negate Initial Overlaps” to False. + + + +#### DisableSortingDistanceFactor() + +Set the value of “Sorting Distance Factor” to False. + + + +#### DisableUse3RdPowerForCfdCgm() + +Set the value of “Use 3Rd Power For Cfd Cgm” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableCompressedFile() + +Set the value of “Compressed File” to True. + + + +#### EnableDpmBlockingEffectForSinglePhaseSimulations() + +The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky +since 25R2. + + + +#### EnableFEMForces() + +Enables the “FEM Forces” calculations. + + + +#### EnableHtcCalculator() + +Enables the “HTC” calculations. + + + +#### EnableMoveCfdCellsWithRockyBoundaries() + +Set the value of “Move Cfd Cells With Rocky Boundaries” to True. + + + +#### EnableNegateInitialOverlaps() + +Set the value of “Negate Initial Overlaps” to True. + + + +#### EnableSortingDistanceFactor() + +Set the value of “Sorting Distance Factor” to True. + + + +#### EnableUse3RdPowerForCfdCgm() + +Set the value of “Use 3Rd Power For Cfd Cgm” to True. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetArraysGrowthRate() + +Get the value of “Arrays Growth Rate”. + + + +#### *static* GetAvailableModulesOutputProperties() + +* **Returns:** + The available “Modules Output Properties”. + + + +#### GetAvailableOutputRootProperties(root_key: str) + +Deprecated: Use GetAvailableStandardOutputProperties instead. + + + +#### GetAvailableOutputRoots() + +Deprecated: Use GetAvailableStandardOutputProperties instead. + + + +#### *static* GetAvailableStandardOutputProperties() + +* **Returns:** + The available “Standard Output Properties”. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetBreakageDelayAfterRelease(unit: str | None = None) + +Get the value of “Breakage Delay After Release”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetBreakageOverlapFactor() + +Get the value of “Breakage Overlap Factor”. + + + +#### GetBreakageStart(unit: str | None = None) + +Get the value of “Breakage Start”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Get the value of “Contact Neighboring Distance Between Particles”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetContactNeighboringDistanceBetweenParticlesAndTriangles(unit: str | None = None) + +Get the value of “Contact Neighboring Distance Between Particles And Triangles”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDeformableMassMatrixType() + +Get “Deformable Mass Matrix Type” as a string. + +* **Returns:** + The returned value will be one of [‘lumped’, ‘consistent’]. + + + +#### GetDisableTrianglesOnPeriodicBoundaries() + +Get the value of “Disable Triangles On Periodic Boundaries”. + + + +#### GetDragLimiterFactor() + +Get the value of “Drag Limiter Factor”. + + + +#### 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. + + + +#### GetFixedTimestep(unit: str | None = None) + +Get the value of “Fixed Timestep”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetFluentOutputsMultiplier() + +Get the value of “Fluent Outputs Multiplier”. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetJointElasticRatio() + +Get the value of “Joint Elastic Ratio”. + + + +#### GetLinearHystDamp() + +Get the value of “Linear Hyst Damp”. + + + +#### GetLoadingNSteps() + +Get the value of “Loading N Steps”. + + + +#### GetMaximumNumberOfIterations() + +Get the value of “Maximum Number of Iterations”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetMinimumLengthDeformationTolerance() + +Get the value of “Minimum Length Deformation Tolerance”. + + + +#### GetMinimumVolumeTolerance() + +Get the value of “Minimum Volume Tolerance”. + + + +#### GetModulesOutputPropertiesData() + +* **Returns:** + The current value of “Modules Output Properties”. + + + +#### GetModulesOutputPropertyEnabled(\*output_property: str) + +Retrieve enable state of given “Modules Output Property”. + +* **Parameters:** + **output_property** – The output property name. + + + +#### GetMoveCfdCellsWithRockyBoundaries() + +Get the value of “Move Cfd Cells With Rocky Boundaries”. + + + +#### GetMultiGpuSlicingDirection() + +Get “Multi Gpu Slicing Direction” as a string. + +* **Returns:** + The returned value will be one of [‘X_Parallel’, ‘Y_Parallel’, ‘Z_Parallel’]. + + + +#### GetNegateInitialOverlaps() + +Get the value of “Negate Initial Overlaps”. + + + +#### GetNeighborSearchModel() + +Get “Neighbor Search Model” as a string. + +* **Returns:** + The returned value will be one of [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfProcessors() + +Get the value of “Number of Processors”. + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputPropertyEnabled(root_key: str, property_name: str) + +Deprecated: Use GetStandardOutputPropertyEnabled instead. + + + +#### GetOutputRootEnabled(root_key: str) + +Deprecated: Use GetStandardOutputPropertyEnabled instead. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetOverRelaxationCoefficient() + +Get the value of “Over Relaxation Coefficient”. + + + +#### GetOverlapParticlesDelay(unit: str | None = None) + +Get the value of “Overlap Particles Delay”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetParticleSizeLimitForReordering(unit: str | None = None) + +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”. + + + +#### GetRefineConcaveSearch() + +Get the value of “Refine Concave Search”. + + + +#### GetReleaseParticlesWithoutOverlapCheck() + +Get the value of “Release Particles Without Overlap Check”. + + + +#### GetResetOnlyPhysicalContactsData() + +Get the value of “Reset Only Physical Contacts Data”. + + + +#### GetResumeDataFrequency() + +Get the value of “Resume Data Frequency”. + + + +#### GetSimulationDuration(unit: str | None = None) + +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() + +Get the value of “Sorting Distance Factor”. + + + +#### GetSpecialReorderingForWidePsd() + +Get the value of “Special Reordering For Wide Psd”. + + + +#### GetStandardOutputPropertiesData() + +* **Returns:** + The current value of “Standard Output Properties”. + + + +#### GetStandardOutputPropertyEnabled(\*output_property: str) + +Retrieve enable state of given “Standard Output Property”. + +* **Parameters:** + **output_property** – The output property name. + + + +#### GetSuccessiveOverRelaxationTolerance() + +Get the value of “Successive Over Relaxation Tolerance”. + + + +#### GetTargetGpu() + +Get the value of “Target Gpu”. + + + +#### GetTargetGpus() + +* **Returns:** + A list of IDs of the GPUs currently selected for Multi GPU simulation. + + + +#### GetTimeInterval(unit: str | None = None) + +Get the value of “Time Interval”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTimestepModel() + +Get “Timestep Model” as a string. + +* **Returns:** + The returned value will be one of [‘constant’, ‘variable’]. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetUse2023R2CellVolumeFractionUpdateApproach() + +Get the value of “Use 2023 R2 Cell Volume Fraction Update Approach”. + + + +#### GetUse2023R2SourceTermsApproach() + +Get the value of “Use 2023 R2 Source Terms Approach”. + + + +#### GetUse3RdPowerForCfdCgm() + +Get the value of “Use 3Rd Power For Cfd Cgm”. + + + +#### GetUseArraysGrowthRate() + +Get the value of “Use Arrays Growth Rate”. + + + +#### GetUseBreakageOverlapFactor() + +Get the value of “Use Breakage Overlap Factor”. + + + +#### GetUseCompressedFiles() + +Get the value of “Use Compressed Files”. + + + +#### GetUseContactNeighboringDistanceBetweenParticles() + +Get the value of “Use Contact Neighboring Distance Between Particles”. + + + +#### GetUseContactNeighboringDistanceBetweenParticlesAndTriangles() + +Get the value of “Use Contact Neighboring Distance Between Particles And Triangles”. + + + +#### GetUseDpmBlockingEffectForSinglePhaseSimulations() + +The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky +since 25R2. + + + +#### GetUseDragLimiterFactor() + +Get the value of “Use Drag Limiter Factor”. + + + +#### GetUseFixedTimestep() + +Get the value of “Use Fixed Timestep”. + + + +#### GetUseNonRoundTorqueCorrection() + +Get the value of “Use Non Round Torque Correction”. + + + +#### GetUseSortingDistanceFactor() + +Get the value of “Use Sorting Distance Factor”. + + + +#### GetValidDeformableMassMatrixTypeValues() + +Get a list of all possible values for “Deformable Mass Matrix Type”. + +* **Returns:** + The returned list is [‘lumped’, ‘consistent’]. + + + +#### GetValidMultiGpuSlicingDirectionValues() + +Get a list of all possible values for “Multi Gpu Slicing Direction”. + +* **Returns:** + The returned list is [‘X_Parallel’, ‘Y_Parallel’, ‘Z_Parallel’]. + + + +#### GetValidNeighborSearchModelValues() + +Get a list of all possible values for “Neighbor Search Model”. + +* **Returns:** + The returned list is [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. + + + +#### GetValidSimulationTargetValues() + +Get a list of all possible values for “Simulation Target”. + +* **Returns:** + The returned list is [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. + + + +#### GetValidTimestepModelValues() + +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. + + + +#### GetWearEnergySpectraBreakageStart(unit: str | None = None) + +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. + + + +#### GetWearGeometryUpdateInterval(unit: str | None = None) + +Get the value of “Wear Geometry Update Interval”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetWearStart(unit: str | None = None) + +Get the value of “Wear Start”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### HasFEMForcesEnabled() + +Whether the simulation is configured to collect forces for FEM analysis. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### HasHtcCalculatedData() + +Whether the “HTC” is being calculated. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsCompressedFileEnabled() + +Check if the “Compressed File” is enabled. + + + +#### IsDpmBlockingEffectForSinglePhaseSimulationsEnabled() + +The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky +since 25R2. + + + +#### IsMoveCfdCellsWithRockyBoundariesEnabled() + +Check if the “Move Cfd Cells With Rocky Boundaries” is enabled. + + + +#### IsNegateInitialOverlapsEnabled() + +Check if the “Negate Initial Overlaps” is enabled. + + + +#### IsSortingDistanceFactorEnabled() + +Check if the “Sorting Distance Factor” is enabled. + + + +#### IsUse3RdPowerForCfdCgmEnabled() + +Check if the “Use 3Rd Power For Cfd Cgm” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +It is not possible to remove the item “Solver” from the project. It’s a standard Rocky +item in project. + + + +#### RestoreOutputPropertiesDefaults() + +Restore default values of “Output Properties”. + + + +#### SetArraysGrowthRate(value: str | float) + +Set the value of “Arrays Growth Rate”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetBreakageDelayAfterRelease(value: str | float, unit: str | None = None) + +Set the value of “Breakage Delay After Release”. + +* **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”. + + + +#### SetBreakageOverlapFactor(value: str | float) + +Set the value of “Breakage Overlap Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetBreakageStart(value: str | float, unit: str | None = None) + +Set the value of “Breakage Start”. + +* **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”. + + + +#### SetCollectForcesForFemAnalysis(value: bool) + +Deprecated: Use this method from RAStudy instead + + + +#### SetContactNeighboringDistanceBetweenParticles(value: str | float, unit: str | None = None) + +Set the value of “Contact Neighboring Distance Between Particles”. + +* **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”. + + + +#### SetContactNeighboringDistanceBetweenParticlesAndTriangles(value: str | float, unit: str | None = None) + +Set the value of “Contact Neighboring Distance Between Particles And Triangles”. + +* **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”. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDeformableMassMatrixType(value: str) + +Set the value of “Deformable Mass Matrix Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘lumped’, ‘consistent’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Deformable Mass Matrix Type” option. + + + +#### SetDisableTrianglesOnPeriodicBoundaries(value: bool) + +Set the value of “Disable Triangles On Periodic Boundaries”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetDragLimiterFactor(value: str | float) + +Set the value of “Drag Limiter Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetFixedTimestep(value: str | float, unit: str | None = None) + +Set the value of “Fixed Timestep”. + +* **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”. + + + +#### SetFluentOutputsMultiplier(value: int) + +Set the value of “Fluent Outputs Multiplier”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetJointElasticRatio(value: str | float) + +Set the value of “Joint Elastic Ratio”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetLinearHystDamp(value: str | float) + +Set the value of “Linear Hyst Damp”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetLoadingNSteps(value: str | int) + +Set the value of “Loading N Steps”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMaximumNumberOfIterations(value: str | int) + +Set the value of “Maximum Number of Iterations”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMinimumLengthDeformationTolerance(value: str | float) + +Set the value of “Minimum Length Deformation Tolerance”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetMinimumVolumeTolerance(value: str | float) + +Set the value of “Minimum Volume Tolerance”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetModulesOutputPropertiesData(data_dict: dict) + +Set the current value of “Modules Output Properties”. + +* **Parameters:** + **data_dict** – The data dictionary to set. + + + +#### SetModulesOutputPropertyEnabled(\*output_property: str, enabled: bool) + +Set enable state of given “Modules Output Property”. + +* **Parameters:** + * **output_property** – The output property name. + * **enabled** – The enable state of given “Modules Output Property”. + + + +#### SetMoveCfdCellsWithRockyBoundaries(value: bool) + +Set the value of “Move Cfd Cells With Rocky Boundaries”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetMultiGpuSlicingDirection(value: str) + +Set the value of “Multi Gpu Slicing Direction”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘X_Parallel’, ‘Y_Parallel’, ‘Z_Parallel’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Multi Gpu Slicing Direction” option. + + + +#### SetNegateInitialOverlaps(value: bool) + +Set the value of “Negate Initial Overlaps”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetNeighborSearchModel(value: str) + +Set the value of “Neighbor Search Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Neighbor Search Model” option. + + + +#### SetNumberOfProcessors(value: str | int) + +Set the value of “Number of Processors”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetOutputPropertyEnabled(root_key: str, property_name: str, enabled: bool) + +Deprecated: Use SetStandardOutputPropertyEnabled instead. + + + +#### SetOutputRootEnabled(root_key: str, enabled: bool) + +Deprecated: Use SetStandardOutputPropertyEnabled instead. + + + +#### SetOverRelaxationCoefficient(value: str | float) + +Set the value of “Over Relaxation Coefficient”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetOverlapParticlesDelay(value: str | float, unit: str | None = None) + +Set the value of “Overlap Particles Delay”. + +* **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”. + + + +#### SetParticleSizeLimitForReordering(value: str | float, unit: str | None = None) + +Set the value of “Particle Size Limit For Reordering”. + +* **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”. + + + +#### SetRefineConcaveSearch(value: bool) + +Set the value of “Refine Concave Search”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetReleaseParticlesWithoutOverlapCheck(value: bool) + +Set the value of “Release Particles Without Overlap Check”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetResetOnlyPhysicalContactsData(value: bool) + +Set the value of “Reset Only Physical Contacts Data”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetResumeDataFrequency(value: str | int) + +Set the value of “Resume Data Frequency”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetSimulationDuration(value: str | float, unit: str | None = None) + +Set the value of “Simulation 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”. + + + +#### 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) + +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) + +Set the value of “Sorting Distance Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSpecialReorderingForWidePsd(value: bool) + +Set the value of “Special Reordering For Wide Psd”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetStandardOutputPropertiesData(data_dict: dict) + +Set the current value of “Standard Output Properties”. + +* **Parameters:** + **data_dict** – The data dictionary to set. + + + +#### SetStandardOutputPropertyEnabled(\*output_property: str, enabled: bool) + +Set enable state of given “Standard Output Property”. + +* **Parameters:** + * **output_property** – The output property name. + * **enabled** – The enable state of given “Standard Output Property”. + + + +#### SetSuccessiveOverRelaxationTolerance(value: str | float) + +Set the value of “Successive Over Relaxation Tolerance”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetTargetGpu(value: str | int) + +Set the value of “Target Gpu”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetTargetGpus(gpus: list[int | str]) + +It will configure the IDs of GPUs that will be used in simulation based on the list of IDs or names of GPUs +passed. + +* **Parameters:** + **gpus** – List with IDs or names of GPUs to be used in simulation. + For example in the name “1 - Geforce GTX 980”, the ID is 1 and the name is “1 - Geforce GTX 980”. + + + +#### SetTimeConfiguration(duration: float, time_interval: float) + +Shortcut to set both the simulation’s duration and its time interval. + +* **Parameters:** + * **duration** – The simulation duration (in seconds). + * **time_interval** – The simulation time interval (in seconds). + + + +#### SetTimeInterval(value: str | float, unit: str | None = None) + +Set the value of “Time Interval”. + +* **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”. + + + +#### SetTimestepModel(value: str) + +Set the value of “Timestep Model”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘constant’, ‘variable’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Timestep Model” option. + + + +#### SetUse2023R2CellVolumeFractionUpdateApproach(value: bool) + +Set the value of “Use 2023 R2 Cell Volume Fraction Update Approach”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUse2023R2SourceTermsApproach(value: bool) + +Set the value of “Use 2023 R2 Source Terms Approach”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUse3RdPowerForCfdCgm(value: bool) + +Set the value of “Use 3Rd Power For Cfd Cgm”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseArraysGrowthRate(value: bool) + +Set the value of “Use Arrays Growth Rate”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseBreakageOverlapFactor(value: bool) + +Set the value of “Use Breakage Overlap Factor”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseCompressedFiles(value: bool) + +Set the value of “Use Compressed Files”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseContactNeighboringDistanceBetweenParticles(value: bool) + +Set the value of “Use Contact Neighboring Distance Between Particles”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseContactNeighboringDistanceBetweenParticlesAndTriangles(value: bool) + +Set the value of “Use Contact Neighboring Distance Between Particles And Triangles”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseDpmBlockingEffectForSinglePhaseSimulations(value: bool) + +The “Use DPM Blocking Effect For Single Phase Simulations” parameter was removed from Rocky +since 25R2. + + + +#### SetUseDragLimiterFactor(value: bool) + +Set the value of “Use Drag Limiter Factor”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseFixedTimestep(value: bool) + +Set the value of “Use Fixed Timestep”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseNonRoundTorqueCorrection(value: bool) + +Set the value of “Use Non Round Torque Correction”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetUseSortingDistanceFactor(value: bool) + +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) + +Set the value of “Wear Geometry Update Interval”. + +* **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”. + + + +#### SetWearStart(value: str | float, unit: str | None = None) + +Set the value of “Wear Start”. + +* **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”. diff --git a/2025R2/rocky-prepost-scripting-manual/RASizeDistribution.md b/2025R2/rocky-prepost-scripting-manual/RASizeDistribution.md index 26feb777ca..a0c6ddead1 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASizeDistribution.md +++ b/2025R2/rocky-prepost-scripting-manual/RASizeDistribution.md @@ -1,86 +1,87 @@ - - -# RASizeDistribution - - - - - - -### *class* RASizeDistribution - -Rocky PrePost Scripting wrapper for a single entry in a single Particle’s size distribution list. - -Access this wrapper from a given [`RAParticle`](RAParticle.md#generated.RAParticle) with: - -```python -size_distribution_list = particle.GetSizeDistributionList() -distribution_1 = size_distribution_list.New() -distribution_1.SetSize(1.0, 'm') -distribution_1.SetCumulativePercentage(100) -``` - -**Methods:** - -| [`GetCumulativePercentage`](#generated.RASizeDistribution.GetCumulativePercentage)() | Get the value of "Cumulative Percentage". | -|-------------------------------------------------------------------------------------------|---------------------------------------------| -| [`GetScaleFactor`](#generated.RASizeDistribution.GetScaleFactor)([unit]) | Get the value of "Scale Factor". | -| [`GetSize`](#generated.RASizeDistribution.GetSize)([unit]) | Get the value of "Size". | -| [`SetCumulativePercentage`](#generated.RASizeDistribution.SetCumulativePercentage)(value) | Set the value of "Cumulative Percentage". | -| [`SetScaleFactor`](#generated.RASizeDistribution.SetScaleFactor)(value[, unit]) | Set the value of "Scale Factor". | -| [`SetSize`](#generated.RASizeDistribution.SetSize)(value[, unit]) | Set the value of "Size". | - - - -#### GetCumulativePercentage() - -Get the value of “Cumulative Percentage”. - - - -#### GetScaleFactor(unit: str | None = None) - -Get the value of “Scale Factor”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetSize(unit: str | None = None) - -Get the value of “Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### SetCumulativePercentage(value: str | float) - -Set the value of “Cumulative Percentage”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetScaleFactor(value: str | float, unit: str | None = None) - -Set the value of “Scale Factor”. - -* **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 “-“. - - - -#### SetSize(value: str | float, unit: str | None = None) - -Set the value of “Size”. - -* **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”. + + +# RASizeDistribution + + + + + + +### *class* RASizeDistribution + +Rocky PrePost Scripting wrapper for a single entry in a single Particle’s size distribution list. + +Access this wrapper from a given [`RAParticle`](RAParticle.md#generated.RAParticle) with: + +```python +size_distribution_list = particle.GetSizeDistributionList() +distribution_1 = size_distribution_list.New() +distribution_1.SetSize(1.0, 'm') +distribution_1.SetCumulativePercentage(100) +``` + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------|---------------------------------------------| +| [`GetCumulativePercentage`](#generated.RASizeDistribution.GetCumulativePercentage)() | Get the value of "Cumulative Percentage". | +| [`GetScaleFactor`](#generated.RASizeDistribution.GetScaleFactor)([unit]) | Get the value of "Scale Factor". | +| [`GetSize`](#generated.RASizeDistribution.GetSize)([unit]) | Get the value of "Size". | +| [`SetCumulativePercentage`](#generated.RASizeDistribution.SetCumulativePercentage)(value) | Set the value of "Cumulative Percentage". | +| [`SetScaleFactor`](#generated.RASizeDistribution.SetScaleFactor)(value[, unit]) | Set the value of "Scale Factor". | +| [`SetSize`](#generated.RASizeDistribution.SetSize)(value[, unit]) | Set the value of "Size". | + + + +#### GetCumulativePercentage() + +Get the value of “Cumulative Percentage”. + + + +#### GetScaleFactor(unit: str | None = None) + +Get the value of “Scale Factor”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetSize(unit: str | None = None) + +Get the value of “Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### SetCumulativePercentage(value: str | float) + +Set the value of “Cumulative Percentage”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetScaleFactor(value: str | float, unit: str | None = None) + +Set the value of “Scale Factor”. + +* **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 “-“. + + + +#### SetSize(value: str | float, unit: str | None = None) + +Set the value of “Size”. + +* **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/2025R2/rocky-prepost-scripting-manual/RASizeDistributionList.md b/2025R2/rocky-prepost-scripting-manual/RASizeDistributionList.md index 06cea726f0..49a5c33f92 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASizeDistributionList.md +++ b/2025R2/rocky-prepost-scripting-manual/RASizeDistributionList.md @@ -1,120 +1,121 @@ - - -# RASizeDistributionList - - - - - - -### *class* RASizeDistributionList - -Rocky PrePost Scripting wrapper to manipulate the size properties in a single Particle. - -To get the [`RASizeDistributionList`](#generated.RASizeDistributionList) from a [`RAParticle`](RAParticle.md#generated.RAParticle), use: - -```python -size_distribution_list = particle.GetSizeDistributionList() -``` - -[`RASizeDistributionList`](#generated.RASizeDistributionList) contains methods to set the size type and add, remove and -retrieve individual size distribution entries. It corresponds to the items on a Particle’s -“Size” tab on the Rocky UI. - -The following examples add, remove and access individual entries in the size distribution list: - -```python -# Add new items -size_distribution = size_distribution_list.New() - -# Access and modify items -size_distribution = size_distribution_list[0] -size_distribution.SetSize(1.0, 'm') - -# Remove items -size_distribution_list.Remove(size_distribution) -del size_distribution_list[0] -size_distribution_list.Clear() -``` - -Note that this list is used even if the configured particle only has a single size, such as when -it is composed of Multiple Elements. In these cases, the single size refers to the first item -on the list (and no other items are used). - -The [`RASizeDistributionList`](#generated.RASizeDistributionList) is a list of [`RASizeDistribution`](RASizeDistribution.md#generated.RASizeDistribution). - -**Methods:** - -| [`Clear`](#generated.RASizeDistributionList.Clear)() | Remove all items from the list. | -|----------------------------------------------------------------------------------------|----------------------------------------------------| -| [`GetCgmScaleFactor`](#generated.RASizeDistributionList.GetCgmScaleFactor)() | Get the value of "Cgm Scale Factor". | -| [`GetSizeType`](#generated.RASizeDistributionList.GetSizeType)() | Get "Size Type" as a string. | -| [`GetValidSizeTypeValues`](#generated.RASizeDistributionList.GetValidSizeTypeValues)() | Get a list of all possible values for "Size Type". | -| [`New`](#generated.RASizeDistributionList.New)() | Add a new item. | -| [`Remove`](#generated.RASizeDistributionList.Remove)(item) | Remove an item from the list. | -| [`SetCgmScaleFactor`](#generated.RASizeDistributionList.SetCgmScaleFactor)(value) | Set the value of "Cgm Scale Factor". | -| [`SetSizeType`](#generated.RASizeDistributionList.SetSizeType)(value) | Set the value of "Size Type". | - - - -#### Clear() - -Remove all items from the list. - - - -#### GetCgmScaleFactor() - -Get the value of “Cgm Scale Factor”. - - - -#### GetSizeType() - -Get “Size Type” as a string. - -* **Returns:** - The returned value will be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. - - - -#### GetValidSizeTypeValues() - -Get a list of all possible values for “Size Type”. - -* **Returns:** - The returned list is [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. - - - -#### New() - -Add a new item. Returns the newly created item. - - - -#### Remove(item: T) - -Remove an item from the list. - - - -#### SetCgmScaleFactor(value: str | float) - -Set the value of “Cgm Scale Factor”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetSizeType(value: str) - -Set the value of “Size Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Size Type” option. + + +# RASizeDistributionList + + + + + + +### *class* RASizeDistributionList + +Rocky PrePost Scripting wrapper to manipulate the size properties in a single Particle. + +To get the [`RASizeDistributionList`](#generated.RASizeDistributionList) from a [`RAParticle`](RAParticle.md#generated.RAParticle), use: + +```python +size_distribution_list = particle.GetSizeDistributionList() +``` + +[`RASizeDistributionList`](#generated.RASizeDistributionList) contains methods to set the size type and add, remove and +retrieve individual size distribution entries. It corresponds to the items on a Particle’s +“Size” tab on the Rocky UI. + +The following examples add, remove and access individual entries in the size distribution list: + +```python +# Add new items +size_distribution = size_distribution_list.New() + +# Access and modify items +size_distribution = size_distribution_list[0] +size_distribution.SetSize(1.0, 'm') + +# Remove items +size_distribution_list.Remove(size_distribution) +del size_distribution_list[0] +size_distribution_list.Clear() +``` + +Note that this list is used even if the configured particle only has a single size, such as when +it is composed of Multiple Elements. In these cases, the single size refers to the first item +on the list (and no other items are used). + +The [`RASizeDistributionList`](#generated.RASizeDistributionList) is a list of [`RASizeDistribution`](RASizeDistribution.md#generated.RASizeDistribution). + +**Methods:** + +| Name | Description | +|----------------------------------------------------------------------------------------|----------------------------------------------------| +| [`Clear`](#generated.RASizeDistributionList.Clear)() | Remove all items from the list. | +| [`GetCgmScaleFactor`](#generated.RASizeDistributionList.GetCgmScaleFactor)() | Get the value of "Cgm Scale Factor". | +| [`GetSizeType`](#generated.RASizeDistributionList.GetSizeType)() | Get "Size Type" as a string. | +| [`GetValidSizeTypeValues`](#generated.RASizeDistributionList.GetValidSizeTypeValues)() | Get a list of all possible values for "Size Type". | +| [`New`](#generated.RASizeDistributionList.New)() | Add a new item. | +| [`Remove`](#generated.RASizeDistributionList.Remove)(item) | Remove an item from the list. | +| [`SetCgmScaleFactor`](#generated.RASizeDistributionList.SetCgmScaleFactor)(value) | Set the value of "Cgm Scale Factor". | +| [`SetSizeType`](#generated.RASizeDistributionList.SetSizeType)(value) | Set the value of "Size Type". | + + + +#### Clear() + +Remove all items from the list. + + + +#### GetCgmScaleFactor() + +Get the value of “Cgm Scale Factor”. + + + +#### GetSizeType() + +Get “Size Type” as a string. + +* **Returns:** + The returned value will be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. + + + +#### GetValidSizeTypeValues() + +Get a list of all possible values for “Size Type”. + +* **Returns:** + The returned list is [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. + + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. + + + +#### SetCgmScaleFactor(value: str | float) + +Set the value of “Cgm Scale Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetSizeType(value: str) + +Set the value of “Size Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘sieve’, ‘equivalent_diameter’, ‘original_size_scale’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Size Type” option. diff --git a/2025R2/rocky-prepost-scripting-manual/RASolidMaterial.md b/2025R2/rocky-prepost-scripting-manual/RASolidMaterial.md index d5a940c299..7705816c87 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASolidMaterial.md +++ b/2025R2/rocky-prepost-scripting-manual/RASolidMaterial.md @@ -1,263 +1,264 @@ - - -# RASolidMaterial - - - - - - -### *class* RASolidMaterial - -Rocky PrePost Scripting wrapper for individual materials in a project. - -Retrieve individual materials from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) via: - -```python -material_1 = study.GetElement('Default Particles') -material_2 = material_collection.GetMaterial('Default Boundaries') -material_3 = material_collection[2] -``` - -**Methods:** - -| [`GetBulkDensity`](#generated.RASolidMaterial.GetBulkDensity)([unit]) | Get the value of "Bulk Density". | -|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| -| [`GetBulkSolidFraction`](#generated.RASolidMaterial.GetBulkSolidFraction)() | Get the value of "Bulk Solid Fraction". | -| [`GetCurrentDensity`](#generated.RASolidMaterial.GetCurrentDensity)([unit]) | Get the value of "Current Density". | -| [`GetDensity`](#generated.RASolidMaterial.GetDensity)([unit]) | Get the value of "Density". | -| [`GetModuleProperties`](#generated.RASolidMaterial.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RASolidMaterial.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetPoissonRatio`](#generated.RASolidMaterial.GetPoissonRatio)([unit]) | Get the value of "Poisson Ratio". | -| [`GetSpecificHeat`](#generated.RASolidMaterial.GetSpecificHeat)([unit]) | Get the value of "Specific Heat". | -| [`GetThermalConductivity`](#generated.RASolidMaterial.GetThermalConductivity)([unit]) | Get the value of "Thermal Conductivity". | -| [`GetUseBulkDensity`](#generated.RASolidMaterial.GetUseBulkDensity)() | Get the value of "Use Bulk Density". | -| [`GetValidOptionsForModuleProperty`](#generated.RASolidMaterial.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`GetYoungsModulus`](#generated.RASolidMaterial.GetYoungsModulus)([unit]) | Get the value of "Youngs Modulus". | -| [`SetBulkDensity`](#generated.RASolidMaterial.SetBulkDensity)(value[, unit]) | Set the value of "Bulk Density". | -| [`SetBulkSolidFraction`](#generated.RASolidMaterial.SetBulkSolidFraction)(value) | Set the value of "Bulk Solid Fraction". | -| [`SetCurrentDensity`](#generated.RASolidMaterial.SetCurrentDensity)(value[, unit]) | Set the value of "Current Density". | -| [`SetDensity`](#generated.RASolidMaterial.SetDensity)(value[, unit]) | Set the value of "Density". | -| [`SetModuleProperty`](#generated.RASolidMaterial.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetPoissonRatio`](#generated.RASolidMaterial.SetPoissonRatio)(value[, unit]) | Set the value of "Poisson Ratio". | -| [`SetSpecificHeat`](#generated.RASolidMaterial.SetSpecificHeat)(value[, unit]) | Set the value of "Specific Heat". | -| [`SetThermalConductivity`](#generated.RASolidMaterial.SetThermalConductivity)(value[, unit]) | Set the value of "Thermal Conductivity". | -| [`SetUseBulkDensity`](#generated.RASolidMaterial.SetUseBulkDensity)(value) | Set the value of "Use Bulk Density". | -| [`SetYoungsModulus`](#generated.RASolidMaterial.SetYoungsModulus)(value[, unit]) | Set the value of "Youngs Modulus". | - - - -#### GetBulkDensity(unit: str | None = None) - -Get the value of “Bulk Density”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. - - - -#### GetBulkSolidFraction() - -Get the value of “Bulk Solid Fraction”. - - - -#### GetCurrentDensity(unit: str | None = None) - -Get the value of “Current Density”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. - - - -#### GetDensity(unit: str | None = None) - -Get the value of “Density”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. - - - -#### GetModuleProperties() - -Get the names of the module properties. - -* **Return type:** - tuple(ModulePropertyIdentifier) - - - -#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) - -Get the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. - * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, - the returned value will be in the unit that was set before (via SetModuleProperty()). -* **Return type:** - float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) -* **Returns:** - - For basic module properties like numbers and booleans, the returned value is a basic - Python type (float, bool, or string) - - For input files, the returned value is the string of the full path to the file - - For properties that are lists of other properties, the returned value is a - : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - - -#### GetPoissonRatio(unit: str | None = None) - -Get the value of “Poisson Ratio”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - - -#### GetSpecificHeat(unit: str | None = None) - -Get the value of “Specific Heat”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”. - - - -#### GetThermalConductivity(unit: str | None = None) - -Get the value of “Thermal Conductivity”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”. - - - -#### GetUseBulkDensity() - -Get the value of “Use Bulk Density”. - - - -#### GetValidOptionsForModuleProperty(property_name) - -Get all valid options only for properties that have a list of possible options. - -* **Parameters:** - **property_name** (*str*) – The name of the module property. -* **Return type:** - List[str] - - - -#### GetYoungsModulus(unit: str | None = None) - -Get the value of “Youngs Modulus”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. - - - -#### SetBulkDensity(value: str | float, unit: str | None = None) - -Set the value of “Bulk Density”. - -* **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 “kg/m3”. - - - -#### SetBulkSolidFraction(value: str | float) - -Set the value of “Bulk Solid Fraction”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or float type. - - - -#### SetCurrentDensity(value: str | float, unit: str | None = None) - -Set the value of “Current Density”. - -* **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 “kg/m3”. - - - -#### SetDensity(value: str | float, unit: str | None = None) - -Set the value of “Density”. - -* **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 “kg/m3”. - - - -#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) - -Set the value of a module property. - -* **Parameters:** - * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. - * **value** (*float* *,* *bool* *or* *str*) – The value to set. - 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. - - - -#### SetPoissonRatio(value: str | float, unit: str | None = None) - -Set the value of “Poisson Ratio”. - -* **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 “-“. - - - -#### SetSpecificHeat(value: str | float, unit: str | None = None) - -Set the value of “Specific Heat”. - -* **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 “J/kg.K”. - - - -#### SetThermalConductivity(value: str | float, unit: str | None = None) - -Set the value of “Thermal Conductivity”. - -* **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 “W/m.K”. - - - -#### SetUseBulkDensity(value: bool) - -Set the value of “Use Bulk Density”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetYoungsModulus(value: str | float, unit: str | None = None) - -Set the value of “Youngs Modulus”. - -* **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 “N/m2”. + + +# RASolidMaterial + + + + + + +### *class* RASolidMaterial + +Rocky PrePost Scripting wrapper for individual materials in a project. + +Retrieve individual materials from the [`RAStudy`](RAStudy.md#generated.RAStudy) or the [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) via: + +```python +material_1 = study.GetElement('Default Particles') +material_2 = material_collection.GetMaterial('Default Boundaries') +material_3 = material_collection[2] +``` + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [`GetBulkDensity`](#generated.RASolidMaterial.GetBulkDensity)([unit]) | Get the value of "Bulk Density". | +| [`GetBulkSolidFraction`](#generated.RASolidMaterial.GetBulkSolidFraction)() | Get the value of "Bulk Solid Fraction". | +| [`GetCurrentDensity`](#generated.RASolidMaterial.GetCurrentDensity)([unit]) | Get the value of "Current Density". | +| [`GetDensity`](#generated.RASolidMaterial.GetDensity)([unit]) | Get the value of "Density". | +| [`GetModuleProperties`](#generated.RASolidMaterial.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RASolidMaterial.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetPoissonRatio`](#generated.RASolidMaterial.GetPoissonRatio)([unit]) | Get the value of "Poisson Ratio". | +| [`GetSpecificHeat`](#generated.RASolidMaterial.GetSpecificHeat)([unit]) | Get the value of "Specific Heat". | +| [`GetThermalConductivity`](#generated.RASolidMaterial.GetThermalConductivity)([unit]) | Get the value of "Thermal Conductivity". | +| [`GetUseBulkDensity`](#generated.RASolidMaterial.GetUseBulkDensity)() | Get the value of "Use Bulk Density". | +| [`GetValidOptionsForModuleProperty`](#generated.RASolidMaterial.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`GetYoungsModulus`](#generated.RASolidMaterial.GetYoungsModulus)([unit]) | Get the value of "Youngs Modulus". | +| [`SetBulkDensity`](#generated.RASolidMaterial.SetBulkDensity)(value[, unit]) | Set the value of "Bulk Density". | +| [`SetBulkSolidFraction`](#generated.RASolidMaterial.SetBulkSolidFraction)(value) | Set the value of "Bulk Solid Fraction". | +| [`SetCurrentDensity`](#generated.RASolidMaterial.SetCurrentDensity)(value[, unit]) | Set the value of "Current Density". | +| [`SetDensity`](#generated.RASolidMaterial.SetDensity)(value[, unit]) | Set the value of "Density". | +| [`SetModuleProperty`](#generated.RASolidMaterial.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetPoissonRatio`](#generated.RASolidMaterial.SetPoissonRatio)(value[, unit]) | Set the value of "Poisson Ratio". | +| [`SetSpecificHeat`](#generated.RASolidMaterial.SetSpecificHeat)(value[, unit]) | Set the value of "Specific Heat". | +| [`SetThermalConductivity`](#generated.RASolidMaterial.SetThermalConductivity)(value[, unit]) | Set the value of "Thermal Conductivity". | +| [`SetUseBulkDensity`](#generated.RASolidMaterial.SetUseBulkDensity)(value) | Set the value of "Use Bulk Density". | +| [`SetYoungsModulus`](#generated.RASolidMaterial.SetYoungsModulus)(value[, unit]) | Set the value of "Youngs Modulus". | + + + +#### GetBulkDensity(unit: str | None = None) + +Get the value of “Bulk Density”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. + + + +#### GetBulkSolidFraction() + +Get the value of “Bulk Solid Fraction”. + + + +#### GetCurrentDensity(unit: str | None = None) + +Get the value of “Current Density”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. + + + +#### GetDensity(unit: str | None = None) + +Get the value of “Density”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “kg/m3”. + + + +#### GetModuleProperties() + +Get the names of the module properties. + +* **Return type:** + tuple(ModulePropertyIdentifier) + + + +#### GetModuleProperty(property_name: str | ModulePropertyIdentifier, unit: str | None = None) + +Get the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to get. + * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, + the returned value will be in the unit that was set before (via SetModuleProperty()). +* **Return type:** + float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) +* **Returns:** + - For basic module properties like numbers and booleans, the returned value is a basic + Python type (float, bool, or string) + - For input files, the returned value is the string of the full path to the file + - For properties that are lists of other properties, the returned value is a + : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + + +#### GetPoissonRatio(unit: str | None = None) + +Get the value of “Poisson Ratio”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. + + + +#### GetSpecificHeat(unit: str | None = None) + +Get the value of “Specific Heat”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”. + + + +#### GetThermalConductivity(unit: str | None = None) + +Get the value of “Thermal Conductivity”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”. + + + +#### GetUseBulkDensity() + +Get the value of “Use Bulk Density”. + + + +#### GetValidOptionsForModuleProperty(property_name) + +Get all valid options only for properties that have a list of possible options. + +* **Parameters:** + **property_name** (*str*) – The name of the module property. +* **Return type:** + List[str] + + + +#### GetYoungsModulus(unit: str | None = None) + +Get the value of “Youngs Modulus”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m2”. + + + +#### SetBulkDensity(value: str | float, unit: str | None = None) + +Set the value of “Bulk Density”. + +* **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 “kg/m3”. + + + +#### SetBulkSolidFraction(value: str | float) + +Set the value of “Bulk Solid Fraction”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetCurrentDensity(value: str | float, unit: str | None = None) + +Set the value of “Current Density”. + +* **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 “kg/m3”. + + + +#### SetDensity(value: str | float, unit: str | None = None) + +Set the value of “Density”. + +* **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 “kg/m3”. + + + +#### SetModuleProperty(property_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None) + +Set the value of a module property. + +* **Parameters:** + * **property_name** (*Union* *[**str* *,* *ModulePropertyIdentifier* *]*) – The name of the module property to set. + * **value** (*float* *,* *bool* *or* *str*) – The value to set. + 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. + + + +#### SetPoissonRatio(value: str | float, unit: str | None = None) + +Set the value of “Poisson Ratio”. + +* **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 “-“. + + + +#### SetSpecificHeat(value: str | float, unit: str | None = None) + +Set the value of “Specific Heat”. + +* **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 “J/kg.K”. + + + +#### SetThermalConductivity(value: str | float, unit: str | None = None) + +Set the value of “Thermal Conductivity”. + +* **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 “W/m.K”. + + + +#### SetUseBulkDensity(value: bool) + +Set the value of “Use Bulk Density”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetYoungsModulus(value: str | float, unit: str | None = None) + +Set the value of “Youngs Modulus”. + +* **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 “N/m2”. diff --git a/2025R2/rocky-prepost-scripting-manual/RASpringDashpotForce.md b/2025R2/rocky-prepost-scripting-manual/RASpringDashpotForce.md index a436465e49..3312e45838 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASpringDashpotForce.md +++ b/2025R2/rocky-prepost-scripting-manual/RASpringDashpotForce.md @@ -1,102 +1,103 @@ - - -# RASpringDashpotForce - - - - - - -### *class* RASpringDashpotForce - -Rocky PrePost Scripting wrapper representing a Spring-Dashpot Force motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Spring-Dashpot Force') -spring_force = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetDashpotCoefficient`](#generated.RASpringDashpotForce.GetDashpotCoefficient)([unit]) | Get the value of "Dashpot Coefficient". | -|-------------------------------------------------------------------------------------------------|----------------------------------------------------| -| [`GetDirection`](#generated.RASpringDashpotForce.GetDirection)() | Get "Direction" as a string. | -| [`GetSpringCoefficient`](#generated.RASpringDashpotForce.GetSpringCoefficient)([unit]) | Get the value of "Spring Coefficient". | -| [`GetValidDirectionValues`](#generated.RASpringDashpotForce.GetValidDirectionValues)() | Get a list of all possible values for "Direction". | -| [`SetDashpotCoefficient`](#generated.RASpringDashpotForce.SetDashpotCoefficient)(value[, unit]) | Set the value of "Dashpot Coefficient". | -| [`SetDirection`](#generated.RASpringDashpotForce.SetDirection)(value) | Set the value of "Direction". | -| [`SetSpringCoefficient`](#generated.RASpringDashpotForce.SetSpringCoefficient)(value[, unit]) | Set the value of "Spring Coefficient". | - - - -#### GetDashpotCoefficient(unit: str | None = None) - -Get the value of “Dashpot Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N.s/m”. - - - -#### GetDirection() - -Get “Direction” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### GetSpringCoefficient(unit: str | None = None) - -Get the value of “Spring Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m”. - - - -#### GetValidDirectionValues() - -Get a list of all possible values for “Direction”. - -* **Returns:** - The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### SetDashpotCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Dashpot Coefficient”. - -* **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 “N.s/m”. - - - -#### SetDirection(value: str) - -Set the value of “Direction”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Direction” option. - - - -#### SetSpringCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Spring Coefficient”. - -* **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 “N/m”. + + +# RASpringDashpotForce + + + + + + +### *class* RASpringDashpotForce + +Rocky PrePost Scripting wrapper representing a Spring-Dashpot Force motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Spring-Dashpot Force') +spring_force = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------|----------------------------------------------------| +| [`GetDashpotCoefficient`](#generated.RASpringDashpotForce.GetDashpotCoefficient)([unit]) | Get the value of "Dashpot Coefficient". | +| [`GetDirection`](#generated.RASpringDashpotForce.GetDirection)() | Get "Direction" as a string. | +| [`GetSpringCoefficient`](#generated.RASpringDashpotForce.GetSpringCoefficient)([unit]) | Get the value of "Spring Coefficient". | +| [`GetValidDirectionValues`](#generated.RASpringDashpotForce.GetValidDirectionValues)() | Get a list of all possible values for "Direction". | +| [`SetDashpotCoefficient`](#generated.RASpringDashpotForce.SetDashpotCoefficient)(value[, unit]) | Set the value of "Dashpot Coefficient". | +| [`SetDirection`](#generated.RASpringDashpotForce.SetDirection)(value) | Set the value of "Direction". | +| [`SetSpringCoefficient`](#generated.RASpringDashpotForce.SetSpringCoefficient)(value[, unit]) | Set the value of "Spring Coefficient". | + + + +#### GetDashpotCoefficient(unit: str | None = None) + +Get the value of “Dashpot Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N.s/m”. + + + +#### GetDirection() + +Get “Direction” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### GetSpringCoefficient(unit: str | None = None) + +Get the value of “Spring Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “N/m”. + + + +#### GetValidDirectionValues() + +Get a list of all possible values for “Direction”. + +* **Returns:** + The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### SetDashpotCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Dashpot Coefficient”. + +* **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 “N.s/m”. + + + +#### SetDirection(value: str) + +Set the value of “Direction”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Direction” option. + + + +#### SetSpringCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Spring Coefficient”. + +* **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 “N/m”. diff --git a/2025R2/rocky-prepost-scripting-manual/RASpringDashpotMoment.md b/2025R2/rocky-prepost-scripting-manual/RASpringDashpotMoment.md index 5eb3255864..1703b20a73 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASpringDashpotMoment.md +++ b/2025R2/rocky-prepost-scripting-manual/RASpringDashpotMoment.md @@ -1,102 +1,103 @@ - - -# RASpringDashpotMoment - - - - - - -### *class* RASpringDashpotMoment - -Rocky PrePost Scripting wrapper representing a Spring-Dashpot Moment motion. - -Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For -example: - -```python -motions = motion_frame.GetMotions() -motion_1 = motions.New() -motion_1.SetType('Spring-Dashpot Moment') -spring_moment = motion_1.GetTypeObject() -``` - -**Methods:** - -| [`GetDashpotCoefficient`](#generated.RASpringDashpotMoment.GetDashpotCoefficient)([unit]) | Get the value of "Dashpot Coefficient". | -|--------------------------------------------------------------------------------------------------|----------------------------------------------------| -| [`GetDirection`](#generated.RASpringDashpotMoment.GetDirection)() | Get "Direction" as a string. | -| [`GetSpringCoefficient`](#generated.RASpringDashpotMoment.GetSpringCoefficient)([unit]) | Get the value of "Spring Coefficient". | -| [`GetValidDirectionValues`](#generated.RASpringDashpotMoment.GetValidDirectionValues)() | Get a list of all possible values for "Direction". | -| [`SetDashpotCoefficient`](#generated.RASpringDashpotMoment.SetDashpotCoefficient)(value[, unit]) | Set the value of "Dashpot Coefficient". | -| [`SetDirection`](#generated.RASpringDashpotMoment.SetDirection)(value) | Set the value of "Direction". | -| [`SetSpringCoefficient`](#generated.RASpringDashpotMoment.SetSpringCoefficient)(value[, unit]) | Set the value of "Spring Coefficient". | - - - -#### GetDashpotCoefficient(unit: str | None = None) - -Get the value of “Dashpot Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Nms/rad”. - - - -#### GetDirection() - -Get “Direction” as a string. - -* **Returns:** - The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### GetSpringCoefficient(unit: str | None = None) - -Get the value of “Spring Coefficient”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Nm/rad”. - - - -#### GetValidDirectionValues() - -Get a list of all possible values for “Direction”. - -* **Returns:** - The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. - - - -#### SetDashpotCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Dashpot Coefficient”. - -* **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 “Nms/rad”. - - - -#### SetDirection(value: str) - -Set the value of “Direction”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Direction” option. - - - -#### SetSpringCoefficient(value: str | float, unit: str | None = None) - -Set the value of “Spring Coefficient”. - -* **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 “Nm/rad”. + + +# RASpringDashpotMoment + + + + + + +### *class* RASpringDashpotMoment + +Rocky PrePost Scripting wrapper representing a Spring-Dashpot Moment motion. + +Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For +example: + +```python +motions = motion_frame.GetMotions() +motion_1 = motions.New() +motion_1.SetType('Spring-Dashpot Moment') +spring_moment = motion_1.GetTypeObject() +``` + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------|----------------------------------------------------| +| [`GetDashpotCoefficient`](#generated.RASpringDashpotMoment.GetDashpotCoefficient)([unit]) | Get the value of "Dashpot Coefficient". | +| [`GetDirection`](#generated.RASpringDashpotMoment.GetDirection)() | Get "Direction" as a string. | +| [`GetSpringCoefficient`](#generated.RASpringDashpotMoment.GetSpringCoefficient)([unit]) | Get the value of "Spring Coefficient". | +| [`GetValidDirectionValues`](#generated.RASpringDashpotMoment.GetValidDirectionValues)() | Get a list of all possible values for "Direction". | +| [`SetDashpotCoefficient`](#generated.RASpringDashpotMoment.SetDashpotCoefficient)(value[, unit]) | Set the value of "Dashpot Coefficient". | +| [`SetDirection`](#generated.RASpringDashpotMoment.SetDirection)(value) | Set the value of "Direction". | +| [`SetSpringCoefficient`](#generated.RASpringDashpotMoment.SetSpringCoefficient)(value[, unit]) | Set the value of "Spring Coefficient". | + + + +#### GetDashpotCoefficient(unit: str | None = None) + +Get the value of “Dashpot Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Nms/rad”. + + + +#### GetDirection() + +Get “Direction” as a string. + +* **Returns:** + The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### GetSpringCoefficient(unit: str | None = None) + +Get the value of “Spring Coefficient”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “Nm/rad”. + + + +#### GetValidDirectionValues() + +Get a list of all possible values for “Direction”. + +* **Returns:** + The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. + + + +#### SetDashpotCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Dashpot Coefficient”. + +* **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 “Nms/rad”. + + + +#### SetDirection(value: str) + +Set the value of “Direction”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Direction” option. + + + +#### SetSpringCoefficient(value: str | float, unit: str | None = None) + +Set the value of “Spring Coefficient”. + +* **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 “Nm/rad”. diff --git a/2025R2/rocky-prepost-scripting-manual/RAStreamlinesUserProcess.md b/2025R2/rocky-prepost-scripting-manual/RAStreamlinesUserProcess.md index dead875aaf..b23485ba4d 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAStreamlinesUserProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RAStreamlinesUserProcess.md @@ -1,1082 +1,1083 @@ - - -# RAStreamlinesUserProcess - - - - - - -### *class* RAStreamlinesUserProcess - -**Methods:** - -| [`AddCurve`](#generated.RAStreamlinesUserProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAStreamlinesUserProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAvailableSources`](#generated.RAStreamlinesUserProcess.GetAvailableSources)() | Get available planar surfaces that can be used to generate Streamlines. | -| [`GetBoundingBox`](#generated.RAStreamlinesUserProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAStreamlinesUserProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAStreamlinesUserProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAStreamlinesUserProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAStreamlinesUserProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAStreamlinesUserProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAStreamlinesUserProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAStreamlinesUserProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAStreamlinesUserProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAStreamlinesUserProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAStreamlinesUserProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`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. | -| [`GetGeometryQuantity`](#generated.RAStreamlinesUserProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfNodes`](#generated.RAStreamlinesUserProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RAStreamlinesUserProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAStreamlinesUserProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAStreamlinesUserProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetSources`](#generated.RAStreamlinesUserProcess.GetSources)() | Get the surfaces defined as sources to generate Streamlines. | -| [`GetSpacing`](#generated.RAStreamlinesUserProcess.GetSpacing)([unit]) | Get the value of "Spacing". | -| [`GetTimeSet`](#generated.RAStreamlinesUserProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAStreamlinesUserProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`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". | -| [`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. | -| [`IterCells`](#generated.RAStreamlinesUserProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAStreamlinesUserProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAStreamlinesUserProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAStreamlinesUserProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAStreamlinesUserProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAStreamlinesUserProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAStreamlinesUserProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAStreamlinesUserProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDirection`](#generated.RAStreamlinesUserProcess.SetDirection)(value) | Set the value of "Direction". | -| [`SetMaximumLength`](#generated.RAStreamlinesUserProcess.SetMaximumLength)(value[, unit]) | Set the value of "Maximum Length". | -| [`SetSources`](#generated.RAStreamlinesUserProcess.SetSources)(surfaces) | Set the surfaces as sources to generate Streamlines. | -| [`SetSpacing`](#generated.RAStreamlinesUserProcess.SetSpacing)(value[, unit]) | Set the value of "Spacing". | -| [`UpdateStreamlines`](#generated.RAStreamlinesUserProcess.UpdateStreamlines)() | Recompute the streamlines from the current values of sources, spacing, direction and maximum length. | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableSources() - -Get available planar surfaces that can be used to generate Streamlines. - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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 - - - -#### GetDirection() - -Get “Direction” as a string. - -* **Returns:** - The returned value will be one of [‘forward’, ‘backward’, ‘both’]. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMaximumLength(unit: str | None = None) - -Get the value of “Maximum Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetSources() - -Get the surfaces defined as sources to generate Streamlines. - - - -#### GetSpacing(unit: str | None = None) - -Get the value of “Spacing”. - -* **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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetValidDirectionValues() - -Get a list of all possible values for “Direction”. - -* **Returns:** - The returned list is [‘forward’, ‘backward’, ‘both’]. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetDirection(value: str) - -Set the value of “Direction”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘forward’, ‘backward’, ‘both’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Direction” option. - - - -#### SetMaximumLength(value: str | float, unit: str | None = None) - -Set the value of “Maximum Length”. - -* **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”. - - - -#### SetSources(surfaces: str | RASurface | RASurfaceUserProcess | RARectangularSurface | RACircularSurface | list) - -Set the surfaces as sources to generate Streamlines. - - - -#### SetSpacing(value: str | float, unit: str | None = None) - -Set the value of “Spacing”. - -* **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”. - - - -#### UpdateStreamlines() - -Recompute the streamlines from the current values of sources, spacing, direction and -maximum length. - -Since computing the streamlines is potentially slow when the spacing is small, this method -must be explicitly called in order to update the streamlines. + + +# RAStreamlinesUserProcess + + + + + + +### *class* RAStreamlinesUserProcess + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAStreamlinesUserProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RAStreamlinesUserProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.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.RAStreamlinesUserProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAvailableSources`](#generated.RAStreamlinesUserProcess.GetAvailableSources)() | Get available planar surfaces that can be used to generate Streamlines. | +| [`GetBoundingBox`](#generated.RAStreamlinesUserProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RAStreamlinesUserProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RAStreamlinesUserProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RAStreamlinesUserProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RAStreamlinesUserProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RAStreamlinesUserProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RAStreamlinesUserProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RAStreamlinesUserProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RAStreamlinesUserProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RAStreamlinesUserProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RAStreamlinesUserProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`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. | +| [`GetGeometryQuantity`](#generated.RAStreamlinesUserProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfNodes`](#generated.RAStreamlinesUserProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfParticles`](#generated.RAStreamlinesUserProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RAStreamlinesUserProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RAStreamlinesUserProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetSources`](#generated.RAStreamlinesUserProcess.GetSources)() | Get the surfaces defined as sources to generate Streamlines. | +| [`GetSpacing`](#generated.RAStreamlinesUserProcess.GetSpacing)([unit]) | Get the value of "Spacing". | +| [`GetTimeSet`](#generated.RAStreamlinesUserProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RAStreamlinesUserProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`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". | +| [`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. | +| [`IterCells`](#generated.RAStreamlinesUserProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RAStreamlinesUserProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RAStreamlinesUserProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RAStreamlinesUserProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RAStreamlinesUserProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RAStreamlinesUserProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RAStreamlinesUserProcess.RemoveProcess)() | Removes the process from the project. | +| [`SetCurrentTimeStep`](#generated.RAStreamlinesUserProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDirection`](#generated.RAStreamlinesUserProcess.SetDirection)(value) | Set the value of "Direction". | +| [`SetMaximumLength`](#generated.RAStreamlinesUserProcess.SetMaximumLength)(value[, unit]) | Set the value of "Maximum Length". | +| [`SetSources`](#generated.RAStreamlinesUserProcess.SetSources)(surfaces) | Set the surfaces as sources to generate Streamlines. | +| [`SetSpacing`](#generated.RAStreamlinesUserProcess.SetSpacing)(value[, unit]) | Set the value of "Spacing". | +| [`UpdateStreamlines`](#generated.RAStreamlinesUserProcess.UpdateStreamlines)() | Recompute the streamlines from the current values of sources, spacing, direction and maximum length. | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableSources() + +Get available planar surfaces that can be used to generate Streamlines. + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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 + + + +#### GetDirection() + +Get “Direction” as a string. + +* **Returns:** + The returned value will be one of [‘forward’, ‘backward’, ‘both’]. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMaximumLength(unit: str | None = None) + +Get the value of “Maximum Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetSources() + +Get the surfaces defined as sources to generate Streamlines. + + + +#### GetSpacing(unit: str | None = None) + +Get the value of “Spacing”. + +* **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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetValidDirectionValues() + +Get a list of all possible values for “Direction”. + +* **Returns:** + The returned list is [‘forward’, ‘backward’, ‘both’]. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetDirection(value: str) + +Set the value of “Direction”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘forward’, ‘backward’, ‘both’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Direction” option. + + + +#### SetMaximumLength(value: str | float, unit: str | None = None) + +Set the value of “Maximum Length”. + +* **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”. + + + +#### SetSources(surfaces: str | RASurface | RASurfaceUserProcess | RARectangularSurface | RACircularSurface | list) + +Set the surfaces as sources to generate Streamlines. + + + +#### SetSpacing(value: str | float, unit: str | None = None) + +Set the value of “Spacing”. + +* **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”. + + + +#### UpdateStreamlines() + +Recompute the streamlines from the current values of sources, spacing, direction and +maximum length. + +Since computing the streamlines is potentially slow when the spacing is small, this method +must be explicitly called in order to update the streamlines. diff --git a/2025R2/rocky-prepost-scripting-manual/RAStudy.md b/2025R2/rocky-prepost-scripting-manual/RAStudy.md index 90a9017415..e252db47b7 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAStudy.md +++ b/2025R2/rocky-prepost-scripting-manual/RAStudy.md @@ -1,685 +1,687 @@ - - -# RAStudy - - - - - - -### *class* RAStudy - -Rocky PrePost Scripting wrapper for a project’s Study. - -This wrapper is the main access point for all other entities typically present in a Rocky -project. Access the [`RAStudy`](#generated.RAStudy) via the [`RAProject`](RAProject.md#generated.RAProject) once a project has been created -or opened (more): - -```python -project = app.GetProject() -study = project.GetStudy() -``` - - - -The [`RAStudy`](#generated.RAStudy) class acts as a main hub of functionality, providing methods to perform -various common actions related to simulations: - -- Helper creation methods for simulation entities such as [`CreateParticle()`](#generated.RAStudy.CreateParticle), - [`CreateFeedConveyor()`](#generated.RAStudy.CreateFeedConveyor), [`ImportWall()`](#generated.RAStudy.ImportWall), etc. -- Accessor methods for specialized PrePost Scripting wrapper objects such as [`GetMaterialCollection()`](#generated.RAStudy.GetMaterialCollection), - [`GetPhysics()`](#generated.RAStudy.GetPhysics), [`GetSimulatorRun()`](#generated.RAStudy.GetSimulatorRun), etc. -- Methods related to the simulation and its results, such as [`StartSimulation()`](#generated.RAStudy.StartSimulation), - [`StopSimulation()`](#generated.RAStudy.StopSimulation), [`DeleteResults()`](#generated.RAStudy.DeleteResults), etc. - -**Methods:** - -| [`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. | - -**Attributes:** - -| [`customer_name`](#generated.RAStudy.customer_name) | Get the study customer name. | -|-------------------------------------------------------|--------------------------------| -| [`description`](#generated.RAStudy.description) | Get the study description. | - - - -#### CanResumeSimulation() - -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) - -Create an outlet with the given exit point. - -* **Parameters:** - **exit_point** – The outlet’s exit point surface. - - - -#### CreateParticle() - -Create a particle in the study with default values. - - - -#### CreateParticleInlet(entry_point: RAFeedConveyor | RAInletGeometry | RASurface, particle: RAParticle) - -Create a particle inlet 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. - - - -#### CreateReceivingConveyor() - -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) - -Creates a volumetric inlet 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. - * **box_dimensions** – The dimensions (lenght, width, height) of the limit cube. - - - -#### DeleteResults() - -Called to delete any results we currently have from a simulation. - - - -#### ExtendSimulation(extension_amount: float | Scalar = 0, time: TimeStep | int | None = None, inlet_extensions: list[tuple[str, float | Scalar]] | None = None, periodic_motion_extensions: list[tuple[str, float | Scalar]] | None = None) - -Extend the simulation: either its duration, the duration of an inlet in the study or the -duration of a periodic motion frame. - -* **Parameters:** - * **extension_amount** – The number of seconds to extend the simulation by. - * **time** – The optional time at which to extend the simulation. - * **inlet_extensions** – The list of input extensions. - The first parameter of each pair must be the name of the continuous injection to extend, - and the second is the number of seconds to extend the input by. - * **periodic_motion_extensions** – the list of periodic motions extensions. - The first parameter of each pair must be the name of the periodic motion to extend, - and the second is the number of seconds to extend the periodic motion by. - - - -#### GetAirFlow() - -Get the RAAirFlow object (if applicable). - -* **Returns:** - The AirFlow object is configured as the CFD coupling mode - None otherwise - - - -#### GetCFDCoupling() - -Get the current CFD coupling object. - -* **Returns:** - The CFDCoupling object - - - -#### GetCalculations() - -Get the project’s Calculations. - - - -#### GetCollectForcesForFemAnalysis() - -Checks wheter the Collision Statistics modules are colecting FEM Forces for analysis - -* **Return bool:** - True if the Collect FEM Forces property of any Collision Statistics module is enabled - - - -#### GetContactData() - -Get the RAContactData object. - -* **Returns:** - The contact data object. - - - -#### GetCustomerName() - -Get the study customer name. - - - -#### GetDescription() - -Get the study description. - - - -#### GetDomainSettings() - -Get the study’s Domain Settings. - - - -#### GetElementCurve(element_name: str, curve_name: str, simulation_name: str | None = None, realization: str | None = None) - -Get the curve matching a given element name and curve 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 -* **Return type:** - Curve -* **Returns:** - The curves for the given element and name. - - - -#### GetExportToolkit() - -Get a RAExportToolkit object related to this RAStudy. The returned object can be used -for export operations. - - - -#### GetFEMForcesAnalysisModules(module_collection: RAModuleCollection) - -Get the name and the FEM Forces property for all available Boundary Collision Statistics -modules - -* **Parameters:** - **module_collection** ([*RAModuleCollection*](RAModuleCollection.md#generated.RAModuleCollection)) – The study’s Module Collection -* **Return Dict[str, str]:** - A Dict with the Module Name and the FEM Forces property name - - - -#### GetGeometry(geometry_name: str) - -Get the geometry with the given name - -* **Returns:** - The geometry with the given name - - - -#### GetGeometryCollection() - -Get the study’s Geometry Collection. - - - -#### GetInletsOutletsCollection() - -Get the study’s Inlets and Outlets Collection. - - - -#### GetIntraParticleCollisionStatistics() - -Get whether the Intra Particle Collision Statistics Module is enabled. - - - -#### GetJointsData() - -Get the RAParticleJointsData object. - -* **Returns:** - The joint statisctics data object. - - - -#### GetMaterialCollection() - -Get the study’s Material Collection. - - - -#### GetMaterialsInteractionCollection() - -Deprecated: Use [`RAMaterialCollection.GetMaterialsInteractionCollection()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterialsInteractionCollection) instead. - - - -#### GetMeshedParticlesUpscalingEnabled() - -Get the Meshed Particles Upscaling value. - - - -#### GetModuleCollection() - -Get the study’s Module Collection. - - - -#### GetMotionFrameSource() - -Get the study’s Motion Frame Source. - -* **Returns:** - The motion frame source, used to deal with motion. - - - -#### GetParticleCollection() - -Get the study’s Particle Collection. - - - -#### GetParticleInput(input_name: str) - -Get the particle input with the given name. - - - -#### GetParticles() - -Get the process that contains the simulated particles. - -* **Returns:** - The particles process - - - -#### GetPhysics() - -Get the study’s Physics object. - - - -#### GetPointCloudCollection() - -Get the study’s Point Cloud Collection. - - - -#### GetProgress() - -Get the current simulation progress [0.00, 100.00] or None if no simulation is running. - - - -#### GetSimulatorRun() - -Get the PrePost Scripting wrapper for simulation-related parameters. - - - -#### GetSolver() - -Synonym for [`GetSimulatorRun()`](#generated.RAStudy.GetSimulatorRun). - - - -#### *classmethod* GetStatus(include_opengl_messages: bool = False) - -Check the current Study status - -* **Parameters:** - **include_opengl_messages** – Whether messages related to OpenGL should be included in the status. -* **Returns:** - Returns a list of subject names and the existing status as a list of tuples with the - message type and description - - - -#### GetSurfaceFromFilename(filename: str) - -Given a filename finds all imported geometries created from it. - -* **Parameters:** - **filename** – The name of the file that originally created a set of geometries - - - -#### GetTimeSet() - -Get the study’s timeset. - -- Before simulation, the timeset will contain the timesteps used in motion preview. -- After simulation, the timeset will contain the actual simulation timesteps. - - - -#### GetWallFromFilename(filename: str) - -Given a filename finds all imported geometries created from it. - -* **Parameters:** - **filename** – The name of the file that originally created a set of geometries - - - -#### HasCalculatedHTC() - -Checks whether HTC is being calculated. - -* **Return bool:** - True if HTC is being calculated. - - - -#### HasResults() - -Whether we have results from a previous simulation. - - - -#### ImportSurface(custom_filename: str, import_scale: float = 1.0, convert_yz: bool = False, custom_name_prefix: str | None = None) - -Import a custom surface file and create one or more corresponding geometries in the study. - -* **Parameters:** - * **custom_filename** – The filename of the STL, DXF or XGL file to import. - * **import_scale** – The import scale to be applied to the imported geometry. - * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. - - - -#### ImportSystemCouplingWall(custom_filename: str, import_scale: float = 1.0, convert_yz: bool = False, custom_name_prefix: str | None = None) - -Import a geometry file and create one or more corresponding geometries in the study. - -* **Parameters:** - * **custom_filename** – The filename of the STL, DXF or XGL file to import. - * **import_scale** – The import scale to be applied to the imported geometry. - * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. - - - -#### ImportWall(custom_filename: str, import_scale: float = 1.0, convert_yz: bool = False, custom_name_prefix: str | None = None) - -Import a geometry file and create one or more corresponding geometries in the study. - -* **Parameters:** - * **custom_filename** – The filename of the STL, DXF or XGL file to import. - * **import_scale** – The import scale to be applied to the imported geometry. - * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. - - - -#### IsSimulating() - -Whether we’re currently simulating something. - - - -#### RefreshResults() - -Called to refresh the results we currently have from a simulation. - - - -#### RemoveMaterialAndRelatedInteractions(material_or_name: RASolidMaterial | str) - -Deprecated: Use `RemoveSolidMaterialAndRelatedInteractions()` instead. - - - -#### RemoveSurface(filename: str) - -Remove custom surfaces associated with the given filename. - -* **Parameters:** - **filename** – The name of the filename associated with the current project custom surfaces - - - -#### RemoveWall(filename: str) - -Remove walls associated with the given filename. - -* **Parameters:** - **filename** – The name of the filename associated with the current project walls - - - -#### ReplaceWallTriangles(new_filename: str, import_scale: float = 1.0, convert_yz: bool = False) - -Replace the existing triangles of a geometry with new triangles. - -It is assumed that there is a geometry corresponding to new_filename, previously -imported. This method is used to update the triangles of the geometry, without -creating new model entities. - -This method only supports geometry files that contain a single object. This is true for -all STL files, but XGL and DXF files generally support multiple objects per file - this -method will raise a RuntimeError in this case. - -* **Parameters:** - * **new_filename** – The filename of the STL, DXF or XGL file with new triangle data. - * **import_scale** – The import scale to be applied to the imported geometry. - * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. - - - -#### SetCollectForcesForFemAnalysis(value: bool) - -Enable the Boundary Collision Statistics modules and enable/disable -the FEM Forces analysis - -* **Parameters:** - **value** (*bool*) – Wheter to enable or disable the modules - - - -#### SetCustomerName(customer_name: str) - -Change the study customer’s name - -* **Parameters:** - **customer_name** – The customer name to be set - - - -#### SetDescription(description: str) - -Change the study description - -* **Parameters:** - **description** – The customer name to be set - - - -#### SetHTCCalculatorEnabled(value: bool) - -Enable/disable the SPH HTC Calculator module. - - - -#### SetIntraParticleCollisionStatistics(value: bool) - -Enable/disable the Intra Particle Collision Statistics Module. - -Note: This shortcut method enables/disables \_all_ properties related to that Module. - -* **Parameters:** - **value** - - - -#### SetVariable(name: str, value: float) - -Sets the values the given parametric variable - -* **Parameters:** - * **name** – The name of the variable - * **value** – The value to be set - - - -#### StartSimulation(skip_summary: bool | None = False, delete_results: bool | None = False, non_blocking: bool = False) - -Start the simulation. If possible, will resume a previously interrupted simulation. -If you wish to start a simulation from scratch, delete previous results via -DeleteResults() first. - -* **Parameters:** - * **skip_summary** (*bool*) – If starting from scratch, whether the simulation summary will be skipped (False) or - 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. - -:return bool -: Returns True if the simulation has started successfully, False otherwise. - - - -#### StopSimulation() - -Stops a currently running simulation. If there’s no simulation running, does nothing. - - - -#### *property* customer_name *: str* - -Get the study customer name. - - - -#### *property* description *: str* - -Get the study description. + + +# RAStudy + + + + + + +### *class* RAStudy + +Rocky PrePost Scripting wrapper for a project’s Study. + +This wrapper is the main access point for all other entities typically present in a Rocky +project. Access the [`RAStudy`](#generated.RAStudy) via the [`RAProject`](RAProject.md#generated.RAProject) once a project has been created +or opened (more): + +```python +project = app.GetProject() +study = project.GetStudy() +``` + + + +The [`RAStudy`](#generated.RAStudy) class acts as a main hub of functionality, providing methods to perform +various common actions related to simulations: + +- Helper creation methods for simulation entities such as [`CreateParticle()`](#generated.RAStudy.CreateParticle), + [`CreateFeedConveyor()`](#generated.RAStudy.CreateFeedConveyor), [`ImportWall()`](#generated.RAStudy.ImportWall), etc. +- Accessor methods for specialized PrePost Scripting wrapper objects such as [`GetMaterialCollection()`](#generated.RAStudy.GetMaterialCollection), + [`GetPhysics()`](#generated.RAStudy.GetPhysics), [`GetSimulatorRun()`](#generated.RAStudy.GetSimulatorRun), etc. +- Methods related to the simulation and its results, such as [`StartSimulation()`](#generated.RAStudy.StartSimulation), + [`StopSimulation()`](#generated.RAStudy.StopSimulation), [`DeleteResults()`](#generated.RAStudy.DeleteResults), etc. + +**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. | + +**Attributes:** + +| Name | Description | +|-------------------------------------------------------|--------------------------------| +| [`customer_name`](#generated.RAStudy.customer_name) | Get the study customer name. | +| [`description`](#generated.RAStudy.description) | Get the study description. | + + + +#### CanResumeSimulation() + +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) + +Create an outlet with the given exit point. + +* **Parameters:** + **exit_point** – The outlet’s exit point surface. + + + +#### CreateParticle() + +Create a particle in the study with default values. + + + +#### CreateParticleInlet(entry_point: RAFeedConveyor | RAInletGeometry | RASurface, particle: RAParticle) + +Create a particle inlet 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. + + + +#### CreateReceivingConveyor() + +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) + +Creates a volumetric inlet 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. + * **box_dimensions** – The dimensions (lenght, width, height) of the limit cube. + + + +#### DeleteResults() + +Called to delete any results we currently have from a simulation. + + + +#### ExtendSimulation(extension_amount: float | Scalar = 0, time: TimeStep | int | None = None, inlet_extensions: list[tuple[str, float | Scalar]] | None = None, periodic_motion_extensions: list[tuple[str, float | Scalar]] | None = None) + +Extend the simulation: either its duration, the duration of an inlet in the study or the +duration of a periodic motion frame. + +* **Parameters:** + * **extension_amount** – The number of seconds to extend the simulation by. + * **time** – The optional time at which to extend the simulation. + * **inlet_extensions** – The list of input extensions. + The first parameter of each pair must be the name of the continuous injection to extend, + and the second is the number of seconds to extend the input by. + * **periodic_motion_extensions** – the list of periodic motions extensions. + The first parameter of each pair must be the name of the periodic motion to extend, + and the second is the number of seconds to extend the periodic motion by. + + + +#### GetAirFlow() + +Get the RAAirFlow object (if applicable). + +* **Returns:** + The AirFlow object is configured as the CFD coupling mode + None otherwise + + + +#### GetCFDCoupling() + +Get the current CFD coupling object. + +* **Returns:** + The CFDCoupling object + + + +#### GetCalculations() + +Get the project’s Calculations. + + + +#### GetCollectForcesForFemAnalysis() + +Checks wheter the Collision Statistics modules are colecting FEM Forces for analysis + +* **Return bool:** + True if the Collect FEM Forces property of any Collision Statistics module is enabled + + + +#### GetContactData() + +Get the RAContactData object. + +* **Returns:** + The contact data object. + + + +#### GetCustomerName() + +Get the study customer name. + + + +#### GetDescription() + +Get the study description. + + + +#### GetDomainSettings() + +Get the study’s Domain Settings. + + + +#### GetElementCurve(element_name: str, curve_name: str, simulation_name: str | None = None, realization: str | None = None) + +Get the curve matching a given element name and curve 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 +* **Return type:** + Curve +* **Returns:** + The curves for the given element and name. + + + +#### GetExportToolkit() + +Get a RAExportToolkit object related to this RAStudy. The returned object can be used +for export operations. + + + +#### GetFEMForcesAnalysisModules(module_collection: RAModuleCollection) + +Get the name and the FEM Forces property for all available Boundary Collision Statistics +modules + +* **Parameters:** + **module_collection** ([*RAModuleCollection*](RAModuleCollection.md#generated.RAModuleCollection)) – The study’s Module Collection +* **Return Dict[str, str]:** + A Dict with the Module Name and the FEM Forces property name + + + +#### GetGeometry(geometry_name: str) + +Get the geometry with the given name + +* **Returns:** + The geometry with the given name + + + +#### GetGeometryCollection() + +Get the study’s Geometry Collection. + + + +#### GetInletsOutletsCollection() + +Get the study’s Inlets and Outlets Collection. + + + +#### GetIntraParticleCollisionStatistics() + +Get whether the Intra Particle Collision Statistics Module is enabled. + + + +#### GetJointsData() + +Get the RAParticleJointsData object. + +* **Returns:** + The joint statisctics data object. + + + +#### GetMaterialCollection() + +Get the study’s Material Collection. + + + +#### GetMaterialsInteractionCollection() + +Deprecated: Use [`RAMaterialCollection.GetMaterialsInteractionCollection()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterialsInteractionCollection) instead. + + + +#### GetMeshedParticlesUpscalingEnabled() + +Get the Meshed Particles Upscaling value. + + + +#### GetModuleCollection() + +Get the study’s Module Collection. + + + +#### GetMotionFrameSource() + +Get the study’s Motion Frame Source. + +* **Returns:** + The motion frame source, used to deal with motion. + + + +#### GetParticleCollection() + +Get the study’s Particle Collection. + + + +#### GetParticleInput(input_name: str) + +Get the particle input with the given name. + + + +#### GetParticles() + +Get the process that contains the simulated particles. + +* **Returns:** + The particles process + + + +#### GetPhysics() + +Get the study’s Physics object. + + + +#### GetPointCloudCollection() + +Get the study’s Point Cloud Collection. + + + +#### GetProgress() + +Get the current simulation progress [0.00, 100.00] or None if no simulation is running. + + + +#### GetSimulatorRun() + +Get the PrePost Scripting wrapper for simulation-related parameters. + + + +#### GetSolver() + +Synonym for [`GetSimulatorRun()`](#generated.RAStudy.GetSimulatorRun). + + + +#### *classmethod* GetStatus(include_opengl_messages: bool = False) + +Check the current Study status + +* **Parameters:** + **include_opengl_messages** – Whether messages related to OpenGL should be included in the status. +* **Returns:** + Returns a list of subject names and the existing status as a list of tuples with the + message type and description + + + +#### GetSurfaceFromFilename(filename: str) + +Given a filename finds all imported geometries created from it. + +* **Parameters:** + **filename** – The name of the file that originally created a set of geometries + + + +#### GetTimeSet() + +Get the study’s timeset. + +- Before simulation, the timeset will contain the timesteps used in motion preview. +- After simulation, the timeset will contain the actual simulation timesteps. + + + +#### GetWallFromFilename(filename: str) + +Given a filename finds all imported geometries created from it. + +* **Parameters:** + **filename** – The name of the file that originally created a set of geometries + + + +#### HasCalculatedHTC() + +Checks whether HTC is being calculated. + +* **Return bool:** + True if HTC is being calculated. + + + +#### HasResults() + +Whether we have results from a previous simulation. + + + +#### ImportSurface(custom_filename: str, import_scale: float = 1.0, convert_yz: bool = False, custom_name_prefix: str | None = None) + +Import a custom surface file and create one or more corresponding geometries in the study. + +* **Parameters:** + * **custom_filename** – The filename of the STL, DXF or XGL file to import. + * **import_scale** – The import scale to be applied to the imported geometry. + * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. + + + +#### ImportSystemCouplingWall(custom_filename: str, import_scale: float = 1.0, convert_yz: bool = False, custom_name_prefix: str | None = None) + +Import a geometry file and create one or more corresponding geometries in the study. + +* **Parameters:** + * **custom_filename** – The filename of the STL, DXF or XGL file to import. + * **import_scale** – The import scale to be applied to the imported geometry. + * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. + + + +#### ImportWall(custom_filename: str, import_scale: float = 1.0, convert_yz: bool = False, custom_name_prefix: str | None = None) + +Import a geometry file and create one or more corresponding geometries in the study. + +* **Parameters:** + * **custom_filename** – The filename of the STL, DXF or XGL file to import. + * **import_scale** – The import scale to be applied to the imported geometry. + * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. + + + +#### IsSimulating() + +Whether we’re currently simulating something. + + + +#### RefreshResults() + +Called to refresh the results we currently have from a simulation. + + + +#### RemoveMaterialAndRelatedInteractions(material_or_name: RASolidMaterial | str) + +Deprecated: Use `RemoveSolidMaterialAndRelatedInteractions()` instead. + + + +#### RemoveSurface(filename: str) + +Remove custom surfaces associated with the given filename. + +* **Parameters:** + **filename** – The name of the filename associated with the current project custom surfaces + + + +#### RemoveWall(filename: str) + +Remove walls associated with the given filename. + +* **Parameters:** + **filename** – The name of the filename associated with the current project walls + + + +#### ReplaceWallTriangles(new_filename: str, import_scale: float = 1.0, convert_yz: bool = False) + +Replace the existing triangles of a geometry with new triangles. + +It is assumed that there is a geometry corresponding to new_filename, previously +imported. This method is used to update the triangles of the geometry, without +creating new model entities. + +This method only supports geometry files that contain a single object. This is true for +all STL files, but XGL and DXF files generally support multiple objects per file - this +method will raise a RuntimeError in this case. + +* **Parameters:** + * **new_filename** – The filename of the STL, DXF or XGL file with new triangle data. + * **import_scale** – The import scale to be applied to the imported geometry. + * **convert_yz** – Whether the y and z axes of the imported geometry should be converted. + + + +#### SetCollectForcesForFemAnalysis(value: bool) + +Enable the Boundary Collision Statistics modules and enable/disable +the FEM Forces analysis + +* **Parameters:** + **value** (*bool*) – Wheter to enable or disable the modules + + + +#### SetCustomerName(customer_name: str) + +Change the study customer’s name + +* **Parameters:** + **customer_name** – The customer name to be set + + + +#### SetDescription(description: str) + +Change the study description + +* **Parameters:** + **description** – The customer name to be set + + + +#### SetHTCCalculatorEnabled(value: bool) + +Enable/disable the SPH HTC Calculator module. + + + +#### SetIntraParticleCollisionStatistics(value: bool) + +Enable/disable the Intra Particle Collision Statistics Module. + +Note: This shortcut method enables/disables \_all_ properties related to that Module. + +* **Parameters:** + **value** + + + +#### SetVariable(name: str, value: float) + +Sets the values the given parametric variable + +* **Parameters:** + * **name** – The name of the variable + * **value** – The value to be set + + + +#### StartSimulation(skip_summary: bool | None = False, delete_results: bool | None = False, non_blocking: bool = False) + +Start the simulation. If possible, will resume a previously interrupted simulation. +If you wish to start a simulation from scratch, delete previous results via +DeleteResults() first. + +* **Parameters:** + * **skip_summary** (*bool*) – If starting from scratch, whether the simulation summary will be skipped (False) or + 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. + +:return bool +: Returns True if the simulation has started successfully, False otherwise. + + + +#### StopSimulation() + +Stops a currently running simulation. If there’s no simulation running, does nothing. + + + +#### *property* customer_name *: str* + +Get the study customer name. + + + +#### *property* description *: str* + +Get the study description. diff --git a/2025R2/rocky-prepost-scripting-manual/RASurface.md b/2025R2/rocky-prepost-scripting-manual/RASurface.md index 060c656558..83b5b58aab 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASurface.md +++ b/2025R2/rocky-prepost-scripting-manual/RASurface.md @@ -1,1078 +1,1079 @@ - - -# RASurface - - - - - - -### *class* RASurface - -Rocky API “Surface” model. - -**Methods:** - -| [`AddCurve`](#generated.RASurface.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RASurface.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.RASurface.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RASurface.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RASurface.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.RASurface.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RASurface.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASurface.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.RASurface.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.RASurface.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.RASurface.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.RASurface.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RASurface.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RASurface.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RASurface.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RASurface.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RASurface.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RASurface.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RASurface.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RASurface.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RASurface.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RASurface.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RASurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`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. | -| [`GetOrientation`](#generated.RASurface.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RASurface.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RASurface.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RASurface.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RASurface.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetPivotPoint`](#generated.RASurface.GetPivotPoint)([unit]) | Get the value of "Pivot Point". | -| [`GetTimeSet`](#generated.RASurface.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RASurface.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`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". | -| [`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 | -| [`IterCellVertices`](#generated.RASurface.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RASurface.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RASurface.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RASurface.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RASurface.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RASurface.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`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". | -| [`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. | -| [`SetOrientationFromBasisVector`](#generated.RASurface.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetPivotPoint`](#generated.RASurface.SetPivotPoint)(values[, unit]) | Set the values of "Pivot Point". | -| [`SetTranslation`](#generated.RASurface.SetTranslation)(values[, unit]) | Set the values of "Translation". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetInvertNormal() - -Get the value of “Invert Normal”. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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. - - - -#### GetNumberOfCells(time_step='current') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetPivotPoint(unit: str | None = None) - -Get the value of “Pivot Point”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values 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 - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTranslation(unit: str | None = None) - -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”. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### HasMotionFrame() - -Whether the geometry is linked to a motion frame. - -* **Returns:** - True if geometry is linked to a motion frame False otherwise - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetInvertNormal(value: bool) - -Set the value of “Invert Normal”. - -* **Parameters:** - **value** – The value to set. - - - -#### 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. - - - -#### SetPivotPoint(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Pivot Point”. - -* **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. - - - -#### SetTranslation(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Translation”. - -* **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. + + +# RASurface + + + + + + +### *class* RASurface + +Rocky API “Surface” model. + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RASurface.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RASurface.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.RASurface.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RASurface.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RASurface.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.RASurface.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RASurface.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASurface.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.RASurface.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.RASurface.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.RASurface.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.RASurface.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RASurface.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RASurface.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RASurface.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RASurface.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RASurface.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RASurface.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RASurface.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RASurface.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RASurface.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RASurface.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RASurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`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. | +| [`GetOrientation`](#generated.RASurface.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RASurface.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RASurface.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RASurface.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RASurface.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetPivotPoint`](#generated.RASurface.GetPivotPoint)([unit]) | Get the value of "Pivot Point". | +| [`GetTimeSet`](#generated.RASurface.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RASurface.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`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". | +| [`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 | +| [`IterCellVertices`](#generated.RASurface.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RASurface.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RASurface.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RASurface.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RASurface.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RASurface.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`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". | +| [`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. | +| [`SetOrientationFromBasisVector`](#generated.RASurface.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetPivotPoint`](#generated.RASurface.SetPivotPoint)(values[, unit]) | Set the values of "Pivot Point". | +| [`SetTranslation`](#generated.RASurface.SetTranslation)(values[, unit]) | Set the values of "Translation". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetInvertNormal() + +Get the value of “Invert Normal”. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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. + + + +#### GetNumberOfCells(time_step='current') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetPivotPoint(unit: str | None = None) + +Get the value of “Pivot Point”. + +* **Parameters:** + **unit** – The unit for the returned values. If no unit is provided, the returned values 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 + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTranslation(unit: str | None = None) + +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”. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### HasMotionFrame() + +Whether the geometry is linked to a motion frame. + +* **Returns:** + True if geometry is linked to a motion frame False otherwise + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetInvertNormal(value: bool) + +Set the value of “Invert Normal”. + +* **Parameters:** + **value** – The value to set. + + + +#### 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. + + + +#### SetPivotPoint(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Pivot Point”. + +* **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. + + + +#### SetTranslation(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Translation”. + +* **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. diff --git a/2025R2/rocky-prepost-scripting-manual/RASurfaceUserProcess.md b/2025R2/rocky-prepost-scripting-manual/RASurfaceUserProcess.md index b3dfb1406a..06137c072c 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASurfaceUserProcess.md +++ b/2025R2/rocky-prepost-scripting-manual/RASurfaceUserProcess.md @@ -1,1116 +1,1117 @@ - - -# RASurfaceUserProcess - - - - - - -### *class* RASurfaceUserProcess - -**Methods:** - -| [`AddCurve`](#generated.RASurfaceUserProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RASurfaceUserProcess.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.RASurfaceUserProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RASurfaceUserProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RASurfaceUserProcess.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.RASurfaceUserProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RASurfaceUserProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASurfaceUserProcess.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.RASurfaceUserProcess.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.RASurfaceUserProcess.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.RASurfaceUserProcess.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.RASurfaceUserProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RASurfaceUserProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RASurfaceUserProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RASurfaceUserProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RASurfaceUserProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RASurfaceUserProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RASurfaceUserProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RASurfaceUserProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RASurfaceUserProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RASurfaceUserProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCenter`](#generated.RASurfaceUserProcess.GetCenter)([unit]) | | -| [`GetCurve`](#generated.RASurfaceUserProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RASurfaceUserProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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. | -| [`GetNumberOfNodes`](#generated.RASurfaceUserProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RASurfaceUserProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RASurfaceUserProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RASurfaceUserProcess.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RASurfaceUserProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RASurfaceUserProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RASurfaceUserProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOutputVariableValue`](#generated.RASurfaceUserProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetScale`](#generated.RASurfaceUserProcess.GetScale)([unit]) | Get the value of "Scale". | -| [`GetTimeSet`](#generated.RASurfaceUserProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`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). | -| [`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. | -| [`IterCells`](#generated.RASurfaceUserProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RASurfaceUserProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RASurfaceUserProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RASurfaceUserProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RASurfaceUserProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RASurfaceUserProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RASurfaceUserProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCenter`](#generated.RASurfaceUserProcess.SetCenter)(x, y, z[, unit]) | Sets the Polyhedron X, Y and Z center | -| [`SetCurrentTimeStep`](#generated.RASurfaceUserProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetMotionFrame`](#generated.RASurfaceUserProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | -| [`SetOrientation`](#generated.RASurfaceUserProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RASurfaceUserProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RASurfaceUserProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RASurfaceUserProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetSTL`](#generated.RASurfaceUserProcess.SetSTL)(filename[, mesh_unit]) | Sets the Polyhedron file | -| [`SetScale`](#generated.RASurfaceUserProcess.SetScale)(values[, unit]) | Set the values of "Scale". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### GetActivesArray(time_step='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 - 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') - -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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - - - -#### GetCenter(unit: str | None = None) - -* **Return type:** - tuple(float, float, float) -* **Returns:** - Returns the X, Y and Z Polyhedron center - - - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumberOfParticles(time_step) - -Get the total number of particles in this selection. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - int -* **Returns:** - The number of particles - - - -#### 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. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetScale(unit: str | None = None) - -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”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### IterParticles(time_step) - -Iterate on particles in this selection at the given time. Only for processes created on Particles. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** - iterator(Particle) -* **Returns:** - An iterator over the particles. - A Particle has: - - x, y, z, size - - x_axis, y_axis, z_axis, orientation_angle - - type, particle_group - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCenter(x: float, y: float, z: float, unit: str | None = None) - -Sets the Polyhedron X, Y and Z center - -* **Parameters:** - * **x** – float - The center X coordinate - * **y** – The center Y coordinate - * **z** – The center Z coordinate - * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') - -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. - - - -#### SetSTL(filename: str, mesh_unit: str | None = None) - -Sets the Polyhedron file - -* **Parameters:** - * **filename** – string - Path to the file to be used - * **mesh_unit** – string or None - unit to be used for the mesh, or None if given in meters (m) - - - -#### SetScale(values: Sequence[str | float], unit: str | None = None) - -Set the values of “Scale”. - -* **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. + + +# RASurfaceUserProcess + + + + + + +### *class* RASurfaceUserProcess + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RASurfaceUserProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RASurfaceUserProcess.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.RASurfaceUserProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RASurfaceUserProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RASurfaceUserProcess.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.RASurfaceUserProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RASurfaceUserProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASurfaceUserProcess.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.RASurfaceUserProcess.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.RASurfaceUserProcess.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.RASurfaceUserProcess.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.RASurfaceUserProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetBoundingBox`](#generated.RASurfaceUserProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCellAreaAsArray`](#generated.RASurfaceUserProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RASurfaceUserProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RASurfaceUserProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RASurfaceUserProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RASurfaceUserProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RASurfaceUserProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RASurfaceUserProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RASurfaceUserProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCenter`](#generated.RASurfaceUserProcess.GetCenter)([unit]) | | +| [`GetCurve`](#generated.RASurfaceUserProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RASurfaceUserProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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. | +| [`GetNumberOfNodes`](#generated.RASurfaceUserProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfParticles`](#generated.RASurfaceUserProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | +| [`GetNumpyCurve`](#generated.RASurfaceUserProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOrientation`](#generated.RASurfaceUserProcess.GetOrientation)([unit]) | Get the orientation angles. | +| [`GetOrientationFromAngleAndVector`](#generated.RASurfaceUserProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | +| [`GetOrientationFromAngles`](#generated.RASurfaceUserProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | +| [`GetOrientationFromBasisVector`](#generated.RASurfaceUserProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | +| [`GetOutputVariableValue`](#generated.RASurfaceUserProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetScale`](#generated.RASurfaceUserProcess.GetScale)([unit]) | Get the value of "Scale". | +| [`GetTimeSet`](#generated.RASurfaceUserProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`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). | +| [`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. | +| [`IterCells`](#generated.RASurfaceUserProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`IterParticles`](#generated.RASurfaceUserProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | +| [`Modified`](#generated.RASurfaceUserProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RASurfaceUserProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RASurfaceUserProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RASurfaceUserProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RASurfaceUserProcess.RemoveProcess)() | Removes the process from the project. | +| [`SetCenter`](#generated.RASurfaceUserProcess.SetCenter)(x, y, z[, unit]) | Sets the Polyhedron X, Y and Z center | +| [`SetCurrentTimeStep`](#generated.RASurfaceUserProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetMotionFrame`](#generated.RASurfaceUserProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | +| [`SetOrientation`](#generated.RASurfaceUserProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | +| [`SetOrientationFromAngleAndVector`](#generated.RASurfaceUserProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | +| [`SetOrientationFromAngles`](#generated.RASurfaceUserProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | +| [`SetOrientationFromBasisVector`](#generated.RASurfaceUserProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | +| [`SetSTL`](#generated.RASurfaceUserProcess.SetSTL)(filename[, mesh_unit]) | Sets the Polyhedron file | +| [`SetScale`](#generated.RASurfaceUserProcess.SetScale)(values[, unit]) | Set the values of "Scale". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### GetActivesArray(time_step='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 + 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') + +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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + + + +#### GetCenter(unit: str | None = None) + +* **Return type:** + tuple(float, float, float) +* **Returns:** + Returns the X, Y and Z Polyhedron center + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumberOfParticles(time_step) + +Get the total number of particles in this selection. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + int +* **Returns:** + The number of particles + + + +#### 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. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetScale(unit: str | None = None) + +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”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### IterParticles(time_step) + +Iterate on particles in this selection at the given time. Only for processes created on Particles. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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:** + iterator(Particle) +* **Returns:** + An iterator over the particles. + A Particle has: + - x, y, z, size + - x_axis, y_axis, z_axis, orientation_angle + - type, particle_group + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCenter(x: float, y: float, z: float, unit: str | None = None) + +Sets the Polyhedron X, Y and Z center + +* **Parameters:** + * **x** – float + The center X coordinate + * **y** – The center Y coordinate + * **z** – The center Z coordinate + * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.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') + +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. + + + +#### SetSTL(filename: str, mesh_unit: str | None = None) + +Sets the Polyhedron file + +* **Parameters:** + * **filename** – string + Path to the file to be used + * **mesh_unit** – string or None + unit to be used for the mesh, or None if given in meters (m) + + + +#### SetScale(values: Sequence[str | float], unit: str | None = None) + +Set the values of “Scale”. + +* **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. diff --git a/2025R2/rocky-prepost-scripting-manual/RASystemCouplingWall.md b/2025R2/rocky-prepost-scripting-manual/RASystemCouplingWall.md index d8e217d88e..63ec31f650 100644 --- a/2025R2/rocky-prepost-scripting-manual/RASystemCouplingWall.md +++ b/2025R2/rocky-prepost-scripting-manual/RASystemCouplingWall.md @@ -1,1151 +1,1152 @@ - - -# RASystemCouplingWall - - - - - - -### *class* RASystemCouplingWall - -Rocky API “System Coupling Wall” model. - -**Methods:** - -| [`AddCurve`](#generated.RASystemCouplingWall.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCustomCurve`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RASystemCouplingWall.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RASystemCouplingWall.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.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). | -| [`DisableStructuralCouplingType`](#generated.RASystemCouplingWall.DisableStructuralCouplingType)() | Set the value of "Structural Coupling Type" to False. | -| [`DisableThermalCouplingType`](#generated.RASystemCouplingWall.DisableThermalCouplingType)() | Set the value of "Thermal Coupling Type" to False. | -| [`EditCustomCurve`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.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. | -| [`EnableStructuralCouplingType`](#generated.RASystemCouplingWall.EnableStructuralCouplingType)() | Set the value of "Structural Coupling Type" to True. | -| [`EnableThermalCouplingType`](#generated.RASystemCouplingWall.EnableThermalCouplingType)() | Set the value of "Thermal Coupling Type" to True. | -| [`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. | -| [`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. | -| [`GetCellFromIJK`](#generated.RASystemCouplingWall.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RASystemCouplingWall.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RASystemCouplingWall.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RASystemCouplingWall.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RASystemCouplingWall.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RASystemCouplingWall.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`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. | -| [`GetGeometryQuantity`](#generated.RASystemCouplingWall.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`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. | -| [`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)() | | -| [`GetNumberOfCells`](#generated.RASystemCouplingWall.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RASystemCouplingWall.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumpyCurve`](#generated.RASystemCouplingWall.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RASystemCouplingWall.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetSphBoundaryType`](#generated.RASystemCouplingWall.GetSphBoundaryType)() | Get "Sph Boundary Type" as a string. | -| [`GetStructuralCouplingTypeEnabled`](#generated.RASystemCouplingWall.GetStructuralCouplingTypeEnabled)() | Get the value of "Structural Coupling Type Enabled". | -| [`GetSurfaceTensionContactAngle`](#generated.RASystemCouplingWall.GetSurfaceTensionContactAngle)([unit]) | Get the value of "Surface Tension Contact Angle". | -| [`GetThermalCouplingTypeEnabled`](#generated.RASystemCouplingWall.GetThermalCouplingTypeEnabled)() | Get the value of "Thermal Coupling Type Enabled". | -| [`GetTimeSet`](#generated.RASystemCouplingWall.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RASystemCouplingWall.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RASystemCouplingWall.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`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". | -| [`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 | -| [`IsStructuralCouplingTypeEnabled`](#generated.RASystemCouplingWall.IsStructuralCouplingTypeEnabled)() | Check if the "Structural Coupling Type" is enabled. | -| [`IsThermalCouplingTypeEnabled`](#generated.RASystemCouplingWall.IsThermalCouplingTypeEnabled)() | Check if the "Thermal Coupling Type" is enabled. | -| [`IterCellVertices`](#generated.RASystemCouplingWall.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RASystemCouplingWall.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RASystemCouplingWall.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RASystemCouplingWall.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`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. | -| [`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. | -| [`SetSphBoundaryType`](#generated.RASystemCouplingWall.SetSphBoundaryType)(value) | Set the value of "Sph Boundary Type". | -| [`SetStructuralCouplingTypeEnabled`](#generated.RASystemCouplingWall.SetStructuralCouplingTypeEnabled)(value) | Set the value of "Structural Coupling Type Enabled". | -| [`SetSurfaceTensionContactAngle`](#generated.RASystemCouplingWall.SetSurfaceTensionContactAngle)(value[, unit]) | Set the value of "Surface Tension Contact Angle". | -| [`SetThermalCouplingTypeEnabled`](#generated.RASystemCouplingWall.SetThermalCouplingTypeEnabled)(value) | Set the value of "Thermal Coupling Type Enabled". | -| [`SetTriangleSize`](#generated.RASystemCouplingWall.SetTriangleSize)(value[, unit]) | Set the value of "Triangle Size". | - - - -#### 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 - - - -#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom curve in the database. -:param name: - -> The name of the curve to be set. -* **Parameters:** - * **curve_type** – The type of the custom curve to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') - -Add a custom property to the database - -* **Parameters:** - * **name** – The name of the property to be set. - * **property_type** – The type of the custom property to be added. - * **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. - * **scope** – The scope to be set. - * **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. - * **expression** – The expression to be set. - - - -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) - -Adds a grid function to the grid. - -* **Parameters:** - * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association - representing the grid function. - * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. - * **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 - function is created and the given array associated with this time-step - -#### SEE ALSO -KAContextDependentElement.GetTimeStep - - - -#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **See:** - CreateTransientCurveOutputVariable for dealing with curves that are transient. -* **Parameters:** - * **curve_name** – The name of the curve for which the output variable is wanted. - * **operation** – - - The operation we want to do to convert the curve into a single value. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateGridFunction(values, location='cell', time_step='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 - - - -#### CreateGridFunctionArrayOnCells(time_step='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 - 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. - - - -#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) - -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). - -* **Parameters:** - * **grid_function_name** – The name of the grid function for which the output variable is wanted. - * **operation** – - - The operation used to select which value to get based on the statistic values obtained. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **statistic_operation** – - - The statistic operation which should be applied to the grid function for each time to - obtain a single value for each time. - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the grid functions to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) - -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). - -* **Parameters:** - * **curve_name** – The name of the transient curve for which the output variable is wanted. - * **operation** – - - The operation we want to do at the curve in each time (i.e.: go from transient curve - to a regular curve). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_operation** – - - The operation that we want to do at the curve when the curve is already converted to - a regular time-based curve (by applying the ‘operation’ at each time). - - Valid operations: - : ’min’ - ‘max’ - ‘sum’ - ‘sum_squared’ - ‘average’ - ‘variance’ - ‘standard_deviation’ - * **time_range** – - - Defines the time range for the curve to be gathered for creating the output - variable (depending on which time range is chosen, the initial_time_range and the - final_time_range may be used to get the actual times for computing the statistics). - - Valid time ranges: - : ’app_time_filter’: - : Uses the application time filter to get the relevant times. -
- ’all’ - : Uses all the times in the simulation. -
- ’last_output’ - : Uses only the last time in the simulation. -
- ’absolute’ - : Defines a time range using the initial_time_range and final_time_range. -
- ’single’ - : Defines a single time to be used as the time range specified as the - initial_time_range. -
- ’absolute_only_start’ - : Defines a time range using all the values after the given initial_time_range. -
- ’relative_to_end’ - : Uses all the values considering initial_time_range as a delta from the end of - the simulation. - * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). - * **domain_range** – - - Define the domain range for the curve to create the output variable - - Valid domain_range: - : ’all’ - : Uses all the domain in the simulation -
- ’single’ - : Defines a single time to be used as the time range specified as the initial_domain_range -
- ’absolute’ - : Defines a domain range using the initial_domain_range and final_domain_range. - * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). - * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). - * **domain_unit** – A unit for the domain_range -* **Return type:** - str -* **Returns:** - Returns the name of the variable to be used later on to reference the output variable. - - - -#### DisableStructuralCouplingType() - -Set the value of “Structural Coupling Type” to False. - - - -#### DisableThermalCouplingType() - -Set the value of “Thermal Coupling Type” to False. - - - -#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom curve saved in the database. -:param edit_curve: - -> The name of the curve to be edited. -* **Parameters:** - * **new_name** – The new name of the curve to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) - -Edit a custom property saved in the database. -:param edit_property: - -> The name of the property to be edited. -* **Parameters:** - * **new_name** – The new name of the property to be set. - * **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. - * **expression** – The expression to be set. - - - -#### EnableStructuralCouplingType() - -Set the value of “Structural Coupling Type” to True. - - - -#### EnableThermalCouplingType() - -Set the value of “Thermal Coupling Type” to True. - - - -#### GetActivesArray(time_step='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 - 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. - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetBoundingBox(unit=None, time_step='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 of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - time step is not available at the requested time. - - - -#### GetCellAreaAsArray(time_step='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 - 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') - -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 - 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') - -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 - 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') - -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 - 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 -* **Raises:** - **IndexError** – An IndexError is raised if the cell is inactive or out of range. - - - -#### GetCellIJK(cell_handle, time_step='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 - 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') - -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 - 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') - -Get a function for the points (vertices) of each cell. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step - or an ITimeStep identifying the time to get the cell points - or an int identifying the time step index to be used based on the global time set -* **Return type:** - PointsFunction -* **Returns:** - A function that provides access to the points of a cell (i.e.: vertices). - -#### NOTE -Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a -reservoir grid, the point id is a value from 0 to 7. - -@usage: - -```default -#To get vertex 0 of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -x, y, z = points_function[(cell, 0)] - -#To iterate over all the vertices of a cell: -points_function = grid.GetCellPointsAsFunction() -cell = grid.GetCellFromIJK(0, 0, 0) -for vertex in grid.IterCellVertices(cell): - x, y, z = points_function[vertex] -``` - - - -#### GetCellVolumeAsArray(time_step='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 - 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) - -Override base class method to check for a request of a grid function statistic. - - - -#### 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. - - - -#### GetGeometryQuantity() - -Get the quantity corresponding to the grid’s geometry. - -* **Return type:** - IQuantity -* **Returns:** - The grid geometry quantity - - - -#### GetGeometryUnit() - -Get the grid’s geometry’s unit. - -* **Return type:** - unicode -* **Returns:** - The unit for the grid geometry - - - -#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) - -Gets a grid function given its name. It provides a representation that’s valid for all times, -so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() - -To get the values of a given time, use: - -```default -time_set = grid.GetTimeSet() -grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) -``` - -#### NOTE -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 - 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:** - **ValueError** – if the grid function is not found. - - - -#### GetGridFunctionNames(translated=False, context=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. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) - -Get the RAMeshColoring related to the current object and a window. - -* **Parameters:** - **window** – The window that the coloring is acting. The window must be a str of the name of the - window or a KAWorkspaceWindow. -* **Raises:** - **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') - -Get the total number of cells. - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') - -Get the total number of nodes (vertices). - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### GetNumpyCurve(curve_name, unit=None, realization=None) - -Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. - - - -#### GetOutputVariableValue(variable_name: str) - -Get the value of a previously-created output variable. - -* **Parameters:** - **variable_name** (*unicode*) – The variable name whose value we want. -* **Returns:** - 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. - - - -#### GetSphBoundaryType() - -Get “Sph Boundary Type” as a string. - -* **Returns:** - The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. - - - -#### GetStructuralCouplingTypeEnabled() - -Get the value of “Structural Coupling Type Enabled”. - - - -#### GetSurfaceTensionContactAngle(unit: str | None = None) - -Get the value of “Surface Tension Contact Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetThermalCouplingTypeEnabled() - -Get the value of “Thermal Coupling Type Enabled”. - - - -#### GetTimeSet() - -Get the list of time-steps associated to the grid. - -* **Return type:** - ITimeSet -* **Returns:** - The list of time-steps associated to the grid - - - -#### GetTimeStatistics() - -Get the object responsible for handling time-statistics grid functions for this process. -This call will return None if the process doesn’t support time statistics. - - - -#### 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’. - - - -#### GetTopologyShape(time_step='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 - 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. - - - -#### GetTriangleSize(unit: str | None = None) - -Get the value of “Triangle Size”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetValidSphBoundaryTypeValues() - -Get a list of all possible values for “Sph Boundary Type”. - -* **Returns:** - The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. - - - -#### HasGridFunction(grid_function_name) - -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 -* **Returns:** - Returns True if the grid function exists and False otherwise. - - - -#### HasMotionFrame() - -Whether the geometry is linked to a motion frame. - -* **Returns:** - True if geometry is linked to a motion frame False otherwise - - - -#### IsCellActive(i, j, k, time_step='current') - -Checks if the given cell is active or not - -@param i, j, k: int -: The cell i, j, k - -* **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 - - - -#### IsStructuralCouplingTypeEnabled() - -Check if the “Structural Coupling Type” is enabled. - - - -#### IsThermalCouplingTypeEnabled() - -Check if the “Thermal Coupling Type” is enabled. - - - -#### IterCellVertices(cell, time_step='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 - 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:** - vertex_handle -* **Returns:** - The iterator over all the cell’s vertices. - - - -#### IterCells(time_step='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 - 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:** - iterator -* **Returns:** - The iterator over all the active grid cells for the given time. - - - -#### Modified(\*args, \*\*kwargs) - -Resets all the cache information after a change in the subject being tracked. - - - -#### RemoveCustomCurve(name: str) - -Remove the curve from the database -:param name: - -> The name of the curve to be removed. - - - -#### RemoveCustomProperty(name: str) - -Remove the property from the database -:param name: - -> The name of the property to be removed. - - - -#### RemoveOutputVariable(variable_name: str) - -Removes some output variable. - -* **Parameters:** - **variable_name** – The name of the variable to be removed. - - - -#### RemoveProcess() - -Removes the process from the project. - - - -#### SetCurrentTimeStep(time_step) - -Sets the current time step. - -* **Parameters:** - **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) - -Assign a Motion Frame to the process. - -* **Parameters:** - **motion_frame** – Either the API object or its name. - - - -#### SetSphBoundaryType(value: str) - -Set the value of “Sph Boundary Type”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Sph Boundary Type” option. - - - -#### SetStructuralCouplingTypeEnabled(value: bool) - -Set the value of “Structural Coupling Type Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) - -Set the value of “Surface Tension Contact 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 “dega”. - - - -#### SetThermalCouplingTypeEnabled(value: bool) - -Set the value of “Thermal Coupling Type Enabled”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetTriangleSize(value: str | float, unit: str | None = None) - -Set the value of “Triangle Size”. - -* **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”. + + +# RASystemCouplingWall + + + + + + +### *class* RASystemCouplingWall + +Rocky API “System Coupling Wall” model. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RASystemCouplingWall.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RASystemCouplingWall.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RASystemCouplingWall.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.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). | +| [`DisableStructuralCouplingType`](#generated.RASystemCouplingWall.DisableStructuralCouplingType)() | Set the value of "Structural Coupling Type" to False. | +| [`DisableThermalCouplingType`](#generated.RASystemCouplingWall.DisableThermalCouplingType)() | Set the value of "Thermal Coupling Type" to False. | +| [`EditCustomCurve`](#generated.RASystemCouplingWall.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.RASystemCouplingWall.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. | +| [`EnableStructuralCouplingType`](#generated.RASystemCouplingWall.EnableStructuralCouplingType)() | Set the value of "Structural Coupling Type" to True. | +| [`EnableThermalCouplingType`](#generated.RASystemCouplingWall.EnableThermalCouplingType)() | Set the value of "Thermal Coupling Type" to True. | +| [`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. | +| [`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. | +| [`GetCellFromIJK`](#generated.RASystemCouplingWall.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RASystemCouplingWall.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RASystemCouplingWall.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RASystemCouplingWall.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RASystemCouplingWall.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetCurve`](#generated.RASystemCouplingWall.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`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. | +| [`GetGeometryQuantity`](#generated.RASystemCouplingWall.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`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. | +| [`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)() | | +| [`GetNumberOfCells`](#generated.RASystemCouplingWall.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RASystemCouplingWall.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumpyCurve`](#generated.RASystemCouplingWall.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RASystemCouplingWall.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetSphBoundaryType`](#generated.RASystemCouplingWall.GetSphBoundaryType)() | Get "Sph Boundary Type" as a string. | +| [`GetStructuralCouplingTypeEnabled`](#generated.RASystemCouplingWall.GetStructuralCouplingTypeEnabled)() | Get the value of "Structural Coupling Type Enabled". | +| [`GetSurfaceTensionContactAngle`](#generated.RASystemCouplingWall.GetSurfaceTensionContactAngle)([unit]) | Get the value of "Surface Tension Contact Angle". | +| [`GetThermalCouplingTypeEnabled`](#generated.RASystemCouplingWall.GetThermalCouplingTypeEnabled)() | Get the value of "Thermal Coupling Type Enabled". | +| [`GetTimeSet`](#generated.RASystemCouplingWall.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RASystemCouplingWall.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RASystemCouplingWall.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`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". | +| [`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 | +| [`IsStructuralCouplingTypeEnabled`](#generated.RASystemCouplingWall.IsStructuralCouplingTypeEnabled)() | Check if the "Structural Coupling Type" is enabled. | +| [`IsThermalCouplingTypeEnabled`](#generated.RASystemCouplingWall.IsThermalCouplingTypeEnabled)() | Check if the "Thermal Coupling Type" is enabled. | +| [`IterCellVertices`](#generated.RASystemCouplingWall.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RASystemCouplingWall.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RASystemCouplingWall.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RASystemCouplingWall.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`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. | +| [`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. | +| [`SetSphBoundaryType`](#generated.RASystemCouplingWall.SetSphBoundaryType)(value) | Set the value of "Sph Boundary Type". | +| [`SetStructuralCouplingTypeEnabled`](#generated.RASystemCouplingWall.SetStructuralCouplingTypeEnabled)(value) | Set the value of "Structural Coupling Type Enabled". | +| [`SetSurfaceTensionContactAngle`](#generated.RASystemCouplingWall.SetSurfaceTensionContactAngle)(value[, unit]) | Set the value of "Surface Tension Contact Angle". | +| [`SetThermalCouplingTypeEnabled`](#generated.RASystemCouplingWall.SetThermalCouplingTypeEnabled)(value) | Set the value of "Thermal Coupling Type Enabled". | +| [`SetTriangleSize`](#generated.RASystemCouplingWall.SetTriangleSize)(value[, unit]) | Set the value of "Triangle Size". | + + + +#### 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 + + + +#### AddCustomCurve(name: str, curve_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom curve in the database. +:param name: + +> The name of the curve to be set. +* **Parameters:** + * **curve_type** – The type of the custom curve to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddCustomProperty(name: str, property_type: str = 'simple', output_unit: str = '', scope: str = 'user', sources: dict[str, str] | None = None, expression: str = '') + +Add a custom property to the database + +* **Parameters:** + * **name** – The name of the property to be set. + * **property_type** – The type of the custom property to be added. + * **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. + * **scope** – The scope to be set. + * **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. + * **expression** – The expression to be set. + + + +#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) + +Adds a grid function to the grid. + +* **Parameters:** + * **grid_function_name** (*unicode* *or* *SemanticAssociation*) – The name of the grid function to be stored in this grid or the semantic association + representing the grid function. + * **grid_function** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. + * **unit** (*unicode* *or* *IQuantity*) – The unit (or quantity) in which the grid function is being given. + * **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 + function is created and the given array associated with this time-step + +#### SEE ALSO +KAContextDependentElement.GetTimeStep + + + +#### CreateCurveOutputVariable(curve_name: str, operation: str = 'max', time_range: str = 'all', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **See:** + CreateTransientCurveOutputVariable for dealing with curves that are transient. +* **Parameters:** + * **curve_name** – The name of the curve for which the output variable is wanted. + * **operation** – + + The operation we want to do to convert the curve into a single value. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateGridFunction(values, location='cell', time_step='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 + + + +#### CreateGridFunctionArrayOnCells(time_step='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 + 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. + + + +#### CreateGridFunctionStatisticOutputVariable(grid_function_name: str, operation: str = 'max', statistic_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0) + +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). + +* **Parameters:** + * **grid_function_name** – The name of the grid function for which the output variable is wanted. + * **operation** – + + The operation used to select which value to get based on the statistic values obtained. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **statistic_operation** – + + The statistic operation which should be applied to the grid function for each time to + obtain a single value for each time. + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the grid functions to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### CreateTransientCurveOutputVariable(curve_name: str, operation: str = 'max', time_operation: str = 'max', time_range: str = 'last_output', initial_time_range: float = 0.0, final_time_range: float = 0.0, domain_range: str = 'all', initial_domain_range: float = 0.0, final_domain_range: float = 0.0, domain_unit: str | None = None) + +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). + +* **Parameters:** + * **curve_name** – The name of the transient curve for which the output variable is wanted. + * **operation** – + + The operation we want to do at the curve in each time (i.e.: go from transient curve + to a regular curve). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_operation** – + + The operation that we want to do at the curve when the curve is already converted to + a regular time-based curve (by applying the ‘operation’ at each time). + + Valid operations: + : ’min’ + ‘max’ + ‘sum’ + ‘sum_squared’ + ‘average’ + ‘variance’ + ‘standard_deviation’ + * **time_range** – + + Defines the time range for the curve to be gathered for creating the output + variable (depending on which time range is chosen, the initial_time_range and the + final_time_range may be used to get the actual times for computing the statistics). + + Valid time ranges: + : ’app_time_filter’: + : Uses the application time filter to get the relevant times. +
+ ’all’ + : Uses all the times in the simulation. +
+ ’last_output’ + : Uses only the last time in the simulation. +
+ ’absolute’ + : Defines a time range using the initial_time_range and final_time_range. +
+ ’single’ + : Defines a single time to be used as the time range specified as the + initial_time_range. +
+ ’absolute_only_start’ + : Defines a time range using all the values after the given initial_time_range. +
+ ’relative_to_end’ + : Uses all the values considering initial_time_range as a delta from the end of + the simulation. + * **initial_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **final_time_range** – A value in seconds (whose actual meaning depends on the defined time_range). + * **domain_range** – + + Define the domain range for the curve to create the output variable + + Valid domain_range: + : ’all’ + : Uses all the domain in the simulation +
+ ’single’ + : Defines a single time to be used as the time range specified as the initial_domain_range +
+ ’absolute’ + : Defines a domain range using the initial_domain_range and final_domain_range. + * **initial_domain_range** – A value for the beginning of the domain (whose actual meaning depends on the defined domain_range). + * **final_domain_range** – A value for the end of the domain (whose actual meaning depends on the defined domain_range). + * **domain_unit** – A unit for the domain_range +* **Return type:** + str +* **Returns:** + Returns the name of the variable to be used later on to reference the output variable. + + + +#### DisableStructuralCouplingType() + +Set the value of “Structural Coupling Type” to False. + + + +#### DisableThermalCouplingType() + +Set the value of “Thermal Coupling Type” to False. + + + +#### EditCustomCurve(edit_curve: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom curve saved in the database. +:param edit_curve: + +> The name of the curve to be edited. +* **Parameters:** + * **new_name** – The new name of the curve to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EditCustomProperty(edit_property: str, new_name: str | None = None, sources: dict[str, str] | None = None, expression: str | None = None) + +Edit a custom property saved in the database. +:param edit_property: + +> The name of the property to be edited. +* **Parameters:** + * **new_name** – The new name of the property to be set. + * **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. + * **expression** – The expression to be set. + + + +#### EnableStructuralCouplingType() + +Set the value of “Structural Coupling Type” to True. + + + +#### EnableThermalCouplingType() + +Set the value of “Thermal Coupling Type” to True. + + + +#### GetActivesArray(time_step='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 + 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. + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetBoundingBox(unit=None, time_step='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 of the geometry). + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + time step is not available at the requested time. + + + +#### GetCellAreaAsArray(time_step='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 + 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') + +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 + 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') + +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 + 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') + +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 + 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 +* **Raises:** + **IndexError** – An IndexError is raised if the cell is inactive or out of range. + + + +#### GetCellIJK(cell_handle, time_step='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 + 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') + +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 + 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') + +Get a function for the points (vertices) of each cell. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the cell points + or an int identifying the time step index to be used based on the global time set +* **Return type:** + PointsFunction +* **Returns:** + A function that provides access to the points of a cell (i.e.: vertices). + +#### NOTE +Each point from a cell must be accessed by a tuple(cell_handle, point_id). In a +reservoir grid, the point id is a value from 0 to 7. + +@usage: + +```default +#To get vertex 0 of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +x, y, z = points_function[(cell, 0)] + +#To iterate over all the vertices of a cell: +points_function = grid.GetCellPointsAsFunction() +cell = grid.GetCellFromIJK(0, 0, 0) +for vertex in grid.IterCellVertices(cell): + x, y, z = points_function[vertex] +``` + + + +#### GetCellVolumeAsArray(time_step='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 + 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) + +Override base class method to check for a request of a grid function statistic. + + + +#### 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. + + + +#### GetGeometryQuantity() + +Get the quantity corresponding to the grid’s geometry. + +* **Return type:** + IQuantity +* **Returns:** + The grid geometry quantity + + + +#### GetGeometryUnit() + +Get the grid’s geometry’s unit. + +* **Return type:** + unicode +* **Returns:** + The unit for the grid geometry + + + +#### GetGridFunction(grid_function_name, simulation_name=None, translated=False) + +Gets a grid function given its name. It provides a representation that’s valid for all times, +so, one can do: grid.GetGridFunction(‘Pressure’).GetMax() + +To get the values of a given time, use: + +```default +time_set = grid.GetTimeSet() +grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10]) +``` + +#### NOTE +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 + 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:** + **ValueError** – if the grid function is not found. + + + +#### GetGridFunctionNames(translated=False, context=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. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) + +Get the RAMeshColoring related to the current object and a window. + +* **Parameters:** + **window** – The window that the coloring is acting. The window must be a str of the name of the + window or a KAWorkspaceWindow. +* **Raises:** + **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') + +Get the total number of cells. + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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') + +Get the total number of nodes (vertices). + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOutputVariableValue(variable_name: str) + +Get the value of a previously-created output variable. + +* **Parameters:** + **variable_name** (*unicode*) – The variable name whose value we want. +* **Returns:** + 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. + + + +#### GetSphBoundaryType() + +Get “Sph Boundary Type” as a string. + +* **Returns:** + The returned value will be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + + +#### GetStructuralCouplingTypeEnabled() + +Get the value of “Structural Coupling Type Enabled”. + + + +#### GetSurfaceTensionContactAngle(unit: str | None = None) + +Get the value of “Surface Tension Contact Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetThermalCouplingTypeEnabled() + +Get the value of “Thermal Coupling Type Enabled”. + + + +#### GetTimeSet() + +Get the list of time-steps associated to the grid. + +* **Return type:** + ITimeSet +* **Returns:** + The list of time-steps associated to the grid + + + +#### GetTimeStatistics() + +Get the object responsible for handling time-statistics grid functions for this process. +This call will return None if the process doesn’t support time statistics. + + + +#### 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’. + + + +#### GetTopologyShape(time_step='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 + 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. + + + +#### GetTriangleSize(unit: str | None = None) + +Get the value of “Triangle Size”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetValidSphBoundaryTypeValues() + +Get a list of all possible values for “Sph Boundary Type”. + +* **Returns:** + The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + + +#### HasGridFunction(grid_function_name) + +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 +* **Returns:** + Returns True if the grid function exists and False otherwise. + + + +#### HasMotionFrame() + +Whether the geometry is linked to a motion frame. + +* **Returns:** + True if geometry is linked to a motion frame False otherwise + + + +#### IsCellActive(i, j, k, time_step='current') + +Checks if the given cell is active or not + +@param i, j, k: int +: The cell i, j, k + +* **Parameters:** + **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – 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 + + + +#### IsStructuralCouplingTypeEnabled() + +Check if the “Structural Coupling Type” is enabled. + + + +#### IsThermalCouplingTypeEnabled() + +Check if the “Thermal Coupling Type” is enabled. + + + +#### IterCellVertices(cell, time_step='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 + 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:** + vertex_handle +* **Returns:** + The iterator over all the cell’s vertices. + + + +#### IterCells(time_step='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 + 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:** + iterator +* **Returns:** + The iterator over all the active grid cells for the given time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### RemoveCustomCurve(name: str) + +Remove the curve from the database +:param name: + +> The name of the curve to be removed. + + + +#### RemoveCustomProperty(name: str) + +Remove the property from the database +:param name: + +> The name of the property to be removed. + + + +#### RemoveOutputVariable(variable_name: str) + +Removes some output variable. + +* **Parameters:** + **variable_name** – The name of the variable to be removed. + + + +#### RemoveProcess() + +Removes the process from the project. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) + +Assign a Motion Frame to the process. + +* **Parameters:** + **motion_frame** – Either the API object or its name. + + + +#### SetSphBoundaryType(value: str) + +Set the value of “Sph Boundary Type”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Sph Boundary Type” option. + + + +#### SetStructuralCouplingTypeEnabled(value: bool) + +Set the value of “Structural Coupling Type Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetSurfaceTensionContactAngle(value: str | float, unit: str | None = None) + +Set the value of “Surface Tension Contact 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 “dega”. + + + +#### SetThermalCouplingTypeEnabled(value: bool) + +Set the value of “Thermal Coupling Type Enabled”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetTriangleSize(value: str | float, unit: str | None = None) + +Set the value of “Triangle Size”. + +* **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/2025R2/rocky-prepost-scripting-manual/RATagging.md b/2025R2/rocky-prepost-scripting-manual/RATagging.md index d4fab0d57f..df8c738dec 100644 --- a/2025R2/rocky-prepost-scripting-manual/RATagging.md +++ b/2025R2/rocky-prepost-scripting-manual/RATagging.md @@ -1,79 +1,80 @@ - - -# RATagging - - - - - - -### *class* RATagging - -Rocky PrePost Scripting wrapper to manipulate Tagging Calculators in a project. - -The class corresponds to an individual “Tagging” calculation under the -“Particles Calculation” item on the project’s data tree. To create the -[`RATagging`](#generated.RATagging) from a [`RACalculations`](RACalculations.md#generated.RACalculations), use: - -```python -selection_process = study.GetElement('Particles') -particles_calculations = study.GetCalculations() -tagging = particles_calculations.CreateTagging(selection_process) -``` - -**Methods:** - -| [`GetGridFunctionName`](#generated.RATagging.GetGridFunctionName)() | Get the tagging grid function name. | -|-----------------------------------------------------------------------|---------------------------------------------------------------| -| [`GetNameMask`](#generated.RATagging.GetNameMask)() | Get the value of "Name Mask". | -| [`GetTagValue`](#generated.RATagging.GetTagValue)() | Get the value of "Tag Value". | -| [`GetTimeRangeFilter`](#generated.RATagging.GetTimeRangeFilter)() | Get the API object that wraps the specific Time Range Filter. | -| [`SetNameMask`](#generated.RATagging.SetNameMask)(value) | Set the value of "Name Mask". | -| [`SetTagValue`](#generated.RATagging.SetTagValue)(value) | Set the value of "Tag Value". | - - - -#### GetGridFunctionName() - -Get the tagging grid function name. This name can be used to access the tagging grid -function on a particle-based process. -:rtype: str - - - -#### GetNameMask() - -Get the value of “Name Mask”. - - - -#### GetTagValue() - -Get the value of “Tag Value”. - - - -#### GetTimeRangeFilter() - -Get the API object that wraps the specific Time Range Filter. -:rtype: RATimeRangeFilter - - - -#### SetNameMask(value: str) - -Set the value of “Name Mask”. - -* **Parameters:** - **value** – The value to set. - - - -#### SetTagValue(value: str | int) - -Set the value of “Tag Value”. - -* **Parameters:** - **value** – The value to set. This value can be an expression with input variables or int type. + + +# RATagging + + + + + + +### *class* RATagging + +Rocky PrePost Scripting wrapper to manipulate Tagging Calculators in a project. + +The class corresponds to an individual “Tagging” calculation under the +“Particles Calculation” item on the project’s data tree. To create the +[`RATagging`](#generated.RATagging) from a [`RACalculations`](RACalculations.md#generated.RACalculations), use: + +```python +selection_process = study.GetElement('Particles') +particles_calculations = study.GetCalculations() +tagging = particles_calculations.CreateTagging(selection_process) +``` + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------|---------------------------------------------------------------| +| [`GetGridFunctionName`](#generated.RATagging.GetGridFunctionName)() | Get the tagging grid function name. | +| [`GetNameMask`](#generated.RATagging.GetNameMask)() | Get the value of "Name Mask". | +| [`GetTagValue`](#generated.RATagging.GetTagValue)() | Get the value of "Tag Value". | +| [`GetTimeRangeFilter`](#generated.RATagging.GetTimeRangeFilter)() | Get the API object that wraps the specific Time Range Filter. | +| [`SetNameMask`](#generated.RATagging.SetNameMask)(value) | Set the value of "Name Mask". | +| [`SetTagValue`](#generated.RATagging.SetTagValue)(value) | Set the value of "Tag Value". | + + + +#### GetGridFunctionName() + +Get the tagging grid function name. This name can be used to access the tagging grid +function on a particle-based process. +:rtype: str + + + +#### GetNameMask() + +Get the value of “Name Mask”. + + + +#### GetTagValue() + +Get the value of “Tag Value”. + + + +#### GetTimeRangeFilter() + +Get the API object that wraps the specific Time Range Filter. +:rtype: RATimeRangeFilter + + + +#### SetNameMask(value: str) + +Set the value of “Name Mask”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetTagValue(value: str | int) + +Set the value of “Tag Value”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. diff --git a/2025R2/rocky-prepost-scripting-manual/RAThreeRollsBeltProfile.md b/2025R2/rocky-prepost-scripting-manual/RAThreeRollsBeltProfile.md index 32d51328dc..0aac9767a5 100644 --- a/2025R2/rocky-prepost-scripting-manual/RAThreeRollsBeltProfile.md +++ b/2025R2/rocky-prepost-scripting-manual/RAThreeRollsBeltProfile.md @@ -1,150 +1,151 @@ - - -# RAThreeRollsBeltProfile - - - - - - -### *class* RAThreeRollsBeltProfile - -Rocky API for a Three Rolls Belt Profile model. - -**Methods:** - -| [`DisableUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths)() | Set the value of "Use 0371 Ratio For Roll Lengths" to False. | -|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| -| [`EnableUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths)() | Set the value of "Use 0371 Ratio For Roll Lengths" to True. | -| [`GetAvailableMaterials`](#generated.RAThreeRollsBeltProfile.GetAvailableMaterials)() | Get all available Materials. | -| [`GetCenterRollLength`](#generated.RAThreeRollsBeltProfile.GetCenterRollLength)([unit]) | Get the value of "Center Roll Length". | -| [`GetLowerCornerRadius`](#generated.RAThreeRollsBeltProfile.GetLowerCornerRadius)([unit]) | Get the value of "Lower Corner Radius". | -| [`GetMaterial`](#generated.RAThreeRollsBeltProfile.GetMaterial)() | Get the "Material". | -| [`GetTroughingAngle`](#generated.RAThreeRollsBeltProfile.GetTroughingAngle)([unit]) | Get the value of "Troughing Angle". | -| [`GetUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths)() | Get the value of "Use 0371 Ratio For Roll Lengths". | -| [`IsUse0371RatioForRollLengthsEnabled`](#generated.RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled)() | Check if the "Use 0371 Ratio For Roll Lengths" is enabled. | -| [`SetCenterRollLength`](#generated.RAThreeRollsBeltProfile.SetCenterRollLength)(value[, unit]) | Set the value of "Center Roll Length". | -| [`SetLowerCornerRadius`](#generated.RAThreeRollsBeltProfile.SetLowerCornerRadius)(value[, unit]) | Set the value of "Lower Corner Radius". | -| [`SetMaterial`](#generated.RAThreeRollsBeltProfile.SetMaterial)(value) | Set the "Material". | -| [`SetTroughingAngle`](#generated.RAThreeRollsBeltProfile.SetTroughingAngle)(value[, unit]) | Set the value of "Troughing Angle". | -| [`SetUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths)(value) | Set the value of "Use 0371 Ratio For Roll Lengths". | - - - -#### DisableUse0371RatioForRollLengths() - -Set the value of “Use 0371 Ratio For Roll Lengths” to False. - - - -#### EnableUse0371RatioForRollLengths() - -Set the value of “Use 0371 Ratio For Roll Lengths” to True. - - - -#### GetAvailableMaterials() - -Get all available Materials. - -* **Return type:** - List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] - A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). - - - -#### GetCenterRollLength(unit: str | None = None) - -Get the value of “Center Roll Length”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetLowerCornerRadius(unit: str | None = None) - -Get the value of “Lower Corner Radius”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. - - - -#### GetMaterial() - -Get the “Material”. - -* **Return type:** - [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - - - -#### GetTroughingAngle(unit: str | None = None) - -Get the value of “Troughing Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. - - - -#### GetUse0371RatioForRollLengths() - -Get the value of “Use 0371 Ratio For Roll Lengths”. - - - -#### IsUse0371RatioForRollLengthsEnabled() - -Check if the “Use 0371 Ratio For Roll Lengths” is enabled. - - - -#### SetCenterRollLength(value: str | float, unit: str | None = None) - -Set the value of “Center Roll Length”. - -* **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”. - - - -#### SetLowerCornerRadius(value: str | float, unit: str | None = None) - -Set the value of “Lower Corner Radius”. - -* **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”. - - - -#### SetMaterial(value) - -Set the “Material”. - -:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: -: Either the API object wrapping the desired entity or its name. - - - -#### SetTroughingAngle(value: str | float, unit: str | None = None) - -Set the value of “Troughing 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 “dega”. - - - -#### SetUse0371RatioForRollLengths(value: bool) - -Set the value of “Use 0371 Ratio For Roll Lengths”. - -* **Parameters:** - **value** – The value to set. + + +# RAThreeRollsBeltProfile + + + + + + +### *class* RAThreeRollsBeltProfile + +Rocky API for a Three Rolls Belt Profile model. + +**Methods:** + +| Name | Description | +|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| [`DisableUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths)() | Set the value of "Use 0371 Ratio For Roll Lengths" to False. | +| [`EnableUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths)() | Set the value of "Use 0371 Ratio For Roll Lengths" to True. | +| [`GetAvailableMaterials`](#generated.RAThreeRollsBeltProfile.GetAvailableMaterials)() | Get all available Materials. | +| [`GetCenterRollLength`](#generated.RAThreeRollsBeltProfile.GetCenterRollLength)([unit]) | Get the value of "Center Roll Length". | +| [`GetLowerCornerRadius`](#generated.RAThreeRollsBeltProfile.GetLowerCornerRadius)([unit]) | Get the value of "Lower Corner Radius". | +| [`GetMaterial`](#generated.RAThreeRollsBeltProfile.GetMaterial)() | Get the "Material". | +| [`GetTroughingAngle`](#generated.RAThreeRollsBeltProfile.GetTroughingAngle)([unit]) | Get the value of "Troughing Angle". | +| [`GetUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths)() | Get the value of "Use 0371 Ratio For Roll Lengths". | +| [`IsUse0371RatioForRollLengthsEnabled`](#generated.RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled)() | Check if the "Use 0371 Ratio For Roll Lengths" is enabled. | +| [`SetCenterRollLength`](#generated.RAThreeRollsBeltProfile.SetCenterRollLength)(value[, unit]) | Set the value of "Center Roll Length". | +| [`SetLowerCornerRadius`](#generated.RAThreeRollsBeltProfile.SetLowerCornerRadius)(value[, unit]) | Set the value of "Lower Corner Radius". | +| [`SetMaterial`](#generated.RAThreeRollsBeltProfile.SetMaterial)(value) | Set the "Material". | +| [`SetTroughingAngle`](#generated.RAThreeRollsBeltProfile.SetTroughingAngle)(value[, unit]) | Set the value of "Troughing Angle". | +| [`SetUse0371RatioForRollLengths`](#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths)(value) | Set the value of "Use 0371 Ratio For Roll Lengths". | + + + +#### DisableUse0371RatioForRollLengths() + +Set the value of “Use 0371 Ratio For Roll Lengths” to False. + + + +#### EnableUse0371RatioForRollLengths() + +Set the value of “Use 0371 Ratio For Roll Lengths” to True. + + + +#### GetAvailableMaterials() + +Get all available Materials. + +* **Return type:** + List[[`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial)] + A list of [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial). + + + +#### GetCenterRollLength(unit: str | None = None) + +Get the value of “Center Roll Length”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetLowerCornerRadius(unit: str | None = None) + +Get the value of “Lower Corner Radius”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + + +#### GetMaterial() + +Get the “Material”. + +* **Return type:** + [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + + + +#### GetTroughingAngle(unit: str | None = None) + +Get the value of “Troughing Angle”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “dega”. + + + +#### GetUse0371RatioForRollLengths() + +Get the value of “Use 0371 Ratio For Roll Lengths”. + + + +#### IsUse0371RatioForRollLengthsEnabled() + +Check if the “Use 0371 Ratio For Roll Lengths” is enabled. + + + +#### SetCenterRollLength(value: str | float, unit: str | None = None) + +Set the value of “Center Roll Length”. + +* **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”. + + + +#### SetLowerCornerRadius(value: str | float, unit: str | None = None) + +Set the value of “Lower Corner Radius”. + +* **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”. + + + +#### SetMaterial(value) + +Set the “Material”. + +:param unicode, [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) value: +: Either the API object wrapping the desired entity or its name. + + + +#### SetTroughingAngle(value: str | float, unit: str | None = None) + +Set the value of “Troughing 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 “dega”. + + + +#### SetUse0371RatioForRollLengths(value: bool) + +Set the value of “Use 0371 Ratio For Roll Lengths”. + +* **Parameters:** + **value** – The value to set. diff --git a/2025R2/rocky-prepost-scripting-manual/about-grid-functions.md b/2025R2/rocky-prepost-scripting-manual/about-grid-functions.md index 4bd6499003..1f03f523c5 100644 --- a/2025R2/rocky-prepost-scripting-manual/about-grid-functions.md +++ b/2025R2/rocky-prepost-scripting-manual/about-grid-functions.md @@ -1,44 +1,44 @@ - - -# About Grid Functions / Properties - -Rocky’s PrePost Scripting provides Grid Functions or Properties that are retrieved by its -respective name (a string parameter) as shown in the following example: - -```python -study = app.GetStudy() -particle = study.GetElement('Particles') -particle_size = particle.GetGridFunction('Particle Size') -``` - -The following documentation provides details about some particular Grid Functions or -Properties. - - - -## Stress Tensor - -The Stress Tensor Grid Function is available when the contacts collection is activated. - -```python -study = app.GetStudy() -particle = study.GetElement('Particles') -stress_tensor = particle.GetGridFunction('Stress Tensor') -``` - -The Stress Tensor array can be retrieved by: - -```python -stress_tensor = particle.GetGridFunction('Stress Tensor') -stress_tensor.GetArray(time_step=1) - -# Sample output: -# array([[0., 0., 0., 0., 0., 0., 0., 0., 0.], -# [0., 0., 0., 0., 0., 0., 0., 0., 0.], -# [0., 0., 0., 0., 0., 0., 0., 0., 0.]]) -``` - -The retrieved array has the structure of N x 9 elements where N is the number of particles -present in the respective time_step. Each 9 element array list represents the particle Stress -Tensor components in the following order: σXX, σXY, σXZ, σYX, σYY, σYZ, σZX, σZY, -σZZ. + + +# About Grid Functions / Properties + +Rocky’s PrePost Scripting provides Grid Functions or Properties that are retrieved by its +respective name (a string parameter) as shown in the following example: + +```python +study = app.GetStudy() +particle = study.GetElement('Particles') +particle_size = particle.GetGridFunction('Particle Size') +``` + +The following documentation provides details about some particular Grid Functions or +Properties. + + + +## Stress Tensor + +The Stress Tensor Grid Function is available when the contacts collection is activated. + +```python +study = app.GetStudy() +particle = study.GetElement('Particles') +stress_tensor = particle.GetGridFunction('Stress Tensor') +``` + +The Stress Tensor array can be retrieved by: + +```python +stress_tensor = particle.GetGridFunction('Stress Tensor') +stress_tensor.GetArray(time_step=1) + +# Sample output: +# array([[0., 0., 0., 0., 0., 0., 0., 0., 0.], +# [0., 0., 0., 0., 0., 0., 0., 0., 0.], +# [0., 0., 0., 0., 0., 0., 0., 0., 0.]]) +``` + +The retrieved array has the structure of N x 9 elements where N is the number of particles +present in the respective time_step. Each 9 element array list represents the particle Stress +Tensor components in the following order: σXX, σXY, σXZ, σYX, σYY, σYZ, σZX, σZY, +σZZ. diff --git a/2025R2/rocky-prepost-scripting-manual/basic-usage.md b/2025R2/rocky-prepost-scripting-manual/basic-usage.md index f51369f600..b273cbd802 100644 --- a/2025R2/rocky-prepost-scripting-manual/basic-usage.md +++ b/2025R2/rocky-prepost-scripting-manual/basic-usage.md @@ -1,24 +1,24 @@ - - -# Introduction - -Rocky’s PrePost Scripting provides lower-level access to Rocky’s data structures and simulation results. -The API can be used to configure and simulate a project from scratch, analyze and export simulation -results and perform computations that go beyond Rocky’s standard feature set. - -This page provides a basic guide/tutorial of the PrePost Scripting from the point of view of setting up -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). - -> :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. - ---- -> :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.) - ---- -> :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. + + +# Introduction + +Rocky’s PrePost Scripting provides lower-level access to Rocky’s data structures and simulation results. +The API can be used to configure and simulate a project from scratch, analyze and export simulation +results and perform computations that go beyond Rocky’s standard feature set. + +This page provides a basic guide/tutorial of the PrePost Scripting from the point of view of setting up +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 +> 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 +> 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. diff --git a/2025R2/rocky-prepost-scripting-manual/changelog.md b/2025R2/rocky-prepost-scripting-manual/changelog.md index dd5a59744a..6565e4ad86 100644 --- a/2025R2/rocky-prepost-scripting-manual/changelog.md +++ b/2025R2/rocky-prepost-scripting-manual/changelog.md @@ -1,119 +1,119 @@ - - -# Release notes for 2025 R2 - - - -## Added - - - -### 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) -* [`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) -* [`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) - - - -### New Classes - -* [`RACubeGroup`](RACubeGroup.md) - Wraps a series of user cubes. -* [`RACylinderGroup`](RACylinderGroup.md) - Wraps a series of user cylinders. - - - -## Changed - - - -## 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. - - - -## Removed + + +# Release notes for 2025 R2 + + + +## Added + + + +### 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) +* [`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) +* [`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) + + + +### New Classes + +* [`RACubeGroup`](RACubeGroup.md) - Wraps a series of user cubes. +* [`RACylinderGroup`](RACylinderGroup.md) - Wraps a series of user cylinders. + + + +## Changed + + + +## 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. + + + +## Removed diff --git a/2025R2/rocky-prepost-scripting-manual/docfx.json b/2025R2/rocky-prepost-scripting-manual/docfx.json index 89db6862fb..58f827eaf4 100644 --- a/2025R2/rocky-prepost-scripting-manual/docfx.json +++ b/2025R2/rocky-prepost-scripting-manual/docfx.json @@ -8,7 +8,7 @@ "product": "Rocky", "programming language": "Python", "product collection": "Fluids", - "physics": "Fluids" + "physics": "Particles" } } } diff --git a/2025R2/rocky-prepost-scripting-manual/getting-started.md b/2025R2/rocky-prepost-scripting-manual/getting-started.md index 21f6bb3011..b747f49d1a 100644 --- a/2025R2/rocky-prepost-scripting-manual/getting-started.md +++ b/2025R2/rocky-prepost-scripting-manual/getting-started.md @@ -1,160 +1,160 @@ - - -# Getting Started - - - -## Setting Up a Project - -Create a new project and set the study description and customer: - -```python -project = app.CreateProject() -project.SaveProject('my_project.rocky') - -study = project.GetStudy() -study.SetDescription('My Simulation') -study.SetCustomerName('My Customer') -``` - -Configure physics settings: - -```python -physics = study.GetPhysics() -physics.SetEnableThermalModel(True) -physics.SetGravityStartTime(10, 's') -physics.SetRollingResistanceModel('type_3') -physics.SetNormalForceModel('damped_hertzian') -``` - -Create and configure materials and their interactions: - -```python -material_collection = study.GetMaterialCollection() -material = material_collection.New() -material.SetUseBulkDensity(False) -material.SetName('My Material') -material.SetDensity(1000) - -interactions = study.GetMaterialsInteractionCollection() -inter_1 = interactions.GetMaterialsInteraction('Default Particles', 'My Material') -inter_1.SetAdhesiveDistance(10, 'cm') -``` - -Create and configure custom geometries and surfaces: - -```python -custom = study.ImportCustomGeometries('my_geometry.stl')[0] -custom.SetBoundaryMass(100, 'kg') -custom.SetVerticalOffset(-10, 'cm') -custom.SetMaterial('My Material') - -surface = study.CreateCircularSurface() -surface.SetName('My Surface') -surface.SetMinRadius(1, 'm') -surface.SetMaxRadius(2, 'm') -``` - -Create and configure the particle sets used in the simulation and the particle inputs: - -```python -particle_collection = study.GetParticleCollection() -particle = particle_collection.New() - -particle.SetShape('polyhedron') -particle.SetNumberOfCorners(14) -particle.SetName('My Particle') -particle.SetBreakageModel('ab_t10') - -inlets = study.GetParticleInputCollection() -inlet_1 = inlets.AddParticleInlet() -inlet_1.SetName('My Particle Inlet') -inlet_1.SetEntryPoint('My Surface') - -entries = inlet_1.GetInputPropertiesList() -entry = entries.New() -entry.SetParticle(particle) -entry.SetMassFlowRate(100, 'kg/s') -entry.SetTemperature(30, 'degC') -``` - -Configure domain settings: - -```python -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.SetPeriodicAtGeometryLimits(True) -``` - -Configure solver settings and start the simulation: - -```python -solver = study.GetSimulatorRun() -solver.SetSimulationDuration(5, 's') -solver.SetOutputFrequency(1, 's') -solver.SetNumberOfProcessors(2) - -# The script will block until the simulation finishes. -study.StartSimulation(skip_summary=True, delete_results=True) -``` - - - -## Post-Processing Results - -The simulation entities that provide results (such as particles, conveyors, and custom geometries) -have methods in their API wrappers to retrieve the geometry, properties (grid functions), curves, etc. - -Get the positions of the particles at a given timestep: - -```python -study = app.GetStudy() -particles = study.GetParticles() -for particle in particles.IterParticles(time_step=10): - print(particle.x, particle.y, particle.z) - -# Sample output: -# (-5.833559188701166, 0.7380019118190704, 0.19294910836680973) -# (-5.1383928383823845, 0.6290253809025952, -0.14368919420973403) -``` - -Get individual properties (grid functions) and curves: - -```python -particles.GetGridFunction('Absolute Translational Velocity').GetArray(time_step=10) - -# Sample output: -# array([ 2.56413788, 4.46129788, 3.96977314, 3.47665254 ]) - -# GetY() returns the curve's image. -particles.GetCurve('Particles Count').GetY() - -# Sample output: -# array([ 0, 1, 2, 3, 4, 6, 6, 7, 8, 9, 11 ]) -``` - -Create and modify user processes, and retrieve their results: - -```python -# Get the collection of user processes. -project = app.GetProject() -user_processes = project.GetUserProcessCollection() - -# Create and configure a Cube on the Particles. -cube = user_processes.CreateCubeProcess(particles) -cube.SetCenter(1.0, 2.0, 3.0, 'm') -cube.SetSize(2.0, 2.0, 2.0) - -# Create and configure an Eulerian Statistics on the Cube. -eulerian = user_processes.CreateEulerianStatistics(cube) -eulerian.SetDivisions((2, 2, 1)) - -# Retrieve a property on the Eulerian Statistics. -eulerian.GetGridFunction('Number of Particles').GetArray(time_step=10) - -# Sample output. The Grid Function has 4 elements because the Eulerian Statistics has 2x2x1 = 4 blocks. -# array([ 0., 2., 3., 0.]) -``` + + +# Getting Started + + + +## Setting Up a Project + +Create a new project and set the study description and customer: + +```python +project = app.CreateProject() +project.SaveProject('my_project.rocky') + +study = project.GetStudy() +study.SetDescription('My Simulation') +study.SetCustomerName('My Customer') +``` + +Configure physics settings: + +```python +physics = study.GetPhysics() +physics.SetEnableThermalModel(True) +physics.SetGravityStartTime(10, 's') +physics.SetRollingResistanceModel('type_3') +physics.SetNormalForceModel('damped_hertzian') +``` + +Create and configure materials and their interactions: + +```python +material_collection = study.GetMaterialCollection() +material = material_collection.New() +material.SetUseBulkDensity(False) +material.SetName('My Material') +material.SetDensity(1000) + +interactions = study.GetMaterialsInteractionCollection() +inter_1 = interactions.GetMaterialsInteraction('Default Particles', 'My Material') +inter_1.SetAdhesiveDistance(10, 'cm') +``` + +Create and configure custom geometries and surfaces: + +```python +custom = study.ImportCustomGeometries('my_geometry.stl')[0] +custom.SetBoundaryMass(100, 'kg') +custom.SetVerticalOffset(-10, 'cm') +custom.SetMaterial('My Material') + +surface = study.CreateCircularSurface() +surface.SetName('My Surface') +surface.SetMinRadius(1, 'm') +surface.SetMaxRadius(2, 'm') +``` + +Create and configure the particle sets used in the simulation and the particle inputs: + +```python +particle_collection = study.GetParticleCollection() +particle = particle_collection.New() + +particle.SetShape('polyhedron') +particle.SetNumberOfCorners(14) +particle.SetName('My Particle') +particle.SetBreakageModel('ab_t10') + +inlets = study.GetParticleInputCollection() +inlet_1 = inlets.AddParticleInlet() +inlet_1.SetName('My Particle Inlet') +inlet_1.SetEntryPoint('My Surface') + +entries = inlet_1.GetInputPropertiesList() +entry = entries.New() +entry.SetParticle(particle) +entry.SetMassFlowRate(100, 'kg/s') +entry.SetTemperature(30, 'degC') +``` + +Configure domain settings: + +```python +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.SetPeriodicAtGeometryLimits(True) +``` + +Configure solver settings and start the simulation: + +```python +solver = study.GetSimulatorRun() +solver.SetSimulationDuration(5, 's') +solver.SetOutputFrequency(1, 's') +solver.SetNumberOfProcessors(2) + +# The script will block until the simulation finishes. +study.StartSimulation(skip_summary=True, delete_results=True) +``` + + + +## Post-Processing Results + +The simulation entities that provide results (such as particles, conveyors, and custom geometries) +have methods in their API wrappers to retrieve the geometry, properties (grid functions), curves, etc. + +Get the positions of the particles at a given timestep: + +```python +study = app.GetStudy() +particles = study.GetParticles() +for particle in particles.IterParticles(time_step=10): + print(particle.x, particle.y, particle.z) + +# Sample output: +# (-5.833559188701166, 0.7380019118190704, 0.19294910836680973) +# (-5.1383928383823845, 0.6290253809025952, -0.14368919420973403) +``` + +Get individual properties (grid functions) and curves: + +```python +particles.GetGridFunction('Absolute Translational Velocity').GetArray(time_step=10) + +# Sample output: +# array([ 2.56413788, 4.46129788, 3.96977314, 3.47665254 ]) + +# GetY() returns the curve's image. +particles.GetCurve('Particles Count').GetY() + +# Sample output: +# array([ 0, 1, 2, 3, 4, 6, 6, 7, 8, 9, 11 ]) +``` + +Create and modify user processes, and retrieve their results: + +```python +# Get the collection of user processes. +project = app.GetProject() +user_processes = project.GetUserProcessCollection() + +# Create and configure a Cube on the Particles. +cube = user_processes.CreateCubeProcess(particles) +cube.SetCenter(1.0, 2.0, 3.0, 'm') +cube.SetSize(2.0, 2.0, 2.0) + +# Create and configure an Eulerian Statistics on the Cube. +eulerian = user_processes.CreateEulerianStatistics(cube) +eulerian.SetDivisions((2, 2, 1)) + +# Retrieve a property on the Eulerian Statistics. +eulerian.GetGridFunction('Number of Particles').GetArray(time_step=10) + +# Sample output. The Grid Function has 4 elements because the Eulerian Statistics has 2x2x1 = 4 blocks. +# array([ 0., 2., 3., 0.]) +``` diff --git a/2025R2/rocky-prepost-scripting-manual/index.md b/2025R2/rocky-prepost-scripting-manual/index.md index 389d955c33..a492e30c11 100644 --- a/2025R2/rocky-prepost-scripting-manual/index.md +++ b/2025R2/rocky-prepost-scripting-manual/index.md @@ -1,4239 +1,4239 @@ - - -# Rocky PrePost Scripting Help - -# Contents: - -* [Introduction](basic-usage.md) -* [Getting Started](getting-started.md) - * [Setting Up a Project](getting-started.md#setting-up-a-project) - * [Post-Processing Results](getting-started.md#post-processing-results) -* [Using VScode to Create/Edit Scripts](setup-ide.md) -* [Class Reference](prepost-scripting-reference.md) - * [RAAirFlow](RAAirFlow.md) - * [`RAAirFlow`](RAAirFlow.md#generated.RAAirFlow) - * [`RAAirFlow.AddCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCurve) - * [`RAAirFlow.AddCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCustomCurve) - * [`RAAirFlow.AddCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.AddCustomProperty) - * [`RAAirFlow.AddGridFunction()`](RAAirFlow.md#generated.RAAirFlow.AddGridFunction) - * [`RAAirFlow.CreateCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateCurveOutputVariable) - * [`RAAirFlow.CreateGridFunction()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunction) - * [`RAAirFlow.CreateGridFunctionArrayOnCells()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionArrayOnCells) - * [`RAAirFlow.CreateGridFunctionStatisticOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionStatisticOutputVariable) - * [`RAAirFlow.CreateTransientCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateTransientCurveOutputVariable) - * [`RAAirFlow.EditCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.EditCustomCurve) - * [`RAAirFlow.EditCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.EditCustomProperty) - * [`RAAirFlow.GetActivesArray()`](RAAirFlow.md#generated.RAAirFlow.GetActivesArray) - * [`RAAirFlow.GetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.GetAirDensity) - * [`RAAirFlow.GetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.GetAirKinematicViscosity) - * [`RAAirFlow.GetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.GetBoundaryConditionType) - * [`RAAirFlow.GetBoundingBox()`](RAAirFlow.md#generated.RAAirFlow.GetBoundingBox) - * [`RAAirFlow.GetCellAreaAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellAreaAsArray) - * [`RAAirFlow.GetCellCenterAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellCenterAsArray) - * [`RAAirFlow.GetCellDzAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellDzAsArray) - * [`RAAirFlow.GetCellFromIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellFromIJK) - * [`RAAirFlow.GetCellIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellIJK) - * [`RAAirFlow.GetCellNumberOfVertices()`](RAAirFlow.md#generated.RAAirFlow.GetCellNumberOfVertices) - * [`RAAirFlow.GetCellPointsAsFunction()`](RAAirFlow.md#generated.RAAirFlow.GetCellPointsAsFunction) - * [`RAAirFlow.GetCellSize()`](RAAirFlow.md#generated.RAAirFlow.GetCellSize) - * [`RAAirFlow.GetCellVolumeAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellVolumeAsArray) - * [`RAAirFlow.GetCurve()`](RAAirFlow.md#generated.RAAirFlow.GetCurve) - * [`RAAirFlow.GetCurveNames()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNames) - * [`RAAirFlow.GetCurveNamesAssociation()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNamesAssociation) - * [`RAAirFlow.GetElementCurve()`](RAAirFlow.md#generated.RAAirFlow.GetElementCurve) - * [`RAAirFlow.GetGeometryQuantity()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryQuantity) - * [`RAAirFlow.GetGeometryUnit()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryUnit) - * [`RAAirFlow.GetGridFunction()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunction) - * [`RAAirFlow.GetGridFunctionNames()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunctionNames) - * [`RAAirFlow.GetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.GetInteractionScale) - * [`RAAirFlow.GetMaxX()`](RAAirFlow.md#generated.RAAirFlow.GetMaxX) - * [`RAAirFlow.GetMaxY()`](RAAirFlow.md#generated.RAAirFlow.GetMaxY) - * [`RAAirFlow.GetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.GetMaxZ) - * [`RAAirFlow.GetMeshColoring()`](RAAirFlow.md#generated.RAAirFlow.GetMeshColoring) - * [`RAAirFlow.GetMinX()`](RAAirFlow.md#generated.RAAirFlow.GetMinX) - * [`RAAirFlow.GetMinY()`](RAAirFlow.md#generated.RAAirFlow.GetMinY) - * [`RAAirFlow.GetMinZ()`](RAAirFlow.md#generated.RAAirFlow.GetMinZ) - * [`RAAirFlow.GetNumberOfCells()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfCells) - * [`RAAirFlow.GetNumberOfNodes()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfNodes) - * [`RAAirFlow.GetNumpyCurve()`](RAAirFlow.md#generated.RAAirFlow.GetNumpyCurve) - * [`RAAirFlow.GetOutputVariableValue()`](RAAirFlow.md#generated.RAAirFlow.GetOutputVariableValue) - * [`RAAirFlow.GetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.GetSpeedOfSound) - * [`RAAirFlow.GetStartTime()`](RAAirFlow.md#generated.RAAirFlow.GetStartTime) - * [`RAAirFlow.GetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.GetStartWhenParticlesEnter) - * [`RAAirFlow.GetTimeSet()`](RAAirFlow.md#generated.RAAirFlow.GetTimeSet) - * [`RAAirFlow.GetTimeStatistics()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStatistics) - * [`RAAirFlow.GetTimeStep()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStep) - * [`RAAirFlow.GetTopologyShape()`](RAAirFlow.md#generated.RAAirFlow.GetTopologyShape) - * [`RAAirFlow.GetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.GetUseAirflow) - * [`RAAirFlow.GetValidBoundaryConditionTypeValues()`](RAAirFlow.md#generated.RAAirFlow.GetValidBoundaryConditionTypeValues) - * [`RAAirFlow.HasGridFunction()`](RAAirFlow.md#generated.RAAirFlow.HasGridFunction) - * [`RAAirFlow.IsCellActive()`](RAAirFlow.md#generated.RAAirFlow.IsCellActive) - * [`RAAirFlow.IterCellVertices()`](RAAirFlow.md#generated.RAAirFlow.IterCellVertices) - * [`RAAirFlow.IterCells()`](RAAirFlow.md#generated.RAAirFlow.IterCells) - * [`RAAirFlow.Modified()`](RAAirFlow.md#generated.RAAirFlow.Modified) - * [`RAAirFlow.RemoveCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomCurve) - * [`RAAirFlow.RemoveCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomProperty) - * [`RAAirFlow.RemoveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.RemoveOutputVariable) - * [`RAAirFlow.RemoveProcess()`](RAAirFlow.md#generated.RAAirFlow.RemoveProcess) - * [`RAAirFlow.SetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.SetAirDensity) - * [`RAAirFlow.SetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.SetAirKinematicViscosity) - * [`RAAirFlow.SetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.SetBoundaryConditionType) - * [`RAAirFlow.SetCellSize()`](RAAirFlow.md#generated.RAAirFlow.SetCellSize) - * [`RAAirFlow.SetCurrentTimeStep()`](RAAirFlow.md#generated.RAAirFlow.SetCurrentTimeStep) - * [`RAAirFlow.SetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.SetInteractionScale) - * [`RAAirFlow.SetMaxX()`](RAAirFlow.md#generated.RAAirFlow.SetMaxX) - * [`RAAirFlow.SetMaxY()`](RAAirFlow.md#generated.RAAirFlow.SetMaxY) - * [`RAAirFlow.SetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.SetMaxZ) - * [`RAAirFlow.SetMinX()`](RAAirFlow.md#generated.RAAirFlow.SetMinX) - * [`RAAirFlow.SetMinY()`](RAAirFlow.md#generated.RAAirFlow.SetMinY) - * [`RAAirFlow.SetMinZ()`](RAAirFlow.md#generated.RAAirFlow.SetMinZ) - * [`RAAirFlow.SetPartIdIfValid()`](RAAirFlow.md#generated.RAAirFlow.SetPartIdIfValid) - * [`RAAirFlow.SetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.SetSpeedOfSound) - * [`RAAirFlow.SetStartTime()`](RAAirFlow.md#generated.RAAirFlow.SetStartTime) - * [`RAAirFlow.SetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.SetStartWhenParticlesEnter) - * [`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) - * [`RACFDParametersList`](RACFDParametersList.md#generated.RACFDParametersList) - * [`RACFDParametersList.Clear()`](RACFDParametersList.md#generated.RACFDParametersList.Clear) - * [`RACFDParametersList.GetParametersFor()`](RACFDParametersList.md#generated.RACFDParametersList.GetParametersFor) - * [`RACFDParametersList.New()`](RACFDParametersList.md#generated.RACFDParametersList.New) - * [`RACFDParametersList.Remove()`](RACFDParametersList.md#generated.RACFDParametersList.Remove) - * [RACFDPerParticleParameters](RACFDPerParticleParameters.md) - * [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - * [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) - * [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) - * [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) - * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) - * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) - * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) - * [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) - * [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) - * [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) - * [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) - * [`RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues) - * [`RACFDPerParticleParameters.GetValidDragLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidDragLawValues) - * [`RACFDPerParticleParameters.GetValidLiftLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidLiftLawValues) - * [`RACFDPerParticleParameters.GetValidTorqueLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidTorqueLawValues) - * [`RACFDPerParticleParameters.GetValidVirtualMassLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidVirtualMassLawValues) - * [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) - * [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) - * [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) - * [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) - * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) - * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) - * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) - * [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) - * [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) - * [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) - * [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) - * [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) - * [RACalculations](RACalculations.md) - * [`RACalculations`](RACalculations.md#generated.RACalculations) - * [`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) - * [`RACalculations.GetTagging()`](RACalculations.md#generated.RACalculations.GetTagging) - * [`RACalculations.GetTaggingNames()`](RACalculations.md#generated.RACalculations.GetTaggingNames) - * [RACircularSurface](RACircularSurface.md) - * [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface) - * [`RACircularSurface.AddCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCurve) - * [`RACircularSurface.AddCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCustomCurve) - * [`RACircularSurface.AddCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.AddCustomProperty) - * [`RACircularSurface.AddGridFunction()`](RACircularSurface.md#generated.RACircularSurface.AddGridFunction) - * [`RACircularSurface.CreateCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateCurveOutputVariable) - * [`RACircularSurface.CreateGridFunction()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunction) - * [`RACircularSurface.CreateGridFunctionArrayOnCells()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionArrayOnCells) - * [`RACircularSurface.CreateGridFunctionStatisticOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionStatisticOutputVariable) - * [`RACircularSurface.CreateTransientCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateTransientCurveOutputVariable) - * [`RACircularSurface.EditCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.EditCustomCurve) - * [`RACircularSurface.EditCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.EditCustomProperty) - * [`RACircularSurface.GetActivesArray()`](RACircularSurface.md#generated.RACircularSurface.GetActivesArray) - * [`RACircularSurface.GetBoundingBox()`](RACircularSurface.md#generated.RACircularSurface.GetBoundingBox) - * [`RACircularSurface.GetCellAreaAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellAreaAsArray) - * [`RACircularSurface.GetCellCenterAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellCenterAsArray) - * [`RACircularSurface.GetCellDzAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellDzAsArray) - * [`RACircularSurface.GetCellFromIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellFromIJK) - * [`RACircularSurface.GetCellIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellIJK) - * [`RACircularSurface.GetCellNumberOfVertices()`](RACircularSurface.md#generated.RACircularSurface.GetCellNumberOfVertices) - * [`RACircularSurface.GetCellPointsAsFunction()`](RACircularSurface.md#generated.RACircularSurface.GetCellPointsAsFunction) - * [`RACircularSurface.GetCellVolumeAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellVolumeAsArray) - * [`RACircularSurface.GetCenter()`](RACircularSurface.md#generated.RACircularSurface.GetCenter) - * [`RACircularSurface.GetCurve()`](RACircularSurface.md#generated.RACircularSurface.GetCurve) - * [`RACircularSurface.GetCurveNames()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNames) - * [`RACircularSurface.GetCurveNamesAssociation()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNamesAssociation) - * [`RACircularSurface.GetElementCurve()`](RACircularSurface.md#generated.RACircularSurface.GetElementCurve) - * [`RACircularSurface.GetGeometryQuantity()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryQuantity) - * [`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.GetNumberOfCells()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfCells) - * [`RACircularSurface.GetNumberOfNodes()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfNodes) - * [`RACircularSurface.GetNumpyCurve()`](RACircularSurface.md#generated.RACircularSurface.GetNumpyCurve) - * [`RACircularSurface.GetOrientation()`](RACircularSurface.md#generated.RACircularSurface.GetOrientation) - * [`RACircularSurface.GetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngleAndVector) - * [`RACircularSurface.GetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngles) - * [`RACircularSurface.GetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromBasisVector) - * [`RACircularSurface.GetOutputVariableValue()`](RACircularSurface.md#generated.RACircularSurface.GetOutputVariableValue) - * [`RACircularSurface.GetTimeSet()`](RACircularSurface.md#generated.RACircularSurface.GetTimeSet) - * [`RACircularSurface.GetTimeStatistics()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStatistics) - * [`RACircularSurface.GetTimeStep()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStep) - * [`RACircularSurface.GetTopologyShape()`](RACircularSurface.md#generated.RACircularSurface.GetTopologyShape) - * [`RACircularSurface.HasGridFunction()`](RACircularSurface.md#generated.RACircularSurface.HasGridFunction) - * [`RACircularSurface.HasMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.HasMotionFrame) - * [`RACircularSurface.IsCellActive()`](RACircularSurface.md#generated.RACircularSurface.IsCellActive) - * [`RACircularSurface.IterCellVertices()`](RACircularSurface.md#generated.RACircularSurface.IterCellVertices) - * [`RACircularSurface.IterCells()`](RACircularSurface.md#generated.RACircularSurface.IterCells) - * [`RACircularSurface.Modified()`](RACircularSurface.md#generated.RACircularSurface.Modified) - * [`RACircularSurface.RemoveCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomCurve) - * [`RACircularSurface.RemoveCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomProperty) - * [`RACircularSurface.RemoveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.RemoveOutputVariable) - * [`RACircularSurface.RemoveProcess()`](RACircularSurface.md#generated.RACircularSurface.RemoveProcess) - * [`RACircularSurface.SetCenter()`](RACircularSurface.md#generated.RACircularSurface.SetCenter) - * [`RACircularSurface.SetCurrentTimeStep()`](RACircularSurface.md#generated.RACircularSurface.SetCurrentTimeStep) - * [`RACircularSurface.SetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMaxRadius) - * [`RACircularSurface.SetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMinRadius) - * [`RACircularSurface.SetOrientation()`](RACircularSurface.md#generated.RACircularSurface.SetOrientation) - * [`RACircularSurface.SetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngleAndVector) - * [`RACircularSurface.SetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngles) - * [`RACircularSurface.SetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromBasisVector) - * [RAConeCrusherFrame](RAConeCrusherFrame.md) - * [`RAConeCrusherFrame`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) - * [`RAConeCrusherFrame.GetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetInitialOrientation) - * [`RAConeCrusherFrame.GetMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetMotionFrame) - * [`RAConeCrusherFrame.GetParentMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetParentMotionFrame) - * [`RAConeCrusherFrame.GetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetPivotPoint) - * [`RAConeCrusherFrame.GetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationAxis) - * [`RAConeCrusherFrame.GetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationalVelocity) - * [`RAConeCrusherFrame.GetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStartTime) - * [`RAConeCrusherFrame.GetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStopTime) - * [`RAConeCrusherFrame.IterMotionFrames()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.IterMotionFrames) - * [`RAConeCrusherFrame.NewConeCrusherFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewConeCrusherFrame) - * [`RAConeCrusherFrame.NewFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewFrame) - * [`RAConeCrusherFrame.RemoveFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.RemoveFrame) - * [`RAConeCrusherFrame.SetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetInitialOrientation) - * [`RAConeCrusherFrame.SetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetPivotPoint) - * [`RAConeCrusherFrame.SetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationAxis) - * [`RAConeCrusherFrame.SetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationalVelocity) - * [`RAConeCrusherFrame.SetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStartTime) - * [`RAConeCrusherFrame.SetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStopTime) - * [RAConstantOneWayCoupling](RAConstantOneWayCoupling.md) - * [`RAConstantOneWayCoupling`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling) - * [`RAConstantOneWayCoupling.AddCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCurve) - * [`RAConstantOneWayCoupling.AddCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomCurve) - * [`RAConstantOneWayCoupling.AddCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomProperty) - * [`RAConstantOneWayCoupling.AddGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddGridFunction) - * [`RAConstantOneWayCoupling.CreateCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateCurveOutputVariable) - * [`RAConstantOneWayCoupling.CreateGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunction) - * [`RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells) - * [`RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable) - * [`RAConstantOneWayCoupling.CreateTransientCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateTransientCurveOutputVariable) - * [`RAConstantOneWayCoupling.DisableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.DisableTurbulentDispersion) - * [`RAConstantOneWayCoupling.EditCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomCurve) - * [`RAConstantOneWayCoupling.EditCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomProperty) - * [`RAConstantOneWayCoupling.EnableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EnableTurbulentDispersion) - * [`RAConstantOneWayCoupling.GetActivesArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetActivesArray) - * [`RAConstantOneWayCoupling.GetBoundingBox()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetBoundingBox) - * [`RAConstantOneWayCoupling.GetCFDParametersList()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCFDParametersList) - * [`RAConstantOneWayCoupling.GetCellAreaAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellAreaAsArray) - * [`RAConstantOneWayCoupling.GetCellCenterAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellCenterAsArray) - * [`RAConstantOneWayCoupling.GetCellDzAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellDzAsArray) - * [`RAConstantOneWayCoupling.GetCellFromIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellFromIJK) - * [`RAConstantOneWayCoupling.GetCellIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellIJK) - * [`RAConstantOneWayCoupling.GetCellNumberOfVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellNumberOfVertices) - * [`RAConstantOneWayCoupling.GetCellPointsAsFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellPointsAsFunction) - * [`RAConstantOneWayCoupling.GetCellVolumeAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellVolumeAsArray) - * [`RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw) - * [`RAConstantOneWayCoupling.GetCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurve) - * [`RAConstantOneWayCoupling.GetCurveNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNames) - * [`RAConstantOneWayCoupling.GetCurveNamesAssociation()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNamesAssociation) - * [`RAConstantOneWayCoupling.GetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDensity) - * [`RAConstantOneWayCoupling.GetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDragLaw) - * [`RAConstantOneWayCoupling.GetElementCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetElementCurve) - * [`RAConstantOneWayCoupling.GetGeometryQuantity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryQuantity) - * [`RAConstantOneWayCoupling.GetGeometryUnit()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryUnit) - * [`RAConstantOneWayCoupling.GetGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunction) - * [`RAConstantOneWayCoupling.GetGridFunctionNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunctionNames) - * [`RAConstantOneWayCoupling.GetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetLiftLaw) - * [`RAConstantOneWayCoupling.GetMeshColoring()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMeshColoring) - * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK1) - * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK2) - * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK3) - * [`RAConstantOneWayCoupling.GetNumberOfCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfCells) - * [`RAConstantOneWayCoupling.GetNumberOfNodes()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfNodes) - * [`RAConstantOneWayCoupling.GetNumpyCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumpyCurve) - * [`RAConstantOneWayCoupling.GetOutputVariableValue()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetOutputVariableValue) - * [`RAConstantOneWayCoupling.GetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSpecificHeat) - * [`RAConstantOneWayCoupling.GetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetStartTime) - * [`RAConstantOneWayCoupling.GetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienC1) - * [`RAConstantOneWayCoupling.GetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienD1) - * [`RAConstantOneWayCoupling.GetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTemperature) - * [`RAConstantOneWayCoupling.GetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetThermalConductivity) - * [`RAConstantOneWayCoupling.GetTimeSet()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeSet) - * [`RAConstantOneWayCoupling.GetTimeStatistics()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStatistics) - * [`RAConstantOneWayCoupling.GetTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStep) - * [`RAConstantOneWayCoupling.GetTopologyShape()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTopologyShape) - * [`RAConstantOneWayCoupling.GetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTorqueLaw) - * [`RAConstantOneWayCoupling.GetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentDissipationRate) - * [`RAConstantOneWayCoupling.GetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentKineticEnergy) - * [`RAConstantOneWayCoupling.GetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion) - * [`RAConstantOneWayCoupling.GetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants) - * [`RAConstantOneWayCoupling.GetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVelocity) - * [`RAConstantOneWayCoupling.GetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVirtualMassLaw) - * [`RAConstantOneWayCoupling.GetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetViscosity) - * [`RAConstantOneWayCoupling.HasGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.HasGridFunction) - * [`RAConstantOneWayCoupling.IsCellActive()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsCellActive) - * [`RAConstantOneWayCoupling.IsTurbulentDispersionEnabled()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsTurbulentDispersionEnabled) - * [`RAConstantOneWayCoupling.IterCellVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCellVertices) - * [`RAConstantOneWayCoupling.IterCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCells) - * [`RAConstantOneWayCoupling.Modified()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.Modified) - * [`RAConstantOneWayCoupling.RemoveCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomCurve) - * [`RAConstantOneWayCoupling.RemoveCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomProperty) - * [`RAConstantOneWayCoupling.RemoveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveOutputVariable) - * [`RAConstantOneWayCoupling.RemoveProcess()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveProcess) - * [`RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw) - * [`RAConstantOneWayCoupling.SetCurrentTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetCurrentTimeStep) - * [`RAConstantOneWayCoupling.SetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDensity) - * [`RAConstantOneWayCoupling.SetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDragLaw) - * [`RAConstantOneWayCoupling.SetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetLiftLaw) - * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK1) - * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK2) - * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK3) - * [`RAConstantOneWayCoupling.SetPartIdIfValid()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetPartIdIfValid) - * [`RAConstantOneWayCoupling.SetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSpecificHeat) - * [`RAConstantOneWayCoupling.SetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetStartTime) - * [`RAConstantOneWayCoupling.SetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienC1) - * [`RAConstantOneWayCoupling.SetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienD1) - * [`RAConstantOneWayCoupling.SetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTemperature) - * [`RAConstantOneWayCoupling.SetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetThermalConductivity) - * [`RAConstantOneWayCoupling.SetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTorqueLaw) - * [`RAConstantOneWayCoupling.SetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentDissipationRate) - * [`RAConstantOneWayCoupling.SetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentKineticEnergy) - * [`RAConstantOneWayCoupling.SetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseTurbulentDispersion) - * [`RAConstantOneWayCoupling.SetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseUserDefinedConstants) - * [`RAConstantOneWayCoupling.SetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVelocity) - * [`RAConstantOneWayCoupling.SetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVirtualMassLaw) - * [`RAConstantOneWayCoupling.SetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetViscosity) - * [RAContactData](RAContactData.md) - * [`RAContactData`](RAContactData.md#generated.RAContactData) - * [`RAContactData.AddCurve()`](RAContactData.md#generated.RAContactData.AddCurve) - * [`RAContactData.AddCustomCurve()`](RAContactData.md#generated.RAContactData.AddCustomCurve) - * [`RAContactData.AddCustomProperty()`](RAContactData.md#generated.RAContactData.AddCustomProperty) - * [`RAContactData.AddGridFunction()`](RAContactData.md#generated.RAContactData.AddGridFunction) - * [`RAContactData.CreateCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateCurveOutputVariable) - * [`RAContactData.CreateGridFunction()`](RAContactData.md#generated.RAContactData.CreateGridFunction) - * [`RAContactData.CreateGridFunctionArrayOnCells()`](RAContactData.md#generated.RAContactData.CreateGridFunctionArrayOnCells) - * [`RAContactData.CreateGridFunctionStatisticOutputVariable()`](RAContactData.md#generated.RAContactData.CreateGridFunctionStatisticOutputVariable) - * [`RAContactData.CreateTransientCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateTransientCurveOutputVariable) - * [`RAContactData.DisableCollectContactsData()`](RAContactData.md#generated.RAContactData.DisableCollectContactsData) - * [`RAContactData.DisableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.DisableIncludeAdhesiveContacts) - * [`RAContactData.EditCustomCurve()`](RAContactData.md#generated.RAContactData.EditCustomCurve) - * [`RAContactData.EditCustomProperty()`](RAContactData.md#generated.RAContactData.EditCustomProperty) - * [`RAContactData.EnableCollectContactsData()`](RAContactData.md#generated.RAContactData.EnableCollectContactsData) - * [`RAContactData.EnableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.EnableIncludeAdhesiveContacts) - * [`RAContactData.GetActivesArray()`](RAContactData.md#generated.RAContactData.GetActivesArray) - * [`RAContactData.GetBoundingBox()`](RAContactData.md#generated.RAContactData.GetBoundingBox) - * [`RAContactData.GetCellAreaAsArray()`](RAContactData.md#generated.RAContactData.GetCellAreaAsArray) - * [`RAContactData.GetCellCenterAsArray()`](RAContactData.md#generated.RAContactData.GetCellCenterAsArray) - * [`RAContactData.GetCellDzAsArray()`](RAContactData.md#generated.RAContactData.GetCellDzAsArray) - * [`RAContactData.GetCellFromIJK()`](RAContactData.md#generated.RAContactData.GetCellFromIJK) - * [`RAContactData.GetCellIJK()`](RAContactData.md#generated.RAContactData.GetCellIJK) - * [`RAContactData.GetCellNumberOfVertices()`](RAContactData.md#generated.RAContactData.GetCellNumberOfVertices) - * [`RAContactData.GetCellPointsAsFunction()`](RAContactData.md#generated.RAContactData.GetCellPointsAsFunction) - * [`RAContactData.GetCellVolumeAsArray()`](RAContactData.md#generated.RAContactData.GetCellVolumeAsArray) - * [`RAContactData.GetCollectContactsData()`](RAContactData.md#generated.RAContactData.GetCollectContactsData) - * [`RAContactData.GetCurve()`](RAContactData.md#generated.RAContactData.GetCurve) - * [`RAContactData.GetCurveNames()`](RAContactData.md#generated.RAContactData.GetCurveNames) - * [`RAContactData.GetCurveNamesAssociation()`](RAContactData.md#generated.RAContactData.GetCurveNamesAssociation) - * [`RAContactData.GetElementCurve()`](RAContactData.md#generated.RAContactData.GetElementCurve) - * [`RAContactData.GetGeometryQuantity()`](RAContactData.md#generated.RAContactData.GetGeometryQuantity) - * [`RAContactData.GetGeometryUnit()`](RAContactData.md#generated.RAContactData.GetGeometryUnit) - * [`RAContactData.GetGridFunction()`](RAContactData.md#generated.RAContactData.GetGridFunction) - * [`RAContactData.GetGridFunctionNames()`](RAContactData.md#generated.RAContactData.GetGridFunctionNames) - * [`RAContactData.GetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.GetIncludeAdhesiveContacts) - * [`RAContactData.GetMeshColoring()`](RAContactData.md#generated.RAContactData.GetMeshColoring) - * [`RAContactData.GetNumberOfCells()`](RAContactData.md#generated.RAContactData.GetNumberOfCells) - * [`RAContactData.GetNumberOfNodes()`](RAContactData.md#generated.RAContactData.GetNumberOfNodes) - * [`RAContactData.GetNumpyCurve()`](RAContactData.md#generated.RAContactData.GetNumpyCurve) - * [`RAContactData.GetOutputVariableValue()`](RAContactData.md#generated.RAContactData.GetOutputVariableValue) - * [`RAContactData.GetTimeSet()`](RAContactData.md#generated.RAContactData.GetTimeSet) - * [`RAContactData.GetTimeStatistics()`](RAContactData.md#generated.RAContactData.GetTimeStatistics) - * [`RAContactData.GetTimeStep()`](RAContactData.md#generated.RAContactData.GetTimeStep) - * [`RAContactData.GetTopologyShape()`](RAContactData.md#generated.RAContactData.GetTopologyShape) - * [`RAContactData.HasGridFunction()`](RAContactData.md#generated.RAContactData.HasGridFunction) - * [`RAContactData.IsCellActive()`](RAContactData.md#generated.RAContactData.IsCellActive) - * [`RAContactData.IsCollectContactsDataEnabled()`](RAContactData.md#generated.RAContactData.IsCollectContactsDataEnabled) - * [`RAContactData.IsIncludeAdhesiveContactsEnabled()`](RAContactData.md#generated.RAContactData.IsIncludeAdhesiveContactsEnabled) - * [`RAContactData.IterCellVertices()`](RAContactData.md#generated.RAContactData.IterCellVertices) - * [`RAContactData.IterCells()`](RAContactData.md#generated.RAContactData.IterCells) - * [`RAContactData.Modified()`](RAContactData.md#generated.RAContactData.Modified) - * [`RAContactData.RemoveCustomCurve()`](RAContactData.md#generated.RAContactData.RemoveCustomCurve) - * [`RAContactData.RemoveCustomProperty()`](RAContactData.md#generated.RAContactData.RemoveCustomProperty) - * [`RAContactData.RemoveOutputVariable()`](RAContactData.md#generated.RAContactData.RemoveOutputVariable) - * [`RAContactData.RemoveProcess()`](RAContactData.md#generated.RAContactData.RemoveProcess) - * [`RAContactData.SetCollectContactsData()`](RAContactData.md#generated.RAContactData.SetCollectContactsData) - * [`RAContactData.SetCurrentTimeStep()`](RAContactData.md#generated.RAContactData.SetCurrentTimeStep) - * [`RAContactData.SetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.SetIncludeAdhesiveContacts) - * [RAContactToParticleProcess](RAContactToParticleProcess.md) - * [`RAContactToParticleProcess`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess) - * [`RAContactToParticleProcess.AddCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCurve) - * [`RAContactToParticleProcess.AddCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomCurve) - * [`RAContactToParticleProcess.AddCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomProperty) - * [`RAContactToParticleProcess.AddGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddGridFunction) - * [`RAContactToParticleProcess.CreateCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateCurveOutputVariable) - * [`RAContactToParticleProcess.CreateGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunction) - * [`RAContactToParticleProcess.CreateGridFunctionArrayOnCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionArrayOnCells) - * [`RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAContactToParticleProcess.CreateTransientCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateTransientCurveOutputVariable) - * [`RAContactToParticleProcess.EditCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomCurve) - * [`RAContactToParticleProcess.EditCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomProperty) - * [`RAContactToParticleProcess.GetActivesArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetActivesArray) - * [`RAContactToParticleProcess.GetBoundingBox()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetBoundingBox) - * [`RAContactToParticleProcess.GetCellAreaAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellAreaAsArray) - * [`RAContactToParticleProcess.GetCellCenterAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellCenterAsArray) - * [`RAContactToParticleProcess.GetCellDzAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellDzAsArray) - * [`RAContactToParticleProcess.GetCellFromIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellFromIJK) - * [`RAContactToParticleProcess.GetCellIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellIJK) - * [`RAContactToParticleProcess.GetCellNumberOfVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellNumberOfVertices) - * [`RAContactToParticleProcess.GetCellPointsAsFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellPointsAsFunction) - * [`RAContactToParticleProcess.GetCellVolumeAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellVolumeAsArray) - * [`RAContactToParticleProcess.GetCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurve) - * [`RAContactToParticleProcess.GetCurveNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNames) - * [`RAContactToParticleProcess.GetCurveNamesAssociation()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNamesAssociation) - * [`RAContactToParticleProcess.GetElementCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetElementCurve) - * [`RAContactToParticleProcess.GetGeometryQuantity()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryQuantity) - * [`RAContactToParticleProcess.GetGeometryUnit()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryUnit) - * [`RAContactToParticleProcess.GetGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunction) - * [`RAContactToParticleProcess.GetGridFunctionNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunctionNames) - * [`RAContactToParticleProcess.GetMeshColoring()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetMeshColoring) - * [`RAContactToParticleProcess.GetNumberOfCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfCells) - * [`RAContactToParticleProcess.GetNumberOfNodes()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfNodes) - * [`RAContactToParticleProcess.GetNumberOfParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfParticles) - * [`RAContactToParticleProcess.GetNumpyCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumpyCurve) - * [`RAContactToParticleProcess.GetOutputVariableValue()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetOutputVariableValue) - * [`RAContactToParticleProcess.GetTimeSet()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeSet) - * [`RAContactToParticleProcess.GetTimeStatistics()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStatistics) - * [`RAContactToParticleProcess.GetTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStep) - * [`RAContactToParticleProcess.GetTopologyShape()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTopologyShape) - * [`RAContactToParticleProcess.HasGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.HasGridFunction) - * [`RAContactToParticleProcess.IsCellActive()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IsCellActive) - * [`RAContactToParticleProcess.IterCellVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCellVertices) - * [`RAContactToParticleProcess.IterCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCells) - * [`RAContactToParticleProcess.IterParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterParticles) - * [`RAContactToParticleProcess.Modified()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.Modified) - * [`RAContactToParticleProcess.RemoveCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomCurve) - * [`RAContactToParticleProcess.RemoveCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomProperty) - * [`RAContactToParticleProcess.RemoveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveOutputVariable) - * [`RAContactToParticleProcess.RemoveProcess()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveProcess) - * [`RAContactToParticleProcess.SetCurrentTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.SetCurrentTimeStep) - * [RAContactsDataMeshColoring](RAContactsDataMeshColoring.md) - * [`RAContactsDataMeshColoring`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring) - * [`RAContactsDataMeshColoring.GetAvailableGridFunctions()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctions) - * [`RAContactsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctionsNames) - * [`RAContactsDataMeshColoring.GetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsColor) - * [`RAContactsDataMeshColoring.GetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkColor) - * [`RAContactsDataMeshColoring.GetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkLineWidth) - * [`RAContactsDataMeshColoring.GetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkProperty) - * [`RAContactsDataMeshColoring.GetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkVisible) - * [`RAContactsDataMeshColoring.GetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsPointSize) - * [`RAContactsDataMeshColoring.GetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsProperty) - * [`RAContactsDataMeshColoring.GetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsVisible) - * [`RAContactsDataMeshColoring.GetValidColoringModes()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetValidColoringModes) - * [`RAContactsDataMeshColoring.SetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsColor) - * [`RAContactsDataMeshColoring.SetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkColor) - * [`RAContactsDataMeshColoring.SetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkLineWidth) - * [`RAContactsDataMeshColoring.SetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkProperty) - * [`RAContactsDataMeshColoring.SetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkVisible) - * [`RAContactsDataMeshColoring.SetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsPointSize) - * [`RAContactsDataMeshColoring.SetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsProperty) - * [`RAContactsDataMeshColoring.SetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsVisible) - * [RACoupledWall](RACoupledWall.md) - * [`RACoupledWall`](RACoupledWall.md#generated.RACoupledWall) - * [`RACoupledWall.AddCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCurve) - * [`RACoupledWall.AddCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCustomCurve) - * [`RACoupledWall.AddCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.AddCustomProperty) - * [`RACoupledWall.AddGridFunction()`](RACoupledWall.md#generated.RACoupledWall.AddGridFunction) - * [`RACoupledWall.CreateCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateCurveOutputVariable) - * [`RACoupledWall.CreateGridFunction()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunction) - * [`RACoupledWall.CreateGridFunctionArrayOnCells()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionArrayOnCells) - * [`RACoupledWall.CreateGridFunctionStatisticOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionStatisticOutputVariable) - * [`RACoupledWall.CreateTransientCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateTransientCurveOutputVariable) - * [`RACoupledWall.EditCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.EditCustomCurve) - * [`RACoupledWall.EditCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.EditCustomProperty) - * [`RACoupledWall.GetActivesArray()`](RACoupledWall.md#generated.RACoupledWall.GetActivesArray) - * [`RACoupledWall.GetAvailableMaterials()`](RACoupledWall.md#generated.RACoupledWall.GetAvailableMaterials) - * [`RACoupledWall.GetBoundingBox()`](RACoupledWall.md#generated.RACoupledWall.GetBoundingBox) - * [`RACoupledWall.GetCellAreaAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellAreaAsArray) - * [`RACoupledWall.GetCellCenterAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellCenterAsArray) - * [`RACoupledWall.GetCellDzAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellDzAsArray) - * [`RACoupledWall.GetCellFromIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellFromIJK) - * [`RACoupledWall.GetCellIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellIJK) - * [`RACoupledWall.GetCellNumberOfVertices()`](RACoupledWall.md#generated.RACoupledWall.GetCellNumberOfVertices) - * [`RACoupledWall.GetCellPointsAsFunction()`](RACoupledWall.md#generated.RACoupledWall.GetCellPointsAsFunction) - * [`RACoupledWall.GetCellVolumeAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellVolumeAsArray) - * [`RACoupledWall.GetCurve()`](RACoupledWall.md#generated.RACoupledWall.GetCurve) - * [`RACoupledWall.GetCurveNames()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNames) - * [`RACoupledWall.GetCurveNamesAssociation()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNamesAssociation) - * [`RACoupledWall.GetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.GetDisableTime) - * [`RACoupledWall.GetElementCurve()`](RACoupledWall.md#generated.RACoupledWall.GetElementCurve) - * [`RACoupledWall.GetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.GetEnableTime) - * [`RACoupledWall.GetGeometryQuantity()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryQuantity) - * [`RACoupledWall.GetGeometryUnit()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryUnit) - * [`RACoupledWall.GetGridFunction()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunction) - * [`RACoupledWall.GetGridFunctionNames()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunctionNames) - * [`RACoupledWall.GetMaterial()`](RACoupledWall.md#generated.RACoupledWall.GetMaterial) - * [`RACoupledWall.GetMeshColoring()`](RACoupledWall.md#generated.RACoupledWall.GetMeshColoring) - * [`RACoupledWall.GetModuleProperties()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperties) - * [`RACoupledWall.GetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperty) - * [`RACoupledWall.GetNumberOfCells()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfCells) - * [`RACoupledWall.GetNumberOfNodes()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfNodes) - * [`RACoupledWall.GetNumpyCurve()`](RACoupledWall.md#generated.RACoupledWall.GetNumpyCurve) - * [`RACoupledWall.GetOutputVariableValue()`](RACoupledWall.md#generated.RACoupledWall.GetOutputVariableValue) - * [`RACoupledWall.GetTimeSet()`](RACoupledWall.md#generated.RACoupledWall.GetTimeSet) - * [`RACoupledWall.GetTimeStatistics()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStatistics) - * [`RACoupledWall.GetTimeStep()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStep) - * [`RACoupledWall.GetTopologyShape()`](RACoupledWall.md#generated.RACoupledWall.GetTopologyShape) - * [`RACoupledWall.GetValidOptionsForModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetValidOptionsForModuleProperty) - * [`RACoupledWall.HasGridFunction()`](RACoupledWall.md#generated.RACoupledWall.HasGridFunction) - * [`RACoupledWall.HasMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.HasMotionFrame) - * [`RACoupledWall.IsCellActive()`](RACoupledWall.md#generated.RACoupledWall.IsCellActive) - * [`RACoupledWall.IterCellVertices()`](RACoupledWall.md#generated.RACoupledWall.IterCellVertices) - * [`RACoupledWall.IterCells()`](RACoupledWall.md#generated.RACoupledWall.IterCells) - * [`RACoupledWall.Modified()`](RACoupledWall.md#generated.RACoupledWall.Modified) - * [`RACoupledWall.RemoveCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomCurve) - * [`RACoupledWall.RemoveCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomProperty) - * [`RACoupledWall.RemoveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.RemoveOutputVariable) - * [`RACoupledWall.RemoveProcess()`](RACoupledWall.md#generated.RACoupledWall.RemoveProcess) - * [`RACoupledWall.SetCurrentTimeStep()`](RACoupledWall.md#generated.RACoupledWall.SetCurrentTimeStep) - * [`RACoupledWall.SetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.SetDisableTime) - * [`RACoupledWall.SetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.SetEnableTime) - * [`RACoupledWall.SetMaterial()`](RACoupledWall.md#generated.RACoupledWall.SetMaterial) - * [`RACoupledWall.SetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.SetModuleProperty) - * [RACubeGroup](RACubeGroup.md) - * [`RACubeGroup`](RACubeGroup.md#generated.RACubeGroup) - * [`RACubeGroup.AddCurve()`](RACubeGroup.md#generated.RACubeGroup.AddCurve) - * [`RACubeGroup.GetCenter()`](RACubeGroup.md#generated.RACubeGroup.GetCenter) - * [`RACubeGroup.GetCenterAfterMovement()`](RACubeGroup.md#generated.RACubeGroup.GetCenterAfterMovement) - * [`RACubeGroup.GetCurve()`](RACubeGroup.md#generated.RACubeGroup.GetCurve) - * [`RACubeGroup.GetCurveNames()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNames) - * [`RACubeGroup.GetCurveNamesAssociation()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNamesAssociation) - * [`RACubeGroup.GetElementCurve()`](RACubeGroup.md#generated.RACubeGroup.GetElementCurve) - * [`RACubeGroup.GetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.GetMotionFrame) - * [`RACubeGroup.GetNumpyCurve()`](RACubeGroup.md#generated.RACubeGroup.GetNumpyCurve) - * [`RACubeGroup.GetOrientation()`](RACubeGroup.md#generated.RACubeGroup.GetOrientation) - * [`RACubeGroup.GetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngleAndVector) - * [`RACubeGroup.GetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngles) - * [`RACubeGroup.GetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromBasisVector) - * [`RACubeGroup.GetRotation()`](RACubeGroup.md#generated.RACubeGroup.GetRotation) - * [`RACubeGroup.GetSize()`](RACubeGroup.md#generated.RACubeGroup.GetSize) - * [`RACubeGroup.SetCenter()`](RACubeGroup.md#generated.RACubeGroup.SetCenter) - * [`RACubeGroup.SetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.SetMotionFrame) - * [`RACubeGroup.SetOrientation()`](RACubeGroup.md#generated.RACubeGroup.SetOrientation) - * [`RACubeGroup.SetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngleAndVector) - * [`RACubeGroup.SetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngles) - * [`RACubeGroup.SetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromBasisVector) - * [`RACubeGroup.SetRotation()`](RACubeGroup.md#generated.RACubeGroup.SetRotation) - * [`RACubeGroup.SetSize()`](RACubeGroup.md#generated.RACubeGroup.SetSize) - * [RACubeProcess](RACubeProcess.md) - * [`RACubeProcess`](RACubeProcess.md#generated.RACubeProcess) - * [`RACubeProcess.AddCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCurve) - * [`RACubeProcess.AddCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCustomCurve) - * [`RACubeProcess.AddCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.AddCustomProperty) - * [`RACubeProcess.AddGridFunction()`](RACubeProcess.md#generated.RACubeProcess.AddGridFunction) - * [`RACubeProcess.CreateCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateCurveOutputVariable) - * [`RACubeProcess.CreateGridFunction()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunction) - * [`RACubeProcess.CreateGridFunctionArrayOnCells()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionArrayOnCells) - * [`RACubeProcess.CreateGridFunctionStatisticOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionStatisticOutputVariable) - * [`RACubeProcess.CreateTransientCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateTransientCurveOutputVariable) - * [`RACubeProcess.EditCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.EditCustomCurve) - * [`RACubeProcess.EditCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.EditCustomProperty) - * [`RACubeProcess.GetActivesArray()`](RACubeProcess.md#generated.RACubeProcess.GetActivesArray) - * [`RACubeProcess.GetBoundingBox()`](RACubeProcess.md#generated.RACubeProcess.GetBoundingBox) - * [`RACubeProcess.GetCellAreaAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellAreaAsArray) - * [`RACubeProcess.GetCellCenterAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellCenterAsArray) - * [`RACubeProcess.GetCellDzAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellDzAsArray) - * [`RACubeProcess.GetCellFromIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellFromIJK) - * [`RACubeProcess.GetCellIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellIJK) - * [`RACubeProcess.GetCellNumberOfVertices()`](RACubeProcess.md#generated.RACubeProcess.GetCellNumberOfVertices) - * [`RACubeProcess.GetCellPointsAsFunction()`](RACubeProcess.md#generated.RACubeProcess.GetCellPointsAsFunction) - * [`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.GetGeometryQuantity()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryQuantity) - * [`RACubeProcess.GetGeometryUnit()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryUnit) - * [`RACubeProcess.GetGridFunction()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunction) - * [`RACubeProcess.GetGridFunctionNames()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunctionNames) - * [`RACubeProcess.GetMeshColoring()`](RACubeProcess.md#generated.RACubeProcess.GetMeshColoring) - * [`RACubeProcess.GetMotionFrame()`](RACubeProcess.md#generated.RACubeProcess.GetMotionFrame) - * [`RACubeProcess.GetNumberOfCells()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfCells) - * [`RACubeProcess.GetNumberOfNodes()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfNodes) - * [`RACubeProcess.GetNumberOfParticles()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfParticles) - * [`RACubeProcess.GetNumpyCurve()`](RACubeProcess.md#generated.RACubeProcess.GetNumpyCurve) - * [`RACubeProcess.GetOrientation()`](RACubeProcess.md#generated.RACubeProcess.GetOrientation) - * [`RACubeProcess.GetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngleAndVector) - * [`RACubeProcess.GetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngles) - * [`RACubeProcess.GetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromBasisVector) - * [`RACubeProcess.GetOutputVariableValue()`](RACubeProcess.md#generated.RACubeProcess.GetOutputVariableValue) - * [`RACubeProcess.GetRotation()`](RACubeProcess.md#generated.RACubeProcess.GetRotation) - * [`RACubeProcess.GetSize()`](RACubeProcess.md#generated.RACubeProcess.GetSize) - * [`RACubeProcess.GetTimeSet()`](RACubeProcess.md#generated.RACubeProcess.GetTimeSet) - * [`RACubeProcess.GetTimeStatistics()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStatistics) - * [`RACubeProcess.GetTimeStep()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStep) - * [`RACubeProcess.GetTopologyShape()`](RACubeProcess.md#generated.RACubeProcess.GetTopologyShape) - * [`RACubeProcess.HasGridFunction()`](RACubeProcess.md#generated.RACubeProcess.HasGridFunction) - * [`RACubeProcess.IsCellActive()`](RACubeProcess.md#generated.RACubeProcess.IsCellActive) - * [`RACubeProcess.IterCellVertices()`](RACubeProcess.md#generated.RACubeProcess.IterCellVertices) - * [`RACubeProcess.IterCells()`](RACubeProcess.md#generated.RACubeProcess.IterCells) - * [`RACubeProcess.IterParticles()`](RACubeProcess.md#generated.RACubeProcess.IterParticles) - * [`RACubeProcess.Modified()`](RACubeProcess.md#generated.RACubeProcess.Modified) - * [`RACubeProcess.RemoveCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomCurve) - * [`RACubeProcess.RemoveCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomProperty) - * [`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) - * [`RACubeProcess.SetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngleAndVector) - * [`RACubeProcess.SetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngles) - * [`RACubeProcess.SetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromBasisVector) - * [`RACubeProcess.SetRotation()`](RACubeProcess.md#generated.RACubeProcess.SetRotation) - * [`RACubeProcess.SetSize()`](RACubeProcess.md#generated.RACubeProcess.SetSize) - * [RACustomInput](RACustomInput.md) - * [`RACustomInput`](RACustomInput.md#generated.RACustomInput) - * [`RACustomInput.GetAvailableMotionFrames()`](RACustomInput.md#generated.RACustomInput.GetAvailableMotionFrames) - * [`RACustomInput.GetAvailableParticles()`](RACustomInput.md#generated.RACustomInput.GetAvailableParticles) - * [`RACustomInput.GetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.GetDefaultTemperature) - * [`RACustomInput.GetFilePath()`](RACustomInput.md#generated.RACustomInput.GetFilePath) - * [`RACustomInput.GetModuleProperties()`](RACustomInput.md#generated.RACustomInput.GetModuleProperties) - * [`RACustomInput.GetModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetModuleProperty) - * [`RACustomInput.GetMotionFrame()`](RACustomInput.md#generated.RACustomInput.GetMotionFrame) - * [`RACustomInput.GetParticle()`](RACustomInput.md#generated.RACustomInput.GetParticle) - * [`RACustomInput.GetValidOptionsForModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetValidOptionsForModuleProperty) - * [`RACustomInput.SetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.SetDefaultTemperature) - * [`RACustomInput.SetFilePath()`](RACustomInput.md#generated.RACustomInput.SetFilePath) - * [`RACustomInput.SetModuleProperty()`](RACustomInput.md#generated.RACustomInput.SetModuleProperty) - * [`RACustomInput.SetMotionFrame()`](RACustomInput.md#generated.RACustomInput.SetMotionFrame) - * [`RACustomInput.SetParticle()`](RACustomInput.md#generated.RACustomInput.SetParticle) - * [RACylinderGroup](RACylinderGroup.md) - * [`RACylinderGroup`](RACylinderGroup.md#generated.RACylinderGroup) - * [`RACylinderGroup.AddCurve()`](RACylinderGroup.md#generated.RACylinderGroup.AddCurve) - * [`RACylinderGroup.GetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenter) - * [`RACylinderGroup.GetCenterAfterMovement()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenterAfterMovement) - * [`RACylinderGroup.GetCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurve) - * [`RACylinderGroup.GetCurveNames()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNames) - * [`RACylinderGroup.GetCurveNamesAssociation()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNamesAssociation) - * [`RACylinderGroup.GetElementCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetElementCurve) - * [`RACylinderGroup.GetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetFinalAngle) - * [`RACylinderGroup.GetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetInitialAngle) - * [`RACylinderGroup.GetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.GetInternalFactor) - * [`RACylinderGroup.GetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.GetMotionFrame) - * [`RACylinderGroup.GetNumpyCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetNumpyCurve) - * [`RACylinderGroup.GetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientation) - * [`RACylinderGroup.GetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngleAndVector) - * [`RACylinderGroup.GetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngles) - * [`RACylinderGroup.GetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromBasisVector) - * [`RACylinderGroup.GetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.GetRotation) - * [`RACylinderGroup.GetSize()`](RACylinderGroup.md#generated.RACylinderGroup.GetSize) - * [`RACylinderGroup.SetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.SetCenter) - * [`RACylinderGroup.SetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetFinalAngle) - * [`RACylinderGroup.SetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetInitialAngle) - * [`RACylinderGroup.SetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.SetInternalFactor) - * [`RACylinderGroup.SetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.SetMotionFrame) - * [`RACylinderGroup.SetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientation) - * [`RACylinderGroup.SetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngleAndVector) - * [`RACylinderGroup.SetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngles) - * [`RACylinderGroup.SetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromBasisVector) - * [`RACylinderGroup.SetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.SetRotation) - * [`RACylinderGroup.SetSize()`](RACylinderGroup.md#generated.RACylinderGroup.SetSize) - * [RACylinderProcess](RACylinderProcess.md) - * [`RACylinderProcess`](RACylinderProcess.md#generated.RACylinderProcess) - * [`RACylinderProcess.AddCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCurve) - * [`RACylinderProcess.AddCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomCurve) - * [`RACylinderProcess.AddCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomProperty) - * [`RACylinderProcess.AddGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.AddGridFunction) - * [`RACylinderProcess.CreateCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateCurveOutputVariable) - * [`RACylinderProcess.CreateGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunction) - * [`RACylinderProcess.CreateGridFunctionArrayOnCells()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionArrayOnCells) - * [`RACylinderProcess.CreateGridFunctionStatisticOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionStatisticOutputVariable) - * [`RACylinderProcess.CreateTransientCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateTransientCurveOutputVariable) - * [`RACylinderProcess.EditCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomCurve) - * [`RACylinderProcess.EditCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomProperty) - * [`RACylinderProcess.GetActivesArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetActivesArray) - * [`RACylinderProcess.GetBoundingBox()`](RACylinderProcess.md#generated.RACylinderProcess.GetBoundingBox) - * [`RACylinderProcess.GetCellAreaAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellAreaAsArray) - * [`RACylinderProcess.GetCellCenterAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellCenterAsArray) - * [`RACylinderProcess.GetCellDzAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellDzAsArray) - * [`RACylinderProcess.GetCellFromIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellFromIJK) - * [`RACylinderProcess.GetCellIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellIJK) - * [`RACylinderProcess.GetCellNumberOfVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellNumberOfVertices) - * [`RACylinderProcess.GetCellPointsAsFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellPointsAsFunction) - * [`RACylinderProcess.GetCellVolumeAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellVolumeAsArray) - * [`RACylinderProcess.GetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenter) - * [`RACylinderProcess.GetCenterAfterMovement()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenterAfterMovement) - * [`RACylinderProcess.GetCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurve) - * [`RACylinderProcess.GetCurveNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNames) - * [`RACylinderProcess.GetCurveNamesAssociation()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNamesAssociation) - * [`RACylinderProcess.GetElementCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetElementCurve) - * [`RACylinderProcess.GetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetFinalAngle) - * [`RACylinderProcess.GetGeometryQuantity()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryQuantity) - * [`RACylinderProcess.GetGeometryUnit()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryUnit) - * [`RACylinderProcess.GetGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunction) - * [`RACylinderProcess.GetGridFunctionNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunctionNames) - * [`RACylinderProcess.GetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetInitialAngle) - * [`RACylinderProcess.GetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.GetInternalFactor) - * [`RACylinderProcess.GetMeshColoring()`](RACylinderProcess.md#generated.RACylinderProcess.GetMeshColoring) - * [`RACylinderProcess.GetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.GetMotionFrame) - * [`RACylinderProcess.GetNumberOfCells()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfCells) - * [`RACylinderProcess.GetNumberOfNodes()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfNodes) - * [`RACylinderProcess.GetNumberOfParticles()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfParticles) - * [`RACylinderProcess.GetNumpyCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumpyCurve) - * [`RACylinderProcess.GetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientation) - * [`RACylinderProcess.GetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngleAndVector) - * [`RACylinderProcess.GetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngles) - * [`RACylinderProcess.GetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromBasisVector) - * [`RACylinderProcess.GetOutputVariableValue()`](RACylinderProcess.md#generated.RACylinderProcess.GetOutputVariableValue) - * [`RACylinderProcess.GetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.GetRotation) - * [`RACylinderProcess.GetSize()`](RACylinderProcess.md#generated.RACylinderProcess.GetSize) - * [`RACylinderProcess.GetTimeSet()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeSet) - * [`RACylinderProcess.GetTimeStatistics()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStatistics) - * [`RACylinderProcess.GetTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStep) - * [`RACylinderProcess.GetTopologyShape()`](RACylinderProcess.md#generated.RACylinderProcess.GetTopologyShape) - * [`RACylinderProcess.HasGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.HasGridFunction) - * [`RACylinderProcess.IsCellActive()`](RACylinderProcess.md#generated.RACylinderProcess.IsCellActive) - * [`RACylinderProcess.IterCellVertices()`](RACylinderProcess.md#generated.RACylinderProcess.IterCellVertices) - * [`RACylinderProcess.IterCells()`](RACylinderProcess.md#generated.RACylinderProcess.IterCells) - * [`RACylinderProcess.IterParticles()`](RACylinderProcess.md#generated.RACylinderProcess.IterParticles) - * [`RACylinderProcess.Modified()`](RACylinderProcess.md#generated.RACylinderProcess.Modified) - * [`RACylinderProcess.RemoveCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomCurve) - * [`RACylinderProcess.RemoveCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomProperty) - * [`RACylinderProcess.RemoveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveOutputVariable) - * [`RACylinderProcess.RemoveProcess()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveProcess) - * [`RACylinderProcess.SetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.SetCenter) - * [`RACylinderProcess.SetCurrentTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.SetCurrentTimeStep) - * [`RACylinderProcess.SetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetFinalAngle) - * [`RACylinderProcess.SetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetInitialAngle) - * [`RACylinderProcess.SetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.SetInternalFactor) - * [`RACylinderProcess.SetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.SetMotionFrame) - * [`RACylinderProcess.SetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientation) - * [`RACylinderProcess.SetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngleAndVector) - * [`RACylinderProcess.SetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngles) - * [`RACylinderProcess.SetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromBasisVector) - * [`RACylinderProcess.SetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.SetRotation) - * [`RACylinderProcess.SetSize()`](RACylinderProcess.md#generated.RACylinderProcess.SetSize) - * [RADivisionsTagging](RADivisionsTagging.md) - * [`RADivisionsTagging`](RADivisionsTagging.md#generated.RADivisionsTagging) - * [`RADivisionsTagging.GetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsI) - * [`RADivisionsTagging.GetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsJ) - * [`RADivisionsTagging.GetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsK) - * [`RADivisionsTagging.GetGridFunctionName()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetGridFunctionName) - * [`RADivisionsTagging.GetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetNameMask) - * [`RADivisionsTagging.GetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagStride) - * [`RADivisionsTagging.GetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagValue) - * [`RADivisionsTagging.GetTimeRangeFilter()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTimeRangeFilter) - * [`RADivisionsTagging.SetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsI) - * [`RADivisionsTagging.SetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsJ) - * [`RADivisionsTagging.SetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsK) - * [`RADivisionsTagging.SetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetNameMask) - * [`RADivisionsTagging.SetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagStride) - * [`RADivisionsTagging.SetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagValue) - * [RADomainSettings](RADomainSettings.md) - * [`RADomainSettings`](RADomainSettings.md#generated.RADomainSettings) - * [`RADomainSettings.DisablePeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.DisablePeriodicAtGeometryLimits) - * [`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) - * [`RADomainSettings.GetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.GetCylindricalPeriodicDirections) - * [`RADomainSettings.GetDomainType()`](RADomainSettings.md#generated.RADomainSettings.GetDomainType) - * [`RADomainSettings.GetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.GetInitialAngle) - * [`RADomainSettings.GetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.GetNumberOfDivisions) - * [`RADomainSettings.GetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicAtGeometryLimits) - * [`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.SetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCartesianPeriodicDirections) - * [`RADomainSettings.SetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMaxValues) - * [`RADomainSettings.SetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMinValues) - * [`RADomainSettings.SetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCylindricalPeriodicDirections) - * [`RADomainSettings.SetDomainType()`](RADomainSettings.md#generated.RADomainSettings.SetDomainType) - * [`RADomainSettings.SetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.SetInitialAngle) - * [`RADomainSettings.SetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.SetNumberOfDivisions) - * [`RADomainSettings.SetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicAtGeometryLimits) - * [`RADomainSettings.SetPeriodicLimitsMaxCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMaxCoordinates) - * [`RADomainSettings.SetPeriodicLimitsMinCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMinCoordinates) - * [`RADomainSettings.SetUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetUseBoundaryLimits) - * [RAEulerianStatistics](RAEulerianStatistics.md) - * [`RAEulerianStatistics`](RAEulerianStatistics.md#generated.RAEulerianStatistics) - * [`RAEulerianStatistics.AddCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCurve) - * [`RAEulerianStatistics.AddCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomCurve) - * [`RAEulerianStatistics.AddCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomProperty) - * [`RAEulerianStatistics.AddGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddGridFunction) - * [`RAEulerianStatistics.CreateCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateCurveOutputVariable) - * [`RAEulerianStatistics.CreateEulerianGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateEulerianGridFunction) - * [`RAEulerianStatistics.CreateGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunction) - * [`RAEulerianStatistics.CreateGridFunctionArrayOnCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionArrayOnCells) - * [`RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable) - * [`RAEulerianStatistics.CreateTransientCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateTransientCurveOutputVariable) - * [`RAEulerianStatistics.EditCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomCurve) - * [`RAEulerianStatistics.EditCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomProperty) - * [`RAEulerianStatistics.GetActivesArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetActivesArray) - * [`RAEulerianStatistics.GetAvailableOperations()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetAvailableOperations) - * [`RAEulerianStatistics.GetBoundingBox()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetBoundingBox) - * [`RAEulerianStatistics.GetCellAreaAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellAreaAsArray) - * [`RAEulerianStatistics.GetCellCenterAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellCenterAsArray) - * [`RAEulerianStatistics.GetCellDzAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellDzAsArray) - * [`RAEulerianStatistics.GetCellFromIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellFromIJK) - * [`RAEulerianStatistics.GetCellIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellIJK) - * [`RAEulerianStatistics.GetCellNumberOfVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellNumberOfVertices) - * [`RAEulerianStatistics.GetCellPointsAsFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellPointsAsFunction) - * [`RAEulerianStatistics.GetCellVolumeAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellVolumeAsArray) - * [`RAEulerianStatistics.GetCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurve) - * [`RAEulerianStatistics.GetCurveNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNames) - * [`RAEulerianStatistics.GetCurveNamesAssociation()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNamesAssociation) - * [`RAEulerianStatistics.GetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetDivisions) - * [`RAEulerianStatistics.GetElementCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetElementCurve) - * [`RAEulerianStatistics.GetGeometryQuantity()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryQuantity) - * [`RAEulerianStatistics.GetGeometryUnit()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryUnit) - * [`RAEulerianStatistics.GetGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunction) - * [`RAEulerianStatistics.GetGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunctionNames) - * [`RAEulerianStatistics.GetMeshColoring()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetMeshColoring) - * [`RAEulerianStatistics.GetNumberOfCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfCells) - * [`RAEulerianStatistics.GetNumberOfNodes()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfNodes) - * [`RAEulerianStatistics.GetNumberOfParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfParticles) - * [`RAEulerianStatistics.GetNumpyCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumpyCurve) - * [`RAEulerianStatistics.GetOutputVariableValue()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetOutputVariableValue) - * [`RAEulerianStatistics.GetParticleGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetParticleGridFunctionNames) - * [`RAEulerianStatistics.GetTimeSet()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeSet) - * [`RAEulerianStatistics.GetTimeStatistics()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStatistics) - * [`RAEulerianStatistics.GetTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStep) - * [`RAEulerianStatistics.GetTopologyShape()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTopologyShape) - * [`RAEulerianStatistics.HasGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.HasGridFunction) - * [`RAEulerianStatistics.IsCellActive()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IsCellActive) - * [`RAEulerianStatistics.IterCellVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCellVertices) - * [`RAEulerianStatistics.IterCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCells) - * [`RAEulerianStatistics.IterParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterParticles) - * [`RAEulerianStatistics.Modified()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.Modified) - * [`RAEulerianStatistics.RemoveCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomCurve) - * [`RAEulerianStatistics.RemoveCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomProperty) - * [`RAEulerianStatistics.RemoveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveOutputVariable) - * [`RAEulerianStatistics.RemoveProcess()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveProcess) - * [`RAEulerianStatistics.SetCurrentTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetCurrentTimeStep) - * [`RAEulerianStatistics.SetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetDivisions) - * [RAExportToolkit](RAExportToolkit.md) - * [`RAExportToolkit`](RAExportToolkit.md#generated.RAExportToolkit) - * [`RAExportToolkit.ExportFEMForces()`](RAExportToolkit.md#generated.RAExportToolkit.ExportFEMForces) - * [`RAExportToolkit.ExportGeometryLoads()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoads) - * [`RAExportToolkit.ExportGeometryLoadsMultiTime()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoadsMultiTime) - * [`RAExportToolkit.ExportHTC()`](RAExportToolkit.md#generated.RAExportToolkit.ExportHTC) - * [`RAExportToolkit.ExportParticleToStl()`](RAExportToolkit.md#generated.RAExportToolkit.ExportParticleToStl) - * [`RAExportToolkit.ExportToSTL()`](RAExportToolkit.md#generated.RAExportToolkit.ExportToSTL) - * [RAFeedConveyor](RAFeedConveyor.md) - * [`RAFeedConveyor`](RAFeedConveyor.md#generated.RAFeedConveyor) - * [`RAFeedConveyor.AddCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCurve) - * [`RAFeedConveyor.AddCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomCurve) - * [`RAFeedConveyor.AddCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomProperty) - * [`RAFeedConveyor.AddGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddGridFunction) - * [`RAFeedConveyor.CreateCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateCurveOutputVariable) - * [`RAFeedConveyor.CreateGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunction) - * [`RAFeedConveyor.CreateGridFunctionArrayOnCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionArrayOnCells) - * [`RAFeedConveyor.CreateGridFunctionStatisticOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionStatisticOutputVariable) - * [`RAFeedConveyor.CreateTransientCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateTransientCurveOutputVariable) - * [`RAFeedConveyor.EditCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomCurve) - * [`RAFeedConveyor.EditCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomProperty) - * [`RAFeedConveyor.GetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAccelerationPeriod) - * [`RAFeedConveyor.GetActivesArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetActivesArray) - * [`RAFeedConveyor.GetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAlignmentAngle) - * [`RAFeedConveyor.GetAvailableMaterials()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAvailableMaterials) - * [`RAFeedConveyor.GetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStartTime) - * [`RAFeedConveyor.GetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStopTime) - * [`RAFeedConveyor.GetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltInclineAngle) - * [`RAFeedConveyor.GetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfile) - * [`RAFeedConveyor.GetBeltProfileName()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfileName) - * [`RAFeedConveyor.GetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltSpeed) - * [`RAFeedConveyor.GetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltThickness) - * [`RAFeedConveyor.GetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltWidth) - * [`RAFeedConveyor.GetBoundingBox()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBoundingBox) - * [`RAFeedConveyor.GetCellAreaAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellAreaAsArray) - * [`RAFeedConveyor.GetCellCenterAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellCenterAsArray) - * [`RAFeedConveyor.GetCellDzAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellDzAsArray) - * [`RAFeedConveyor.GetCellFromIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellFromIJK) - * [`RAFeedConveyor.GetCellIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellIJK) - * [`RAFeedConveyor.GetCellNumberOfVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellNumberOfVertices) - * [`RAFeedConveyor.GetCellPointsAsFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellPointsAsFunction) - * [`RAFeedConveyor.GetCellVolumeAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellVolumeAsArray) - * [`RAFeedConveyor.GetCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurve) - * [`RAFeedConveyor.GetCurveNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNames) - * [`RAFeedConveyor.GetCurveNamesAssociation()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNamesAssociation) - * [`RAFeedConveyor.GetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDecelerationPeriod) - * [`RAFeedConveyor.GetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDiameter) - * [`RAFeedConveyor.GetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxHeight) - * [`RAFeedConveyor.GetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxLength) - * [`RAFeedConveyor.GetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxWidth) - * [`RAFeedConveyor.GetElementCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetElementCurve) - * [`RAFeedConveyor.GetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceWidth) - * [`RAFeedConveyor.GetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFrontPlateOffset) - * [`RAFeedConveyor.GetGeometryQuantity()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryQuantity) - * [`RAFeedConveyor.GetGeometryUnit()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryUnit) - * [`RAFeedConveyor.GetGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunction) - * [`RAFeedConveyor.GetGridFunctionNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunctionNames) - * [`RAFeedConveyor.GetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHeightOffset) - * [`RAFeedConveyor.GetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHorizontalOffset) - * [`RAFeedConveyor.GetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLengthOffset) - * [`RAFeedConveyor.GetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLoadingLength) - * [`RAFeedConveyor.GetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMaterial) - * [`RAFeedConveyor.GetMeshColoring()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMeshColoring) - * [`RAFeedConveyor.GetModuleProperties()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperties) - * [`RAFeedConveyor.GetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperty) - * [`RAFeedConveyor.GetNumberOfCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfCells) - * [`RAFeedConveyor.GetNumberOfNodes()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfNodes) - * [`RAFeedConveyor.GetNumpyCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumpyCurve) - * [`RAFeedConveyor.GetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOffsetToIdlers) - * [`RAFeedConveyor.GetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutOfPlaneOffset) - * [`RAFeedConveyor.GetOutputVariableValue()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutputVariableValue) - * [`RAFeedConveyor.GetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetReturnBeltAngle) - * [`RAFeedConveyor.GetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardHeight) - * [`RAFeedConveyor.GetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardLength) - * [`RAFeedConveyor.GetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSphBoundaryType) - * [`RAFeedConveyor.GetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSurfaceTensionContactAngle) - * [`RAFeedConveyor.GetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTemperature) - * [`RAFeedConveyor.GetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetThermalBoundaryConditionType) - * [`RAFeedConveyor.GetTimeSet()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeSet) - * [`RAFeedConveyor.GetTimeStatistics()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStatistics) - * [`RAFeedConveyor.GetTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStep) - * [`RAFeedConveyor.GetTopologyShape()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTopologyShape) - * [`RAFeedConveyor.GetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTransitionLength) - * [`RAFeedConveyor.GetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTriangleSize) - * [`RAFeedConveyor.GetValidBeltProfileNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidBeltProfileNames) - * [`RAFeedConveyor.GetValidOptionsForModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidOptionsForModuleProperty) - * [`RAFeedConveyor.GetValidSphBoundaryTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues) - * [`RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues) - * [`RAFeedConveyor.GetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVerticalOffset) - * [`RAFeedConveyor.GetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWallThickness) - * [`RAFeedConveyor.GetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWidth) - * [`RAFeedConveyor.HasGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.HasGridFunction) - * [`RAFeedConveyor.IsCellActive()`](RAFeedConveyor.md#generated.RAFeedConveyor.IsCellActive) - * [`RAFeedConveyor.IterCellVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCellVertices) - * [`RAFeedConveyor.IterCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCells) - * [`RAFeedConveyor.Modified()`](RAFeedConveyor.md#generated.RAFeedConveyor.Modified) - * [`RAFeedConveyor.RemoveCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomCurve) - * [`RAFeedConveyor.RemoveCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomProperty) - * [`RAFeedConveyor.RemoveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveOutputVariable) - * [`RAFeedConveyor.RemoveProcess()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveProcess) - * [`RAFeedConveyor.SetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAccelerationPeriod) - * [`RAFeedConveyor.SetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAlignmentAngle) - * [`RAFeedConveyor.SetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStartTime) - * [`RAFeedConveyor.SetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStopTime) - * [`RAFeedConveyor.SetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltInclineAngle) - * [`RAFeedConveyor.SetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltProfile) - * [`RAFeedConveyor.SetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltSpeed) - * [`RAFeedConveyor.SetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltThickness) - * [`RAFeedConveyor.SetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltWidth) - * [`RAFeedConveyor.SetCurrentTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCurrentTimeStep) - * [`RAFeedConveyor.SetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDecelerationPeriod) - * [`RAFeedConveyor.SetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDiameter) - * [`RAFeedConveyor.SetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxHeight) - * [`RAFeedConveyor.SetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxLength) - * [`RAFeedConveyor.SetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxWidth) - * [`RAFeedConveyor.SetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFaceWidth) - * [`RAFeedConveyor.SetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFrontPlateOffset) - * [`RAFeedConveyor.SetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHeightOffset) - * [`RAFeedConveyor.SetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHorizontalOffset) - * [`RAFeedConveyor.SetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLengthOffset) - * [`RAFeedConveyor.SetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLoadingLength) - * [`RAFeedConveyor.SetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetMaterial) - * [`RAFeedConveyor.SetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetModuleProperty) - * [`RAFeedConveyor.SetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOffsetToIdlers) - * [`RAFeedConveyor.SetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOutOfPlaneOffset) - * [`RAFeedConveyor.SetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetReturnBeltAngle) - * [`RAFeedConveyor.SetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardHeight) - * [`RAFeedConveyor.SetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardLength) - * [`RAFeedConveyor.SetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSphBoundaryType) - * [`RAFeedConveyor.SetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSurfaceTensionContactAngle) - * [`RAFeedConveyor.SetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTemperature) - * [`RAFeedConveyor.SetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetThermalBoundaryConditionType) - * [`RAFeedConveyor.SetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTransitionLength) - * [`RAFeedConveyor.SetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTriangleSize) - * [`RAFeedConveyor.SetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetVerticalOffset) - * [`RAFeedConveyor.SetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWallThickness) - * [`RAFeedConveyor.SetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWidth) - * [RAFilterProcess](RAFilterProcess.md) - * [`RAFilterProcess`](RAFilterProcess.md#generated.RAFilterProcess) - * [`RAFilterProcess.AddCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCurve) - * [`RAFilterProcess.AddCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomCurve) - * [`RAFilterProcess.AddCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomProperty) - * [`RAFilterProcess.AddGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.AddGridFunction) - * [`RAFilterProcess.CreateCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateCurveOutputVariable) - * [`RAFilterProcess.CreateGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunction) - * [`RAFilterProcess.CreateGridFunctionArrayOnCells()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionArrayOnCells) - * [`RAFilterProcess.CreateGridFunctionStatisticOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAFilterProcess.CreateTransientCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateTransientCurveOutputVariable) - * [`RAFilterProcess.EditCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomCurve) - * [`RAFilterProcess.EditCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomProperty) - * [`RAFilterProcess.GetActivesArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetActivesArray) - * [`RAFilterProcess.GetBoundingBox()`](RAFilterProcess.md#generated.RAFilterProcess.GetBoundingBox) - * [`RAFilterProcess.GetCellAreaAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellAreaAsArray) - * [`RAFilterProcess.GetCellCenterAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellCenterAsArray) - * [`RAFilterProcess.GetCellDzAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellDzAsArray) - * [`RAFilterProcess.GetCellFromIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellFromIJK) - * [`RAFilterProcess.GetCellIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellIJK) - * [`RAFilterProcess.GetCellNumberOfVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellNumberOfVertices) - * [`RAFilterProcess.GetCellPointsAsFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellPointsAsFunction) - * [`RAFilterProcess.GetCellVolumeAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellVolumeAsArray) - * [`RAFilterProcess.GetCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurve) - * [`RAFilterProcess.GetCurveNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNames) - * [`RAFilterProcess.GetCurveNamesAssociation()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNamesAssociation) - * [`RAFilterProcess.GetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetCutValue) - * [`RAFilterProcess.GetElementCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetElementCurve) - * [`RAFilterProcess.GetGeometryQuantity()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryQuantity) - * [`RAFilterProcess.GetGeometryUnit()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryUnit) - * [`RAFilterProcess.GetGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunction) - * [`RAFilterProcess.GetGridFunctionNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunctionNames) - * [`RAFilterProcess.GetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMaxValue) - * [`RAFilterProcess.GetMeshColoring()`](RAFilterProcess.md#generated.RAFilterProcess.GetMeshColoring) - * [`RAFilterProcess.GetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMinValue) - * [`RAFilterProcess.GetMode()`](RAFilterProcess.md#generated.RAFilterProcess.GetMode) - * [`RAFilterProcess.GetNumberOfCells()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfCells) - * [`RAFilterProcess.GetNumberOfNodes()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfNodes) - * [`RAFilterProcess.GetNumberOfParticles()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfParticles) - * [`RAFilterProcess.GetNumpyCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumpyCurve) - * [`RAFilterProcess.GetOutputVariableValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetOutputVariableValue) - * [`RAFilterProcess.GetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetPropertyGridFunction) - * [`RAFilterProcess.GetTimeSet()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeSet) - * [`RAFilterProcess.GetTimeStatistics()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStatistics) - * [`RAFilterProcess.GetTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStep) - * [`RAFilterProcess.GetTopologyShape()`](RAFilterProcess.md#generated.RAFilterProcess.GetTopologyShape) - * [`RAFilterProcess.GetType()`](RAFilterProcess.md#generated.RAFilterProcess.GetType) - * [`RAFilterProcess.HasGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.HasGridFunction) - * [`RAFilterProcess.IsCellActive()`](RAFilterProcess.md#generated.RAFilterProcess.IsCellActive) - * [`RAFilterProcess.IterCellVertices()`](RAFilterProcess.md#generated.RAFilterProcess.IterCellVertices) - * [`RAFilterProcess.IterCells()`](RAFilterProcess.md#generated.RAFilterProcess.IterCells) - * [`RAFilterProcess.IterParticles()`](RAFilterProcess.md#generated.RAFilterProcess.IterParticles) - * [`RAFilterProcess.Modified()`](RAFilterProcess.md#generated.RAFilterProcess.Modified) - * [`RAFilterProcess.RemoveCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomCurve) - * [`RAFilterProcess.RemoveCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomProperty) - * [`RAFilterProcess.RemoveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveOutputVariable) - * [`RAFilterProcess.RemoveProcess()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveProcess) - * [`RAFilterProcess.SetCurrentTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.SetCurrentTimeStep) - * [`RAFilterProcess.SetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetCutValue) - * [`RAFilterProcess.SetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMaxValue) - * [`RAFilterProcess.SetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMinValue) - * [`RAFilterProcess.SetMode()`](RAFilterProcess.md#generated.RAFilterProcess.SetMode) - * [`RAFilterProcess.SetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.SetPropertyGridFunction) - * [`RAFilterProcess.SetType()`](RAFilterProcess.md#generated.RAFilterProcess.SetType) - * [RAFiveRollsBeltProfile](RAFiveRollsBeltProfile.md) - * [`RAFiveRollsBeltProfile`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile) - * [`RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths) - * [`RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths) - * [`RAFiveRollsBeltProfile.GetAvailableMaterials()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetAvailableMaterials) - * [`RAFiveRollsBeltProfile.GetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetCenterRollLength) - * [`RAFiveRollsBeltProfile.GetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLastRollAngle) - * [`RAFiveRollsBeltProfile.GetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLowerCornerRadius) - * [`RAFiveRollsBeltProfile.GetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetMaterial) - * [`RAFiveRollsBeltProfile.GetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetSideRollLength) - * [`RAFiveRollsBeltProfile.GetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetTroughingAngle) - * [`RAFiveRollsBeltProfile.GetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUpperCornerRadius) - * [`RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths) - * [`RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled) - * [`RAFiveRollsBeltProfile.SetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetCenterRollLength) - * [`RAFiveRollsBeltProfile.SetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLastRollAngle) - * [`RAFiveRollsBeltProfile.SetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLowerCornerRadius) - * [`RAFiveRollsBeltProfile.SetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetMaterial) - * [`RAFiveRollsBeltProfile.SetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetSideRollLength) - * [`RAFiveRollsBeltProfile.SetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetTroughingAngle) - * [`RAFiveRollsBeltProfile.SetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUpperCornerRadius) - * [`RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths) - * [RAFluentOneWayCoupling](RAFluentOneWayCoupling.md) - * [`RAFluentOneWayCoupling`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling) - * [`RAFluentOneWayCoupling.AddCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCurve) - * [`RAFluentOneWayCoupling.AddCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomCurve) - * [`RAFluentOneWayCoupling.AddCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomProperty) - * [`RAFluentOneWayCoupling.AddGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddGridFunction) - * [`RAFluentOneWayCoupling.CreateCoupledBoundaries()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCoupledBoundaries) - * [`RAFluentOneWayCoupling.CreateCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCurveOutputVariable) - * [`RAFluentOneWayCoupling.CreateGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunction) - * [`RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells) - * [`RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable) - * [`RAFluentOneWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateTransientCurveOutputVariable) - * [`RAFluentOneWayCoupling.EditCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomCurve) - * [`RAFluentOneWayCoupling.EditCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomProperty) - * [`RAFluentOneWayCoupling.GetActivesArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetActivesArray) - * [`RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames) - * [`RAFluentOneWayCoupling.GetBoundingBox()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetBoundingBox) - * [`RAFluentOneWayCoupling.GetCFDParametersList()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCFDParametersList) - * [`RAFluentOneWayCoupling.GetCellAreaAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellAreaAsArray) - * [`RAFluentOneWayCoupling.GetCellCenterAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellCenterAsArray) - * [`RAFluentOneWayCoupling.GetCellDzAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellDzAsArray) - * [`RAFluentOneWayCoupling.GetCellFromIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellFromIJK) - * [`RAFluentOneWayCoupling.GetCellIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellIJK) - * [`RAFluentOneWayCoupling.GetCellNumberOfVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellNumberOfVertices) - * [`RAFluentOneWayCoupling.GetCellPointsAsFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellPointsAsFunction) - * [`RAFluentOneWayCoupling.GetCellVolumeAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellVolumeAsArray) - * [`RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw) - * [`RAFluentOneWayCoupling.GetCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurve) - * [`RAFluentOneWayCoupling.GetCurveNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNames) - * [`RAFluentOneWayCoupling.GetCurveNamesAssociation()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation) - * [`RAFluentOneWayCoupling.GetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetDragLaw) - * [`RAFluentOneWayCoupling.GetElementCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetElementCurve) - * [`RAFluentOneWayCoupling.GetGeometryQuantity()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryQuantity) - * [`RAFluentOneWayCoupling.GetGeometryUnit()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryUnit) - * [`RAFluentOneWayCoupling.GetGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunction) - * [`RAFluentOneWayCoupling.GetGridFunctionNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunctionNames) - * [`RAFluentOneWayCoupling.GetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetIsOneWayPeriodic) - * [`RAFluentOneWayCoupling.GetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetLiftLaw) - * [`RAFluentOneWayCoupling.GetMeshColoring()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMeshColoring) - * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK1) - * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK2) - * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK3) - * [`RAFluentOneWayCoupling.GetNumberOfCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfCells) - * [`RAFluentOneWayCoupling.GetNumberOfNodes()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfNodes) - * [`RAFluentOneWayCoupling.GetNumpyCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumpyCurve) - * [`RAFluentOneWayCoupling.GetOutputVariableValue()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOutputVariableValue) - * [`RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance) - * [`RAFluentOneWayCoupling.GetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetStartTime) - * [`RAFluentOneWayCoupling.GetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienC1) - * [`RAFluentOneWayCoupling.GetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienD1) - * [`RAFluentOneWayCoupling.GetTimeSet()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeSet) - * [`RAFluentOneWayCoupling.GetTimeStatistics()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStatistics) - * [`RAFluentOneWayCoupling.GetTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStep) - * [`RAFluentOneWayCoupling.GetTopologyShape()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTopologyShape) - * [`RAFluentOneWayCoupling.GetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTorqueLaw) - * [`RAFluentOneWayCoupling.GetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion) - * [`RAFluentOneWayCoupling.GetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants) - * [`RAFluentOneWayCoupling.GetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance) - * [`RAFluentOneWayCoupling.GetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVirtualMassLaw) - * [`RAFluentOneWayCoupling.HasGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.HasGridFunction) - * [`RAFluentOneWayCoupling.IsCellActive()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IsCellActive) - * [`RAFluentOneWayCoupling.IterCellVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCellVertices) - * [`RAFluentOneWayCoupling.IterCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCells) - * [`RAFluentOneWayCoupling.Modified()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.Modified) - * [`RAFluentOneWayCoupling.RemoveCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomCurve) - * [`RAFluentOneWayCoupling.RemoveCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomProperty) - * [`RAFluentOneWayCoupling.RemoveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveOutputVariable) - * [`RAFluentOneWayCoupling.RemoveProcess()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveProcess) - * [`RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw) - * [`RAFluentOneWayCoupling.SetCurrentTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetCurrentTimeStep) - * [`RAFluentOneWayCoupling.SetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetDragLaw) - * [`RAFluentOneWayCoupling.SetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetIsOneWayPeriodic) - * [`RAFluentOneWayCoupling.SetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetLiftLaw) - * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK1) - * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK2) - * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK3) - * [`RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance) - * [`RAFluentOneWayCoupling.SetPartIdIfValid()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetPartIdIfValid) - * [`RAFluentOneWayCoupling.SetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetStartTime) - * [`RAFluentOneWayCoupling.SetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienC1) - * [`RAFluentOneWayCoupling.SetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienD1) - * [`RAFluentOneWayCoupling.SetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetTorqueLaw) - * [`RAFluentOneWayCoupling.SetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseTurbulentDispersion) - * [`RAFluentOneWayCoupling.SetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseUserDefinedConstants) - * [`RAFluentOneWayCoupling.SetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUserCfdUpdateDistance) - * [`RAFluentOneWayCoupling.SetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetVirtualMassLaw) - * [`RAFluentOneWayCoupling.SetupStoreFiles()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetupStoreFiles) - * [RAFluentSemiResolvedCoupling](RAFluentSemiResolvedCoupling.md) - * [`RAFluentSemiResolvedCoupling`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling) - * [`RAFluentSemiResolvedCoupling.GetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetCouplingFilesKept) - * [`RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs) - * [`RAFluentSemiResolvedCoupling.GetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentExecutionMode) - * [`RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier) - * [`RAFluentSemiResolvedCoupling.GetFluentReleases()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentReleases) - * [`RAFluentSemiResolvedCoupling.GetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentSolverProcesses) - * [`RAFluentSemiResolvedCoupling.GetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentVersion) - * [`RAFluentSemiResolvedCoupling.GetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetUseDatInitialization) - * [`RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues) - * [`RAFluentSemiResolvedCoupling.SetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetCouplingFilesKept) - * [`RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs) - * [`RAFluentSemiResolvedCoupling.SetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentExecutionMode) - * [`RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier) - * [`RAFluentSemiResolvedCoupling.SetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentSolverProcesses) - * [`RAFluentSemiResolvedCoupling.SetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentVersion) - * [`RAFluentSemiResolvedCoupling.SetPartIdIfValid()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetPartIdIfValid) - * [`RAFluentSemiResolvedCoupling.SetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetUseDatInitialization) - * [`RAFluentSemiResolvedCoupling.SetupStoreFiles()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetupStoreFiles) - * [RAFluentTwoWayCoupling](RAFluentTwoWayCoupling.md) - * [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling) - * [`RAFluentTwoWayCoupling.AddCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCurve) - * [`RAFluentTwoWayCoupling.AddCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomCurve) - * [`RAFluentTwoWayCoupling.AddCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomProperty) - * [`RAFluentTwoWayCoupling.AddGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddGridFunction) - * [`RAFluentTwoWayCoupling.CloseFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CloseFluent) - * [`RAFluentTwoWayCoupling.CreateCoupledBoundaries()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCoupledBoundaries) - * [`RAFluentTwoWayCoupling.CreateCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCurveOutputVariable) - * [`RAFluentTwoWayCoupling.CreateGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunction) - * [`RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells) - * [`RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable) - * [`RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable) - * [`RAFluentTwoWayCoupling.DisableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableBackDiffusion) - * [`RAFluentTwoWayCoupling.DisableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableSubstepping) - * [`RAFluentTwoWayCoupling.EditCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomCurve) - * [`RAFluentTwoWayCoupling.EditCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomProperty) - * [`RAFluentTwoWayCoupling.EnableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableBackDiffusion) - * [`RAFluentTwoWayCoupling.EnableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableSubstepping) - * [`RAFluentTwoWayCoupling.GetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAbsoluteValue) - * [`RAFluentTwoWayCoupling.GetActivesArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetActivesArray) - * [`RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames) - * [`RAFluentTwoWayCoupling.GetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingMethod) - * [`RAFluentTwoWayCoupling.GetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingRadiusType) - * [`RAFluentTwoWayCoupling.GetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBackDiffusion) - * [`RAFluentTwoWayCoupling.GetBoundingBox()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBoundingBox) - * [`RAFluentTwoWayCoupling.GetCFDParametersList()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCFDParametersList) - * [`RAFluentTwoWayCoupling.GetCellAreaAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellAreaAsArray) - * [`RAFluentTwoWayCoupling.GetCellCenterAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellCenterAsArray) - * [`RAFluentTwoWayCoupling.GetCellDzAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellDzAsArray) - * [`RAFluentTwoWayCoupling.GetCellFromIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellFromIJK) - * [`RAFluentTwoWayCoupling.GetCellIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellIJK) - * [`RAFluentTwoWayCoupling.GetCellNumberOfVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellNumberOfVertices) - * [`RAFluentTwoWayCoupling.GetCellPointsAsFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellPointsAsFunction) - * [`RAFluentTwoWayCoupling.GetCellVolumeAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellVolumeAsArray) - * [`RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw) - * [`RAFluentTwoWayCoupling.GetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCouplingFilesKept) - * [`RAFluentTwoWayCoupling.GetCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurve) - * [`RAFluentTwoWayCoupling.GetCurveNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNames) - * [`RAFluentTwoWayCoupling.GetCurveNamesAssociation()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNamesAssociation) - * [`RAFluentTwoWayCoupling.GetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDecompositionFactor) - * [`RAFluentTwoWayCoupling.GetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient) - * [`RAFluentTwoWayCoupling.GetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDragLaw) - * [`RAFluentTwoWayCoupling.GetElementCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetElementCurve) - * [`RAFluentTwoWayCoupling.GetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs) - * [`RAFluentTwoWayCoupling.GetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode) - * [`RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier) - * [`RAFluentTwoWayCoupling.GetFluentReleases()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentReleases) - * [`RAFluentTwoWayCoupling.GetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentSolverProcesses) - * [`RAFluentTwoWayCoupling.GetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentVersion) - * [`RAFluentTwoWayCoupling.GetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFractionParticleSize) - * [`RAFluentTwoWayCoupling.GetGeometryQuantity()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryQuantity) - * [`RAFluentTwoWayCoupling.GetGeometryUnit()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryUnit) - * [`RAFluentTwoWayCoupling.GetGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunction) - * [`RAFluentTwoWayCoupling.GetGridFunctionNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunctionNames) - * [`RAFluentTwoWayCoupling.GetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetLiftLaw) - * [`RAFluentTwoWayCoupling.GetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMappingMethod) - * [`RAFluentTwoWayCoupling.GetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumIterations) - * [`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) - * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1) - * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2) - * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3) - * [`RAFluentTwoWayCoupling.GetNumberOfCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfCells) - * [`RAFluentTwoWayCoupling.GetNumberOfNodes()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfNodes) - * [`RAFluentTwoWayCoupling.GetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfSubsteps) - * [`RAFluentTwoWayCoupling.GetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfThreads) - * [`RAFluentTwoWayCoupling.GetNumpyCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumpyCurve) - * [`RAFluentTwoWayCoupling.GetOutputVariableValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOutputVariableValue) - * [`RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.GetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSubstepping) - * [`RAFluentTwoWayCoupling.GetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienC1) - * [`RAFluentTwoWayCoupling.GetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienD1) - * [`RAFluentTwoWayCoupling.GetTimeSet()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeSet) - * [`RAFluentTwoWayCoupling.GetTimeStatistics()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStatistics) - * [`RAFluentTwoWayCoupling.GetTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStep) - * [`RAFluentTwoWayCoupling.GetTopologyShape()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTopologyShape) - * [`RAFluentTwoWayCoupling.GetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTorqueLaw) - * [`RAFluentTwoWayCoupling.GetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseDatInitialization) - * [`RAFluentTwoWayCoupling.GetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseTurbulentDispersion) - * [`RAFluentTwoWayCoupling.GetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseUserDefinedConstants) - * [`RAFluentTwoWayCoupling.GetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUserCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.GetValidAveragingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingMethodValues) - * [`RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues) - * [`RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues) - * [`RAFluentTwoWayCoupling.GetValidMappingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) - * [`RAFluentTwoWayCoupling.GetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw) - * [`RAFluentTwoWayCoupling.GetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.HasGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.HasGridFunction) - * [`RAFluentTwoWayCoupling.IsBackDiffusionEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsBackDiffusionEnabled) - * [`RAFluentTwoWayCoupling.IsCellActive()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsCellActive) - * [`RAFluentTwoWayCoupling.IsFluentRunning()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsFluentRunning) - * [`RAFluentTwoWayCoupling.IsSubsteppingEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsSubsteppingEnabled) - * [`RAFluentTwoWayCoupling.IterCellVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCellVertices) - * [`RAFluentTwoWayCoupling.IterCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCells) - * [`RAFluentTwoWayCoupling.Modified()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.Modified) - * [`RAFluentTwoWayCoupling.RemoveCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomCurve) - * [`RAFluentTwoWayCoupling.RemoveCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomProperty) - * [`RAFluentTwoWayCoupling.RemoveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveOutputVariable) - * [`RAFluentTwoWayCoupling.RemoveProcess()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveProcess) - * [`RAFluentTwoWayCoupling.SetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAbsoluteValue) - * [`RAFluentTwoWayCoupling.SetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingMethod) - * [`RAFluentTwoWayCoupling.SetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingRadiusType) - * [`RAFluentTwoWayCoupling.SetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetBackDiffusion) - * [`RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw) - * [`RAFluentTwoWayCoupling.SetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCouplingFilesKept) - * [`RAFluentTwoWayCoupling.SetCurrentTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCurrentTimeStep) - * [`RAFluentTwoWayCoupling.SetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDecompositionFactor) - * [`RAFluentTwoWayCoupling.SetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDiffusionCoefficient) - * [`RAFluentTwoWayCoupling.SetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDragLaw) - * [`RAFluentTwoWayCoupling.SetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentAdditionalArgs) - * [`RAFluentTwoWayCoupling.SetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentExecutionMode) - * [`RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier) - * [`RAFluentTwoWayCoupling.SetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentSolverProcesses) - * [`RAFluentTwoWayCoupling.SetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentVersion) - * [`RAFluentTwoWayCoupling.SetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFractionParticleSize) - * [`RAFluentTwoWayCoupling.SetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetLiftLaw) - * [`RAFluentTwoWayCoupling.SetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMappingMethod) - * [`RAFluentTwoWayCoupling.SetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumIterations) - * [`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) - * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2) - * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3) - * [`RAFluentTwoWayCoupling.SetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfSubsteps) - * [`RAFluentTwoWayCoupling.SetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfThreads) - * [`RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.SetPartIdIfValid()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetPartIdIfValid) - * [`RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.SetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSubstepping) - * [`RAFluentTwoWayCoupling.SetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienC1) - * [`RAFluentTwoWayCoupling.SetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienD1) - * [`RAFluentTwoWayCoupling.SetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetTorqueLaw) - * [`RAFluentTwoWayCoupling.SetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseDatInitialization) - * [`RAFluentTwoWayCoupling.SetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseTurbulentDispersion) - * [`RAFluentTwoWayCoupling.SetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseUserDefinedConstants) - * [`RAFluentTwoWayCoupling.SetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUserCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.SetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVirtualMassLaw) - * [`RAFluentTwoWayCoupling.SetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.SetupStoreFiles()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetupStoreFiles) - * [`RAFluentTwoWayCoupling.StartFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.StartFluent) - * [`RAFluentTwoWayCoupling.UpdateFluentInfo()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.UpdateFluentInfo) - * [RAFluidInlet](RAFluidInlet.md) - * [`RAFluidInlet`](RAFluidInlet.md#generated.RAFluidInlet) - * [`RAFluidInlet.GetAvailableEntryPoints()`](RAFluidInlet.md#generated.RAFluidInlet.GetAvailableEntryPoints) - * [`RAFluidInlet.GetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.GetBoundaryCondition) - * [`RAFluidInlet.GetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.GetEntryPoint) - * [`RAFluidInlet.GetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.GetMassFlowRate) - * [`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.SetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.SetBoundaryCondition) - * [`RAFluidInlet.SetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.SetEntryPoint) - * [`RAFluidInlet.SetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.SetMassFlowRate) - * [`RAFluidInlet.SetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStartTime) - * [`RAFluidInlet.SetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStopTime) - * [`RAFluidInlet.SetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.SetTemperature) - * [`RAFluidInlet.SetVelocity()`](RAFluidInlet.md#generated.RAFluidInlet.SetVelocity) - * [RAFluidMaterial](RAFluidMaterial.md) - * [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) - * [`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) - * [RAFreeBodyRotation](RAFreeBodyRotation.md) - * [`RAFreeBodyRotation`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation) - * [`RAFreeBodyRotation.GetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetFreeMotionDirection) - * [`RAFreeBodyRotation.GetValidFreeMotionDirectionValues()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetValidFreeMotionDirectionValues) - * [`RAFreeBodyRotation.SetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.SetFreeMotionDirection) - * [RAFreeBodyTranslation](RAFreeBodyTranslation.md) - * [`RAFreeBodyTranslation`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation) - * [`RAFreeBodyTranslation.GetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetFreeMotionDirection) - * [`RAFreeBodyTranslation.GetValidFreeMotionDirectionValues()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetValidFreeMotionDirectionValues) - * [`RAFreeBodyTranslation.SetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.SetFreeMotionDirection) - * [RAGeometryCollection](RAGeometryCollection.md) - * [`RAGeometryCollection`](RAGeometryCollection.md#generated.RAGeometryCollection) - * [`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.RemoveGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.RemoveGeometry) - * [RAInletGeometry](RAInletGeometry.md) - * [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry) - * [`RAInletGeometry.AddCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCurve) - * [`RAInletGeometry.AddCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomCurve) - * [`RAInletGeometry.AddCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomProperty) - * [`RAInletGeometry.AddGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.AddGridFunction) - * [`RAInletGeometry.CreateCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateCurveOutputVariable) - * [`RAInletGeometry.CreateGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunction) - * [`RAInletGeometry.CreateGridFunctionArrayOnCells()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionArrayOnCells) - * [`RAInletGeometry.CreateGridFunctionStatisticOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionStatisticOutputVariable) - * [`RAInletGeometry.CreateTransientCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateTransientCurveOutputVariable) - * [`RAInletGeometry.EditCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomCurve) - * [`RAInletGeometry.EditCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomProperty) - * [`RAInletGeometry.GetActivesArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetActivesArray) - * [`RAInletGeometry.GetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetAlignmentAngle) - * [`RAInletGeometry.GetBoundingBox()`](RAInletGeometry.md#generated.RAInletGeometry.GetBoundingBox) - * [`RAInletGeometry.GetCellAreaAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellAreaAsArray) - * [`RAInletGeometry.GetCellCenterAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellCenterAsArray) - * [`RAInletGeometry.GetCellDzAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellDzAsArray) - * [`RAInletGeometry.GetCellFromIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellFromIJK) - * [`RAInletGeometry.GetCellIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellIJK) - * [`RAInletGeometry.GetCellNumberOfVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellNumberOfVertices) - * [`RAInletGeometry.GetCellPointsAsFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellPointsAsFunction) - * [`RAInletGeometry.GetCellVolumeAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellVolumeAsArray) - * [`RAInletGeometry.GetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.GetCenter) - * [`RAInletGeometry.GetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.GetCircularMinMaxRadius) - * [`RAInletGeometry.GetCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurve) - * [`RAInletGeometry.GetCurveNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNames) - * [`RAInletGeometry.GetCurveNamesAssociation()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNamesAssociation) - * [`RAInletGeometry.GetElementCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetElementCurve) - * [`RAInletGeometry.GetGeometryQuantity()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryQuantity) - * [`RAInletGeometry.GetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryType) - * [`RAInletGeometry.GetGeometryUnit()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryUnit) - * [`RAInletGeometry.GetGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunction) - * [`RAInletGeometry.GetGridFunctionNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunctionNames) - * [`RAInletGeometry.GetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetInclineAngle) - * [`RAInletGeometry.GetLength()`](RAInletGeometry.md#generated.RAInletGeometry.GetLength) - * [`RAInletGeometry.GetMeshColoring()`](RAInletGeometry.md#generated.RAInletGeometry.GetMeshColoring) - * [`RAInletGeometry.GetNumberOfCells()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfCells) - * [`RAInletGeometry.GetNumberOfNodes()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfNodes) - * [`RAInletGeometry.GetNumpyCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumpyCurve) - * [`RAInletGeometry.GetOutputVariableValue()`](RAInletGeometry.md#generated.RAInletGeometry.GetOutputVariableValue) - * [`RAInletGeometry.GetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.GetRectangularSize) - * [`RAInletGeometry.GetTimeSet()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeSet) - * [`RAInletGeometry.GetTimeStatistics()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStatistics) - * [`RAInletGeometry.GetTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStep) - * [`RAInletGeometry.GetTopologyShape()`](RAInletGeometry.md#generated.RAInletGeometry.GetTopologyShape) - * [`RAInletGeometry.GetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.GetWidth) - * [`RAInletGeometry.HasGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.HasGridFunction) - * [`RAInletGeometry.IsCellActive()`](RAInletGeometry.md#generated.RAInletGeometry.IsCellActive) - * [`RAInletGeometry.IterCellVertices()`](RAInletGeometry.md#generated.RAInletGeometry.IterCellVertices) - * [`RAInletGeometry.IterCells()`](RAInletGeometry.md#generated.RAInletGeometry.IterCells) - * [`RAInletGeometry.Modified()`](RAInletGeometry.md#generated.RAInletGeometry.Modified) - * [`RAInletGeometry.RemoveCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomCurve) - * [`RAInletGeometry.RemoveCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomProperty) - * [`RAInletGeometry.RemoveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveOutputVariable) - * [`RAInletGeometry.RemoveProcess()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveProcess) - * [`RAInletGeometry.SetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetAlignmentAngle) - * [`RAInletGeometry.SetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.SetCenter) - * [`RAInletGeometry.SetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.SetCircularMinMaxRadius) - * [`RAInletGeometry.SetCurrentTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.SetCurrentTimeStep) - * [`RAInletGeometry.SetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.SetGeometryType) - * [`RAInletGeometry.SetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetInclineAngle) - * [`RAInletGeometry.SetLength()`](RAInletGeometry.md#generated.RAInletGeometry.SetLength) - * [`RAInletGeometry.SetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.SetRectangularSize) - * [`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) - * [`RAInletsOutletsCollection.AddParticleInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddParticleInlet) - * [`RAInletsOutletsCollection.AddVolumetricInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddVolumetricInlet) - * [`RAInletsOutletsCollection.Clear()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Clear) - * [`RAInletsOutletsCollection.GetParticleInput()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInput) - * [`RAInletsOutletsCollection.GetParticleInputNames()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInputNames) - * [`RAInletsOutletsCollection.New()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.New) - * [`RAInletsOutletsCollection.Remove()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Remove) - * [RAInputVariables](RAInputVariables.md) - * [`RAInputVariables`](RAInputVariables.md#generated.RAInputVariables) - * [`RAInputVariables.CreateVariable()`](RAInputVariables.md#generated.RAInputVariables.CreateVariable) - * [`RAInputVariables.GetVariableByName()`](RAInputVariables.md#generated.RAInputVariables.GetVariableByName) - * [`RAInputVariables.RemoveVariable()`](RAInputVariables.md#generated.RAInputVariables.RemoveVariable) - * [RAInspectorProcess](RAInspectorProcess.md) - * [`RAInspectorProcess`](RAInspectorProcess.md#generated.RAInspectorProcess) - * [`RAInspectorProcess.AddCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCurve) - * [`RAInspectorProcess.AddCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomCurve) - * [`RAInspectorProcess.AddCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomProperty) - * [`RAInspectorProcess.AddGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddGridFunction) - * [`RAInspectorProcess.CreateCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateCurveOutputVariable) - * [`RAInspectorProcess.CreateGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunction) - * [`RAInspectorProcess.CreateGridFunctionArrayOnCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionArrayOnCells) - * [`RAInspectorProcess.CreateGridFunctionStatisticOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAInspectorProcess.CreateTransientCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateTransientCurveOutputVariable) - * [`RAInspectorProcess.EditCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomCurve) - * [`RAInspectorProcess.EditCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomProperty) - * [`RAInspectorProcess.GetActivesArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetActivesArray) - * [`RAInspectorProcess.GetBoundingBox()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetBoundingBox) - * [`RAInspectorProcess.GetCellAreaAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellAreaAsArray) - * [`RAInspectorProcess.GetCellCenterAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellCenterAsArray) - * [`RAInspectorProcess.GetCellDzAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellDzAsArray) - * [`RAInspectorProcess.GetCellFromIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellFromIJK) - * [`RAInspectorProcess.GetCellIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellIJK) - * [`RAInspectorProcess.GetCellNumberOfVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellNumberOfVertices) - * [`RAInspectorProcess.GetCellPointsAsFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellPointsAsFunction) - * [`RAInspectorProcess.GetCellVolumeAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellVolumeAsArray) - * [`RAInspectorProcess.GetCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurve) - * [`RAInspectorProcess.GetCurveNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNames) - * [`RAInspectorProcess.GetCurveNamesAssociation()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNamesAssociation) - * [`RAInspectorProcess.GetElementCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetElementCurve) - * [`RAInspectorProcess.GetGeometryQuantity()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryQuantity) - * [`RAInspectorProcess.GetGeometryUnit()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryUnit) - * [`RAInspectorProcess.GetGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunction) - * [`RAInspectorProcess.GetGridFunctionNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunctionNames) - * [`RAInspectorProcess.GetMeshColoring()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetMeshColoring) - * [`RAInspectorProcess.GetNumberOfCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfCells) - * [`RAInspectorProcess.GetNumberOfNodes()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfNodes) - * [`RAInspectorProcess.GetNumberOfParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfParticles) - * [`RAInspectorProcess.GetNumpyCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumpyCurve) - * [`RAInspectorProcess.GetOutputVariableValue()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetOutputVariableValue) - * [`RAInspectorProcess.GetTimeSet()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeSet) - * [`RAInspectorProcess.GetTimeStatistics()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStatistics) - * [`RAInspectorProcess.GetTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStep) - * [`RAInspectorProcess.GetTopologyShape()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTopologyShape) - * [`RAInspectorProcess.HasGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.HasGridFunction) - * [`RAInspectorProcess.IsCellActive()`](RAInspectorProcess.md#generated.RAInspectorProcess.IsCellActive) - * [`RAInspectorProcess.IterCellVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCellVertices) - * [`RAInspectorProcess.IterCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCells) - * [`RAInspectorProcess.IterParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterParticles) - * [`RAInspectorProcess.Modified()`](RAInspectorProcess.md#generated.RAInspectorProcess.Modified) - * [`RAInspectorProcess.RemoveCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomCurve) - * [`RAInspectorProcess.RemoveCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomProperty) - * [`RAInspectorProcess.RemoveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveOutputVariable) - * [`RAInspectorProcess.RemoveProcess()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveProcess) - * [`RAInspectorProcess.SetCurrentTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.SetCurrentTimeStep) - * [RAJointsDataMeshColoring](RAJointsDataMeshColoring.md) - * [`RAJointsDataMeshColoring`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring) - * [`RAJointsDataMeshColoring.GetAvailableGridFunctions()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctions) - * [`RAJointsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctionsNames) - * [`RAJointsDataMeshColoring.GetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsColor) - * [`RAJointsDataMeshColoring.GetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityColor) - * [`RAJointsDataMeshColoring.GetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityLineWidth) - * [`RAJointsDataMeshColoring.GetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityProperty) - * [`RAJointsDataMeshColoring.GetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityVisible) - * [`RAJointsDataMeshColoring.GetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsPointSize) - * [`RAJointsDataMeshColoring.GetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsProperty) - * [`RAJointsDataMeshColoring.GetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsVisible) - * [`RAJointsDataMeshColoring.GetValidColoringModes()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetValidColoringModes) - * [`RAJointsDataMeshColoring.SetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsColor) - * [`RAJointsDataMeshColoring.SetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityColor) - * [`RAJointsDataMeshColoring.SetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityLineWidth) - * [`RAJointsDataMeshColoring.SetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityProperty) - * [`RAJointsDataMeshColoring.SetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityVisible) - * [`RAJointsDataMeshColoring.SetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsPointSize) - * [`RAJointsDataMeshColoring.SetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsProperty) - * [`RAJointsDataMeshColoring.SetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsVisible) - * [RALinearTimeVariableForce](RALinearTimeVariableForce.md) - * [`RALinearTimeVariableForce`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce) - * [`RALinearTimeVariableForce.GetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetInitialForceValue) - * [`RALinearTimeVariableForce.GetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetTimeCoefficients) - * [`RALinearTimeVariableForce.SetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetInitialForceValue) - * [`RALinearTimeVariableForce.SetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetTimeCoefficients) - * [RALinearTimeVariableMoment](RALinearTimeVariableMoment.md) - * [`RALinearTimeVariableMoment`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment) - * [`RALinearTimeVariableMoment.GetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetInitialMomentValue) - * [`RALinearTimeVariableMoment.GetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetTimeCoefficients) - * [`RALinearTimeVariableMoment.SetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetInitialMomentValue) - * [`RALinearTimeVariableMoment.SetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetTimeCoefficients) - * [RAMaterialCollection](RAMaterialCollection.md) - * [`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) - * [`RAMaterialCollection.Remove()`](RAMaterialCollection.md#generated.RAMaterialCollection.Remove) - * [`RAMaterialCollection.SetBulkSolidFraction()`](RAMaterialCollection.md#generated.RAMaterialCollection.SetBulkSolidFraction) - * [RAMaterialsInteraction](RAMaterialsInteraction.md) - * [`RAMaterialsInteraction`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction) - * [`RAMaterialsInteraction.GetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveDistance) - * [`RAMaterialsInteraction.GetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveFraction) - * [`RAMaterialsInteraction.GetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetContactStiffnessMultiplier) - * [`RAMaterialsInteraction.GetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetDynamicFriction) - * [`RAMaterialsInteraction.GetFirstMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetFirstMaterial) - * [`RAMaterialsInteraction.GetModuleProperties()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperties) - * [`RAMaterialsInteraction.GetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperty) - * [`RAMaterialsInteraction.GetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetRestitutionCoefficient) - * [`RAMaterialsInteraction.GetSecondMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSecondMaterial) - * [`RAMaterialsInteraction.GetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetStaticFriction) - * [`RAMaterialsInteraction.GetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSurfaceEnergy) - * [`RAMaterialsInteraction.GetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetTangentialStiffnessRatio) - * [`RAMaterialsInteraction.GetValidOptionsForModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetValidOptionsForModuleProperty) - * [`RAMaterialsInteraction.GetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityExponent) - * [`RAMaterialsInteraction.GetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityLimit) - * [`RAMaterialsInteraction.SetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveDistance) - * [`RAMaterialsInteraction.SetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveFraction) - * [`RAMaterialsInteraction.SetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetContactStiffnessMultiplier) - * [`RAMaterialsInteraction.SetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetDynamicFriction) - * [`RAMaterialsInteraction.SetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetModuleProperty) - * [`RAMaterialsInteraction.SetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetRestitutionCoefficient) - * [`RAMaterialsInteraction.SetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetStaticFriction) - * [`RAMaterialsInteraction.SetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetSurfaceEnergy) - * [`RAMaterialsInteraction.SetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetTangentialStiffnessRatio) - * [`RAMaterialsInteraction.SetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityExponent) - * [`RAMaterialsInteraction.SetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityLimit) - * [RAMaterialsInteractionCollection](RAMaterialsInteractionCollection.md) - * [`RAMaterialsInteractionCollection`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection) - * [`RAMaterialsInteractionCollection.Clear()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Clear) - * [`RAMaterialsInteractionCollection.GetMaterialsInteraction()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.GetMaterialsInteraction) - * [`RAMaterialsInteractionCollection.New()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.New) - * [`RAMaterialsInteractionCollection.Remove()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Remove) - * [RAMeshColoring](RAMeshColoring.md) - * [`RAMeshColoring`](RAMeshColoring.md#generated.RAMeshColoring) - * [`RAMeshColoring.GetAvailableGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctions) - * [`RAMeshColoring.GetAvailableGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctionsNames) - * [`RAMeshColoring.GetAvailableVectorGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctions) - * [`RAMeshColoring.GetAvailableVectorGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctionsNames) - * [`RAMeshColoring.GetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeColor) - * [`RAMeshColoring.GetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeGridFunction) - * [`RAMeshColoring.GetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeLineWidth) - * [`RAMeshColoring.GetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeVisible) - * [`RAMeshColoring.GetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceColor) - * [`RAMeshColoring.GetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceCustomStructuredPartitions) - * [`RAMeshColoring.GetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceGridFunction) - * [`RAMeshColoring.GetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceScope) - * [`RAMeshColoring.GetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceShowOnNode) - * [`RAMeshColoring.GetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceStructuredPartitions) - * [`RAMeshColoring.GetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceVisible) - * [`RAMeshColoring.GetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.GetLevelOfDetail) - * [`RAMeshColoring.GetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeColor) - * [`RAMeshColoring.GetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeGridFunction) - * [`RAMeshColoring.GetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodePointSize) - * [`RAMeshColoring.GetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeVisible) - * [`RAMeshColoring.GetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetNormalizedVectorsEnabled) - * [`RAMeshColoring.GetStride()`](RAMeshColoring.md#generated.RAMeshColoring.GetStride) - * [`RAMeshColoring.GetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparency) - * [`RAMeshColoring.GetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparencyEnabled) - * [`RAMeshColoring.GetValidColoringModes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidColoringModes) - * [`RAMeshColoring.GetValidFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceCustomStructuredPartitions) - * [`RAMeshColoring.GetValidFaceScopes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceScopes) - * [`RAMeshColoring.GetValidFaceStructuredPartitionsValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceStructuredPartitionsValues) - * [`RAMeshColoring.GetValidLevelOfDetailValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidLevelOfDetailValues) - * [`RAMeshColoring.GetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorGridFunction) - * [`RAMeshColoring.GetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorScale) - * [`RAMeshColoring.GetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorVisible) - * [`RAMeshColoring.GetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVisible) - * [`RAMeshColoring.SetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeColor) - * [`RAMeshColoring.SetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeGridFunction) - * [`RAMeshColoring.SetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeLineWidth) - * [`RAMeshColoring.SetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeVisible) - * [`RAMeshColoring.SetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceColor) - * [`RAMeshColoring.SetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceCustomStructuredPartitions) - * [`RAMeshColoring.SetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceGridFunction) - * [`RAMeshColoring.SetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceScope) - * [`RAMeshColoring.SetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceShowOnNode) - * [`RAMeshColoring.SetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceStructuredPartitions) - * [`RAMeshColoring.SetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceVisible) - * [`RAMeshColoring.SetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.SetLevelOfDetail) - * [`RAMeshColoring.SetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeColor) - * [`RAMeshColoring.SetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeGridFunction) - * [`RAMeshColoring.SetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodePointSize) - * [`RAMeshColoring.SetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeVisible) - * [`RAMeshColoring.SetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetNormalizedVectorsEnabled) - * [`RAMeshColoring.SetStride()`](RAMeshColoring.md#generated.RAMeshColoring.SetStride) - * [`RAMeshColoring.SetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparency) - * [`RAMeshColoring.SetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparencyEnabled) - * [`RAMeshColoring.SetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorGridFunction) - * [`RAMeshColoring.SetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorScale) - * [`RAMeshColoring.SetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorVisible) - * [`RAMeshColoring.SetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVisible) - * [RAModule](RAModule.md) - * [`RAModule`](RAModule.md#generated.RAModule) - * [`RAModule.DisableModule()`](RAModule.md#generated.RAModule.DisableModule) - * [`RAModule.EnableModule()`](RAModule.md#generated.RAModule.EnableModule) - * [`RAModule.GetModuleProperties()`](RAModule.md#generated.RAModule.GetModuleProperties) - * [`RAModule.GetModuleProperty()`](RAModule.md#generated.RAModule.GetModuleProperty) - * [`RAModule.GetOutputObject()`](RAModule.md#generated.RAModule.GetOutputObject) - * [`RAModule.GetValidOptionsForModuleProperty()`](RAModule.md#generated.RAModule.GetValidOptionsForModuleProperty) - * [`RAModule.IsModuleEnabled()`](RAModule.md#generated.RAModule.IsModuleEnabled) - * [`RAModule.SetModuleEnabled()`](RAModule.md#generated.RAModule.SetModuleEnabled) - * [`RAModule.SetModuleProperty()`](RAModule.md#generated.RAModule.SetModuleProperty) - * [RAModuleCollection](RAModuleCollection.md) - * [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) - * [`RAModuleCollection.GetEnabledModules()`](RAModuleCollection.md#generated.RAModuleCollection.GetEnabledModules) - * [`RAModuleCollection.GetModule()`](RAModuleCollection.md#generated.RAModuleCollection.GetModule) - * [`RAModuleCollection.GetModuleNames()`](RAModuleCollection.md#generated.RAModuleCollection.GetModuleNames) - * [RAModuleOutput](RAModuleOutput.md) - * [`RAModuleOutput`](RAModuleOutput.md#generated.RAModuleOutput) - * [`RAModuleOutput.AddCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCurve) - * [`RAModuleOutput.AddCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomCurve) - * [`RAModuleOutput.AddCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomProperty) - * [`RAModuleOutput.AddGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.AddGridFunction) - * [`RAModuleOutput.CreateCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateCurveOutputVariable) - * [`RAModuleOutput.CreateGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunction) - * [`RAModuleOutput.CreateGridFunctionArrayOnCells()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionArrayOnCells) - * [`RAModuleOutput.CreateGridFunctionStatisticOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionStatisticOutputVariable) - * [`RAModuleOutput.CreateTransientCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateTransientCurveOutputVariable) - * [`RAModuleOutput.EditCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomCurve) - * [`RAModuleOutput.EditCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomProperty) - * [`RAModuleOutput.GetActivesArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetActivesArray) - * [`RAModuleOutput.GetBoundingBox()`](RAModuleOutput.md#generated.RAModuleOutput.GetBoundingBox) - * [`RAModuleOutput.GetCellAreaAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellAreaAsArray) - * [`RAModuleOutput.GetCellCenterAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellCenterAsArray) - * [`RAModuleOutput.GetCellDzAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellDzAsArray) - * [`RAModuleOutput.GetCellFromIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellFromIJK) - * [`RAModuleOutput.GetCellIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellIJK) - * [`RAModuleOutput.GetCellNumberOfVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellNumberOfVertices) - * [`RAModuleOutput.GetCellPointsAsFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellPointsAsFunction) - * [`RAModuleOutput.GetCellVolumeAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellVolumeAsArray) - * [`RAModuleOutput.GetCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurve) - * [`RAModuleOutput.GetCurveNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNames) - * [`RAModuleOutput.GetCurveNamesAssociation()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNamesAssociation) - * [`RAModuleOutput.GetElementCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetElementCurve) - * [`RAModuleOutput.GetGeometryQuantity()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryQuantity) - * [`RAModuleOutput.GetGeometryUnit()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryUnit) - * [`RAModuleOutput.GetGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunction) - * [`RAModuleOutput.GetGridFunctionNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunctionNames) - * [`RAModuleOutput.GetMeshColoring()`](RAModuleOutput.md#generated.RAModuleOutput.GetMeshColoring) - * [`RAModuleOutput.GetNumberOfCells()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfCells) - * [`RAModuleOutput.GetNumberOfNodes()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfNodes) - * [`RAModuleOutput.GetNumpyCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumpyCurve) - * [`RAModuleOutput.GetOutputVariableValue()`](RAModuleOutput.md#generated.RAModuleOutput.GetOutputVariableValue) - * [`RAModuleOutput.GetTimeSet()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeSet) - * [`RAModuleOutput.GetTimeStatistics()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStatistics) - * [`RAModuleOutput.GetTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStep) - * [`RAModuleOutput.GetTopologyShape()`](RAModuleOutput.md#generated.RAModuleOutput.GetTopologyShape) - * [`RAModuleOutput.HasGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.HasGridFunction) - * [`RAModuleOutput.IsCellActive()`](RAModuleOutput.md#generated.RAModuleOutput.IsCellActive) - * [`RAModuleOutput.IterCellVertices()`](RAModuleOutput.md#generated.RAModuleOutput.IterCellVertices) - * [`RAModuleOutput.IterCells()`](RAModuleOutput.md#generated.RAModuleOutput.IterCells) - * [`RAModuleOutput.Modified()`](RAModuleOutput.md#generated.RAModuleOutput.Modified) - * [`RAModuleOutput.RemoveCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomCurve) - * [`RAModuleOutput.RemoveCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomProperty) - * [`RAModuleOutput.RemoveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveOutputVariable) - * [`RAModuleOutput.RemoveProcess()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveProcess) - * [`RAModuleOutput.SetCurrentTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.SetCurrentTimeStep) - * [RAModulePropertyList](RAModulePropertyList.md) - * [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) - * [`RAModulePropertyList.Clear()`](RAModulePropertyList.md#generated.RAModulePropertyList.Clear) - * [`RAModulePropertyList.New()`](RAModulePropertyList.md#generated.RAModulePropertyList.New) - * [`RAModulePropertyList.Remove()`](RAModulePropertyList.md#generated.RAModulePropertyList.Remove) - * [RAModulePropertyListItem](RAModulePropertyListItem.md) - * [`RAModulePropertyListItem`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem) - * [`RAModulePropertyListItem.GetModuleProperties()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperties) - * [`RAModulePropertyListItem.GetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperty) - * [`RAModulePropertyListItem.GetValidOptionsForModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetValidOptionsForModuleProperty) - * [`RAModulePropertyListItem.SetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.SetModuleProperty) - * [RAMotion](RAMotion.md) - * [`RAMotion`](RAMotion.md#generated.RAMotion) - * [`RAMotion.GetStartTime()`](RAMotion.md#generated.RAMotion.GetStartTime) - * [`RAMotion.GetStopTime()`](RAMotion.md#generated.RAMotion.GetStopTime) - * [`RAMotion.GetType()`](RAMotion.md#generated.RAMotion.GetType) - * [`RAMotion.GetTypeObject()`](RAMotion.md#generated.RAMotion.GetTypeObject) - * [`RAMotion.GetValidTypes()`](RAMotion.md#generated.RAMotion.GetValidTypes) - * [`RAMotion.SetStartTime()`](RAMotion.md#generated.RAMotion.SetStartTime) - * [`RAMotion.SetStopTime()`](RAMotion.md#generated.RAMotion.SetStopTime) - * [`RAMotion.SetType()`](RAMotion.md#generated.RAMotion.SetType) - * [RAMotionFrame](RAMotionFrame.md) - * [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame) - * [`RAMotionFrame.AddCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCurve) - * [`RAMotionFrame.AddCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomCurve) - * [`RAMotionFrame.AddCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomProperty) - * [`RAMotionFrame.AddGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.AddGridFunction) - * [`RAMotionFrame.AddPendulumMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddPendulumMotion) - * [`RAMotionFrame.AddRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddRotationMotion) - * [`RAMotionFrame.AddTranslationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddTranslationMotion) - * [`RAMotionFrame.AddVibrationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddVibrationMotion) - * [`RAMotionFrame.ApplyTo()`](RAMotionFrame.md#generated.RAMotionFrame.ApplyTo) - * [`RAMotionFrame.CreateCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateCurveOutputVariable) - * [`RAMotionFrame.CreateGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunction) - * [`RAMotionFrame.CreateGridFunctionArrayOnCells()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionArrayOnCells) - * [`RAMotionFrame.CreateGridFunctionStatisticOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionStatisticOutputVariable) - * [`RAMotionFrame.CreateTransientCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateTransientCurveOutputVariable) - * [`RAMotionFrame.EditCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomCurve) - * [`RAMotionFrame.EditCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomProperty) - * [`RAMotionFrame.GetActivesArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetActivesArray) - * [`RAMotionFrame.GetBoundingBox()`](RAMotionFrame.md#generated.RAMotionFrame.GetBoundingBox) - * [`RAMotionFrame.GetCellAreaAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellAreaAsArray) - * [`RAMotionFrame.GetCellCenterAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellCenterAsArray) - * [`RAMotionFrame.GetCellDzAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellDzAsArray) - * [`RAMotionFrame.GetCellFromIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellFromIJK) - * [`RAMotionFrame.GetCellIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellIJK) - * [`RAMotionFrame.GetCellNumberOfVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellNumberOfVertices) - * [`RAMotionFrame.GetCellPointsAsFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellPointsAsFunction) - * [`RAMotionFrame.GetCellVolumeAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellVolumeAsArray) - * [`RAMotionFrame.GetCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurve) - * [`RAMotionFrame.GetCurveNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNames) - * [`RAMotionFrame.GetCurveNamesAssociation()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNamesAssociation) - * [`RAMotionFrame.GetElementCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetElementCurve) - * [`RAMotionFrame.GetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmAngularLimits) - * [`RAMotionFrame.GetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmLinearLimits) - * [`RAMotionFrame.GetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnablePeriodicMotion) - * [`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.GetGeometryUnit()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryUnit) - * [`RAMotionFrame.GetGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunction) - * [`RAMotionFrame.GetGridFunctionNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunctionNames) - * [`RAMotionFrame.GetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.GetKeepInPlace) - * [`RAMotionFrame.GetMeshColoring()`](RAMotionFrame.md#generated.RAMotionFrame.GetMeshColoring) - * [`RAMotionFrame.GetMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotionFrame) - * [`RAMotionFrame.GetMotions()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotions) - * [`RAMotionFrame.GetNumberOfCells()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfCells) - * [`RAMotionFrame.GetNumberOfNodes()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfNodes) - * [`RAMotionFrame.GetNumpyCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumpyCurve) - * [`RAMotionFrame.GetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientation) - * [`RAMotionFrame.GetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngleAndVector) - * [`RAMotionFrame.GetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngles) - * [`RAMotionFrame.GetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromBasisVector) - * [`RAMotionFrame.GetOutputVariableValue()`](RAMotionFrame.md#generated.RAMotionFrame.GetOutputVariableValue) - * [`RAMotionFrame.GetParentMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetParentMotionFrame) - * [`RAMotionFrame.GetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionPeriod) - * [`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.HasGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.HasGridFunction) - * [`RAMotionFrame.IsCellActive()`](RAMotionFrame.md#generated.RAMotionFrame.IsCellActive) - * [`RAMotionFrame.IterCellVertices()`](RAMotionFrame.md#generated.RAMotionFrame.IterCellVertices) - * [`RAMotionFrame.IterCells()`](RAMotionFrame.md#generated.RAMotionFrame.IterCells) - * [`RAMotionFrame.IterMotionFrames()`](RAMotionFrame.md#generated.RAMotionFrame.IterMotionFrames) - * [`RAMotionFrame.Modified()`](RAMotionFrame.md#generated.RAMotionFrame.Modified) - * [`RAMotionFrame.NewConeCrusherFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewConeCrusherFrame) - * [`RAMotionFrame.NewFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewFrame) - * [`RAMotionFrame.RemoveCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomCurve) - * [`RAMotionFrame.RemoveCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomProperty) - * [`RAMotionFrame.RemoveFrame()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveFrame) - * [`RAMotionFrame.RemoveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveOutputVariable) - * [`RAMotionFrame.RemoveProcess()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveProcess) - * [`RAMotionFrame.SetCurrentTimeStep()`](RAMotionFrame.md#generated.RAMotionFrame.SetCurrentTimeStep) - * [`RAMotionFrame.SetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmAngularLimits) - * [`RAMotionFrame.SetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmLinearLimits) - * [`RAMotionFrame.SetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnablePeriodicMotion) - * [`RAMotionFrame.SetFbmMaxAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxAngularLimits) - * [`RAMotionFrame.SetFbmMaxLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxLinearLimits) - * [`RAMotionFrame.SetFbmMinAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinAngularLimits) - * [`RAMotionFrame.SetFbmMinLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinLinearLimits) - * [`RAMotionFrame.SetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.SetKeepInPlace) - * [`RAMotionFrame.SetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientation) - * [`RAMotionFrame.SetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngleAndVector) - * [`RAMotionFrame.SetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngles) - * [`RAMotionFrame.SetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromBasisVector) - * [`RAMotionFrame.SetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionPeriod) - * [`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) - * [`RAMotionFrameSource.GetParentMotionFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.GetParentMotionFrame) - * [`RAMotionFrameSource.IterMotionFrames()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.IterMotionFrames) - * [`RAMotionFrameSource.NewConeCrusherFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewConeCrusherFrame) - * [`RAMotionFrameSource.NewFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewFrame) - * [`RAMotionFrameSource.RemoveFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.RemoveFrame) - * [RAMotionList](RAMotionList.md) - * [`RAMotionList`](RAMotionList.md#generated.RAMotionList) - * [`RAMotionList.Clear()`](RAMotionList.md#generated.RAMotionList.Clear) - * [`RAMotionList.New()`](RAMotionList.md#generated.RAMotionList.New) - * [`RAMotionList.Remove()`](RAMotionList.md#generated.RAMotionList.Remove) - * [RAOneRollBeltProfile](RAOneRollBeltProfile.md) - * [`RAOneRollBeltProfile`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile) - * [`RAOneRollBeltProfile.GetAvailableMaterials()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetAvailableMaterials) - * [`RAOneRollBeltProfile.GetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetMaterial) - * [`RAOneRollBeltProfile.SetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.SetMaterial) - * [RAOutlet](RAOutlet.md) - * [`RAOutlet`](RAOutlet.md#generated.RAOutlet) - * [`RAOutlet.DisablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.DisablePrescribedPressure) - * [`RAOutlet.EnablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.EnablePrescribedPressure) - * [`RAOutlet.GetAvailableExitPoints()`](RAOutlet.md#generated.RAOutlet.GetAvailableExitPoints) - * [`RAOutlet.GetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.GetEnabledForParticles) - * [`RAOutlet.GetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.GetEnabledForSph) - * [`RAOutlet.GetExitPoint()`](RAOutlet.md#generated.RAOutlet.GetExitPoint) - * [`RAOutlet.GetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.GetPrescribedPressureEnabled) - * [`RAOutlet.GetPressure()`](RAOutlet.md#generated.RAOutlet.GetPressure) - * [`RAOutlet.IsPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.IsPrescribedPressureEnabled) - * [`RAOutlet.SetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.SetEnabledForParticles) - * [`RAOutlet.SetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.SetEnabledForSph) - * [`RAOutlet.SetExitPoint()`](RAOutlet.md#generated.RAOutlet.SetExitPoint) - * [`RAOutlet.SetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.SetPrescribedPressureEnabled) - * [`RAOutlet.SetPressure()`](RAOutlet.md#generated.RAOutlet.SetPressure) - * [RAParametricVar](RAParametricVar.md) - * [`RAParametricVar`](RAParametricVar.md#generated.RAParametricVar) - * [`RAParametricVar.GetValue()`](RAParametricVar.md#generated.RAParametricVar.GetValue) - * [`RAParametricVar.SetValue()`](RAParametricVar.md#generated.RAParametricVar.SetValue) - * [RAParametricVariables](RAParametricVariables.md) - * [`RAParametricVariables`](RAParametricVariables.md#generated.RAParametricVariables) - * [`RAParametricVariables.GetInputVariables()`](RAParametricVariables.md#generated.RAParametricVariables.GetInputVariables) - * [RAParticle](RAParticle.md) - * [`RAParticle`](RAParticle.md#generated.RAParticle) - * [`RAParticle.AddCurve()`](RAParticle.md#generated.RAParticle.AddCurve) - * [`RAParticle.AddCustomCurve()`](RAParticle.md#generated.RAParticle.AddCustomCurve) - * [`RAParticle.AddCustomProperty()`](RAParticle.md#generated.RAParticle.AddCustomProperty) - * [`RAParticle.AddGridFunction()`](RAParticle.md#generated.RAParticle.AddGridFunction) - * [`RAParticle.CreateCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateCurveOutputVariable) - * [`RAParticle.CreateGridFunction()`](RAParticle.md#generated.RAParticle.CreateGridFunction) - * [`RAParticle.CreateGridFunctionArrayOnCells()`](RAParticle.md#generated.RAParticle.CreateGridFunctionArrayOnCells) - * [`RAParticle.CreateGridFunctionStatisticOutputVariable()`](RAParticle.md#generated.RAParticle.CreateGridFunctionStatisticOutputVariable) - * [`RAParticle.CreateTransientCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateTransientCurveOutputVariable) - * [`RAParticle.DisableBreakage()`](RAParticle.md#generated.RAParticle.DisableBreakage) - * [`RAParticle.DisableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.DisableIncludeRotationalDeformations) - * [`RAParticle.DisableRandomOrientation()`](RAParticle.md#generated.RAParticle.DisableRandomOrientation) - * [`RAParticle.EditCustomCurve()`](RAParticle.md#generated.RAParticle.EditCustomCurve) - * [`RAParticle.EditCustomProperty()`](RAParticle.md#generated.RAParticle.EditCustomProperty) - * [`RAParticle.EnableBreakage()`](RAParticle.md#generated.RAParticle.EnableBreakage) - * [`RAParticle.EnableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.EnableIncludeRotationalDeformations) - * [`RAParticle.EnableRandomOrientation()`](RAParticle.md#generated.RAParticle.EnableRandomOrientation) - * [`RAParticle.GetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.GetAbt10MaximumT10Value) - * [`RAParticle.GetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10MinimumSpecificEnergy) - * [`RAParticle.GetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) - * [`RAParticle.GetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceSize) - * [`RAParticle.GetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.GetAbt10SelectFunctionCoefficient) - * [`RAParticle.GetActivesArray()`](RAParticle.md#generated.RAParticle.GetActivesArray) - * [`RAParticle.GetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) - * [`RAParticle.GetAnisotropic()`](RAParticle.md#generated.RAParticle.GetAnisotropic) - * [`RAParticle.GetAvailableMaterials()`](RAParticle.md#generated.RAParticle.GetAvailableMaterials) - * [`RAParticle.GetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetBendingAngleLimit) - * [`RAParticle.GetBoundingBox()`](RAParticle.md#generated.RAParticle.GetBoundingBox) - * [`RAParticle.GetBreakageModel()`](RAParticle.md#generated.RAParticle.GetBreakageModel) - * [`RAParticle.GetCellAreaAsArray()`](RAParticle.md#generated.RAParticle.GetCellAreaAsArray) - * [`RAParticle.GetCellCenterAsArray()`](RAParticle.md#generated.RAParticle.GetCellCenterAsArray) - * [`RAParticle.GetCellDzAsArray()`](RAParticle.md#generated.RAParticle.GetCellDzAsArray) - * [`RAParticle.GetCellFromIJK()`](RAParticle.md#generated.RAParticle.GetCellFromIJK) - * [`RAParticle.GetCellIJK()`](RAParticle.md#generated.RAParticle.GetCellIJK) - * [`RAParticle.GetCellNumberOfVertices()`](RAParticle.md#generated.RAParticle.GetCellNumberOfVertices) - * [`RAParticle.GetCellPointsAsFunction()`](RAParticle.md#generated.RAParticle.GetCellPointsAsFunction) - * [`RAParticle.GetCellVolumeAsArray()`](RAParticle.md#generated.RAParticle.GetCellVolumeAsArray) - * [`RAParticle.GetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.GetCenterOfMassOffset) - * [`RAParticle.GetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.GetCgmScaleFactor) - * [`RAParticle.GetChangeMassProperties()`](RAParticle.md#generated.RAParticle.GetChangeMassProperties) - * [`RAParticle.GetCurve()`](RAParticle.md#generated.RAParticle.GetCurve) - * [`RAParticle.GetCurveNames()`](RAParticle.md#generated.RAParticle.GetCurveNames) - * [`RAParticle.GetCurveNamesAssociation()`](RAParticle.md#generated.RAParticle.GetCurveNamesAssociation) - * [`RAParticle.GetDeformationModel()`](RAParticle.md#generated.RAParticle.GetDeformationModel) - * [`RAParticle.GetDistributionModel()`](RAParticle.md#generated.RAParticle.GetDistributionModel) - * [`RAParticle.GetEdgeAngle()`](RAParticle.md#generated.RAParticle.GetEdgeAngle) - * [`RAParticle.GetElasticRatioBending()`](RAParticle.md#generated.RAParticle.GetElasticRatioBending) - * [`RAParticle.GetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.GetElasticRatioNormal) - * [`RAParticle.GetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.GetElasticRatioTangential) - * [`RAParticle.GetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.GetElasticRatioTorsion) - * [`RAParticle.GetElasticity()`](RAParticle.md#generated.RAParticle.GetElasticity) - * [`RAParticle.GetElementCurve()`](RAParticle.md#generated.RAParticle.GetElementCurve) - * [`RAParticle.GetElementDampingRatio()`](RAParticle.md#generated.RAParticle.GetElementDampingRatio) - * [`RAParticle.GetEnableBreakage()`](RAParticle.md#generated.RAParticle.GetEnableBreakage) - * [`RAParticle.GetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.GetEnableRandomAngle) - * [`RAParticle.GetEnableRotations()`](RAParticle.md#generated.RAParticle.GetEnableRotations) - * [`RAParticle.GetFailureRatio()`](RAParticle.md#generated.RAParticle.GetFailureRatio) - * [`RAParticle.GetFlexible()`](RAParticle.md#generated.RAParticle.GetFlexible) - * [`RAParticle.GetGeometryQuantity()`](RAParticle.md#generated.RAParticle.GetGeometryQuantity) - * [`RAParticle.GetGeometryUnit()`](RAParticle.md#generated.RAParticle.GetGeometryUnit) - * [`RAParticle.GetGridFunction()`](RAParticle.md#generated.RAParticle.GetGridFunction) - * [`RAParticle.GetGridFunctionNames()`](RAParticle.md#generated.RAParticle.GetGridFunctionNames) - * [`RAParticle.GetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.GetHorizontalAspectRatio) - * [`RAParticle.GetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.GetIncludeRotationalDeformations) - * [`RAParticle.GetInternalFriction()`](RAParticle.md#generated.RAParticle.GetInternalFriction) - * [`RAParticle.GetJointDampingRatio()`](RAParticle.md#generated.RAParticle.GetJointDampingRatio) - * [`RAParticle.GetJointElasticRatio()`](RAParticle.md#generated.RAParticle.GetJointElasticRatio) - * [`RAParticle.GetJointThermalRatio()`](RAParticle.md#generated.RAParticle.GetJointThermalRatio) - * [`RAParticle.GetMaterial()`](RAParticle.md#generated.RAParticle.GetMaterial) - * [`RAParticle.GetMeshColoring()`](RAParticle.md#generated.RAParticle.GetMeshColoring) - * [`RAParticle.GetMinimumSize()`](RAParticle.md#generated.RAParticle.GetMinimumSize) - * [`RAParticle.GetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.GetMinimumSizeRatio) - * [`RAParticle.GetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.GetMinimumVolumeFractionForFragmentDisabling) - * [`RAParticle.GetModuleProperties()`](RAParticle.md#generated.RAParticle.GetModuleProperties) - * [`RAParticle.GetModuleProperty()`](RAParticle.md#generated.RAParticle.GetModuleProperty) - * [`RAParticle.GetNumberOfCells()`](RAParticle.md#generated.RAParticle.GetNumberOfCells) - * [`RAParticle.GetNumberOfCorners()`](RAParticle.md#generated.RAParticle.GetNumberOfCorners) - * [`RAParticle.GetNumberOfNodes()`](RAParticle.md#generated.RAParticle.GetNumberOfNodes) - * [`RAParticle.GetNumpyCurve()`](RAParticle.md#generated.RAParticle.GetNumpyCurve) - * [`RAParticle.GetOrientation()`](RAParticle.md#generated.RAParticle.GetOrientation) - * [`RAParticle.GetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngleAndVector) - * [`RAParticle.GetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngles) - * [`RAParticle.GetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromBasisVector) - * [`RAParticle.GetOutputVariableValue()`](RAParticle.md#generated.RAParticle.GetOutputVariableValue) - * [`RAParticle.GetPlasticLimit()`](RAParticle.md#generated.RAParticle.GetPlasticLimit) - * [`RAParticle.GetPlasticRatio()`](RAParticle.md#generated.RAParticle.GetPlasticRatio) - * [`RAParticle.GetPlasticityModel()`](RAParticle.md#generated.RAParticle.GetPlasticityModel) - * [`RAParticle.GetPorosity()`](RAParticle.md#generated.RAParticle.GetPorosity) - * [`RAParticle.GetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.GetPrincipalMomentOfInertia) - * [`RAParticle.GetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.GetRandomAnglesHalfRange) - * [`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) - * [`RAParticle.GetSideAngle()`](RAParticle.md#generated.RAParticle.GetSideAngle) - * [`RAParticle.GetSizeDistributionList()`](RAParticle.md#generated.RAParticle.GetSizeDistributionList) - * [`RAParticle.GetSizeType()`](RAParticle.md#generated.RAParticle.GetSizeType) - * [`RAParticle.GetSmoothness()`](RAParticle.md#generated.RAParticle.GetSmoothness) - * [`RAParticle.GetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.GetSuperquadricDegree) - * [`RAParticle.GetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.GetSurfaceEnergy) - * [`RAParticle.GetT10Formula()`](RAParticle.md#generated.RAParticle.GetT10Formula) - * [`RAParticle.GetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.GetTargetNumberOfElements) - * [`RAParticle.GetTavaresA()`](RAParticle.md#generated.RAParticle.GetTavaresA) - * [`RAParticle.GetTavaresB()`](RAParticle.md#generated.RAParticle.GetTavaresB) - * [`RAParticle.GetTavaresD0()`](RAParticle.md#generated.RAParticle.GetTavaresD0) - * [`RAParticle.GetTavaresEInf()`](RAParticle.md#generated.RAParticle.GetTavaresEInf) - * [`RAParticle.GetTavaresGamma()`](RAParticle.md#generated.RAParticle.GetTavaresGamma) - * [`RAParticle.GetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.GetTavaresMinimumEnergy) - * [`RAParticle.GetTavaresPhi()`](RAParticle.md#generated.RAParticle.GetTavaresPhi) - * [`RAParticle.GetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.GetTavaresRatioEmax) - * [`RAParticle.GetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.GetTavaresSigmaSquared) - * [`RAParticle.GetTensileStressLimit()`](RAParticle.md#generated.RAParticle.GetTensileStressLimit) - * [`RAParticle.GetThickness()`](RAParticle.md#generated.RAParticle.GetThickness) - * [`RAParticle.GetTimeSet()`](RAParticle.md#generated.RAParticle.GetTimeSet) - * [`RAParticle.GetTimeStatistics()`](RAParticle.md#generated.RAParticle.GetTimeStatistics) - * [`RAParticle.GetTimeStep()`](RAParticle.md#generated.RAParticle.GetTimeStep) - * [`RAParticle.GetTopologyShape()`](RAParticle.md#generated.RAParticle.GetTopologyShape) - * [`RAParticle.GetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.GetTorsionAngleLimit) - * [`RAParticle.GetUseMultipleElements()`](RAParticle.md#generated.RAParticle.GetUseMultipleElements) - * [`RAParticle.GetValidBreakageModelValues()`](RAParticle.md#generated.RAParticle.GetValidBreakageModelValues) - * [`RAParticle.GetValidDeformationModelValues()`](RAParticle.md#generated.RAParticle.GetValidDeformationModelValues) - * [`RAParticle.GetValidDistributionModelValues()`](RAParticle.md#generated.RAParticle.GetValidDistributionModelValues) - * [`RAParticle.GetValidElasticityValues()`](RAParticle.md#generated.RAParticle.GetValidElasticityValues) - * [`RAParticle.GetValidOptionsForModuleProperty()`](RAParticle.md#generated.RAParticle.GetValidOptionsForModuleProperty) - * [`RAParticle.GetValidPlasticityModelValues()`](RAParticle.md#generated.RAParticle.GetValidPlasticityModelValues) - * [`RAParticle.GetValidShapeValues()`](RAParticle.md#generated.RAParticle.GetValidShapeValues) - * [`RAParticle.GetValidSizeTypeValues()`](RAParticle.md#generated.RAParticle.GetValidSizeTypeValues) - * [`RAParticle.GetValidT10FormulaValues()`](RAParticle.md#generated.RAParticle.GetValidT10FormulaValues) - * [`RAParticle.GetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.GetVerticalAspectRatio) - * [`RAParticle.GetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.GetVonMisesStressLimit) - * [`RAParticle.GetWithFailure()`](RAParticle.md#generated.RAParticle.GetWithFailure) - * [`RAParticle.GetXDirection()`](RAParticle.md#generated.RAParticle.GetXDirection) - * [`RAParticle.GetYDirection()`](RAParticle.md#generated.RAParticle.GetYDirection) - * [`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) - * [`RAParticle.IsConcave()`](RAParticle.md#generated.RAParticle.IsConcave) - * [`RAParticle.IsIncludeRotationalDeformationsEnabled()`](RAParticle.md#generated.RAParticle.IsIncludeRotationalDeformationsEnabled) - * [`RAParticle.IsRandomOrientationEnabled()`](RAParticle.md#generated.RAParticle.IsRandomOrientationEnabled) - * [`RAParticle.IterCellVertices()`](RAParticle.md#generated.RAParticle.IterCellVertices) - * [`RAParticle.IterCells()`](RAParticle.md#generated.RAParticle.IterCells) - * [`RAParticle.Modified()`](RAParticle.md#generated.RAParticle.Modified) - * [`RAParticle.RemoveCustomCurve()`](RAParticle.md#generated.RAParticle.RemoveCustomCurve) - * [`RAParticle.RemoveCustomProperty()`](RAParticle.md#generated.RAParticle.RemoveCustomProperty) - * [`RAParticle.RemoveOutputVariable()`](RAParticle.md#generated.RAParticle.RemoveOutputVariable) - * [`RAParticle.RemoveProcess()`](RAParticle.md#generated.RAParticle.RemoveProcess) - * [`RAParticle.SetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.SetAbt10MaximumT10Value) - * [`RAParticle.SetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10MinimumSpecificEnergy) - * [`RAParticle.SetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) - * [`RAParticle.SetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceSize) - * [`RAParticle.SetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.SetAbt10SelectFunctionCoefficient) - * [`RAParticle.SetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.SetAllowSelfContacts) - * [`RAParticle.SetAnisotropic()`](RAParticle.md#generated.RAParticle.SetAnisotropic) - * [`RAParticle.SetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.SetBendingAngleLimit) - * [`RAParticle.SetBreakageModel()`](RAParticle.md#generated.RAParticle.SetBreakageModel) - * [`RAParticle.SetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.SetCenterOfMassOffset) - * [`RAParticle.SetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.SetCgmScaleFactor) - * [`RAParticle.SetChangeMassProperties()`](RAParticle.md#generated.RAParticle.SetChangeMassProperties) - * [`RAParticle.SetCurrentTimeStep()`](RAParticle.md#generated.RAParticle.SetCurrentTimeStep) - * [`RAParticle.SetDeformationModel()`](RAParticle.md#generated.RAParticle.SetDeformationModel) - * [`RAParticle.SetDistributionModel()`](RAParticle.md#generated.RAParticle.SetDistributionModel) - * [`RAParticle.SetEdgeAngle()`](RAParticle.md#generated.RAParticle.SetEdgeAngle) - * [`RAParticle.SetElasticRatioBending()`](RAParticle.md#generated.RAParticle.SetElasticRatioBending) - * [`RAParticle.SetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.SetElasticRatioNormal) - * [`RAParticle.SetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.SetElasticRatioTangential) - * [`RAParticle.SetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.SetElasticRatioTorsion) - * [`RAParticle.SetElasticity()`](RAParticle.md#generated.RAParticle.SetElasticity) - * [`RAParticle.SetElementDampingRatio()`](RAParticle.md#generated.RAParticle.SetElementDampingRatio) - * [`RAParticle.SetEnableBreakage()`](RAParticle.md#generated.RAParticle.SetEnableBreakage) - * [`RAParticle.SetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.SetEnableRandomAngle) - * [`RAParticle.SetEnableRotations()`](RAParticle.md#generated.RAParticle.SetEnableRotations) - * [`RAParticle.SetFailureRatio()`](RAParticle.md#generated.RAParticle.SetFailureRatio) - * [`RAParticle.SetFlexible()`](RAParticle.md#generated.RAParticle.SetFlexible) - * [`RAParticle.SetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.SetHorizontalAspectRatio) - * [`RAParticle.SetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.SetIncludeRotationalDeformations) - * [`RAParticle.SetInternalFriction()`](RAParticle.md#generated.RAParticle.SetInternalFriction) - * [`RAParticle.SetJointDampingRatio()`](RAParticle.md#generated.RAParticle.SetJointDampingRatio) - * [`RAParticle.SetJointElasticRatio()`](RAParticle.md#generated.RAParticle.SetJointElasticRatio) - * [`RAParticle.SetJointThermalRatio()`](RAParticle.md#generated.RAParticle.SetJointThermalRatio) - * [`RAParticle.SetMaterial()`](RAParticle.md#generated.RAParticle.SetMaterial) - * [`RAParticle.SetMinimumSize()`](RAParticle.md#generated.RAParticle.SetMinimumSize) - * [`RAParticle.SetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.SetMinimumSizeRatio) - * [`RAParticle.SetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.SetMinimumVolumeFractionForFragmentDisabling) - * [`RAParticle.SetModuleProperty()`](RAParticle.md#generated.RAParticle.SetModuleProperty) - * [`RAParticle.SetNumberOfCorners()`](RAParticle.md#generated.RAParticle.SetNumberOfCorners) - * [`RAParticle.SetOrientation()`](RAParticle.md#generated.RAParticle.SetOrientation) - * [`RAParticle.SetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngleAndVector) - * [`RAParticle.SetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngles) - * [`RAParticle.SetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromBasisVector) - * [`RAParticle.SetPlasticLimit()`](RAParticle.md#generated.RAParticle.SetPlasticLimit) - * [`RAParticle.SetPlasticRatio()`](RAParticle.md#generated.RAParticle.SetPlasticRatio) - * [`RAParticle.SetPlasticityModel()`](RAParticle.md#generated.RAParticle.SetPlasticityModel) - * [`RAParticle.SetPorosity()`](RAParticle.md#generated.RAParticle.SetPorosity) - * [`RAParticle.SetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.SetPrincipalMomentOfInertia) - * [`RAParticle.SetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.SetRandomAnglesHalfRange) - * [`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) - * [`RAParticle.SetSideAngle()`](RAParticle.md#generated.RAParticle.SetSideAngle) - * [`RAParticle.SetSizeType()`](RAParticle.md#generated.RAParticle.SetSizeType) - * [`RAParticle.SetSmoothness()`](RAParticle.md#generated.RAParticle.SetSmoothness) - * [`RAParticle.SetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.SetSuperquadricDegree) - * [`RAParticle.SetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.SetSurfaceEnergy) - * [`RAParticle.SetT10Formula()`](RAParticle.md#generated.RAParticle.SetT10Formula) - * [`RAParticle.SetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.SetTargetNumberOfElements) - * [`RAParticle.SetTavaresA()`](RAParticle.md#generated.RAParticle.SetTavaresA) - * [`RAParticle.SetTavaresB()`](RAParticle.md#generated.RAParticle.SetTavaresB) - * [`RAParticle.SetTavaresD0()`](RAParticle.md#generated.RAParticle.SetTavaresD0) - * [`RAParticle.SetTavaresEInf()`](RAParticle.md#generated.RAParticle.SetTavaresEInf) - * [`RAParticle.SetTavaresGamma()`](RAParticle.md#generated.RAParticle.SetTavaresGamma) - * [`RAParticle.SetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.SetTavaresMinimumEnergy) - * [`RAParticle.SetTavaresPhi()`](RAParticle.md#generated.RAParticle.SetTavaresPhi) - * [`RAParticle.SetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.SetTavaresRatioEmax) - * [`RAParticle.SetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.SetTavaresSigmaSquared) - * [`RAParticle.SetTensileStressLimit()`](RAParticle.md#generated.RAParticle.SetTensileStressLimit) - * [`RAParticle.SetThickness()`](RAParticle.md#generated.RAParticle.SetThickness) - * [`RAParticle.SetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.SetTorsionAngleLimit) - * [`RAParticle.SetUseMultipleElements()`](RAParticle.md#generated.RAParticle.SetUseMultipleElements) - * [`RAParticle.SetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.SetVerticalAspectRatio) - * [`RAParticle.SetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.SetVonMisesStressLimit) - * [`RAParticle.SetWithFailure()`](RAParticle.md#generated.RAParticle.SetWithFailure) - * [`RAParticle.SetXDirection()`](RAParticle.md#generated.RAParticle.SetXDirection) - * [`RAParticle.SetYDirection()`](RAParticle.md#generated.RAParticle.SetYDirection) - * [`RAParticle.SetZDirection()`](RAParticle.md#generated.RAParticle.SetZDirection) - * [RAParticleAssemblyPart](RAParticleAssemblyPart.md) - * [`RAParticleAssemblyPart`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart) - * [`RAParticleAssemblyPart.GetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAngle) - * [`RAParticleAssemblyPart.GetAvailableParticles()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAvailableParticles) - * [`RAParticleAssemblyPart.GetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetParticle) - * [`RAParticleAssemblyPart.GetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionX) - * [`RAParticleAssemblyPart.GetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionY) - * [`RAParticleAssemblyPart.GetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionZ) - * [`RAParticleAssemblyPart.GetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationX) - * [`RAParticleAssemblyPart.GetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationY) - * [`RAParticleAssemblyPart.GetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationZ) - * [`RAParticleAssemblyPart.GetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetScale) - * [`RAParticleAssemblyPart.SetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetAngle) - * [`RAParticleAssemblyPart.SetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetParticle) - * [`RAParticleAssemblyPart.SetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionX) - * [`RAParticleAssemblyPart.SetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionY) - * [`RAParticleAssemblyPart.SetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionZ) - * [`RAParticleAssemblyPart.SetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationX) - * [`RAParticleAssemblyPart.SetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationY) - * [`RAParticleAssemblyPart.SetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationZ) - * [`RAParticleAssemblyPart.SetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetScale) - * [RAParticleAssemblyPartList](RAParticleAssemblyPartList.md) - * [`RAParticleAssemblyPartList`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList) - * [`RAParticleAssemblyPartList.Clear()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Clear) - * [`RAParticleAssemblyPartList.New()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.New) - * [`RAParticleAssemblyPartList.Remove()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Remove) - * [RAParticleCollection](RAParticleCollection.md) - * [`RAParticleCollection`](RAParticleCollection.md#generated.RAParticleCollection) - * [`RAParticleCollection.Clear()`](RAParticleCollection.md#generated.RAParticleCollection.Clear) - * [`RAParticleCollection.GetParticle()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticle) - * [`RAParticleCollection.GetParticleNames()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticleNames) - * [`RAParticleCollection.New()`](RAParticleCollection.md#generated.RAParticleCollection.New) - * [`RAParticleCollection.Remove()`](RAParticleCollection.md#generated.RAParticleCollection.Remove) - * [RAParticleInlet](RAParticleInlet.md) - * [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) - * [`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.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) - * [`RAParticleInlet.SetStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopAllAtStopTime) - * [`RAParticleInlet.SetStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopTime) - * [`RAParticleInlet.SetTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetTargetNormalVelocity) - * [`RAParticleInlet.SetUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetUseTargetNormalVelocity) - * [`RAParticleInlet.SetUxLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUxLocal) - * [`RAParticleInlet.SetUzLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUzLocal) - * [RAParticleInletProperties](RAParticleInletProperties.md) - * [`RAParticleInletProperties`](RAParticleInletProperties.md#generated.RAParticleInletProperties) - * [`RAParticleInletProperties.GetAvailableParticles()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetAvailableParticles) - * [`RAParticleInletProperties.GetMassFlowRate()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetMassFlowRate) - * [`RAParticleInletProperties.GetModuleProperties()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetModuleProperties) - * [`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) - * [`RAParticleInletPropertiesList.New()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.New) - * [`RAParticleInletPropertiesList.Remove()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.Remove) - * [RAParticleJointsData](RAParticleJointsData.md) - * [`RAParticleJointsData`](RAParticleJointsData.md#generated.RAParticleJointsData) - * [`RAParticleJointsData.AddCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCurve) - * [`RAParticleJointsData.AddCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomCurve) - * [`RAParticleJointsData.AddCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomProperty) - * [`RAParticleJointsData.AddGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddGridFunction) - * [`RAParticleJointsData.CreateCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateCurveOutputVariable) - * [`RAParticleJointsData.CreateGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunction) - * [`RAParticleJointsData.CreateGridFunctionArrayOnCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionArrayOnCells) - * [`RAParticleJointsData.CreateGridFunctionStatisticOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionStatisticOutputVariable) - * [`RAParticleJointsData.CreateTransientCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateTransientCurveOutputVariable) - * [`RAParticleJointsData.DisableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.DisableCollectJointData) - * [`RAParticleJointsData.EditCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomCurve) - * [`RAParticleJointsData.EditCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomProperty) - * [`RAParticleJointsData.EnableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.EnableCollectJointData) - * [`RAParticleJointsData.GetActivesArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetActivesArray) - * [`RAParticleJointsData.GetBoundingBox()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetBoundingBox) - * [`RAParticleJointsData.GetCellAreaAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellAreaAsArray) - * [`RAParticleJointsData.GetCellCenterAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellCenterAsArray) - * [`RAParticleJointsData.GetCellDzAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellDzAsArray) - * [`RAParticleJointsData.GetCellFromIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellFromIJK) - * [`RAParticleJointsData.GetCellIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellIJK) - * [`RAParticleJointsData.GetCellNumberOfVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellNumberOfVertices) - * [`RAParticleJointsData.GetCellPointsAsFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellPointsAsFunction) - * [`RAParticleJointsData.GetCellVolumeAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellVolumeAsArray) - * [`RAParticleJointsData.GetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCollectJointData) - * [`RAParticleJointsData.GetCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurve) - * [`RAParticleJointsData.GetCurveNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNames) - * [`RAParticleJointsData.GetCurveNamesAssociation()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNamesAssociation) - * [`RAParticleJointsData.GetElementCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetElementCurve) - * [`RAParticleJointsData.GetGeometryQuantity()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryQuantity) - * [`RAParticleJointsData.GetGeometryUnit()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryUnit) - * [`RAParticleJointsData.GetGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunction) - * [`RAParticleJointsData.GetGridFunctionNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunctionNames) - * [`RAParticleJointsData.GetMeshColoring()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetMeshColoring) - * [`RAParticleJointsData.GetNumberOfCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfCells) - * [`RAParticleJointsData.GetNumberOfNodes()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfNodes) - * [`RAParticleJointsData.GetNumpyCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumpyCurve) - * [`RAParticleJointsData.GetOutputVariableValue()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetOutputVariableValue) - * [`RAParticleJointsData.GetTimeSet()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeSet) - * [`RAParticleJointsData.GetTimeStatistics()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStatistics) - * [`RAParticleJointsData.GetTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStep) - * [`RAParticleJointsData.GetTopologyShape()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTopologyShape) - * [`RAParticleJointsData.HasGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.HasGridFunction) - * [`RAParticleJointsData.IsCellActive()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCellActive) - * [`RAParticleJointsData.IsCollectJointDataEnabled()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCollectJointDataEnabled) - * [`RAParticleJointsData.IterCellVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCellVertices) - * [`RAParticleJointsData.IterCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCells) - * [`RAParticleJointsData.Modified()`](RAParticleJointsData.md#generated.RAParticleJointsData.Modified) - * [`RAParticleJointsData.RemoveCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomCurve) - * [`RAParticleJointsData.RemoveCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomProperty) - * [`RAParticleJointsData.RemoveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveOutputVariable) - * [`RAParticleJointsData.RemoveProcess()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveProcess) - * [`RAParticleJointsData.SetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCollectJointData) - * [`RAParticleJointsData.SetCurrentTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCurrentTimeStep) - * [RAParticleTimeSelectionProcess](RAParticleTimeSelectionProcess.md) - * [`RAParticleTimeSelectionProcess`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess) - * [`RAParticleTimeSelectionProcess.AddCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCurve) - * [`RAParticleTimeSelectionProcess.AddCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomCurve) - * [`RAParticleTimeSelectionProcess.AddCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomProperty) - * [`RAParticleTimeSelectionProcess.AddGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddGridFunction) - * [`RAParticleTimeSelectionProcess.CreateCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateCurveOutputVariable) - * [`RAParticleTimeSelectionProcess.CreateGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunction) - * [`RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells) - * [`RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable) - * [`RAParticleTimeSelectionProcess.EditCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomCurve) - * [`RAParticleTimeSelectionProcess.EditCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomProperty) - * [`RAParticleTimeSelectionProcess.GetActivesArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetActivesArray) - * [`RAParticleTimeSelectionProcess.GetBoundingBox()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetBoundingBox) - * [`RAParticleTimeSelectionProcess.GetCellAreaAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellAreaAsArray) - * [`RAParticleTimeSelectionProcess.GetCellCenterAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellCenterAsArray) - * [`RAParticleTimeSelectionProcess.GetCellDzAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellDzAsArray) - * [`RAParticleTimeSelectionProcess.GetCellFromIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellFromIJK) - * [`RAParticleTimeSelectionProcess.GetCellIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellIJK) - * [`RAParticleTimeSelectionProcess.GetCellNumberOfVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellNumberOfVertices) - * [`RAParticleTimeSelectionProcess.GetCellPointsAsFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellPointsAsFunction) - * [`RAParticleTimeSelectionProcess.GetCellVolumeAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellVolumeAsArray) - * [`RAParticleTimeSelectionProcess.GetCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurve) - * [`RAParticleTimeSelectionProcess.GetCurveNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNames) - * [`RAParticleTimeSelectionProcess.GetCurveNamesAssociation()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation) - * [`RAParticleTimeSelectionProcess.GetElementCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetElementCurve) - * [`RAParticleTimeSelectionProcess.GetGeometryQuantity()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity) - * [`RAParticleTimeSelectionProcess.GetGeometryUnit()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryUnit) - * [`RAParticleTimeSelectionProcess.GetGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunction) - * [`RAParticleTimeSelectionProcess.GetGridFunctionNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames) - * [`RAParticleTimeSelectionProcess.GetMeshColoring()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetMeshColoring) - * [`RAParticleTimeSelectionProcess.GetNumberOfCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfCells) - * [`RAParticleTimeSelectionProcess.GetNumberOfNodes()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfNodes) - * [`RAParticleTimeSelectionProcess.GetNumberOfParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfParticles) - * [`RAParticleTimeSelectionProcess.GetNumpyCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumpyCurve) - * [`RAParticleTimeSelectionProcess.GetOutputVariableValue()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetOutputVariableValue) - * [`RAParticleTimeSelectionProcess.GetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeRange) - * [`RAParticleTimeSelectionProcess.GetTimeSet()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeSet) - * [`RAParticleTimeSelectionProcess.GetTimeStatistics()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStatistics) - * [`RAParticleTimeSelectionProcess.GetTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStep) - * [`RAParticleTimeSelectionProcess.GetTopologyShape()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTopologyShape) - * [`RAParticleTimeSelectionProcess.HasGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.HasGridFunction) - * [`RAParticleTimeSelectionProcess.IsCellActive()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IsCellActive) - * [`RAParticleTimeSelectionProcess.IterCellVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCellVertices) - * [`RAParticleTimeSelectionProcess.IterCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCells) - * [`RAParticleTimeSelectionProcess.IterParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterParticles) - * [`RAParticleTimeSelectionProcess.Modified()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.Modified) - * [`RAParticleTimeSelectionProcess.RemoveCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomCurve) - * [`RAParticleTimeSelectionProcess.RemoveCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomProperty) - * [`RAParticleTimeSelectionProcess.RemoveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveOutputVariable) - * [`RAParticleTimeSelectionProcess.RemoveProcess()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveProcess) - * [`RAParticleTimeSelectionProcess.SetAbsoluteTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetAbsoluteTimeRange) - * [`RAParticleTimeSelectionProcess.SetCurrentTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetCurrentTimeStep) - * [`RAParticleTimeSelectionProcess.SetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetTimeRange) - * [RAParticleToContactProcess](RAParticleToContactProcess.md) - * [`RAParticleToContactProcess`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess) - * [`RAParticleToContactProcess.AddCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCurve) - * [`RAParticleToContactProcess.AddCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomCurve) - * [`RAParticleToContactProcess.AddCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomProperty) - * [`RAParticleToContactProcess.AddGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddGridFunction) - * [`RAParticleToContactProcess.CreateCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateCurveOutputVariable) - * [`RAParticleToContactProcess.CreateGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunction) - * [`RAParticleToContactProcess.CreateGridFunctionArrayOnCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionArrayOnCells) - * [`RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAParticleToContactProcess.CreateTransientCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateTransientCurveOutputVariable) - * [`RAParticleToContactProcess.EditCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomCurve) - * [`RAParticleToContactProcess.EditCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomProperty) - * [`RAParticleToContactProcess.GetActivesArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetActivesArray) - * [`RAParticleToContactProcess.GetBoundingBox()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetBoundingBox) - * [`RAParticleToContactProcess.GetCellAreaAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellAreaAsArray) - * [`RAParticleToContactProcess.GetCellCenterAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellCenterAsArray) - * [`RAParticleToContactProcess.GetCellDzAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellDzAsArray) - * [`RAParticleToContactProcess.GetCellFromIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellFromIJK) - * [`RAParticleToContactProcess.GetCellIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellIJK) - * [`RAParticleToContactProcess.GetCellNumberOfVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellNumberOfVertices) - * [`RAParticleToContactProcess.GetCellPointsAsFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellPointsAsFunction) - * [`RAParticleToContactProcess.GetCellVolumeAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellVolumeAsArray) - * [`RAParticleToContactProcess.GetCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurve) - * [`RAParticleToContactProcess.GetCurveNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNames) - * [`RAParticleToContactProcess.GetCurveNamesAssociation()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNamesAssociation) - * [`RAParticleToContactProcess.GetElementCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetElementCurve) - * [`RAParticleToContactProcess.GetGeometryQuantity()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryQuantity) - * [`RAParticleToContactProcess.GetGeometryUnit()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryUnit) - * [`RAParticleToContactProcess.GetGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunction) - * [`RAParticleToContactProcess.GetGridFunctionNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunctionNames) - * [`RAParticleToContactProcess.GetMeshColoring()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetMeshColoring) - * [`RAParticleToContactProcess.GetNumberOfCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfCells) - * [`RAParticleToContactProcess.GetNumberOfNodes()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfNodes) - * [`RAParticleToContactProcess.GetNumberOfParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfParticles) - * [`RAParticleToContactProcess.GetNumpyCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumpyCurve) - * [`RAParticleToContactProcess.GetOutputVariableValue()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetOutputVariableValue) - * [`RAParticleToContactProcess.GetTimeSet()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeSet) - * [`RAParticleToContactProcess.GetTimeStatistics()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStatistics) - * [`RAParticleToContactProcess.GetTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStep) - * [`RAParticleToContactProcess.GetTopologyShape()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTopologyShape) - * [`RAParticleToContactProcess.HasGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.HasGridFunction) - * [`RAParticleToContactProcess.IsCellActive()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IsCellActive) - * [`RAParticleToContactProcess.IterCellVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCellVertices) - * [`RAParticleToContactProcess.IterCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCells) - * [`RAParticleToContactProcess.IterParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterParticles) - * [`RAParticleToContactProcess.Modified()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.Modified) - * [`RAParticleToContactProcess.RemoveCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomCurve) - * [`RAParticleToContactProcess.RemoveCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomProperty) - * [`RAParticleToContactProcess.RemoveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveOutputVariable) - * [`RAParticleToContactProcess.RemoveProcess()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveProcess) - * [`RAParticleToContactProcess.SetCurrentTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.SetCurrentTimeStep) - * [RAParticles](RAParticles.md) - * [`RAParticles`](RAParticles.md#generated.RAParticles) - * [`RAParticles.AddCurve()`](RAParticles.md#generated.RAParticles.AddCurve) - * [`RAParticles.AddCustomCurve()`](RAParticles.md#generated.RAParticles.AddCustomCurve) - * [`RAParticles.AddCustomProperty()`](RAParticles.md#generated.RAParticles.AddCustomProperty) - * [`RAParticles.AddGridFunction()`](RAParticles.md#generated.RAParticles.AddGridFunction) - * [`RAParticles.CreateCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateCurveOutputVariable) - * [`RAParticles.CreateGridFunction()`](RAParticles.md#generated.RAParticles.CreateGridFunction) - * [`RAParticles.CreateGridFunctionArrayOnCells()`](RAParticles.md#generated.RAParticles.CreateGridFunctionArrayOnCells) - * [`RAParticles.CreateGridFunctionStatisticOutputVariable()`](RAParticles.md#generated.RAParticles.CreateGridFunctionStatisticOutputVariable) - * [`RAParticles.CreateTransientCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateTransientCurveOutputVariable) - * [`RAParticles.EditCustomCurve()`](RAParticles.md#generated.RAParticles.EditCustomCurve) - * [`RAParticles.EditCustomProperty()`](RAParticles.md#generated.RAParticles.EditCustomProperty) - * [`RAParticles.GetActivesArray()`](RAParticles.md#generated.RAParticles.GetActivesArray) - * [`RAParticles.GetBoundingBox()`](RAParticles.md#generated.RAParticles.GetBoundingBox) - * [`RAParticles.GetCellAreaAsArray()`](RAParticles.md#generated.RAParticles.GetCellAreaAsArray) - * [`RAParticles.GetCellCenterAsArray()`](RAParticles.md#generated.RAParticles.GetCellCenterAsArray) - * [`RAParticles.GetCellDzAsArray()`](RAParticles.md#generated.RAParticles.GetCellDzAsArray) - * [`RAParticles.GetCellFromIJK()`](RAParticles.md#generated.RAParticles.GetCellFromIJK) - * [`RAParticles.GetCellIJK()`](RAParticles.md#generated.RAParticles.GetCellIJK) - * [`RAParticles.GetCellNumberOfVertices()`](RAParticles.md#generated.RAParticles.GetCellNumberOfVertices) - * [`RAParticles.GetCellPointsAsFunction()`](RAParticles.md#generated.RAParticles.GetCellPointsAsFunction) - * [`RAParticles.GetCellVolumeAsArray()`](RAParticles.md#generated.RAParticles.GetCellVolumeAsArray) - * [`RAParticles.GetCurve()`](RAParticles.md#generated.RAParticles.GetCurve) - * [`RAParticles.GetCurveNames()`](RAParticles.md#generated.RAParticles.GetCurveNames) - * [`RAParticles.GetCurveNamesAssociation()`](RAParticles.md#generated.RAParticles.GetCurveNamesAssociation) - * [`RAParticles.GetElementCurve()`](RAParticles.md#generated.RAParticles.GetElementCurve) - * [`RAParticles.GetGeometryQuantity()`](RAParticles.md#generated.RAParticles.GetGeometryQuantity) - * [`RAParticles.GetGeometryUnit()`](RAParticles.md#generated.RAParticles.GetGeometryUnit) - * [`RAParticles.GetGridFunction()`](RAParticles.md#generated.RAParticles.GetGridFunction) - * [`RAParticles.GetGridFunctionNames()`](RAParticles.md#generated.RAParticles.GetGridFunctionNames) - * [`RAParticles.GetMeshColoring()`](RAParticles.md#generated.RAParticles.GetMeshColoring) - * [`RAParticles.GetNumberOfCells()`](RAParticles.md#generated.RAParticles.GetNumberOfCells) - * [`RAParticles.GetNumberOfNodes()`](RAParticles.md#generated.RAParticles.GetNumberOfNodes) - * [`RAParticles.GetNumberOfParticles()`](RAParticles.md#generated.RAParticles.GetNumberOfParticles) - * [`RAParticles.GetNumpyCurve()`](RAParticles.md#generated.RAParticles.GetNumpyCurve) - * [`RAParticles.GetOutputVariableValue()`](RAParticles.md#generated.RAParticles.GetOutputVariableValue) - * [`RAParticles.GetTimeSet()`](RAParticles.md#generated.RAParticles.GetTimeSet) - * [`RAParticles.GetTimeStatistics()`](RAParticles.md#generated.RAParticles.GetTimeStatistics) - * [`RAParticles.GetTimeStep()`](RAParticles.md#generated.RAParticles.GetTimeStep) - * [`RAParticles.GetTopologyShape()`](RAParticles.md#generated.RAParticles.GetTopologyShape) - * [`RAParticles.HasGridFunction()`](RAParticles.md#generated.RAParticles.HasGridFunction) - * [`RAParticles.IsCellActive()`](RAParticles.md#generated.RAParticles.IsCellActive) - * [`RAParticles.IterCellVertices()`](RAParticles.md#generated.RAParticles.IterCellVertices) - * [`RAParticles.IterCells()`](RAParticles.md#generated.RAParticles.IterCells) - * [`RAParticles.IterParticles()`](RAParticles.md#generated.RAParticles.IterParticles) - * [`RAParticles.Modified()`](RAParticles.md#generated.RAParticles.Modified) - * [`RAParticles.RemoveCustomCurve()`](RAParticles.md#generated.RAParticles.RemoveCustomCurve) - * [`RAParticles.RemoveCustomProperty()`](RAParticles.md#generated.RAParticles.RemoveCustomProperty) - * [`RAParticles.RemoveOutputVariable()`](RAParticles.md#generated.RAParticles.RemoveOutputVariable) - * [`RAParticles.RemoveProcess()`](RAParticles.md#generated.RAParticles.RemoveProcess) - * [`RAParticles.SetCurrentTimeStep()`](RAParticles.md#generated.RAParticles.SetCurrentTimeStep) - * [RAPendulum](RAPendulum.md) - * [`RAPendulum`](RAPendulum.md#generated.RAPendulum) - * [`RAPendulum.GetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.GetAmplitudeVariation) - * [`RAPendulum.GetDirection()`](RAPendulum.md#generated.RAPendulum.GetDirection) - * [`RAPendulum.GetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.GetFrequencyVariation) - * [`RAPendulum.GetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.GetInitialAmplitude) - * [`RAPendulum.GetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.GetInitialFrequency) - * [`RAPendulum.GetInitialPhase()`](RAPendulum.md#generated.RAPendulum.GetInitialPhase) - * [`RAPendulum.SetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.SetAmplitudeVariation) - * [`RAPendulum.SetDirection()`](RAPendulum.md#generated.RAPendulum.SetDirection) - * [`RAPendulum.SetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.SetFrequencyVariation) - * [`RAPendulum.SetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.SetInitialAmplitude) - * [`RAPendulum.SetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.SetInitialFrequency) - * [`RAPendulum.SetInitialPhase()`](RAPendulum.md#generated.RAPendulum.SetInitialPhase) - * [RAPhysics](RAPhysics.md) - * [`RAPhysics`](RAPhysics.md#generated.RAPhysics) - * [`RAPhysics.GetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.GetAdhesionModel) - * [`RAPhysics.GetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.GetClosePackingVolumeFraction) - * [`RAPhysics.GetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.GetEnableCoarseGrainModeling) - * [`RAPhysics.GetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.GetEnableThermalModel) - * [`RAPhysics.GetExponentLimit()`](RAPhysics.md#generated.RAPhysics.GetExponentLimit) - * [`RAPhysics.GetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStartTime) - * [`RAPhysics.GetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStopTime) - * [`RAPhysics.GetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityXDirection) - * [`RAPhysics.GetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityYDirection) - * [`RAPhysics.GetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityZDirection) - * [`RAPhysics.GetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.GetImpactEnergyModel) - * [`RAPhysics.GetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.GetNormalForceModel) - * [`RAPhysics.GetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.GetNumericalSofteningFactor) - * [`RAPhysics.GetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.GetRestitutionModel) - * [`RAPhysics.GetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.GetRollingResistanceModel) - * [`RAPhysics.GetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetSearchDistanceMultiplier) - * [`RAPhysics.GetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.GetSphThermalTransferModel) - * [`RAPhysics.GetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.GetTangentialForceModel) - * [`RAPhysics.GetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.GetThermalCorrectionModel) - * [`RAPhysics.GetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetUpdateDistanceMultiplier) - * [`RAPhysics.GetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.GetUseRadlEtAl) - * [`RAPhysics.GetValidAdhesionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidAdhesionModelValues) - * [`RAPhysics.GetValidImpactEnergyModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidImpactEnergyModelValues) - * [`RAPhysics.GetValidNormalForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidNormalForceModelValues) - * [`RAPhysics.GetValidRestitutionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRestitutionModelValues) - * [`RAPhysics.GetValidRollingResistanceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRollingResistanceModelValues) - * [`RAPhysics.GetValidSphThermalTransferModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidSphThermalTransferModelValues) - * [`RAPhysics.GetValidTangentialForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidTangentialForceModelValues) - * [`RAPhysics.GetValidThermalCorrectionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidThermalCorrectionModelValues) - * [`RAPhysics.GetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.GetVolumeFractionLimit) - * [`RAPhysics.SetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.SetAdhesionModel) - * [`RAPhysics.SetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.SetClosePackingVolumeFraction) - * [`RAPhysics.SetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.SetEnableCoarseGrainModeling) - * [`RAPhysics.SetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.SetEnableThermalModel) - * [`RAPhysics.SetExponentLimit()`](RAPhysics.md#generated.RAPhysics.SetExponentLimit) - * [`RAPhysics.SetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStartTime) - * [`RAPhysics.SetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStopTime) - * [`RAPhysics.SetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityXDirection) - * [`RAPhysics.SetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityYDirection) - * [`RAPhysics.SetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityZDirection) - * [`RAPhysics.SetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.SetImpactEnergyModel) - * [`RAPhysics.SetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.SetNormalForceModel) - * [`RAPhysics.SetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.SetNumericalSofteningFactor) - * [`RAPhysics.SetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.SetRestitutionModel) - * [`RAPhysics.SetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.SetRollingResistanceModel) - * [`RAPhysics.SetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetSearchDistanceMultiplier) - * [`RAPhysics.SetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.SetSphThermalTransferModel) - * [`RAPhysics.SetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.SetTangentialForceModel) - * [`RAPhysics.SetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.SetThermalCorrectionModel) - * [`RAPhysics.SetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetUpdateDistanceMultiplier) - * [`RAPhysics.SetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.SetUseRadlEtAl) - * [`RAPhysics.SetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.SetVolumeFractionLimit) - * [RAPlaneProcess](RAPlaneProcess.md) - * [`RAPlaneProcess`](RAPlaneProcess.md#generated.RAPlaneProcess) - * [`RAPlaneProcess.AddCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCurve) - * [`RAPlaneProcess.AddCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomCurve) - * [`RAPlaneProcess.AddCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomProperty) - * [`RAPlaneProcess.AddGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddGridFunction) - * [`RAPlaneProcess.CreateCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateCurveOutputVariable) - * [`RAPlaneProcess.CreateGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunction) - * [`RAPlaneProcess.CreateGridFunctionArrayOnCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionArrayOnCells) - * [`RAPlaneProcess.CreateGridFunctionStatisticOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAPlaneProcess.CreateTransientCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateTransientCurveOutputVariable) - * [`RAPlaneProcess.EditCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomCurve) - * [`RAPlaneProcess.EditCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomProperty) - * [`RAPlaneProcess.GetActivesArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetActivesArray) - * [`RAPlaneProcess.GetBoundingBox()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetBoundingBox) - * [`RAPlaneProcess.GetCellAreaAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellAreaAsArray) - * [`RAPlaneProcess.GetCellCenterAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellCenterAsArray) - * [`RAPlaneProcess.GetCellDzAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellDzAsArray) - * [`RAPlaneProcess.GetCellFromIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellFromIJK) - * [`RAPlaneProcess.GetCellIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellIJK) - * [`RAPlaneProcess.GetCellNumberOfVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellNumberOfVertices) - * [`RAPlaneProcess.GetCellPointsAsFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellPointsAsFunction) - * [`RAPlaneProcess.GetCellVolumeAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellVolumeAsArray) - * [`RAPlaneProcess.GetCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurve) - * [`RAPlaneProcess.GetCurveNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNames) - * [`RAPlaneProcess.GetCurveNamesAssociation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNamesAssociation) - * [`RAPlaneProcess.GetElementCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetElementCurve) - * [`RAPlaneProcess.GetGeometryQuantity()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryQuantity) - * [`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) - * [`RAPlaneProcess.GetNumpyCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumpyCurve) - * [`RAPlaneProcess.GetOrientation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientation) - * [`RAPlaneProcess.GetOrientationFromAngleAndVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngleAndVector) - * [`RAPlaneProcess.GetOrientationFromAngles()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngles) - * [`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.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.HasGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.HasGridFunction) - * [`RAPlaneProcess.IsCellActive()`](RAPlaneProcess.md#generated.RAPlaneProcess.IsCellActive) - * [`RAPlaneProcess.IterCellVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCellVertices) - * [`RAPlaneProcess.IterCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCells) - * [`RAPlaneProcess.IterParticles()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterParticles) - * [`RAPlaneProcess.Modified()`](RAPlaneProcess.md#generated.RAPlaneProcess.Modified) - * [`RAPlaneProcess.RemoveCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomCurve) - * [`RAPlaneProcess.RemoveCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomProperty) - * [`RAPlaneProcess.RemoveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveOutputVariable) - * [`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.SetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetType) - * [RAPointCloud](RAPointCloud.md) - * [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud) - * [`RAPointCloud.AddCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCurve) - * [`RAPointCloud.AddCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCustomCurve) - * [`RAPointCloud.AddCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.AddCustomProperty) - * [`RAPointCloud.AddGridFunction()`](RAPointCloud.md#generated.RAPointCloud.AddGridFunction) - * [`RAPointCloud.CreateCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateCurveOutputVariable) - * [`RAPointCloud.CreateGridFunction()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunction) - * [`RAPointCloud.CreateGridFunctionArrayOnCells()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionArrayOnCells) - * [`RAPointCloud.CreateGridFunctionStatisticOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionStatisticOutputVariable) - * [`RAPointCloud.CreateTransientCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateTransientCurveOutputVariable) - * [`RAPointCloud.DisablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.DisablePeriodic) - * [`RAPointCloud.EditCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.EditCustomCurve) - * [`RAPointCloud.EditCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.EditCustomProperty) - * [`RAPointCloud.EnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.EnablePeriodic) - * [`RAPointCloud.GetActivesArray()`](RAPointCloud.md#generated.RAPointCloud.GetActivesArray) - * [`RAPointCloud.GetBoundingBox()`](RAPointCloud.md#generated.RAPointCloud.GetBoundingBox) - * [`RAPointCloud.GetCellAreaAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellAreaAsArray) - * [`RAPointCloud.GetCellCenterAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellCenterAsArray) - * [`RAPointCloud.GetCellDzAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellDzAsArray) - * [`RAPointCloud.GetCellFromIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellFromIJK) - * [`RAPointCloud.GetCellIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellIJK) - * [`RAPointCloud.GetCellNumberOfVertices()`](RAPointCloud.md#generated.RAPointCloud.GetCellNumberOfVertices) - * [`RAPointCloud.GetCellPointsAsFunction()`](RAPointCloud.md#generated.RAPointCloud.GetCellPointsAsFunction) - * [`RAPointCloud.GetCellVolumeAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellVolumeAsArray) - * [`RAPointCloud.GetCurve()`](RAPointCloud.md#generated.RAPointCloud.GetCurve) - * [`RAPointCloud.GetCurveNames()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNames) - * [`RAPointCloud.GetCurveNamesAssociation()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNamesAssociation) - * [`RAPointCloud.GetElementCurve()`](RAPointCloud.md#generated.RAPointCloud.GetElementCurve) - * [`RAPointCloud.GetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.GetEnablePeriodic) - * [`RAPointCloud.GetFilePath()`](RAPointCloud.md#generated.RAPointCloud.GetFilePath) - * [`RAPointCloud.GetGeometryQuantity()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryQuantity) - * [`RAPointCloud.GetGeometryUnit()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryUnit) - * [`RAPointCloud.GetGridFunction()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunction) - * [`RAPointCloud.GetGridFunctionNames()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunctionNames) - * [`RAPointCloud.GetMeshColoring()`](RAPointCloud.md#generated.RAPointCloud.GetMeshColoring) - * [`RAPointCloud.GetModuleProperties()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperties) - * [`RAPointCloud.GetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperty) - * [`RAPointCloud.GetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.GetMotionFrame) - * [`RAPointCloud.GetNumberOfCells()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfCells) - * [`RAPointCloud.GetNumberOfNodes()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfNodes) - * [`RAPointCloud.GetNumpyCurve()`](RAPointCloud.md#generated.RAPointCloud.GetNumpyCurve) - * [`RAPointCloud.GetOutputVariableValue()`](RAPointCloud.md#generated.RAPointCloud.GetOutputVariableValue) - * [`RAPointCloud.GetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStartTime) - * [`RAPointCloud.GetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStopTime) - * [`RAPointCloud.GetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOff) - * [`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.HasGridFunction()`](RAPointCloud.md#generated.RAPointCloud.HasGridFunction) - * [`RAPointCloud.IsCellActive()`](RAPointCloud.md#generated.RAPointCloud.IsCellActive) - * [`RAPointCloud.IsPeriodicEnabled()`](RAPointCloud.md#generated.RAPointCloud.IsPeriodicEnabled) - * [`RAPointCloud.IsTransient()`](RAPointCloud.md#generated.RAPointCloud.IsTransient) - * [`RAPointCloud.IterCellVertices()`](RAPointCloud.md#generated.RAPointCloud.IterCellVertices) - * [`RAPointCloud.IterCells()`](RAPointCloud.md#generated.RAPointCloud.IterCells) - * [`RAPointCloud.Modified()`](RAPointCloud.md#generated.RAPointCloud.Modified) - * [`RAPointCloud.RemoveCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomCurve) - * [`RAPointCloud.RemoveCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomProperty) - * [`RAPointCloud.RemoveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.RemoveOutputVariable) - * [`RAPointCloud.RemoveProcess()`](RAPointCloud.md#generated.RAPointCloud.RemoveProcess) - * [`RAPointCloud.SetCurrentTimeStep()`](RAPointCloud.md#generated.RAPointCloud.SetCurrentTimeStep) - * [`RAPointCloud.SetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.SetEnablePeriodic) - * [`RAPointCloud.SetFilePath()`](RAPointCloud.md#generated.RAPointCloud.SetFilePath) - * [`RAPointCloud.SetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.SetModuleProperty) - * [`RAPointCloud.SetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.SetMotionFrame) - * [`RAPointCloud.SetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStartTime) - * [`RAPointCloud.SetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStopTime) - * [`RAPointCloud.SetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOff) - * [RAPointCloudCollection](RAPointCloudCollection.md) - * [`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) - * [`RAPointCloudCollection.Clear()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Clear) - * [`RAPointCloudCollection.New()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.New) - * [`RAPointCloudCollection.Remove()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Remove) - * [RAPolyhedronProcess](RAPolyhedronProcess.md) - * [`RAPolyhedronProcess`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess) - * [`RAPolyhedronProcess.AddCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCurve) - * [`RAPolyhedronProcess.AddCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomCurve) - * [`RAPolyhedronProcess.AddCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomProperty) - * [`RAPolyhedronProcess.AddGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddGridFunction) - * [`RAPolyhedronProcess.CreateCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateCurveOutputVariable) - * [`RAPolyhedronProcess.CreateGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunction) - * [`RAPolyhedronProcess.CreateGridFunctionArrayOnCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionArrayOnCells) - * [`RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAPolyhedronProcess.CreateTransientCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateTransientCurveOutputVariable) - * [`RAPolyhedronProcess.EditCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomCurve) - * [`RAPolyhedronProcess.EditCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomProperty) - * [`RAPolyhedronProcess.GetActivesArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetActivesArray) - * [`RAPolyhedronProcess.GetBoundingBox()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetBoundingBox) - * [`RAPolyhedronProcess.GetCellAreaAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellAreaAsArray) - * [`RAPolyhedronProcess.GetCellCenterAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellCenterAsArray) - * [`RAPolyhedronProcess.GetCellDzAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellDzAsArray) - * [`RAPolyhedronProcess.GetCellFromIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellFromIJK) - * [`RAPolyhedronProcess.GetCellIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellIJK) - * [`RAPolyhedronProcess.GetCellNumberOfVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellNumberOfVertices) - * [`RAPolyhedronProcess.GetCellPointsAsFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellPointsAsFunction) - * [`RAPolyhedronProcess.GetCellVolumeAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellVolumeAsArray) - * [`RAPolyhedronProcess.GetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenter) - * [`RAPolyhedronProcess.GetCenterAfterMovement()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenterAfterMovement) - * [`RAPolyhedronProcess.GetCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurve) - * [`RAPolyhedronProcess.GetCurveNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNames) - * [`RAPolyhedronProcess.GetCurveNamesAssociation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNamesAssociation) - * [`RAPolyhedronProcess.GetElementCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetElementCurve) - * [`RAPolyhedronProcess.GetGeometryQuantity()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryQuantity) - * [`RAPolyhedronProcess.GetGeometryUnit()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryUnit) - * [`RAPolyhedronProcess.GetGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunction) - * [`RAPolyhedronProcess.GetGridFunctionNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunctionNames) - * [`RAPolyhedronProcess.GetMeshColoring()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMeshColoring) - * [`RAPolyhedronProcess.GetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMotionFrame) - * [`RAPolyhedronProcess.GetNumberOfCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfCells) - * [`RAPolyhedronProcess.GetNumberOfNodes()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfNodes) - * [`RAPolyhedronProcess.GetNumberOfParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfParticles) - * [`RAPolyhedronProcess.GetNumpyCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumpyCurve) - * [`RAPolyhedronProcess.GetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientation) - * [`RAPolyhedronProcess.GetOrientationFromAngleAndVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromAngleAndVector) - * [`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.HasGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.HasGridFunction) - * [`RAPolyhedronProcess.IsCellActive()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IsCellActive) - * [`RAPolyhedronProcess.IterCellVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCellVertices) - * [`RAPolyhedronProcess.IterCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCells) - * [`RAPolyhedronProcess.IterParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterParticles) - * [`RAPolyhedronProcess.Modified()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.Modified) - * [`RAPolyhedronProcess.RemoveCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomCurve) - * [`RAPolyhedronProcess.RemoveCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomProperty) - * [`RAPolyhedronProcess.RemoveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveOutputVariable) - * [`RAPolyhedronProcess.RemoveProcess()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveProcess) - * [`RAPolyhedronProcess.SetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCenter) - * [`RAPolyhedronProcess.SetCurrentTimeStep()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCurrentTimeStep) - * [`RAPolyhedronProcess.SetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetMotionFrame) - * [`RAPolyhedronProcess.SetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientation) - * [`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) - * [`RAPrescribedForce.SetForceValue()`](RAPrescribedForce.md#generated.RAPrescribedForce.SetForceValue) - * [RAPrescribedMoment](RAPrescribedMoment.md) - * [`RAPrescribedMoment`](RAPrescribedMoment.md#generated.RAPrescribedMoment) - * [`RAPrescribedMoment.GetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.GetMomentValue) - * [`RAPrescribedMoment.SetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.SetMomentValue) - * [RAProject](RAProject.md) - * [`RAProject`](RAProject.md#generated.RAProject) - * [`RAProject.CloseProject()`](RAProject.md#generated.RAProject.CloseProject) - * [`RAProject.CreateStudy()`](RAProject.md#generated.RAProject.CreateStudy) - * [`RAProject.GetInputVariables()`](RAProject.md#generated.RAProject.GetInputVariables) - * [`RAProject.GetModelElement()`](RAProject.md#generated.RAProject.GetModelElement) - * [`RAProject.GetModelStudy()`](RAProject.md#generated.RAProject.GetModelStudy) - * [`RAProject.GetParametricVariables()`](RAProject.md#generated.RAProject.GetParametricVariables) - * [`RAProject.GetProjectFilename()`](RAProject.md#generated.RAProject.GetProjectFilename) - * [`RAProject.GetStudy()`](RAProject.md#generated.RAProject.GetStudy) - * [`RAProject.GetTimeFilter()`](RAProject.md#generated.RAProject.GetTimeFilter) - * [`RAProject.GetUserProcessCollection()`](RAProject.md#generated.RAProject.GetUserProcessCollection) - * [`RAProject.RemoveProcess()`](RAProject.md#generated.RAProject.RemoveProcess) - * [`RAProject.SaveProject()`](RAProject.md#generated.RAProject.SaveProject) - * [`RAProject.SaveProjectForRestart()`](RAProject.md#generated.RAProject.SaveProjectForRestart) - * [RAReceivingConveyor](RAReceivingConveyor.md) - * [`RAReceivingConveyor`](RAReceivingConveyor.md#generated.RAReceivingConveyor) - * [`RAReceivingConveyor.AddCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCurve) - * [`RAReceivingConveyor.AddCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomCurve) - * [`RAReceivingConveyor.AddCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomProperty) - * [`RAReceivingConveyor.AddGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddGridFunction) - * [`RAReceivingConveyor.CreateCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateCurveOutputVariable) - * [`RAReceivingConveyor.CreateGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunction) - * [`RAReceivingConveyor.CreateGridFunctionArrayOnCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionArrayOnCells) - * [`RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable) - * [`RAReceivingConveyor.CreateTransientCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateTransientCurveOutputVariable) - * [`RAReceivingConveyor.EditCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomCurve) - * [`RAReceivingConveyor.EditCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomProperty) - * [`RAReceivingConveyor.GetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAccelerationPeriod) - * [`RAReceivingConveyor.GetActivesArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetActivesArray) - * [`RAReceivingConveyor.GetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAlignmentAngle) - * [`RAReceivingConveyor.GetAvailableMaterials()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAvailableMaterials) - * [`RAReceivingConveyor.GetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStartTime) - * [`RAReceivingConveyor.GetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStopTime) - * [`RAReceivingConveyor.GetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltInclineAngle) - * [`RAReceivingConveyor.GetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfile) - * [`RAReceivingConveyor.GetBeltProfileName()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfileName) - * [`RAReceivingConveyor.GetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltSpeed) - * [`RAReceivingConveyor.GetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltThickness) - * [`RAReceivingConveyor.GetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltWidth) - * [`RAReceivingConveyor.GetBoundingBox()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBoundingBox) - * [`RAReceivingConveyor.GetCellAreaAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellAreaAsArray) - * [`RAReceivingConveyor.GetCellCenterAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellCenterAsArray) - * [`RAReceivingConveyor.GetCellDzAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellDzAsArray) - * [`RAReceivingConveyor.GetCellFromIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellFromIJK) - * [`RAReceivingConveyor.GetCellIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellIJK) - * [`RAReceivingConveyor.GetCellNumberOfVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellNumberOfVertices) - * [`RAReceivingConveyor.GetCellPointsAsFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellPointsAsFunction) - * [`RAReceivingConveyor.GetCellVolumeAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellVolumeAsArray) - * [`RAReceivingConveyor.GetCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurve) - * [`RAReceivingConveyor.GetCurveNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNames) - * [`RAReceivingConveyor.GetCurveNamesAssociation()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNamesAssociation) - * [`RAReceivingConveyor.GetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetDecelerationPeriod) - * [`RAReceivingConveyor.GetElementCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetElementCurve) - * [`RAReceivingConveyor.GetGeometryQuantity()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryQuantity) - * [`RAReceivingConveyor.GetGeometryUnit()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryUnit) - * [`RAReceivingConveyor.GetGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunction) - * [`RAReceivingConveyor.GetGridFunctionNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunctionNames) - * [`RAReceivingConveyor.GetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHeightOffset) - * [`RAReceivingConveyor.GetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHorizontalOffset) - * [`RAReceivingConveyor.GetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLength) - * [`RAReceivingConveyor.GetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLengthOffset) - * [`RAReceivingConveyor.GetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMaterial) - * [`RAReceivingConveyor.GetMeshColoring()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMeshColoring) - * [`RAReceivingConveyor.GetModuleProperties()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperties) - * [`RAReceivingConveyor.GetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperty) - * [`RAReceivingConveyor.GetNumberOfCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfCells) - * [`RAReceivingConveyor.GetNumberOfNodes()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfNodes) - * [`RAReceivingConveyor.GetNumpyCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumpyCurve) - * [`RAReceivingConveyor.GetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutOfPlaneOffset) - * [`RAReceivingConveyor.GetOutputVariableValue()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutputVariableValue) - * [`RAReceivingConveyor.GetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetReturnBeltAngle) - * [`RAReceivingConveyor.GetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardHeight) - * [`RAReceivingConveyor.GetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardLength) - * [`RAReceivingConveyor.GetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSphBoundaryType) - * [`RAReceivingConveyor.GetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSurfaceTensionContactAngle) - * [`RAReceivingConveyor.GetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTemperature) - * [`RAReceivingConveyor.GetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetThermalBoundaryConditionType) - * [`RAReceivingConveyor.GetTimeSet()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeSet) - * [`RAReceivingConveyor.GetTimeStatistics()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStatistics) - * [`RAReceivingConveyor.GetTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStep) - * [`RAReceivingConveyor.GetTopologyShape()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTopologyShape) - * [`RAReceivingConveyor.GetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTriangleSize) - * [`RAReceivingConveyor.GetValidBeltProfileNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidBeltProfileNames) - * [`RAReceivingConveyor.GetValidOptionsForModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidOptionsForModuleProperty) - * [`RAReceivingConveyor.GetValidSphBoundaryTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues) - * [`RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues) - * [`RAReceivingConveyor.GetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVerticalOffset) - * [`RAReceivingConveyor.GetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetWidth) - * [`RAReceivingConveyor.HasGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.HasGridFunction) - * [`RAReceivingConveyor.IsCellActive()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IsCellActive) - * [`RAReceivingConveyor.IterCellVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCellVertices) - * [`RAReceivingConveyor.IterCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCells) - * [`RAReceivingConveyor.Modified()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.Modified) - * [`RAReceivingConveyor.RemoveCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomCurve) - * [`RAReceivingConveyor.RemoveCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomProperty) - * [`RAReceivingConveyor.RemoveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveOutputVariable) - * [`RAReceivingConveyor.RemoveProcess()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveProcess) - * [`RAReceivingConveyor.SetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAccelerationPeriod) - * [`RAReceivingConveyor.SetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAlignmentAngle) - * [`RAReceivingConveyor.SetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStartTime) - * [`RAReceivingConveyor.SetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStopTime) - * [`RAReceivingConveyor.SetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltInclineAngle) - * [`RAReceivingConveyor.SetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltProfile) - * [`RAReceivingConveyor.SetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltSpeed) - * [`RAReceivingConveyor.SetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltThickness) - * [`RAReceivingConveyor.SetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltWidth) - * [`RAReceivingConveyor.SetCurrentTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCurrentTimeStep) - * [`RAReceivingConveyor.SetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetDecelerationPeriod) - * [`RAReceivingConveyor.SetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHeightOffset) - * [`RAReceivingConveyor.SetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHorizontalOffset) - * [`RAReceivingConveyor.SetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLength) - * [`RAReceivingConveyor.SetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLengthOffset) - * [`RAReceivingConveyor.SetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetMaterial) - * [`RAReceivingConveyor.SetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetModuleProperty) - * [`RAReceivingConveyor.SetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetOutOfPlaneOffset) - * [`RAReceivingConveyor.SetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetReturnBeltAngle) - * [`RAReceivingConveyor.SetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardHeight) - * [`RAReceivingConveyor.SetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardLength) - * [`RAReceivingConveyor.SetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSphBoundaryType) - * [`RAReceivingConveyor.SetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSurfaceTensionContactAngle) - * [`RAReceivingConveyor.SetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTemperature) - * [`RAReceivingConveyor.SetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetThermalBoundaryConditionType) - * [`RAReceivingConveyor.SetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTriangleSize) - * [`RAReceivingConveyor.SetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetVerticalOffset) - * [`RAReceivingConveyor.SetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetWidth) - * [RARectangularSurface](RARectangularSurface.md) - * [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface) - * [`RARectangularSurface.AddCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCurve) - * [`RARectangularSurface.AddCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomCurve) - * [`RARectangularSurface.AddCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomProperty) - * [`RARectangularSurface.AddGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.AddGridFunction) - * [`RARectangularSurface.CreateCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateCurveOutputVariable) - * [`RARectangularSurface.CreateGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunction) - * [`RARectangularSurface.CreateGridFunctionArrayOnCells()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionArrayOnCells) - * [`RARectangularSurface.CreateGridFunctionStatisticOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionStatisticOutputVariable) - * [`RARectangularSurface.CreateTransientCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateTransientCurveOutputVariable) - * [`RARectangularSurface.EditCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomCurve) - * [`RARectangularSurface.EditCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomProperty) - * [`RARectangularSurface.GetActivesArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetActivesArray) - * [`RARectangularSurface.GetBoundingBox()`](RARectangularSurface.md#generated.RARectangularSurface.GetBoundingBox) - * [`RARectangularSurface.GetCellAreaAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellAreaAsArray) - * [`RARectangularSurface.GetCellCenterAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellCenterAsArray) - * [`RARectangularSurface.GetCellDzAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellDzAsArray) - * [`RARectangularSurface.GetCellFromIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellFromIJK) - * [`RARectangularSurface.GetCellIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellIJK) - * [`RARectangularSurface.GetCellNumberOfVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellNumberOfVertices) - * [`RARectangularSurface.GetCellPointsAsFunction()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellPointsAsFunction) - * [`RARectangularSurface.GetCellVolumeAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellVolumeAsArray) - * [`RARectangularSurface.GetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.GetCenter) - * [`RARectangularSurface.GetCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurve) - * [`RARectangularSurface.GetCurveNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNames) - * [`RARectangularSurface.GetCurveNamesAssociation()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNamesAssociation) - * [`RARectangularSurface.GetElementCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetElementCurve) - * [`RARectangularSurface.GetGeometryQuantity()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryQuantity) - * [`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.GetNumberOfCells()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfCells) - * [`RARectangularSurface.GetNumberOfNodes()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfNodes) - * [`RARectangularSurface.GetNumpyCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumpyCurve) - * [`RARectangularSurface.GetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientation) - * [`RARectangularSurface.GetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngleAndVector) - * [`RARectangularSurface.GetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngles) - * [`RARectangularSurface.GetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromBasisVector) - * [`RARectangularSurface.GetOutputVariableValue()`](RARectangularSurface.md#generated.RARectangularSurface.GetOutputVariableValue) - * [`RARectangularSurface.GetTimeSet()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeSet) - * [`RARectangularSurface.GetTimeStatistics()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStatistics) - * [`RARectangularSurface.GetTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStep) - * [`RARectangularSurface.GetTopologyShape()`](RARectangularSurface.md#generated.RARectangularSurface.GetTopologyShape) - * [`RARectangularSurface.GetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.GetWidth) - * [`RARectangularSurface.HasGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.HasGridFunction) - * [`RARectangularSurface.HasMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.HasMotionFrame) - * [`RARectangularSurface.IsCellActive()`](RARectangularSurface.md#generated.RARectangularSurface.IsCellActive) - * [`RARectangularSurface.IterCellVertices()`](RARectangularSurface.md#generated.RARectangularSurface.IterCellVertices) - * [`RARectangularSurface.IterCells()`](RARectangularSurface.md#generated.RARectangularSurface.IterCells) - * [`RARectangularSurface.Modified()`](RARectangularSurface.md#generated.RARectangularSurface.Modified) - * [`RARectangularSurface.RemoveCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomCurve) - * [`RARectangularSurface.RemoveCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomProperty) - * [`RARectangularSurface.RemoveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveOutputVariable) - * [`RARectangularSurface.RemoveProcess()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveProcess) - * [`RARectangularSurface.SetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.SetCenter) - * [`RARectangularSurface.SetCurrentTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.SetCurrentTimeStep) - * [`RARectangularSurface.SetLength()`](RARectangularSurface.md#generated.RARectangularSurface.SetLength) - * [`RARectangularSurface.SetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientation) - * [`RARectangularSurface.SetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngleAndVector) - * [`RARectangularSurface.SetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngles) - * [`RARectangularSurface.SetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromBasisVector) - * [`RARectangularSurface.SetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.SetWidth) - * [RARegionOfInterestCube](RARegionOfInterestCube.md) - * [`RARegionOfInterestCube`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube) - * [`RARegionOfInterestCube.AddCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCurve) - * [`RARegionOfInterestCube.AddCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomCurve) - * [`RARegionOfInterestCube.AddCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomProperty) - * [`RARegionOfInterestCube.AddGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddGridFunction) - * [`RARegionOfInterestCube.CreateCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateCurveOutputVariable) - * [`RARegionOfInterestCube.CreateGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunction) - * [`RARegionOfInterestCube.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionArrayOnCells) - * [`RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable) - * [`RARegionOfInterestCube.CreateTransientCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateTransientCurveOutputVariable) - * [`RARegionOfInterestCube.EditCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomCurve) - * [`RARegionOfInterestCube.EditCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomProperty) - * [`RARegionOfInterestCube.GetActivesArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetActivesArray) - * [`RARegionOfInterestCube.GetBoundingBox()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetBoundingBox) - * [`RARegionOfInterestCube.GetCellAreaAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellAreaAsArray) - * [`RARegionOfInterestCube.GetCellCenterAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellCenterAsArray) - * [`RARegionOfInterestCube.GetCellDzAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellDzAsArray) - * [`RARegionOfInterestCube.GetCellFromIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellFromIJK) - * [`RARegionOfInterestCube.GetCellIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellIJK) - * [`RARegionOfInterestCube.GetCellNumberOfVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellNumberOfVertices) - * [`RARegionOfInterestCube.GetCellPointsAsFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellPointsAsFunction) - * [`RARegionOfInterestCube.GetCellVolumeAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellVolumeAsArray) - * [`RARegionOfInterestCube.GetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenter) - * [`RARegionOfInterestCube.GetCenterAfterMovement()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenterAfterMovement) - * [`RARegionOfInterestCube.GetCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurve) - * [`RARegionOfInterestCube.GetCurveNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNames) - * [`RARegionOfInterestCube.GetCurveNamesAssociation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNamesAssociation) - * [`RARegionOfInterestCube.GetElementCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetElementCurve) - * [`RARegionOfInterestCube.GetGeometryQuantity()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryQuantity) - * [`RARegionOfInterestCube.GetGeometryUnit()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryUnit) - * [`RARegionOfInterestCube.GetGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunction) - * [`RARegionOfInterestCube.GetGridFunctionNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunctionNames) - * [`RARegionOfInterestCube.GetMeshColoring()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMeshColoring) - * [`RARegionOfInterestCube.GetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMotionFrame) - * [`RARegionOfInterestCube.GetNumberOfCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfCells) - * [`RARegionOfInterestCube.GetNumberOfNodes()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfNodes) - * [`RARegionOfInterestCube.GetNumpyCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumpyCurve) - * [`RARegionOfInterestCube.GetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientation) - * [`RARegionOfInterestCube.GetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngleAndVector) - * [`RARegionOfInterestCube.GetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngles) - * [`RARegionOfInterestCube.GetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromBasisVector) - * [`RARegionOfInterestCube.GetOutputVariableValue()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOutputVariableValue) - * [`RARegionOfInterestCube.GetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetSize) - * [`RARegionOfInterestCube.GetTimeSet()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeSet) - * [`RARegionOfInterestCube.GetTimeStatistics()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStatistics) - * [`RARegionOfInterestCube.GetTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStep) - * [`RARegionOfInterestCube.GetTopologyShape()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTopologyShape) - * [`RARegionOfInterestCube.HasGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.HasGridFunction) - * [`RARegionOfInterestCube.IsCellActive()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IsCellActive) - * [`RARegionOfInterestCube.IterCellVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCellVertices) - * [`RARegionOfInterestCube.IterCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCells) - * [`RARegionOfInterestCube.Modified()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.Modified) - * [`RARegionOfInterestCube.RemoveCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomCurve) - * [`RARegionOfInterestCube.RemoveCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomProperty) - * [`RARegionOfInterestCube.RemoveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveOutputVariable) - * [`RARegionOfInterestCube.RemoveProcess()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveProcess) - * [`RARegionOfInterestCube.SetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCenter) - * [`RARegionOfInterestCube.SetCurrentTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCurrentTimeStep) - * [`RARegionOfInterestCube.SetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetMotionFrame) - * [`RARegionOfInterestCube.SetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientation) - * [`RARegionOfInterestCube.SetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngleAndVector) - * [`RARegionOfInterestCube.SetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngles) - * [`RARegionOfInterestCube.SetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromBasisVector) - * [`RARegionOfInterestCube.SetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetSize) - * [RARegionOfInterestCylinder](RARegionOfInterestCylinder.md) - * [`RARegionOfInterestCylinder`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder) - * [`RARegionOfInterestCylinder.AddCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCurve) - * [`RARegionOfInterestCylinder.AddCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomCurve) - * [`RARegionOfInterestCylinder.AddCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomProperty) - * [`RARegionOfInterestCylinder.AddGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddGridFunction) - * [`RARegionOfInterestCylinder.CreateCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateCurveOutputVariable) - * [`RARegionOfInterestCylinder.CreateGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunction) - * [`RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells) - * [`RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable) - * [`RARegionOfInterestCylinder.CreateTransientCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateTransientCurveOutputVariable) - * [`RARegionOfInterestCylinder.EditCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomCurve) - * [`RARegionOfInterestCylinder.EditCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomProperty) - * [`RARegionOfInterestCylinder.GetActivesArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetActivesArray) - * [`RARegionOfInterestCylinder.GetBoundingBox()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetBoundingBox) - * [`RARegionOfInterestCylinder.GetCellAreaAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellAreaAsArray) - * [`RARegionOfInterestCylinder.GetCellCenterAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellCenterAsArray) - * [`RARegionOfInterestCylinder.GetCellDzAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellDzAsArray) - * [`RARegionOfInterestCylinder.GetCellFromIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellFromIJK) - * [`RARegionOfInterestCylinder.GetCellIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellIJK) - * [`RARegionOfInterestCylinder.GetCellNumberOfVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellNumberOfVertices) - * [`RARegionOfInterestCylinder.GetCellPointsAsFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellPointsAsFunction) - * [`RARegionOfInterestCylinder.GetCellVolumeAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellVolumeAsArray) - * [`RARegionOfInterestCylinder.GetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenter) - * [`RARegionOfInterestCylinder.GetCenterAfterMovement()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenterAfterMovement) - * [`RARegionOfInterestCylinder.GetCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurve) - * [`RARegionOfInterestCylinder.GetCurveNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNames) - * [`RARegionOfInterestCylinder.GetCurveNamesAssociation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation) - * [`RARegionOfInterestCylinder.GetElementCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetElementCurve) - * [`RARegionOfInterestCylinder.GetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFinalAngle) - * [`RARegionOfInterestCylinder.GetGeometryQuantity()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryQuantity) - * [`RARegionOfInterestCylinder.GetGeometryUnit()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryUnit) - * [`RARegionOfInterestCylinder.GetGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunction) - * [`RARegionOfInterestCylinder.GetGridFunctionNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunctionNames) - * [`RARegionOfInterestCylinder.GetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetHeight) - * [`RARegionOfInterestCylinder.GetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInitialAngle) - * [`RARegionOfInterestCylinder.GetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInternalFactor) - * [`RARegionOfInterestCylinder.GetMeshColoring()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMeshColoring) - * [`RARegionOfInterestCylinder.GetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMotionFrame) - * [`RARegionOfInterestCylinder.GetNumberOfCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfCells) - * [`RARegionOfInterestCylinder.GetNumberOfNodes()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfNodes) - * [`RARegionOfInterestCylinder.GetNumpyCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumpyCurve) - * [`RARegionOfInterestCylinder.GetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientation) - * [`RARegionOfInterestCylinder.GetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngleAndVector) - * [`RARegionOfInterestCylinder.GetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngles) - * [`RARegionOfInterestCylinder.GetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromBasisVector) - * [`RARegionOfInterestCylinder.GetOutputVariableValue()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOutputVariableValue) - * [`RARegionOfInterestCylinder.GetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetRadius) - * [`RARegionOfInterestCylinder.GetTimeSet()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeSet) - * [`RARegionOfInterestCylinder.GetTimeStatistics()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStatistics) - * [`RARegionOfInterestCylinder.GetTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStep) - * [`RARegionOfInterestCylinder.GetTopologyShape()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTopologyShape) - * [`RARegionOfInterestCylinder.HasGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.HasGridFunction) - * [`RARegionOfInterestCylinder.IsCellActive()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IsCellActive) - * [`RARegionOfInterestCylinder.IterCellVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCellVertices) - * [`RARegionOfInterestCylinder.IterCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCells) - * [`RARegionOfInterestCylinder.Modified()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.Modified) - * [`RARegionOfInterestCylinder.RemoveCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomCurve) - * [`RARegionOfInterestCylinder.RemoveCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomProperty) - * [`RARegionOfInterestCylinder.RemoveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveOutputVariable) - * [`RARegionOfInterestCylinder.RemoveProcess()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveProcess) - * [`RARegionOfInterestCylinder.SetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCenter) - * [`RARegionOfInterestCylinder.SetCurrentTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCurrentTimeStep) - * [`RARegionOfInterestCylinder.SetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetFinalAngle) - * [`RARegionOfInterestCylinder.SetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetHeight) - * [`RARegionOfInterestCylinder.SetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInitialAngle) - * [`RARegionOfInterestCylinder.SetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInternalFactor) - * [`RARegionOfInterestCylinder.SetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetMotionFrame) - * [`RARegionOfInterestCylinder.SetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientation) - * [`RARegionOfInterestCylinder.SetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngleAndVector) - * [`RARegionOfInterestCylinder.SetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngles) - * [`RARegionOfInterestCylinder.SetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromBasisVector) - * [`RARegionOfInterestCylinder.SetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetRadius) - * [RARegionsOfInterestCollection](RARegionsOfInterestCollection.md) - * [`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) - * [`RARegionsOfInterestCollection.AddCube()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCube) - * [`RARegionsOfInterestCollection.AddCylinder()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCylinder) - * [`RARegionsOfInterestCollection.Clear()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Clear) - * [`RARegionsOfInterestCollection.New()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.New) - * [`RARegionsOfInterestCollection.Remove()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Remove) - * [RARotation](RARotation.md) - * [`RARotation`](RARotation.md#generated.RARotation) - * [`RARotation.GetAngularAcceleration()`](RARotation.md#generated.RARotation.GetAngularAcceleration) - * [`RARotation.GetInitialAngularVelocity()`](RARotation.md#generated.RARotation.GetInitialAngularVelocity) - * [`RARotation.SetAngularAcceleration()`](RARotation.md#generated.RARotation.SetAngularAcceleration) - * [`RARotation.SetInitialAngularVelocity()`](RARotation.md#generated.RARotation.SetInitialAngularVelocity) - * [RASPHEulerianSolution](RASPHEulerianSolution.md) - * [`RASPHEulerianSolution`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution) - * [`RASPHEulerianSolution.DisableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.DisableEulerianSolution) - * [`RASPHEulerianSolution.EnableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.EnableEulerianSolution) - * [`RASPHEulerianSolution.GetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetEulerianSolutionEnabled) - * [`RASPHEulerianSolution.GetMeshColoring()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetMeshColoring) - * [`RASPHEulerianSolution.IsEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.IsEulerianSolutionEnabled) - * [`RASPHEulerianSolution.SetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.SetEulerianSolutionEnabled) - * [RASPHSettings](RASPHSettings.md) - * [`RASPHSettings`](RASPHSettings.md#generated.RASPHSettings) - * [`RASPHSettings.AddCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCurve) - * [`RASPHSettings.AddCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCustomCurve) - * [`RASPHSettings.AddCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.AddCustomProperty) - * [`RASPHSettings.AddGridFunction()`](RASPHSettings.md#generated.RASPHSettings.AddGridFunction) - * [`RASPHSettings.CreateCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateCurveOutputVariable) - * [`RASPHSettings.CreateGridFunction()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunction) - * [`RASPHSettings.CreateGridFunctionArrayOnCells()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionArrayOnCells) - * [`RASPHSettings.CreateGridFunctionStatisticOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable) - * [`RASPHSettings.CreateTransientCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateTransientCurveOutputVariable) - * [`RASPHSettings.DisableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.DisableEulerianSolution) - * [`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.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) - * [`RASPHSettings.GetCellCenterAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellCenterAsArray) - * [`RASPHSettings.GetCellDzAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellDzAsArray) - * [`RASPHSettings.GetCellFromIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellFromIJK) - * [`RASPHSettings.GetCellIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellIJK) - * [`RASPHSettings.GetCellNumberOfVertices()`](RASPHSettings.md#generated.RASPHSettings.GetCellNumberOfVertices) - * [`RASPHSettings.GetCellPointsAsFunction()`](RASPHSettings.md#generated.RASPHSettings.GetCellPointsAsFunction) - * [`RASPHSettings.GetCellVolumeAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellVolumeAsArray) - * [`RASPHSettings.GetClearyFactor()`](RASPHSettings.md#generated.RASPHSettings.GetClearyFactor) - * [`RASPHSettings.GetCurve()`](RASPHSettings.md#generated.RASPHSettings.GetCurve) - * [`RASPHSettings.GetCurveNames()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNames) - * [`RASPHSettings.GetCurveNamesAssociation()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNamesAssociation) - * [`RASPHSettings.GetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevMinus) - * [`RASPHSettings.GetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevPlus) - * [`RASPHSettings.GetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.GetDensityRelativeErrorTolerance) - * [`RASPHSettings.GetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.GetDissFactor) - * [`RASPHSettings.GetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorNorm) - * [`RASPHSettings.GetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorTang) - * [`RASPHSettings.GetElementCurve()`](RASPHSettings.md#generated.RASPHSettings.GetElementCurve) - * [`RASPHSettings.GetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEulerianSolutionEnabled) - * [`RASPHSettings.GetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.GetFluidMaterial) - * [`RASPHSettings.GetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit) - * [`RASPHSettings.GetGeometryQuantity()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryQuantity) - * [`RASPHSettings.GetGeometryUnit()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryUnit) - * [`RASPHSettings.GetGridFunction()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunction) - * [`RASPHSettings.GetGridFunctionNames()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunctionNames) - * [`RASPHSettings.GetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetKernelDistFactor) - * [`RASPHSettings.GetKernelType()`](RASPHSettings.md#generated.RASPHSettings.GetKernelType) - * [`RASPHSettings.GetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.GetLimitTurbulentViscosity) - * [`RASPHSettings.GetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumExpectedVelocity) - * [`RASPHSettings.GetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumNumberOfIterations) - * [`RASPHSettings.GetMeshColoring()`](RASPHSettings.md#generated.RASPHSettings.GetMeshColoring) - * [`RASPHSettings.GetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetMinDistFactor) - * [`RASPHSettings.GetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.GetNegativePressureFactor) - * [`RASPHSettings.GetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumCellSteps) - * [`RASPHSettings.GetNumberOfCells()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfCells) - * [`RASPHSettings.GetNumberOfNodes()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfNodes) - * [`RASPHSettings.GetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfSteps) - * [`RASPHSettings.GetNumpyCurve()`](RASPHSettings.md#generated.RASPHSettings.GetNumpyCurve) - * [`RASPHSettings.GetOutputVariableValue()`](RASPHSettings.md#generated.RASPHSettings.GetOutputVariableValue) - * [`RASPHSettings.GetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.GetPosCorrectionType) - * [`RASPHSettings.GetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.GetPressureDeg) - * [`RASPHSettings.GetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetPressureUnderRelaxationFactor) - * [`RASPHSettings.GetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) - * [`RASPHSettings.GetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) - * [`RASPHSettings.GetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.GetShiftingFactor) - * [`RASPHSettings.GetSize()`](RASPHSettings.md#generated.RASPHSettings.GetSize) - * [`RASPHSettings.GetSolver()`](RASPHSettings.md#generated.RASPHSettings.GetSolver) - * [`RASPHSettings.GetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.GetSolverModel) - * [`RASPHSettings.GetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.GetSoundSpeed) - * [`RASPHSettings.GetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityDegree) - * [`RASPHSettings.GetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityNegFactor) - * [`RASPHSettings.GetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityPosFactor) - * [`RASPHSettings.GetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStiffFactor) - * [`RASPHSettings.GetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryAngle) - * [`RASPHSettings.GetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryFraction) - * [`RASPHSettings.GetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionCoefficient) - * [`RASPHSettings.GetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionType) - * [`RASPHSettings.GetTimeSet()`](RASPHSettings.md#generated.RASPHSettings.GetTimeSet) - * [`RASPHSettings.GetTimeStatistics()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStatistics) - * [`RASPHSettings.GetTimeStep()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStep) - * [`RASPHSettings.GetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.GetTimestepFactor) - * [`RASPHSettings.GetTopologyShape()`](RASPHSettings.md#generated.RASPHSettings.GetTopologyShape) - * [`RASPHSettings.GetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.GetTurbDistanceFraction) - * [`RASPHSettings.GetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulenceType) - * [`RASPHSettings.GetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentPrandtl) - * [`RASPHSettings.GetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentViscosityMaximumRatio) - * [`RASPHSettings.GetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.GetUpdateCoupledDensity) - * [`RASPHSettings.GetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.GetUseParticlesNeighborsList) - * [`RASPHSettings.GetValidKernelTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidKernelTypeValues) - * [`RASPHSettings.GetValidPosCorrectionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidPosCorrectionTypeValues) - * [`RASPHSettings.GetValidSolverModelValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSolverModelValues) - * [`RASPHSettings.GetValidSurfaceTensionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSurfaceTensionTypeValues) - * [`RASPHSettings.GetValidTurbulenceTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidTurbulenceTypeValues) - * [`RASPHSettings.GetValidViscosityTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscosityTypeValues) - * [`RASPHSettings.GetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.GetViscosityType) - * [`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.IsShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) - * [`RASPHSettings.IsShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) - * [`RASPHSettings.IterCellVertices()`](RASPHSettings.md#generated.RASPHSettings.IterCellVertices) - * [`RASPHSettings.IterCells()`](RASPHSettings.md#generated.RASPHSettings.IterCells) - * [`RASPHSettings.Modified()`](RASPHSettings.md#generated.RASPHSettings.Modified) - * [`RASPHSettings.RemoveCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.RemoveCustomCurve) - * [`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) - * [`RASPHSettings.SetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevMinus) - * [`RASPHSettings.SetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevPlus) - * [`RASPHSettings.SetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.SetDensityRelativeErrorTolerance) - * [`RASPHSettings.SetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.SetDissFactor) - * [`RASPHSettings.SetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorNorm) - * [`RASPHSettings.SetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorTang) - * [`RASPHSettings.SetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEulerianSolutionEnabled) - * [`RASPHSettings.SetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.SetFluidMaterial) - * [`RASPHSettings.SetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit) - * [`RASPHSettings.SetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetKernelDistFactor) - * [`RASPHSettings.SetKernelType()`](RASPHSettings.md#generated.RASPHSettings.SetKernelType) - * [`RASPHSettings.SetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.SetLimitTurbulentViscosity) - * [`RASPHSettings.SetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumExpectedVelocity) - * [`RASPHSettings.SetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumNumberOfIterations) - * [`RASPHSettings.SetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetMinDistFactor) - * [`RASPHSettings.SetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.SetNegativePressureFactor) - * [`RASPHSettings.SetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumCellSteps) - * [`RASPHSettings.SetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumberOfSteps) - * [`RASPHSettings.SetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.SetPosCorrectionType) - * [`RASPHSettings.SetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.SetPressureDeg) - * [`RASPHSettings.SetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetPressureUnderRelaxationFactor) - * [`RASPHSettings.SetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) - * [`RASPHSettings.SetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) - * [`RASPHSettings.SetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.SetShiftingFactor) - * [`RASPHSettings.SetSize()`](RASPHSettings.md#generated.RASPHSettings.SetSize) - * [`RASPHSettings.SetSolver()`](RASPHSettings.md#generated.RASPHSettings.SetSolver) - * [`RASPHSettings.SetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.SetSolverModel) - * [`RASPHSettings.SetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.SetSoundSpeed) - * [`RASPHSettings.SetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityDegree) - * [`RASPHSettings.SetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityNegFactor) - * [`RASPHSettings.SetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityPosFactor) - * [`RASPHSettings.SetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStiffFactor) - * [`RASPHSettings.SetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryAngle) - * [`RASPHSettings.SetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryFraction) - * [`RASPHSettings.SetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionCoefficient) - * [`RASPHSettings.SetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionType) - * [`RASPHSettings.SetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.SetTimestepFactor) - * [`RASPHSettings.SetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.SetTurbDistanceFraction) - * [`RASPHSettings.SetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulenceType) - * [`RASPHSettings.SetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentPrandtl) - * [`RASPHSettings.SetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentViscosityMaximumRatio) - * [`RASPHSettings.SetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.SetUpdateCoupledDensity) - * [`RASPHSettings.SetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.SetUseParticlesNeighborsList) - * [`RASPHSettings.SetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.SetViscosityType) - * [`RASPHSettings.SetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.SetXsphFactor) - * [RASimulatorRun](RASimulatorRun.md) - * [`RASimulatorRun`](RASimulatorRun.md#generated.RASimulatorRun) - * [`RASimulatorRun.AddCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCurve) - * [`RASimulatorRun.AddCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomCurve) - * [`RASimulatorRun.AddCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomProperty) - * [`RASimulatorRun.AddGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.AddGridFunction) - * [`RASimulatorRun.CreateCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateCurveOutputVariable) - * [`RASimulatorRun.CreateGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunction) - * [`RASimulatorRun.CreateGridFunctionArrayOnCells()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionArrayOnCells) - * [`RASimulatorRun.CreateGridFunctionStatisticOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionStatisticOutputVariable) - * [`RASimulatorRun.CreateTransientCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateTransientCurveOutputVariable) - * [`RASimulatorRun.DisableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.DisableCompressedFile) - * [`RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.DisableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.DisableFEMForces) - * [`RASimulatorRun.DisableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.DisableHtcCalculator) - * [`RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.DisableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.DisableNegateInitialOverlaps) - * [`RASimulatorRun.DisableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.DisableSortingDistanceFactor) - * [`RASimulatorRun.DisableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.DisableUse3RdPowerForCfdCgm) - * [`RASimulatorRun.EditCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomCurve) - * [`RASimulatorRun.EditCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomProperty) - * [`RASimulatorRun.EnableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.EnableCompressedFile) - * [`RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.EnableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.EnableFEMForces) - * [`RASimulatorRun.EnableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.EnableHtcCalculator) - * [`RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.EnableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.EnableNegateInitialOverlaps) - * [`RASimulatorRun.EnableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.EnableSortingDistanceFactor) - * [`RASimulatorRun.EnableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.EnableUse3RdPowerForCfdCgm) - * [`RASimulatorRun.GetActivesArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetActivesArray) - * [`RASimulatorRun.GetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetArraysGrowthRate) - * [`RASimulatorRun.GetAvailableModulesOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableModulesOutputProperties) - * [`RASimulatorRun.GetAvailableOutputRootProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRootProperties) - * [`RASimulatorRun.GetAvailableOutputRoots()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRoots) - * [`RASimulatorRun.GetAvailableStandardOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableStandardOutputProperties) - * [`RASimulatorRun.GetBoundingBox()`](RASimulatorRun.md#generated.RASimulatorRun.GetBoundingBox) - * [`RASimulatorRun.GetBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageDelayAfterRelease) - * [`RASimulatorRun.GetBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageOverlapFactor) - * [`RASimulatorRun.GetBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageStart) - * [`RASimulatorRun.GetCellAreaAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellAreaAsArray) - * [`RASimulatorRun.GetCellCenterAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellCenterAsArray) - * [`RASimulatorRun.GetCellDzAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellDzAsArray) - * [`RASimulatorRun.GetCellFromIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellFromIJK) - * [`RASimulatorRun.GetCellIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellIJK) - * [`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) - * [`RASimulatorRun.GetCurveNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNames) - * [`RASimulatorRun.GetCurveNamesAssociation()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNamesAssociation) - * [`RASimulatorRun.GetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.GetDeformableMassMatrixType) - * [`RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries) - * [`RASimulatorRun.GetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetDragLimiterFactor) - * [`RASimulatorRun.GetElementCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetElementCurve) - * [`RASimulatorRun.GetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetFixedTimestep) - * [`RASimulatorRun.GetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.GetFluentOutputsMultiplier) - * [`RASimulatorRun.GetGeometryQuantity()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryQuantity) - * [`RASimulatorRun.GetGeometryUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryUnit) - * [`RASimulatorRun.GetGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunction) - * [`RASimulatorRun.GetGridFunctionNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunctionNames) - * [`RASimulatorRun.GetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.GetJointElasticRatio) - * [`RASimulatorRun.GetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.GetLinearHystDamp) - * [`RASimulatorRun.GetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.GetLoadingNSteps) - * [`RASimulatorRun.GetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.GetMaximumNumberOfIterations) - * [`RASimulatorRun.GetMeshColoring()`](RASimulatorRun.md#generated.RASimulatorRun.GetMeshColoring) - * [`RASimulatorRun.GetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumLengthDeformationTolerance) - * [`RASimulatorRun.GetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumVolumeTolerance) - * [`RASimulatorRun.GetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertiesData) - * [`RASimulatorRun.GetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertyEnabled) - * [`RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.GetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.GetMultiGpuSlicingDirection) - * [`RASimulatorRun.GetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.GetNegateInitialOverlaps) - * [`RASimulatorRun.GetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetNeighborSearchModel) - * [`RASimulatorRun.GetNumberOfCells()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfCells) - * [`RASimulatorRun.GetNumberOfNodes()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfNodes) - * [`RASimulatorRun.GetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfProcessors) - * [`RASimulatorRun.GetNumpyCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumpyCurve) - * [`RASimulatorRun.GetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputPropertyEnabled) - * [`RASimulatorRun.GetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputRootEnabled) - * [`RASimulatorRun.GetOutputVariableValue()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputVariableValue) - * [`RASimulatorRun.GetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverRelaxationCoefficient) - * [`RASimulatorRun.GetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverlapParticlesDelay) - * [`RASimulatorRun.GetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.GetParticleSizeLimitForReordering) - * [`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) - * [`RASimulatorRun.GetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetStandardOutputPropertyEnabled) - * [`RASimulatorRun.GetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetSuccessiveOverRelaxationTolerance) - * [`RASimulatorRun.GetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpu) - * [`RASimulatorRun.GetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpus) - * [`RASimulatorRun.GetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeInterval) - * [`RASimulatorRun.GetTimeSet()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeSet) - * [`RASimulatorRun.GetTimeStatistics()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStatistics) - * [`RASimulatorRun.GetTimeStep()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStep) - * [`RASimulatorRun.GetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimestepModel) - * [`RASimulatorRun.GetTopologyShape()`](RASimulatorRun.md#generated.RASimulatorRun.GetTopologyShape) - * [`RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach) - * [`RASimulatorRun.GetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2SourceTermsApproach) - * [`RASimulatorRun.GetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse3RdPowerForCfdCgm) - * [`RASimulatorRun.GetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseArraysGrowthRate) - * [`RASimulatorRun.GetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseBreakageOverlapFactor) - * [`RASimulatorRun.GetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseCompressedFiles) - * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles) - * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles) - * [`RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.GetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDragLimiterFactor) - * [`RASimulatorRun.GetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseFixedTimestep) - * [`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.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.GetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateInterval) - * [`RASimulatorRun.GetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearStart) - * [`RASimulatorRun.HasFEMForcesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.HasFEMForcesEnabled) - * [`RASimulatorRun.HasGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.HasGridFunction) - * [`RASimulatorRun.HasHtcCalculatedData()`](RASimulatorRun.md#generated.RASimulatorRun.HasHtcCalculatedData) - * [`RASimulatorRun.IsCellActive()`](RASimulatorRun.md#generated.RASimulatorRun.IsCellActive) - * [`RASimulatorRun.IsCompressedFileEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsCompressedFileEnabled) - * [`RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled) - * [`RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled) - * [`RASimulatorRun.IsNegateInitialOverlapsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsNegateInitialOverlapsEnabled) - * [`RASimulatorRun.IsSortingDistanceFactorEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsSortingDistanceFactorEnabled) - * [`RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled) - * [`RASimulatorRun.IterCellVertices()`](RASimulatorRun.md#generated.RASimulatorRun.IterCellVertices) - * [`RASimulatorRun.IterCells()`](RASimulatorRun.md#generated.RASimulatorRun.IterCells) - * [`RASimulatorRun.Modified()`](RASimulatorRun.md#generated.RASimulatorRun.Modified) - * [`RASimulatorRun.RemoveCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomCurve) - * [`RASimulatorRun.RemoveCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomProperty) - * [`RASimulatorRun.RemoveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveOutputVariable) - * [`RASimulatorRun.RemoveProcess()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveProcess) - * [`RASimulatorRun.RestoreOutputPropertiesDefaults()`](RASimulatorRun.md#generated.RASimulatorRun.RestoreOutputPropertiesDefaults) - * [`RASimulatorRun.SetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetArraysGrowthRate) - * [`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) - * [`RASimulatorRun.SetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.SetDeformableMassMatrixType) - * [`RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries) - * [`RASimulatorRun.SetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetDragLimiterFactor) - * [`RASimulatorRun.SetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetFixedTimestep) - * [`RASimulatorRun.SetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.SetFluentOutputsMultiplier) - * [`RASimulatorRun.SetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.SetJointElasticRatio) - * [`RASimulatorRun.SetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.SetLinearHystDamp) - * [`RASimulatorRun.SetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.SetLoadingNSteps) - * [`RASimulatorRun.SetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.SetMaximumNumberOfIterations) - * [`RASimulatorRun.SetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumLengthDeformationTolerance) - * [`RASimulatorRun.SetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumVolumeTolerance) - * [`RASimulatorRun.SetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertiesData) - * [`RASimulatorRun.SetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertyEnabled) - * [`RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.SetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.SetMultiGpuSlicingDirection) - * [`RASimulatorRun.SetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.SetNegateInitialOverlaps) - * [`RASimulatorRun.SetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetNeighborSearchModel) - * [`RASimulatorRun.SetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.SetNumberOfProcessors) - * [`RASimulatorRun.SetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputPropertyEnabled) - * [`RASimulatorRun.SetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputRootEnabled) - * [`RASimulatorRun.SetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverRelaxationCoefficient) - * [`RASimulatorRun.SetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverlapParticlesDelay) - * [`RASimulatorRun.SetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.SetParticleSizeLimitForReordering) - * [`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) - * [`RASimulatorRun.SetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetStandardOutputPropertyEnabled) - * [`RASimulatorRun.SetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetSuccessiveOverRelaxationTolerance) - * [`RASimulatorRun.SetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpu) - * [`RASimulatorRun.SetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpus) - * [`RASimulatorRun.SetTimeConfiguration()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeConfiguration) - * [`RASimulatorRun.SetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeInterval) - * [`RASimulatorRun.SetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimestepModel) - * [`RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach) - * [`RASimulatorRun.SetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2SourceTermsApproach) - * [`RASimulatorRun.SetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse3RdPowerForCfdCgm) - * [`RASimulatorRun.SetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseArraysGrowthRate) - * [`RASimulatorRun.SetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseBreakageOverlapFactor) - * [`RASimulatorRun.SetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseCompressedFiles) - * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles) - * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles) - * [`RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.SetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDragLimiterFactor) - * [`RASimulatorRun.SetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseFixedTimestep) - * [`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) - * [`RASizeDistribution`](RASizeDistribution.md#generated.RASizeDistribution) - * [`RASizeDistribution.GetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.GetCumulativePercentage) - * [`RASizeDistribution.GetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.GetScaleFactor) - * [`RASizeDistribution.GetSize()`](RASizeDistribution.md#generated.RASizeDistribution.GetSize) - * [`RASizeDistribution.SetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.SetCumulativePercentage) - * [`RASizeDistribution.SetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.SetScaleFactor) - * [`RASizeDistribution.SetSize()`](RASizeDistribution.md#generated.RASizeDistribution.SetSize) - * [RASizeDistributionList](RASizeDistributionList.md) - * [`RASizeDistributionList`](RASizeDistributionList.md#generated.RASizeDistributionList) - * [`RASizeDistributionList.Clear()`](RASizeDistributionList.md#generated.RASizeDistributionList.Clear) - * [`RASizeDistributionList.GetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetCgmScaleFactor) - * [`RASizeDistributionList.GetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetSizeType) - * [`RASizeDistributionList.GetValidSizeTypeValues()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetValidSizeTypeValues) - * [`RASizeDistributionList.New()`](RASizeDistributionList.md#generated.RASizeDistributionList.New) - * [`RASizeDistributionList.Remove()`](RASizeDistributionList.md#generated.RASizeDistributionList.Remove) - * [`RASizeDistributionList.SetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetCgmScaleFactor) - * [`RASizeDistributionList.SetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetSizeType) - * [RASolidMaterial](RASolidMaterial.md) - * [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - * [`RASolidMaterial.GetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkDensity) - * [`RASolidMaterial.GetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkSolidFraction) - * [`RASolidMaterial.GetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetCurrentDensity) - * [`RASolidMaterial.GetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetDensity) - * [`RASolidMaterial.GetModuleProperties()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperties) - * [`RASolidMaterial.GetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperty) - * [`RASolidMaterial.GetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.GetPoissonRatio) - * [`RASolidMaterial.GetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.GetSpecificHeat) - * [`RASolidMaterial.GetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.GetThermalConductivity) - * [`RASolidMaterial.GetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetUseBulkDensity) - * [`RASolidMaterial.GetValidOptionsForModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetValidOptionsForModuleProperty) - * [`RASolidMaterial.GetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.GetYoungsModulus) - * [`RASolidMaterial.SetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkDensity) - * [`RASolidMaterial.SetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkSolidFraction) - * [`RASolidMaterial.SetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetCurrentDensity) - * [`RASolidMaterial.SetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetDensity) - * [`RASolidMaterial.SetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.SetModuleProperty) - * [`RASolidMaterial.SetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.SetPoissonRatio) - * [`RASolidMaterial.SetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.SetSpecificHeat) - * [`RASolidMaterial.SetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.SetThermalConductivity) - * [`RASolidMaterial.SetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetUseBulkDensity) - * [`RASolidMaterial.SetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.SetYoungsModulus) - * [RASpringDashpotForce](RASpringDashpotForce.md) - * [`RASpringDashpotForce`](RASpringDashpotForce.md#generated.RASpringDashpotForce) - * [`RASpringDashpotForce.GetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDashpotCoefficient) - * [`RASpringDashpotForce.GetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDirection) - * [`RASpringDashpotForce.GetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetSpringCoefficient) - * [`RASpringDashpotForce.GetValidDirectionValues()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetValidDirectionValues) - * [`RASpringDashpotForce.SetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDashpotCoefficient) - * [`RASpringDashpotForce.SetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDirection) - * [`RASpringDashpotForce.SetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetSpringCoefficient) - * [RASpringDashpotMoment](RASpringDashpotMoment.md) - * [`RASpringDashpotMoment`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment) - * [`RASpringDashpotMoment.GetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDashpotCoefficient) - * [`RASpringDashpotMoment.GetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDirection) - * [`RASpringDashpotMoment.GetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetSpringCoefficient) - * [`RASpringDashpotMoment.GetValidDirectionValues()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetValidDirectionValues) - * [`RASpringDashpotMoment.SetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDashpotCoefficient) - * [`RASpringDashpotMoment.SetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDirection) - * [`RASpringDashpotMoment.SetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetSpringCoefficient) - * [RAStreamlinesUserProcess](RAStreamlinesUserProcess.md) - * [`RAStreamlinesUserProcess`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess) - * [`RAStreamlinesUserProcess.AddCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCurve) - * [`RAStreamlinesUserProcess.AddCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomCurve) - * [`RAStreamlinesUserProcess.AddCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomProperty) - * [`RAStreamlinesUserProcess.AddGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddGridFunction) - * [`RAStreamlinesUserProcess.CreateCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateCurveOutputVariable) - * [`RAStreamlinesUserProcess.CreateGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunction) - * [`RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells) - * [`RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAStreamlinesUserProcess.CreateTransientCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateTransientCurveOutputVariable) - * [`RAStreamlinesUserProcess.EditCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomCurve) - * [`RAStreamlinesUserProcess.EditCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomProperty) - * [`RAStreamlinesUserProcess.GetActivesArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetActivesArray) - * [`RAStreamlinesUserProcess.GetAvailableSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetAvailableSources) - * [`RAStreamlinesUserProcess.GetBoundingBox()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetBoundingBox) - * [`RAStreamlinesUserProcess.GetCellAreaAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellAreaAsArray) - * [`RAStreamlinesUserProcess.GetCellCenterAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellCenterAsArray) - * [`RAStreamlinesUserProcess.GetCellDzAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellDzAsArray) - * [`RAStreamlinesUserProcess.GetCellFromIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellFromIJK) - * [`RAStreamlinesUserProcess.GetCellIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellIJK) - * [`RAStreamlinesUserProcess.GetCellNumberOfVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellNumberOfVertices) - * [`RAStreamlinesUserProcess.GetCellPointsAsFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellPointsAsFunction) - * [`RAStreamlinesUserProcess.GetCellVolumeAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellVolumeAsArray) - * [`RAStreamlinesUserProcess.GetCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurve) - * [`RAStreamlinesUserProcess.GetCurveNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNames) - * [`RAStreamlinesUserProcess.GetCurveNamesAssociation()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation) - * [`RAStreamlinesUserProcess.GetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetDirection) - * [`RAStreamlinesUserProcess.GetElementCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetElementCurve) - * [`RAStreamlinesUserProcess.GetGeometryQuantity()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryQuantity) - * [`RAStreamlinesUserProcess.GetGeometryUnit()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryUnit) - * [`RAStreamlinesUserProcess.GetGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunction) - * [`RAStreamlinesUserProcess.GetGridFunctionNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunctionNames) - * [`RAStreamlinesUserProcess.GetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMaximumLength) - * [`RAStreamlinesUserProcess.GetMeshColoring()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMeshColoring) - * [`RAStreamlinesUserProcess.GetNumberOfCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfCells) - * [`RAStreamlinesUserProcess.GetNumberOfNodes()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfNodes) - * [`RAStreamlinesUserProcess.GetNumberOfParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfParticles) - * [`RAStreamlinesUserProcess.GetNumpyCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumpyCurve) - * [`RAStreamlinesUserProcess.GetOutputVariableValue()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetOutputVariableValue) - * [`RAStreamlinesUserProcess.GetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSources) - * [`RAStreamlinesUserProcess.GetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSpacing) - * [`RAStreamlinesUserProcess.GetTimeSet()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeSet) - * [`RAStreamlinesUserProcess.GetTimeStatistics()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStatistics) - * [`RAStreamlinesUserProcess.GetTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStep) - * [`RAStreamlinesUserProcess.GetTopologyShape()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTopologyShape) - * [`RAStreamlinesUserProcess.GetValidDirectionValues()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetValidDirectionValues) - * [`RAStreamlinesUserProcess.HasGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.HasGridFunction) - * [`RAStreamlinesUserProcess.IsCellActive()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IsCellActive) - * [`RAStreamlinesUserProcess.IterCellVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCellVertices) - * [`RAStreamlinesUserProcess.IterCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCells) - * [`RAStreamlinesUserProcess.IterParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterParticles) - * [`RAStreamlinesUserProcess.Modified()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.Modified) - * [`RAStreamlinesUserProcess.RemoveCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomCurve) - * [`RAStreamlinesUserProcess.RemoveCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomProperty) - * [`RAStreamlinesUserProcess.RemoveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveOutputVariable) - * [`RAStreamlinesUserProcess.RemoveProcess()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveProcess) - * [`RAStreamlinesUserProcess.SetCurrentTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetCurrentTimeStep) - * [`RAStreamlinesUserProcess.SetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetDirection) - * [`RAStreamlinesUserProcess.SetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetMaximumLength) - * [`RAStreamlinesUserProcess.SetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSources) - * [`RAStreamlinesUserProcess.SetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSpacing) - * [`RAStreamlinesUserProcess.UpdateStreamlines()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.UpdateStreamlines) - * [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) - * [`RAStudy.GetAirFlow()`](RAStudy.md#generated.RAStudy.GetAirFlow) - * [`RAStudy.GetCFDCoupling()`](RAStudy.md#generated.RAStudy.GetCFDCoupling) - * [`RAStudy.GetCalculations()`](RAStudy.md#generated.RAStudy.GetCalculations) - * [`RAStudy.GetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.GetCollectForcesForFemAnalysis) - * [`RAStudy.GetContactData()`](RAStudy.md#generated.RAStudy.GetContactData) - * [`RAStudy.GetCustomerName()`](RAStudy.md#generated.RAStudy.GetCustomerName) - * [`RAStudy.GetDescription()`](RAStudy.md#generated.RAStudy.GetDescription) - * [`RAStudy.GetDomainSettings()`](RAStudy.md#generated.RAStudy.GetDomainSettings) - * [`RAStudy.GetElementCurve()`](RAStudy.md#generated.RAStudy.GetElementCurve) - * [`RAStudy.GetExportToolkit()`](RAStudy.md#generated.RAStudy.GetExportToolkit) - * [`RAStudy.GetFEMForcesAnalysisModules()`](RAStudy.md#generated.RAStudy.GetFEMForcesAnalysisModules) - * [`RAStudy.GetGeometry()`](RAStudy.md#generated.RAStudy.GetGeometry) - * [`RAStudy.GetGeometryCollection()`](RAStudy.md#generated.RAStudy.GetGeometryCollection) - * [`RAStudy.GetInletsOutletsCollection()`](RAStudy.md#generated.RAStudy.GetInletsOutletsCollection) - * [`RAStudy.GetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.GetIntraParticleCollisionStatistics) - * [`RAStudy.GetJointsData()`](RAStudy.md#generated.RAStudy.GetJointsData) - * [`RAStudy.GetMaterialCollection()`](RAStudy.md#generated.RAStudy.GetMaterialCollection) - * [`RAStudy.GetMaterialsInteractionCollection()`](RAStudy.md#generated.RAStudy.GetMaterialsInteractionCollection) - * [`RAStudy.GetMeshedParticlesUpscalingEnabled()`](RAStudy.md#generated.RAStudy.GetMeshedParticlesUpscalingEnabled) - * [`RAStudy.GetModuleCollection()`](RAStudy.md#generated.RAStudy.GetModuleCollection) - * [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource) - * [`RAStudy.GetParticleCollection()`](RAStudy.md#generated.RAStudy.GetParticleCollection) - * [`RAStudy.GetParticleInput()`](RAStudy.md#generated.RAStudy.GetParticleInput) - * [`RAStudy.GetParticles()`](RAStudy.md#generated.RAStudy.GetParticles) - * [`RAStudy.GetPhysics()`](RAStudy.md#generated.RAStudy.GetPhysics) - * [`RAStudy.GetPointCloudCollection()`](RAStudy.md#generated.RAStudy.GetPointCloudCollection) - * [`RAStudy.GetProgress()`](RAStudy.md#generated.RAStudy.GetProgress) - * [`RAStudy.GetSimulatorRun()`](RAStudy.md#generated.RAStudy.GetSimulatorRun) - * [`RAStudy.GetSolver()`](RAStudy.md#generated.RAStudy.GetSolver) - * [`RAStudy.GetStatus()`](RAStudy.md#generated.RAStudy.GetStatus) - * [`RAStudy.GetSurfaceFromFilename()`](RAStudy.md#generated.RAStudy.GetSurfaceFromFilename) - * [`RAStudy.GetTimeSet()`](RAStudy.md#generated.RAStudy.GetTimeSet) - * [`RAStudy.GetWallFromFilename()`](RAStudy.md#generated.RAStudy.GetWallFromFilename) - * [`RAStudy.HasCalculatedHTC()`](RAStudy.md#generated.RAStudy.HasCalculatedHTC) - * [`RAStudy.HasResults()`](RAStudy.md#generated.RAStudy.HasResults) - * [`RAStudy.ImportSurface()`](RAStudy.md#generated.RAStudy.ImportSurface) - * [`RAStudy.ImportSystemCouplingWall()`](RAStudy.md#generated.RAStudy.ImportSystemCouplingWall) - * [`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) - * [`RAStudy.SetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.SetCollectForcesForFemAnalysis) - * [`RAStudy.SetCustomerName()`](RAStudy.md#generated.RAStudy.SetCustomerName) - * [`RAStudy.SetDescription()`](RAStudy.md#generated.RAStudy.SetDescription) - * [`RAStudy.SetHTCCalculatorEnabled()`](RAStudy.md#generated.RAStudy.SetHTCCalculatorEnabled) - * [`RAStudy.SetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.SetIntraParticleCollisionStatistics) - * [`RAStudy.SetVariable()`](RAStudy.md#generated.RAStudy.SetVariable) - * [`RAStudy.StartSimulation()`](RAStudy.md#generated.RAStudy.StartSimulation) - * [`RAStudy.StopSimulation()`](RAStudy.md#generated.RAStudy.StopSimulation) - * [`RAStudy.customer_name`](RAStudy.md#generated.RAStudy.customer_name) - * [`RAStudy.description`](RAStudy.md#generated.RAStudy.description) - * [RASurface](RASurface.md) - * [`RASurface`](RASurface.md#generated.RASurface) - * [`RASurface.AddCurve()`](RASurface.md#generated.RASurface.AddCurve) - * [`RASurface.AddCustomCurve()`](RASurface.md#generated.RASurface.AddCustomCurve) - * [`RASurface.AddCustomProperty()`](RASurface.md#generated.RASurface.AddCustomProperty) - * [`RASurface.AddGridFunction()`](RASurface.md#generated.RASurface.AddGridFunction) - * [`RASurface.CreateCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateCurveOutputVariable) - * [`RASurface.CreateGridFunction()`](RASurface.md#generated.RASurface.CreateGridFunction) - * [`RASurface.CreateGridFunctionArrayOnCells()`](RASurface.md#generated.RASurface.CreateGridFunctionArrayOnCells) - * [`RASurface.CreateGridFunctionStatisticOutputVariable()`](RASurface.md#generated.RASurface.CreateGridFunctionStatisticOutputVariable) - * [`RASurface.CreateTransientCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateTransientCurveOutputVariable) - * [`RASurface.EditCustomCurve()`](RASurface.md#generated.RASurface.EditCustomCurve) - * [`RASurface.EditCustomProperty()`](RASurface.md#generated.RASurface.EditCustomProperty) - * [`RASurface.GetActivesArray()`](RASurface.md#generated.RASurface.GetActivesArray) - * [`RASurface.GetBoundingBox()`](RASurface.md#generated.RASurface.GetBoundingBox) - * [`RASurface.GetCellAreaAsArray()`](RASurface.md#generated.RASurface.GetCellAreaAsArray) - * [`RASurface.GetCellCenterAsArray()`](RASurface.md#generated.RASurface.GetCellCenterAsArray) - * [`RASurface.GetCellDzAsArray()`](RASurface.md#generated.RASurface.GetCellDzAsArray) - * [`RASurface.GetCellFromIJK()`](RASurface.md#generated.RASurface.GetCellFromIJK) - * [`RASurface.GetCellIJK()`](RASurface.md#generated.RASurface.GetCellIJK) - * [`RASurface.GetCellNumberOfVertices()`](RASurface.md#generated.RASurface.GetCellNumberOfVertices) - * [`RASurface.GetCellPointsAsFunction()`](RASurface.md#generated.RASurface.GetCellPointsAsFunction) - * [`RASurface.GetCellVolumeAsArray()`](RASurface.md#generated.RASurface.GetCellVolumeAsArray) - * [`RASurface.GetCurve()`](RASurface.md#generated.RASurface.GetCurve) - * [`RASurface.GetCurveNames()`](RASurface.md#generated.RASurface.GetCurveNames) - * [`RASurface.GetCurveNamesAssociation()`](RASurface.md#generated.RASurface.GetCurveNamesAssociation) - * [`RASurface.GetElementCurve()`](RASurface.md#generated.RASurface.GetElementCurve) - * [`RASurface.GetGeometryQuantity()`](RASurface.md#generated.RASurface.GetGeometryQuantity) - * [`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.GetNumberOfCells()`](RASurface.md#generated.RASurface.GetNumberOfCells) - * [`RASurface.GetNumberOfNodes()`](RASurface.md#generated.RASurface.GetNumberOfNodes) - * [`RASurface.GetNumpyCurve()`](RASurface.md#generated.RASurface.GetNumpyCurve) - * [`RASurface.GetOrientation()`](RASurface.md#generated.RASurface.GetOrientation) - * [`RASurface.GetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.GetOrientationFromAngleAndVector) - * [`RASurface.GetOrientationFromAngles()`](RASurface.md#generated.RASurface.GetOrientationFromAngles) - * [`RASurface.GetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.GetOrientationFromBasisVector) - * [`RASurface.GetOutputVariableValue()`](RASurface.md#generated.RASurface.GetOutputVariableValue) - * [`RASurface.GetPivotPoint()`](RASurface.md#generated.RASurface.GetPivotPoint) - * [`RASurface.GetTimeSet()`](RASurface.md#generated.RASurface.GetTimeSet) - * [`RASurface.GetTimeStatistics()`](RASurface.md#generated.RASurface.GetTimeStatistics) - * [`RASurface.GetTimeStep()`](RASurface.md#generated.RASurface.GetTimeStep) - * [`RASurface.GetTopologyShape()`](RASurface.md#generated.RASurface.GetTopologyShape) - * [`RASurface.GetTranslation()`](RASurface.md#generated.RASurface.GetTranslation) - * [`RASurface.HasGridFunction()`](RASurface.md#generated.RASurface.HasGridFunction) - * [`RASurface.HasMotionFrame()`](RASurface.md#generated.RASurface.HasMotionFrame) - * [`RASurface.IsCellActive()`](RASurface.md#generated.RASurface.IsCellActive) - * [`RASurface.IterCellVertices()`](RASurface.md#generated.RASurface.IterCellVertices) - * [`RASurface.IterCells()`](RASurface.md#generated.RASurface.IterCells) - * [`RASurface.Modified()`](RASurface.md#generated.RASurface.Modified) - * [`RASurface.RemoveCustomCurve()`](RASurface.md#generated.RASurface.RemoveCustomCurve) - * [`RASurface.RemoveCustomProperty()`](RASurface.md#generated.RASurface.RemoveCustomProperty) - * [`RASurface.RemoveOutputVariable()`](RASurface.md#generated.RASurface.RemoveOutputVariable) - * [`RASurface.RemoveProcess()`](RASurface.md#generated.RASurface.RemoveProcess) - * [`RASurface.SetCurrentTimeStep()`](RASurface.md#generated.RASurface.SetCurrentTimeStep) - * [`RASurface.SetInvertNormal()`](RASurface.md#generated.RASurface.SetInvertNormal) - * [`RASurface.SetOrientation()`](RASurface.md#generated.RASurface.SetOrientation) - * [`RASurface.SetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.SetOrientationFromAngleAndVector) - * [`RASurface.SetOrientationFromAngles()`](RASurface.md#generated.RASurface.SetOrientationFromAngles) - * [`RASurface.SetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.SetOrientationFromBasisVector) - * [`RASurface.SetPivotPoint()`](RASurface.md#generated.RASurface.SetPivotPoint) - * [`RASurface.SetTranslation()`](RASurface.md#generated.RASurface.SetTranslation) - * [RASurfaceUserProcess](RASurfaceUserProcess.md) - * [`RASurfaceUserProcess`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess) - * [`RASurfaceUserProcess.AddCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCurve) - * [`RASurfaceUserProcess.AddCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomCurve) - * [`RASurfaceUserProcess.AddCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomProperty) - * [`RASurfaceUserProcess.AddGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddGridFunction) - * [`RASurfaceUserProcess.CreateCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateCurveOutputVariable) - * [`RASurfaceUserProcess.CreateGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunction) - * [`RASurfaceUserProcess.CreateGridFunctionArrayOnCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionArrayOnCells) - * [`RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable) - * [`RASurfaceUserProcess.CreateTransientCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateTransientCurveOutputVariable) - * [`RASurfaceUserProcess.EditCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomCurve) - * [`RASurfaceUserProcess.EditCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomProperty) - * [`RASurfaceUserProcess.GetActivesArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetActivesArray) - * [`RASurfaceUserProcess.GetBoundingBox()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetBoundingBox) - * [`RASurfaceUserProcess.GetCellAreaAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellAreaAsArray) - * [`RASurfaceUserProcess.GetCellCenterAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellCenterAsArray) - * [`RASurfaceUserProcess.GetCellDzAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellDzAsArray) - * [`RASurfaceUserProcess.GetCellFromIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellFromIJK) - * [`RASurfaceUserProcess.GetCellIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellIJK) - * [`RASurfaceUserProcess.GetCellNumberOfVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellNumberOfVertices) - * [`RASurfaceUserProcess.GetCellPointsAsFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellPointsAsFunction) - * [`RASurfaceUserProcess.GetCellVolumeAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellVolumeAsArray) - * [`RASurfaceUserProcess.GetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCenter) - * [`RASurfaceUserProcess.GetCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurve) - * [`RASurfaceUserProcess.GetCurveNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNames) - * [`RASurfaceUserProcess.GetCurveNamesAssociation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNamesAssociation) - * [`RASurfaceUserProcess.GetElementCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetElementCurve) - * [`RASurfaceUserProcess.GetGeometryQuantity()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryQuantity) - * [`RASurfaceUserProcess.GetGeometryUnit()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryUnit) - * [`RASurfaceUserProcess.GetGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunction) - * [`RASurfaceUserProcess.GetGridFunctionNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunctionNames) - * [`RASurfaceUserProcess.GetMeshColoring()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMeshColoring) - * [`RASurfaceUserProcess.GetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMotionFrame) - * [`RASurfaceUserProcess.GetNumberOfCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfCells) - * [`RASurfaceUserProcess.GetNumberOfNodes()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfNodes) - * [`RASurfaceUserProcess.GetNumberOfParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfParticles) - * [`RASurfaceUserProcess.GetNumpyCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumpyCurve) - * [`RASurfaceUserProcess.GetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientation) - * [`RASurfaceUserProcess.GetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngleAndVector) - * [`RASurfaceUserProcess.GetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngles) - * [`RASurfaceUserProcess.GetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromBasisVector) - * [`RASurfaceUserProcess.GetOutputVariableValue()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOutputVariableValue) - * [`RASurfaceUserProcess.GetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetScale) - * [`RASurfaceUserProcess.GetTimeSet()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeSet) - * [`RASurfaceUserProcess.GetTimeStatistics()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStatistics) - * [`RASurfaceUserProcess.GetTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStep) - * [`RASurfaceUserProcess.GetTopologyShape()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTopologyShape) - * [`RASurfaceUserProcess.HasGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.HasGridFunction) - * [`RASurfaceUserProcess.IsCellActive()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IsCellActive) - * [`RASurfaceUserProcess.IterCellVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCellVertices) - * [`RASurfaceUserProcess.IterCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCells) - * [`RASurfaceUserProcess.IterParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterParticles) - * [`RASurfaceUserProcess.Modified()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.Modified) - * [`RASurfaceUserProcess.RemoveCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomCurve) - * [`RASurfaceUserProcess.RemoveCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomProperty) - * [`RASurfaceUserProcess.RemoveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveOutputVariable) - * [`RASurfaceUserProcess.RemoveProcess()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveProcess) - * [`RASurfaceUserProcess.SetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCenter) - * [`RASurfaceUserProcess.SetCurrentTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCurrentTimeStep) - * [`RASurfaceUserProcess.SetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetMotionFrame) - * [`RASurfaceUserProcess.SetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientation) - * [`RASurfaceUserProcess.SetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngleAndVector) - * [`RASurfaceUserProcess.SetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngles) - * [`RASurfaceUserProcess.SetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromBasisVector) - * [`RASurfaceUserProcess.SetSTL()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetSTL) - * [`RASurfaceUserProcess.SetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetScale) - * [RASystemCouplingWall](RASystemCouplingWall.md) - * [`RASystemCouplingWall`](RASystemCouplingWall.md#generated.RASystemCouplingWall) - * [`RASystemCouplingWall.AddCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCurve) - * [`RASystemCouplingWall.AddCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomCurve) - * [`RASystemCouplingWall.AddCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomProperty) - * [`RASystemCouplingWall.AddGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddGridFunction) - * [`RASystemCouplingWall.CreateCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateCurveOutputVariable) - * [`RASystemCouplingWall.CreateGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunction) - * [`RASystemCouplingWall.CreateGridFunctionArrayOnCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionArrayOnCells) - * [`RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable) - * [`RASystemCouplingWall.CreateTransientCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateTransientCurveOutputVariable) - * [`RASystemCouplingWall.DisableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableStructuralCouplingType) - * [`RASystemCouplingWall.DisableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableThermalCouplingType) - * [`RASystemCouplingWall.EditCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomCurve) - * [`RASystemCouplingWall.EditCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomProperty) - * [`RASystemCouplingWall.EnableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableStructuralCouplingType) - * [`RASystemCouplingWall.EnableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableThermalCouplingType) - * [`RASystemCouplingWall.GetActivesArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetActivesArray) - * [`RASystemCouplingWall.GetAvailableMaterials()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetAvailableMaterials) - * [`RASystemCouplingWall.GetBoundingBox()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetBoundingBox) - * [`RASystemCouplingWall.GetCellAreaAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellAreaAsArray) - * [`RASystemCouplingWall.GetCellCenterAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellCenterAsArray) - * [`RASystemCouplingWall.GetCellDzAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellDzAsArray) - * [`RASystemCouplingWall.GetCellFromIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellFromIJK) - * [`RASystemCouplingWall.GetCellIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellIJK) - * [`RASystemCouplingWall.GetCellNumberOfVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellNumberOfVertices) - * [`RASystemCouplingWall.GetCellPointsAsFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellPointsAsFunction) - * [`RASystemCouplingWall.GetCellVolumeAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellVolumeAsArray) - * [`RASystemCouplingWall.GetCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurve) - * [`RASystemCouplingWall.GetCurveNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNames) - * [`RASystemCouplingWall.GetCurveNamesAssociation()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNamesAssociation) - * [`RASystemCouplingWall.GetElementCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetElementCurve) - * [`RASystemCouplingWall.GetGeometryQuantity()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryQuantity) - * [`RASystemCouplingWall.GetGeometryUnit()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryUnit) - * [`RASystemCouplingWall.GetGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunction) - * [`RASystemCouplingWall.GetGridFunctionNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunctionNames) - * [`RASystemCouplingWall.GetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMaterial) - * [`RASystemCouplingWall.GetMeshColoring()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMeshColoring) - * [`RASystemCouplingWall.GetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMotionFrame) - * [`RASystemCouplingWall.GetNumberOfCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfCells) - * [`RASystemCouplingWall.GetNumberOfNodes()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfNodes) - * [`RASystemCouplingWall.GetNumpyCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumpyCurve) - * [`RASystemCouplingWall.GetOutputVariableValue()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetOutputVariableValue) - * [`RASystemCouplingWall.GetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSphBoundaryType) - * [`RASystemCouplingWall.GetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetStructuralCouplingTypeEnabled) - * [`RASystemCouplingWall.GetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSurfaceTensionContactAngle) - * [`RASystemCouplingWall.GetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetThermalCouplingTypeEnabled) - * [`RASystemCouplingWall.GetTimeSet()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeSet) - * [`RASystemCouplingWall.GetTimeStatistics()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStatistics) - * [`RASystemCouplingWall.GetTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStep) - * [`RASystemCouplingWall.GetTopologyShape()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTopologyShape) - * [`RASystemCouplingWall.GetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTriangleSize) - * [`RASystemCouplingWall.GetValidSphBoundaryTypeValues()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues) - * [`RASystemCouplingWall.HasGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasGridFunction) - * [`RASystemCouplingWall.HasMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasMotionFrame) - * [`RASystemCouplingWall.IsCellActive()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsCellActive) - * [`RASystemCouplingWall.IsStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsStructuralCouplingTypeEnabled) - * [`RASystemCouplingWall.IsThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsThermalCouplingTypeEnabled) - * [`RASystemCouplingWall.IterCellVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCellVertices) - * [`RASystemCouplingWall.IterCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCells) - * [`RASystemCouplingWall.Modified()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.Modified) - * [`RASystemCouplingWall.RemoveCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomCurve) - * [`RASystemCouplingWall.RemoveCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomProperty) - * [`RASystemCouplingWall.RemoveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveOutputVariable) - * [`RASystemCouplingWall.RemoveProcess()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveProcess) - * [`RASystemCouplingWall.SetCurrentTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCurrentTimeStep) - * [`RASystemCouplingWall.SetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMaterial) - * [`RASystemCouplingWall.SetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMotionFrame) - * [`RASystemCouplingWall.SetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSphBoundaryType) - * [`RASystemCouplingWall.SetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetStructuralCouplingTypeEnabled) - * [`RASystemCouplingWall.SetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSurfaceTensionContactAngle) - * [`RASystemCouplingWall.SetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetThermalCouplingTypeEnabled) - * [`RASystemCouplingWall.SetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetTriangleSize) - * [RATagging](RATagging.md) - * [`RATagging`](RATagging.md#generated.RATagging) - * [`RATagging.GetGridFunctionName()`](RATagging.md#generated.RATagging.GetGridFunctionName) - * [`RATagging.GetNameMask()`](RATagging.md#generated.RATagging.GetNameMask) - * [`RATagging.GetTagValue()`](RATagging.md#generated.RATagging.GetTagValue) - * [`RATagging.GetTimeRangeFilter()`](RATagging.md#generated.RATagging.GetTimeRangeFilter) - * [`RATagging.SetNameMask()`](RATagging.md#generated.RATagging.SetNameMask) - * [`RATagging.SetTagValue()`](RATagging.md#generated.RATagging.SetTagValue) - * [RAThreeRollsBeltProfile](RAThreeRollsBeltProfile.md) - * [`RAThreeRollsBeltProfile`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile) - * [`RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths) - * [`RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths) - * [`RAThreeRollsBeltProfile.GetAvailableMaterials()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetAvailableMaterials) - * [`RAThreeRollsBeltProfile.GetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetCenterRollLength) - * [`RAThreeRollsBeltProfile.GetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetLowerCornerRadius) - * [`RAThreeRollsBeltProfile.GetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetMaterial) - * [`RAThreeRollsBeltProfile.GetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetTroughingAngle) - * [`RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths) - * [`RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled) - * [`RAThreeRollsBeltProfile.SetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetCenterRollLength) - * [`RAThreeRollsBeltProfile.SetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetLowerCornerRadius) - * [`RAThreeRollsBeltProfile.SetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetMaterial) - * [`RAThreeRollsBeltProfile.SetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetTroughingAngle) - * [`RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths) - * [RATimeRangeFilter](RATimeRangeFilter.md) - * [`RATimeRangeFilter`](RATimeRangeFilter.md#generated.RATimeRangeFilter) - * [`RATimeRangeFilter.GetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetDomainRange) - * [`RATimeRangeFilter.GetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetFinal) - * [`RATimeRangeFilter.GetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetInitial) - * [`RATimeRangeFilter.GetValidDomainRangeValues()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetValidDomainRangeValues) - * [`RATimeRangeFilter.SetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetDomainRange) - * [`RATimeRangeFilter.SetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetFinal) - * [`RATimeRangeFilter.SetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetInitial) - * [RATimeSeriesRotation](RATimeSeriesRotation.md) - * [`RATimeSeriesRotation`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation) - * [`RATimeSeriesRotation.ImportTimeSeriesMotion()`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation.ImportTimeSeriesMotion) - * [RATimeSeriesTranslation](RATimeSeriesTranslation.md) - * [`RATimeSeriesTranslation`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation) - * [`RATimeSeriesTranslation.ImportTimeSeriesMotion()`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation.ImportTimeSeriesMotion) - * [RATrajectoryProcess](RATrajectoryProcess.md) - * [`RATrajectoryProcess`](RATrajectoryProcess.md#generated.RATrajectoryProcess) - * [`RATrajectoryProcess.AddCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCurve) - * [`RATrajectoryProcess.AddCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomCurve) - * [`RATrajectoryProcess.AddCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomProperty) - * [`RATrajectoryProcess.AddGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddGridFunction) - * [`RATrajectoryProcess.CreateCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateCurveOutputVariable) - * [`RATrajectoryProcess.CreateGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunction) - * [`RATrajectoryProcess.CreateGridFunctionArrayOnCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionArrayOnCells) - * [`RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable) - * [`RATrajectoryProcess.CreateTransientCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateTransientCurveOutputVariable) - * [`RATrajectoryProcess.EditCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomCurve) - * [`RATrajectoryProcess.EditCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomProperty) - * [`RATrajectoryProcess.GetActivesArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetActivesArray) - * [`RATrajectoryProcess.GetBoundingBox()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetBoundingBox) - * [`RATrajectoryProcess.GetCellAreaAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellAreaAsArray) - * [`RATrajectoryProcess.GetCellCenterAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellCenterAsArray) - * [`RATrajectoryProcess.GetCellDzAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellDzAsArray) - * [`RATrajectoryProcess.GetCellFromIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellFromIJK) - * [`RATrajectoryProcess.GetCellIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellIJK) - * [`RATrajectoryProcess.GetCellNumberOfVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellNumberOfVertices) - * [`RATrajectoryProcess.GetCellPointsAsFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellPointsAsFunction) - * [`RATrajectoryProcess.GetCellVolumeAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellVolumeAsArray) - * [`RATrajectoryProcess.GetCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurve) - * [`RATrajectoryProcess.GetCurveNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNames) - * [`RATrajectoryProcess.GetCurveNamesAssociation()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNamesAssociation) - * [`RATrajectoryProcess.GetElementCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetElementCurve) - * [`RATrajectoryProcess.GetGeometryQuantity()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryQuantity) - * [`RATrajectoryProcess.GetGeometryUnit()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryUnit) - * [`RATrajectoryProcess.GetGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunction) - * [`RATrajectoryProcess.GetGridFunctionNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunctionNames) - * [`RATrajectoryProcess.GetMeshColoring()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetMeshColoring) - * [`RATrajectoryProcess.GetNumberOfCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfCells) - * [`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.HasGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.HasGridFunction) - * [`RATrajectoryProcess.IsCellActive()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IsCellActive) - * [`RATrajectoryProcess.IterCellVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCellVertices) - * [`RATrajectoryProcess.IterCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCells) - * [`RATrajectoryProcess.IterParticles()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterParticles) - * [`RATrajectoryProcess.Modified()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.Modified) - * [`RATrajectoryProcess.RemoveCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomCurve) - * [`RATrajectoryProcess.RemoveCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomProperty) - * [`RATrajectoryProcess.RemoveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveOutputVariable) - * [`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) - * [`RATranslation.GetAcceleration()`](RATranslation.md#generated.RATranslation.GetAcceleration) - * [`RATranslation.GetFinalVelocity()`](RATranslation.md#generated.RATranslation.GetFinalVelocity) - * [`RATranslation.GetInput()`](RATranslation.md#generated.RATranslation.GetInput) - * [`RATranslation.GetValidInputValues()`](RATranslation.md#generated.RATranslation.GetValidInputValues) - * [`RATranslation.GetVelocity()`](RATranslation.md#generated.RATranslation.GetVelocity) - * [`RATranslation.SetAcceleration()`](RATranslation.md#generated.RATranslation.SetAcceleration) - * [`RATranslation.SetFinalVelocity()`](RATranslation.md#generated.RATranslation.SetFinalVelocity) - * [`RATranslation.SetInput()`](RATranslation.md#generated.RATranslation.SetInput) - * [`RATranslation.SetVelocity()`](RATranslation.md#generated.RATranslation.SetVelocity) - * [RATwoRollsBeltProfile](RATwoRollsBeltProfile.md) - * [`RATwoRollsBeltProfile`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile) - * [`RATwoRollsBeltProfile.GetAvailableMaterials()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetAvailableMaterials) - * [`RATwoRollsBeltProfile.GetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetLowerCornerRadius) - * [`RATwoRollsBeltProfile.GetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetMaterial) - * [`RATwoRollsBeltProfile.GetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetTroughingAngle) - * [`RATwoRollsBeltProfile.SetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetLowerCornerRadius) - * [`RATwoRollsBeltProfile.SetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetMaterial) - * [`RATwoRollsBeltProfile.SetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetTroughingAngle) - * [RAUserProcessCollection](RAUserProcessCollection.md) - * [`RAUserProcessCollection`](RAUserProcessCollection.md#generated.RAUserProcessCollection) - * [`RAUserProcessCollection.CreateContactToParticleProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateContactToParticleProcess) - * [`RAUserProcessCollection.CreateCubeProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCubeProcess) - * [`RAUserProcessCollection.CreateCylinderProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCylinderProcess) - * [`RAUserProcessCollection.CreateEulerianStatistics()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateEulerianStatistics) - * [`RAUserProcessCollection.CreateFilterProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateFilterProcess) - * [`RAUserProcessCollection.CreateInspectorProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateInspectorProcess) - * [`RAUserProcessCollection.CreateParticleTimeSelectionProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleTimeSelectionProcess) - * [`RAUserProcessCollection.CreateParticleToContactProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleToContactProcess) - * [`RAUserProcessCollection.CreatePlaneProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePlaneProcess) - * [`RAUserProcessCollection.CreatePolyhedronProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePolyhedronProcess) - * [`RAUserProcessCollection.CreatePropertyProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePropertyProcess) - * [`RAUserProcessCollection.CreateStreamlinesUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateStreamlinesUserProcess) - * [`RAUserProcessCollection.CreateSurfaceUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateSurfaceUserProcess) - * [`RAUserProcessCollection.CreateTrajectoryProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateTrajectoryProcess) - * [`RAUserProcessCollection.GetContactToParticleProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetContactToParticleProcessNames) - * [`RAUserProcessCollection.GetCubeProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCubeProcessNames) - * [`RAUserProcessCollection.GetCylinderProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCylinderProcessNames) - * [`RAUserProcessCollection.GetEulerianStatisticsNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetEulerianStatisticsNames) - * [`RAUserProcessCollection.GetFilterProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetFilterProcessNames) - * [`RAUserProcessCollection.GetInspectorProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetInspectorProcessNames) - * [`RAUserProcessCollection.GetParticleTimeSelectionProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleTimeSelectionProcessNames) - * [`RAUserProcessCollection.GetParticleToContactProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleToContactProcessNames) - * [`RAUserProcessCollection.GetPlaneProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPlaneProcessNames) - * [`RAUserProcessCollection.GetPolyhedronProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPolyhedronProcessNames) - * [`RAUserProcessCollection.GetProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcess) - * [`RAUserProcessCollection.GetProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcessNames) - * [`RAUserProcessCollection.GetPropertyProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPropertyProcessNames) - * [`RAUserProcessCollection.GetStreamlinesUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetStreamlinesUserProcessNames) - * [`RAUserProcessCollection.GetSurfaceUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetSurfaceUserProcessNames) - * [`RAUserProcessCollection.GetTrajectoryProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetTrajectoryProcessNames) - * [RAVibration](RAVibration.md) - * [`RAVibration`](RAVibration.md#generated.RAVibration) - * [`RAVibration.GetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.GetAmplitudeVariation) - * [`RAVibration.GetDirection()`](RAVibration.md#generated.RAVibration.GetDirection) - * [`RAVibration.GetFrequencyVariation()`](RAVibration.md#generated.RAVibration.GetFrequencyVariation) - * [`RAVibration.GetInitialAmplitude()`](RAVibration.md#generated.RAVibration.GetInitialAmplitude) - * [`RAVibration.GetInitialFrequency()`](RAVibration.md#generated.RAVibration.GetInitialFrequency) - * [`RAVibration.GetInitialPhase()`](RAVibration.md#generated.RAVibration.GetInitialPhase) - * [`RAVibration.SetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.SetAmplitudeVariation) - * [`RAVibration.SetDirection()`](RAVibration.md#generated.RAVibration.SetDirection) - * [`RAVibration.SetFrequencyVariation()`](RAVibration.md#generated.RAVibration.SetFrequencyVariation) - * [`RAVibration.SetInitialAmplitude()`](RAVibration.md#generated.RAVibration.SetInitialAmplitude) - * [`RAVibration.SetInitialFrequency()`](RAVibration.md#generated.RAVibration.SetInitialFrequency) - * [`RAVibration.SetInitialPhase()`](RAVibration.md#generated.RAVibration.SetInitialPhase) - * [RAVolumetricInlet](RAVolumetricInlet.md) - * [`RAVolumetricInlet`](RAVolumetricInlet.md#generated.RAVolumetricInlet) - * [`RAVolumetricInlet.DisablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisablePeriodic) - * [`RAVolumetricInlet.EnablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnablePeriodic) - * [`RAVolumetricInlet.GetAvailableGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetAvailableGeometries) - * [`RAVolumetricInlet.GetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxCenter) - * [`RAVolumetricInlet.GetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxDimensions) - * [`RAVolumetricInlet.GetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGapScaleFactor) - * [`RAVolumetricInlet.GetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGeometries) - * [`RAVolumetricInlet.GetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInitialVelocity) - * [`RAVolumetricInlet.GetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInjectionTime) - * [`RAVolumetricInlet.GetInputPropertiesList()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInputPropertiesList) - * [`RAVolumetricInlet.GetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientation) - * [`RAVolumetricInlet.GetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngleAndVector) - * [`RAVolumetricInlet.GetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngles) - * [`RAVolumetricInlet.GetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromBasisVector) - * [`RAVolumetricInlet.GetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriod) - * [`RAVolumetricInlet.GetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriodic) - * [`RAVolumetricInlet.GetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSeedCoordinates) - * [`RAVolumetricInlet.GetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphMass) - * [`RAVolumetricInlet.GetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphTemperature) - * [`RAVolumetricInlet.GetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetStopTime) - * [`RAVolumetricInlet.GetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseGeometriesToCompute) - * [`RAVolumetricInlet.IsPeriodicEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled) - * [`RAVolumetricInlet.SetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxCenter) - * [`RAVolumetricInlet.SetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxDimensions) - * [`RAVolumetricInlet.SetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGapScaleFactor) - * [`RAVolumetricInlet.SetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGeometries) - * [`RAVolumetricInlet.SetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInitialVelocity) - * [`RAVolumetricInlet.SetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInjectionTime) - * [`RAVolumetricInlet.SetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientation) - * [`RAVolumetricInlet.SetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngleAndVector) - * [`RAVolumetricInlet.SetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngles) - * [`RAVolumetricInlet.SetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromBasisVector) - * [`RAVolumetricInlet.SetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriod) - * [`RAVolumetricInlet.SetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriodic) - * [`RAVolumetricInlet.SetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSeedCoordinates) - * [`RAVolumetricInlet.SetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphMass) - * [`RAVolumetricInlet.SetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphTemperature) - * [`RAVolumetricInlet.SetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetStopTime) - * [`RAVolumetricInlet.SetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseGeometriesToCompute) - * [RAVolumetricInletProperties](RAVolumetricInletProperties.md) - * [`RAVolumetricInletProperties`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties) - * [`RAVolumetricInletProperties.GetAvailableParticles()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetAvailableParticles) - * [`RAVolumetricInletProperties.GetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetMass) - * [`RAVolumetricInletProperties.GetModuleProperties()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperties) - * [`RAVolumetricInletProperties.GetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperty) - * [`RAVolumetricInletProperties.GetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetParticle) - * [`RAVolumetricInletProperties.GetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetTemperature) - * [`RAVolumetricInletProperties.GetValidOptionsForModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetValidOptionsForModuleProperty) - * [`RAVolumetricInletProperties.SetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetMass) - * [`RAVolumetricInletProperties.SetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetModuleProperty) - * [`RAVolumetricInletProperties.SetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetParticle) - * [`RAVolumetricInletProperties.SetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetTemperature) - * [RAVolumetricInletPropertiesList](RAVolumetricInletPropertiesList.md) - * [`RAVolumetricInletPropertiesList`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList) - * [`RAVolumetricInletPropertiesList.Clear()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Clear) - * [`RAVolumetricInletPropertiesList.New()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.New) - * [`RAVolumetricInletPropertiesList.Remove()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Remove) - * [RAWall](RAWall.md) - * [`RAWall`](RAWall.md#generated.RAWall) - * [`RAWall.AddCurve()`](RAWall.md#generated.RAWall.AddCurve) - * [`RAWall.AddCustomCurve()`](RAWall.md#generated.RAWall.AddCustomCurve) - * [`RAWall.AddCustomProperty()`](RAWall.md#generated.RAWall.AddCustomProperty) - * [`RAWall.AddGridFunction()`](RAWall.md#generated.RAWall.AddGridFunction) - * [`RAWall.CreateCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateCurveOutputVariable) - * [`RAWall.CreateGridFunction()`](RAWall.md#generated.RAWall.CreateGridFunction) - * [`RAWall.CreateGridFunctionArrayOnCells()`](RAWall.md#generated.RAWall.CreateGridFunctionArrayOnCells) - * [`RAWall.CreateGridFunctionStatisticOutputVariable()`](RAWall.md#generated.RAWall.CreateGridFunctionStatisticOutputVariable) - * [`RAWall.CreateTransientCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateTransientCurveOutputVariable) - * [`RAWall.EditCustomCurve()`](RAWall.md#generated.RAWall.EditCustomCurve) - * [`RAWall.EditCustomProperty()`](RAWall.md#generated.RAWall.EditCustomProperty) - * [`RAWall.GetActivesArray()`](RAWall.md#generated.RAWall.GetActivesArray) - * [`RAWall.GetAvailableMaterials()`](RAWall.md#generated.RAWall.GetAvailableMaterials) - * [`RAWall.GetBoundaryMass()`](RAWall.md#generated.RAWall.GetBoundaryMass) - * [`RAWall.GetBoundingBox()`](RAWall.md#generated.RAWall.GetBoundingBox) - * [`RAWall.GetCellAreaAsArray()`](RAWall.md#generated.RAWall.GetCellAreaAsArray) - * [`RAWall.GetCellCenterAsArray()`](RAWall.md#generated.RAWall.GetCellCenterAsArray) - * [`RAWall.GetCellDzAsArray()`](RAWall.md#generated.RAWall.GetCellDzAsArray) - * [`RAWall.GetCellFromIJK()`](RAWall.md#generated.RAWall.GetCellFromIJK) - * [`RAWall.GetCellIJK()`](RAWall.md#generated.RAWall.GetCellIJK) - * [`RAWall.GetCellNumberOfVertices()`](RAWall.md#generated.RAWall.GetCellNumberOfVertices) - * [`RAWall.GetCellPointsAsFunction()`](RAWall.md#generated.RAWall.GetCellPointsAsFunction) - * [`RAWall.GetCellVolumeAsArray()`](RAWall.md#generated.RAWall.GetCellVolumeAsArray) - * [`RAWall.GetCurve()`](RAWall.md#generated.RAWall.GetCurve) - * [`RAWall.GetCurveNames()`](RAWall.md#generated.RAWall.GetCurveNames) - * [`RAWall.GetCurveNamesAssociation()`](RAWall.md#generated.RAWall.GetCurveNamesAssociation) - * [`RAWall.GetDisableTime()`](RAWall.md#generated.RAWall.GetDisableTime) - * [`RAWall.GetElementCurve()`](RAWall.md#generated.RAWall.GetElementCurve) - * [`RAWall.GetEnableTime()`](RAWall.md#generated.RAWall.GetEnableTime) - * [`RAWall.GetGeometryQuantity()`](RAWall.md#generated.RAWall.GetGeometryQuantity) - * [`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) - * [`RAWall.GetModuleProperty()`](RAWall.md#generated.RAWall.GetModuleProperty) - * [`RAWall.GetMomentXDirection()`](RAWall.md#generated.RAWall.GetMomentXDirection) - * [`RAWall.GetMomentYDirection()`](RAWall.md#generated.RAWall.GetMomentYDirection) - * [`RAWall.GetMomentZDirection()`](RAWall.md#generated.RAWall.GetMomentZDirection) - * [`RAWall.GetNumberOfCells()`](RAWall.md#generated.RAWall.GetNumberOfCells) - * [`RAWall.GetNumberOfNodes()`](RAWall.md#generated.RAWall.GetNumberOfNodes) - * [`RAWall.GetNumberOfReplications()`](RAWall.md#generated.RAWall.GetNumberOfReplications) - * [`RAWall.GetNumpyCurve()`](RAWall.md#generated.RAWall.GetNumpyCurve) - * [`RAWall.GetOrientation()`](RAWall.md#generated.RAWall.GetOrientation) - * [`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) - * [`RAWall.GetPrincipalMomentOfInertia()`](RAWall.md#generated.RAWall.GetPrincipalMomentOfInertia) - * [`RAWall.GetReplicateGeometry()`](RAWall.md#generated.RAWall.GetReplicateGeometry) - * [`RAWall.GetReplicateTime()`](RAWall.md#generated.RAWall.GetReplicateTime) - * [`RAWall.GetSphBoundaryType()`](RAWall.md#generated.RAWall.GetSphBoundaryType) - * [`RAWall.GetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.GetSurfaceTensionContactAngle) - * [`RAWall.GetTemperature()`](RAWall.md#generated.RAWall.GetTemperature) - * [`RAWall.GetThermalBoundaryConditionType()`](RAWall.md#generated.RAWall.GetThermalBoundaryConditionType) - * [`RAWall.GetTimeSet()`](RAWall.md#generated.RAWall.GetTimeSet) - * [`RAWall.GetTimeStatistics()`](RAWall.md#generated.RAWall.GetTimeStatistics) - * [`RAWall.GetTimeStep()`](RAWall.md#generated.RAWall.GetTimeStep) - * [`RAWall.GetTopologyShape()`](RAWall.md#generated.RAWall.GetTopologyShape) - * [`RAWall.GetTranslation()`](RAWall.md#generated.RAWall.GetTranslation) - * [`RAWall.GetTriangleSize()`](RAWall.md#generated.RAWall.GetTriangleSize) - * [`RAWall.GetValidOptionsForModuleProperty()`](RAWall.md#generated.RAWall.GetValidOptionsForModuleProperty) - * [`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.GetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.GetVolumeShearWorkRatio) - * [`RAWall.GetWearModel()`](RAWall.md#generated.RAWall.GetWearModel) - * [`RAWall.HasGridFunction()`](RAWall.md#generated.RAWall.HasGridFunction) - * [`RAWall.HasMotionFrame()`](RAWall.md#generated.RAWall.HasMotionFrame) - * [`RAWall.IsCellActive()`](RAWall.md#generated.RAWall.IsCellActive) - * [`RAWall.IterCellVertices()`](RAWall.md#generated.RAWall.IterCellVertices) - * [`RAWall.IterCells()`](RAWall.md#generated.RAWall.IterCells) - * [`RAWall.LoadFile()`](RAWall.md#generated.RAWall.LoadFile) - * [`RAWall.Modified()`](RAWall.md#generated.RAWall.Modified) - * [`RAWall.OrientationAnglesOrder`](RAWall.md#generated.RAWall.OrientationAnglesOrder) - * [`RAWall.RemoveCustomCurve()`](RAWall.md#generated.RAWall.RemoveCustomCurve) - * [`RAWall.RemoveCustomProperty()`](RAWall.md#generated.RAWall.RemoveCustomProperty) - * [`RAWall.RemoveOutputVariable()`](RAWall.md#generated.RAWall.RemoveOutputVariable) - * [`RAWall.RemoveProcess()`](RAWall.md#generated.RAWall.RemoveProcess) - * [`RAWall.SetBoundaryMass()`](RAWall.md#generated.RAWall.SetBoundaryMass) - * [`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.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) - * [`RAWall.SetReplicateGeometry()`](RAWall.md#generated.RAWall.SetReplicateGeometry) - * [`RAWall.SetReplicateTime()`](RAWall.md#generated.RAWall.SetReplicateTime) - * [`RAWall.SetSphBoundaryType()`](RAWall.md#generated.RAWall.SetSphBoundaryType) - * [`RAWall.SetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.SetSurfaceTensionContactAngle) - * [`RAWall.SetTemperature()`](RAWall.md#generated.RAWall.SetTemperature) - * [`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) - * [Added](changelog.md#added) - * [New Methods](changelog.md#new-methods) - * [New Classes](changelog.md#new-classes) - * [Changed](changelog.md#changed) - * [Deprecated](changelog.md#deprecated) - * [Removed](changelog.md#removed) + + +# Rocky PrePost Scripting Help + +# Contents: + +* [Introduction](basic-usage.md) +* [Getting Started](getting-started.md) + * [Setting Up a Project](getting-started.md#setting-up-a-project) + * [Post-Processing Results](getting-started.md#post-processing-results) +* [Using VScode to Create/Edit Scripts](setup-ide.md) +* [Class Reference](prepost-scripting-reference.md) + * [RAAirFlow](RAAirFlow.md) + * [`RAAirFlow`](RAAirFlow.md#generated.RAAirFlow) + * [`RAAirFlow.AddCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCurve) + * [`RAAirFlow.AddCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCustomCurve) + * [`RAAirFlow.AddCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.AddCustomProperty) + * [`RAAirFlow.AddGridFunction()`](RAAirFlow.md#generated.RAAirFlow.AddGridFunction) + * [`RAAirFlow.CreateCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateCurveOutputVariable) + * [`RAAirFlow.CreateGridFunction()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunction) + * [`RAAirFlow.CreateGridFunctionArrayOnCells()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionArrayOnCells) + * [`RAAirFlow.CreateGridFunctionStatisticOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionStatisticOutputVariable) + * [`RAAirFlow.CreateTransientCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateTransientCurveOutputVariable) + * [`RAAirFlow.EditCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.EditCustomCurve) + * [`RAAirFlow.EditCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.EditCustomProperty) + * [`RAAirFlow.GetActivesArray()`](RAAirFlow.md#generated.RAAirFlow.GetActivesArray) + * [`RAAirFlow.GetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.GetAirDensity) + * [`RAAirFlow.GetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.GetAirKinematicViscosity) + * [`RAAirFlow.GetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.GetBoundaryConditionType) + * [`RAAirFlow.GetBoundingBox()`](RAAirFlow.md#generated.RAAirFlow.GetBoundingBox) + * [`RAAirFlow.GetCellAreaAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellAreaAsArray) + * [`RAAirFlow.GetCellCenterAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellCenterAsArray) + * [`RAAirFlow.GetCellDzAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellDzAsArray) + * [`RAAirFlow.GetCellFromIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellFromIJK) + * [`RAAirFlow.GetCellIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellIJK) + * [`RAAirFlow.GetCellNumberOfVertices()`](RAAirFlow.md#generated.RAAirFlow.GetCellNumberOfVertices) + * [`RAAirFlow.GetCellPointsAsFunction()`](RAAirFlow.md#generated.RAAirFlow.GetCellPointsAsFunction) + * [`RAAirFlow.GetCellSize()`](RAAirFlow.md#generated.RAAirFlow.GetCellSize) + * [`RAAirFlow.GetCellVolumeAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellVolumeAsArray) + * [`RAAirFlow.GetCurve()`](RAAirFlow.md#generated.RAAirFlow.GetCurve) + * [`RAAirFlow.GetCurveNames()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNames) + * [`RAAirFlow.GetCurveNamesAssociation()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNamesAssociation) + * [`RAAirFlow.GetElementCurve()`](RAAirFlow.md#generated.RAAirFlow.GetElementCurve) + * [`RAAirFlow.GetGeometryQuantity()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryQuantity) + * [`RAAirFlow.GetGeometryUnit()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryUnit) + * [`RAAirFlow.GetGridFunction()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunction) + * [`RAAirFlow.GetGridFunctionNames()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunctionNames) + * [`RAAirFlow.GetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.GetInteractionScale) + * [`RAAirFlow.GetMaxX()`](RAAirFlow.md#generated.RAAirFlow.GetMaxX) + * [`RAAirFlow.GetMaxY()`](RAAirFlow.md#generated.RAAirFlow.GetMaxY) + * [`RAAirFlow.GetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.GetMaxZ) + * [`RAAirFlow.GetMeshColoring()`](RAAirFlow.md#generated.RAAirFlow.GetMeshColoring) + * [`RAAirFlow.GetMinX()`](RAAirFlow.md#generated.RAAirFlow.GetMinX) + * [`RAAirFlow.GetMinY()`](RAAirFlow.md#generated.RAAirFlow.GetMinY) + * [`RAAirFlow.GetMinZ()`](RAAirFlow.md#generated.RAAirFlow.GetMinZ) + * [`RAAirFlow.GetNumberOfCells()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfCells) + * [`RAAirFlow.GetNumberOfNodes()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfNodes) + * [`RAAirFlow.GetNumpyCurve()`](RAAirFlow.md#generated.RAAirFlow.GetNumpyCurve) + * [`RAAirFlow.GetOutputVariableValue()`](RAAirFlow.md#generated.RAAirFlow.GetOutputVariableValue) + * [`RAAirFlow.GetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.GetSpeedOfSound) + * [`RAAirFlow.GetStartTime()`](RAAirFlow.md#generated.RAAirFlow.GetStartTime) + * [`RAAirFlow.GetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.GetStartWhenParticlesEnter) + * [`RAAirFlow.GetTimeSet()`](RAAirFlow.md#generated.RAAirFlow.GetTimeSet) + * [`RAAirFlow.GetTimeStatistics()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStatistics) + * [`RAAirFlow.GetTimeStep()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStep) + * [`RAAirFlow.GetTopologyShape()`](RAAirFlow.md#generated.RAAirFlow.GetTopologyShape) + * [`RAAirFlow.GetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.GetUseAirflow) + * [`RAAirFlow.GetValidBoundaryConditionTypeValues()`](RAAirFlow.md#generated.RAAirFlow.GetValidBoundaryConditionTypeValues) + * [`RAAirFlow.HasGridFunction()`](RAAirFlow.md#generated.RAAirFlow.HasGridFunction) + * [`RAAirFlow.IsCellActive()`](RAAirFlow.md#generated.RAAirFlow.IsCellActive) + * [`RAAirFlow.IterCellVertices()`](RAAirFlow.md#generated.RAAirFlow.IterCellVertices) + * [`RAAirFlow.IterCells()`](RAAirFlow.md#generated.RAAirFlow.IterCells) + * [`RAAirFlow.Modified()`](RAAirFlow.md#generated.RAAirFlow.Modified) + * [`RAAirFlow.RemoveCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomCurve) + * [`RAAirFlow.RemoveCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomProperty) + * [`RAAirFlow.RemoveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.RemoveOutputVariable) + * [`RAAirFlow.RemoveProcess()`](RAAirFlow.md#generated.RAAirFlow.RemoveProcess) + * [`RAAirFlow.SetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.SetAirDensity) + * [`RAAirFlow.SetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.SetAirKinematicViscosity) + * [`RAAirFlow.SetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.SetBoundaryConditionType) + * [`RAAirFlow.SetCellSize()`](RAAirFlow.md#generated.RAAirFlow.SetCellSize) + * [`RAAirFlow.SetCurrentTimeStep()`](RAAirFlow.md#generated.RAAirFlow.SetCurrentTimeStep) + * [`RAAirFlow.SetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.SetInteractionScale) + * [`RAAirFlow.SetMaxX()`](RAAirFlow.md#generated.RAAirFlow.SetMaxX) + * [`RAAirFlow.SetMaxY()`](RAAirFlow.md#generated.RAAirFlow.SetMaxY) + * [`RAAirFlow.SetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.SetMaxZ) + * [`RAAirFlow.SetMinX()`](RAAirFlow.md#generated.RAAirFlow.SetMinX) + * [`RAAirFlow.SetMinY()`](RAAirFlow.md#generated.RAAirFlow.SetMinY) + * [`RAAirFlow.SetMinZ()`](RAAirFlow.md#generated.RAAirFlow.SetMinZ) + * [`RAAirFlow.SetPartIdIfValid()`](RAAirFlow.md#generated.RAAirFlow.SetPartIdIfValid) + * [`RAAirFlow.SetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.SetSpeedOfSound) + * [`RAAirFlow.SetStartTime()`](RAAirFlow.md#generated.RAAirFlow.SetStartTime) + * [`RAAirFlow.SetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.SetStartWhenParticlesEnter) + * [`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) + * [`RACFDParametersList`](RACFDParametersList.md#generated.RACFDParametersList) + * [`RACFDParametersList.Clear()`](RACFDParametersList.md#generated.RACFDParametersList.Clear) + * [`RACFDParametersList.GetParametersFor()`](RACFDParametersList.md#generated.RACFDParametersList.GetParametersFor) + * [`RACFDParametersList.New()`](RACFDParametersList.md#generated.RACFDParametersList.New) + * [`RACFDParametersList.Remove()`](RACFDParametersList.md#generated.RACFDParametersList.Remove) + * [RACFDPerParticleParameters](RACFDPerParticleParameters.md) + * [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + * [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) + * [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) + * [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) + * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) + * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) + * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) + * [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) + * [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) + * [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) + * [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) + * [`RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues) + * [`RACFDPerParticleParameters.GetValidDragLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidDragLawValues) + * [`RACFDPerParticleParameters.GetValidLiftLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidLiftLawValues) + * [`RACFDPerParticleParameters.GetValidTorqueLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidTorqueLawValues) + * [`RACFDPerParticleParameters.GetValidVirtualMassLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidVirtualMassLawValues) + * [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) + * [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) + * [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) + * [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) + * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) + * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) + * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) + * [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) + * [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) + * [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) + * [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) + * [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) + * [RACalculations](RACalculations.md) + * [`RACalculations`](RACalculations.md#generated.RACalculations) + * [`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) + * [`RACalculations.GetTagging()`](RACalculations.md#generated.RACalculations.GetTagging) + * [`RACalculations.GetTaggingNames()`](RACalculations.md#generated.RACalculations.GetTaggingNames) + * [RACircularSurface](RACircularSurface.md) + * [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface) + * [`RACircularSurface.AddCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCurve) + * [`RACircularSurface.AddCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCustomCurve) + * [`RACircularSurface.AddCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.AddCustomProperty) + * [`RACircularSurface.AddGridFunction()`](RACircularSurface.md#generated.RACircularSurface.AddGridFunction) + * [`RACircularSurface.CreateCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateCurveOutputVariable) + * [`RACircularSurface.CreateGridFunction()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunction) + * [`RACircularSurface.CreateGridFunctionArrayOnCells()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionArrayOnCells) + * [`RACircularSurface.CreateGridFunctionStatisticOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionStatisticOutputVariable) + * [`RACircularSurface.CreateTransientCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateTransientCurveOutputVariable) + * [`RACircularSurface.EditCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.EditCustomCurve) + * [`RACircularSurface.EditCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.EditCustomProperty) + * [`RACircularSurface.GetActivesArray()`](RACircularSurface.md#generated.RACircularSurface.GetActivesArray) + * [`RACircularSurface.GetBoundingBox()`](RACircularSurface.md#generated.RACircularSurface.GetBoundingBox) + * [`RACircularSurface.GetCellAreaAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellAreaAsArray) + * [`RACircularSurface.GetCellCenterAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellCenterAsArray) + * [`RACircularSurface.GetCellDzAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellDzAsArray) + * [`RACircularSurface.GetCellFromIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellFromIJK) + * [`RACircularSurface.GetCellIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellIJK) + * [`RACircularSurface.GetCellNumberOfVertices()`](RACircularSurface.md#generated.RACircularSurface.GetCellNumberOfVertices) + * [`RACircularSurface.GetCellPointsAsFunction()`](RACircularSurface.md#generated.RACircularSurface.GetCellPointsAsFunction) + * [`RACircularSurface.GetCellVolumeAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellVolumeAsArray) + * [`RACircularSurface.GetCenter()`](RACircularSurface.md#generated.RACircularSurface.GetCenter) + * [`RACircularSurface.GetCurve()`](RACircularSurface.md#generated.RACircularSurface.GetCurve) + * [`RACircularSurface.GetCurveNames()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNames) + * [`RACircularSurface.GetCurveNamesAssociation()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNamesAssociation) + * [`RACircularSurface.GetElementCurve()`](RACircularSurface.md#generated.RACircularSurface.GetElementCurve) + * [`RACircularSurface.GetGeometryQuantity()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryQuantity) + * [`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.GetNumberOfCells()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfCells) + * [`RACircularSurface.GetNumberOfNodes()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfNodes) + * [`RACircularSurface.GetNumpyCurve()`](RACircularSurface.md#generated.RACircularSurface.GetNumpyCurve) + * [`RACircularSurface.GetOrientation()`](RACircularSurface.md#generated.RACircularSurface.GetOrientation) + * [`RACircularSurface.GetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngleAndVector) + * [`RACircularSurface.GetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngles) + * [`RACircularSurface.GetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromBasisVector) + * [`RACircularSurface.GetOutputVariableValue()`](RACircularSurface.md#generated.RACircularSurface.GetOutputVariableValue) + * [`RACircularSurface.GetTimeSet()`](RACircularSurface.md#generated.RACircularSurface.GetTimeSet) + * [`RACircularSurface.GetTimeStatistics()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStatistics) + * [`RACircularSurface.GetTimeStep()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStep) + * [`RACircularSurface.GetTopologyShape()`](RACircularSurface.md#generated.RACircularSurface.GetTopologyShape) + * [`RACircularSurface.HasGridFunction()`](RACircularSurface.md#generated.RACircularSurface.HasGridFunction) + * [`RACircularSurface.HasMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.HasMotionFrame) + * [`RACircularSurface.IsCellActive()`](RACircularSurface.md#generated.RACircularSurface.IsCellActive) + * [`RACircularSurface.IterCellVertices()`](RACircularSurface.md#generated.RACircularSurface.IterCellVertices) + * [`RACircularSurface.IterCells()`](RACircularSurface.md#generated.RACircularSurface.IterCells) + * [`RACircularSurface.Modified()`](RACircularSurface.md#generated.RACircularSurface.Modified) + * [`RACircularSurface.RemoveCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomCurve) + * [`RACircularSurface.RemoveCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomProperty) + * [`RACircularSurface.RemoveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.RemoveOutputVariable) + * [`RACircularSurface.RemoveProcess()`](RACircularSurface.md#generated.RACircularSurface.RemoveProcess) + * [`RACircularSurface.SetCenter()`](RACircularSurface.md#generated.RACircularSurface.SetCenter) + * [`RACircularSurface.SetCurrentTimeStep()`](RACircularSurface.md#generated.RACircularSurface.SetCurrentTimeStep) + * [`RACircularSurface.SetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMaxRadius) + * [`RACircularSurface.SetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMinRadius) + * [`RACircularSurface.SetOrientation()`](RACircularSurface.md#generated.RACircularSurface.SetOrientation) + * [`RACircularSurface.SetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngleAndVector) + * [`RACircularSurface.SetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngles) + * [`RACircularSurface.SetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromBasisVector) + * [RAConeCrusherFrame](RAConeCrusherFrame.md) + * [`RAConeCrusherFrame`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) + * [`RAConeCrusherFrame.GetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetInitialOrientation) + * [`RAConeCrusherFrame.GetMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetMotionFrame) + * [`RAConeCrusherFrame.GetParentMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetParentMotionFrame) + * [`RAConeCrusherFrame.GetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetPivotPoint) + * [`RAConeCrusherFrame.GetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationAxis) + * [`RAConeCrusherFrame.GetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationalVelocity) + * [`RAConeCrusherFrame.GetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStartTime) + * [`RAConeCrusherFrame.GetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStopTime) + * [`RAConeCrusherFrame.IterMotionFrames()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.IterMotionFrames) + * [`RAConeCrusherFrame.NewConeCrusherFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewConeCrusherFrame) + * [`RAConeCrusherFrame.NewFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewFrame) + * [`RAConeCrusherFrame.RemoveFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.RemoveFrame) + * [`RAConeCrusherFrame.SetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetInitialOrientation) + * [`RAConeCrusherFrame.SetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetPivotPoint) + * [`RAConeCrusherFrame.SetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationAxis) + * [`RAConeCrusherFrame.SetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationalVelocity) + * [`RAConeCrusherFrame.SetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStartTime) + * [`RAConeCrusherFrame.SetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStopTime) + * [RAConstantOneWayCoupling](RAConstantOneWayCoupling.md) + * [`RAConstantOneWayCoupling`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling) + * [`RAConstantOneWayCoupling.AddCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCurve) + * [`RAConstantOneWayCoupling.AddCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomCurve) + * [`RAConstantOneWayCoupling.AddCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomProperty) + * [`RAConstantOneWayCoupling.AddGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddGridFunction) + * [`RAConstantOneWayCoupling.CreateCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateCurveOutputVariable) + * [`RAConstantOneWayCoupling.CreateGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunction) + * [`RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells) + * [`RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable) + * [`RAConstantOneWayCoupling.CreateTransientCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateTransientCurveOutputVariable) + * [`RAConstantOneWayCoupling.DisableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.DisableTurbulentDispersion) + * [`RAConstantOneWayCoupling.EditCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomCurve) + * [`RAConstantOneWayCoupling.EditCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomProperty) + * [`RAConstantOneWayCoupling.EnableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EnableTurbulentDispersion) + * [`RAConstantOneWayCoupling.GetActivesArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetActivesArray) + * [`RAConstantOneWayCoupling.GetBoundingBox()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetBoundingBox) + * [`RAConstantOneWayCoupling.GetCFDParametersList()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCFDParametersList) + * [`RAConstantOneWayCoupling.GetCellAreaAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellAreaAsArray) + * [`RAConstantOneWayCoupling.GetCellCenterAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellCenterAsArray) + * [`RAConstantOneWayCoupling.GetCellDzAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellDzAsArray) + * [`RAConstantOneWayCoupling.GetCellFromIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellFromIJK) + * [`RAConstantOneWayCoupling.GetCellIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellIJK) + * [`RAConstantOneWayCoupling.GetCellNumberOfVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellNumberOfVertices) + * [`RAConstantOneWayCoupling.GetCellPointsAsFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellPointsAsFunction) + * [`RAConstantOneWayCoupling.GetCellVolumeAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellVolumeAsArray) + * [`RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw) + * [`RAConstantOneWayCoupling.GetCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurve) + * [`RAConstantOneWayCoupling.GetCurveNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNames) + * [`RAConstantOneWayCoupling.GetCurveNamesAssociation()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNamesAssociation) + * [`RAConstantOneWayCoupling.GetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDensity) + * [`RAConstantOneWayCoupling.GetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDragLaw) + * [`RAConstantOneWayCoupling.GetElementCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetElementCurve) + * [`RAConstantOneWayCoupling.GetGeometryQuantity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryQuantity) + * [`RAConstantOneWayCoupling.GetGeometryUnit()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryUnit) + * [`RAConstantOneWayCoupling.GetGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunction) + * [`RAConstantOneWayCoupling.GetGridFunctionNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunctionNames) + * [`RAConstantOneWayCoupling.GetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetLiftLaw) + * [`RAConstantOneWayCoupling.GetMeshColoring()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMeshColoring) + * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK1) + * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK2) + * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK3) + * [`RAConstantOneWayCoupling.GetNumberOfCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfCells) + * [`RAConstantOneWayCoupling.GetNumberOfNodes()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfNodes) + * [`RAConstantOneWayCoupling.GetNumpyCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumpyCurve) + * [`RAConstantOneWayCoupling.GetOutputVariableValue()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetOutputVariableValue) + * [`RAConstantOneWayCoupling.GetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSpecificHeat) + * [`RAConstantOneWayCoupling.GetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetStartTime) + * [`RAConstantOneWayCoupling.GetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienC1) + * [`RAConstantOneWayCoupling.GetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienD1) + * [`RAConstantOneWayCoupling.GetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTemperature) + * [`RAConstantOneWayCoupling.GetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetThermalConductivity) + * [`RAConstantOneWayCoupling.GetTimeSet()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeSet) + * [`RAConstantOneWayCoupling.GetTimeStatistics()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStatistics) + * [`RAConstantOneWayCoupling.GetTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStep) + * [`RAConstantOneWayCoupling.GetTopologyShape()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTopologyShape) + * [`RAConstantOneWayCoupling.GetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTorqueLaw) + * [`RAConstantOneWayCoupling.GetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentDissipationRate) + * [`RAConstantOneWayCoupling.GetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentKineticEnergy) + * [`RAConstantOneWayCoupling.GetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion) + * [`RAConstantOneWayCoupling.GetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants) + * [`RAConstantOneWayCoupling.GetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVelocity) + * [`RAConstantOneWayCoupling.GetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVirtualMassLaw) + * [`RAConstantOneWayCoupling.GetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetViscosity) + * [`RAConstantOneWayCoupling.HasGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.HasGridFunction) + * [`RAConstantOneWayCoupling.IsCellActive()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsCellActive) + * [`RAConstantOneWayCoupling.IsTurbulentDispersionEnabled()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsTurbulentDispersionEnabled) + * [`RAConstantOneWayCoupling.IterCellVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCellVertices) + * [`RAConstantOneWayCoupling.IterCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCells) + * [`RAConstantOneWayCoupling.Modified()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.Modified) + * [`RAConstantOneWayCoupling.RemoveCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomCurve) + * [`RAConstantOneWayCoupling.RemoveCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomProperty) + * [`RAConstantOneWayCoupling.RemoveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveOutputVariable) + * [`RAConstantOneWayCoupling.RemoveProcess()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveProcess) + * [`RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw) + * [`RAConstantOneWayCoupling.SetCurrentTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetCurrentTimeStep) + * [`RAConstantOneWayCoupling.SetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDensity) + * [`RAConstantOneWayCoupling.SetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDragLaw) + * [`RAConstantOneWayCoupling.SetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetLiftLaw) + * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK1) + * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK2) + * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK3) + * [`RAConstantOneWayCoupling.SetPartIdIfValid()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetPartIdIfValid) + * [`RAConstantOneWayCoupling.SetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSpecificHeat) + * [`RAConstantOneWayCoupling.SetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetStartTime) + * [`RAConstantOneWayCoupling.SetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienC1) + * [`RAConstantOneWayCoupling.SetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienD1) + * [`RAConstantOneWayCoupling.SetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTemperature) + * [`RAConstantOneWayCoupling.SetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetThermalConductivity) + * [`RAConstantOneWayCoupling.SetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTorqueLaw) + * [`RAConstantOneWayCoupling.SetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentDissipationRate) + * [`RAConstantOneWayCoupling.SetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentKineticEnergy) + * [`RAConstantOneWayCoupling.SetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseTurbulentDispersion) + * [`RAConstantOneWayCoupling.SetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseUserDefinedConstants) + * [`RAConstantOneWayCoupling.SetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVelocity) + * [`RAConstantOneWayCoupling.SetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVirtualMassLaw) + * [`RAConstantOneWayCoupling.SetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetViscosity) + * [RAContactData](RAContactData.md) + * [`RAContactData`](RAContactData.md#generated.RAContactData) + * [`RAContactData.AddCurve()`](RAContactData.md#generated.RAContactData.AddCurve) + * [`RAContactData.AddCustomCurve()`](RAContactData.md#generated.RAContactData.AddCustomCurve) + * [`RAContactData.AddCustomProperty()`](RAContactData.md#generated.RAContactData.AddCustomProperty) + * [`RAContactData.AddGridFunction()`](RAContactData.md#generated.RAContactData.AddGridFunction) + * [`RAContactData.CreateCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateCurveOutputVariable) + * [`RAContactData.CreateGridFunction()`](RAContactData.md#generated.RAContactData.CreateGridFunction) + * [`RAContactData.CreateGridFunctionArrayOnCells()`](RAContactData.md#generated.RAContactData.CreateGridFunctionArrayOnCells) + * [`RAContactData.CreateGridFunctionStatisticOutputVariable()`](RAContactData.md#generated.RAContactData.CreateGridFunctionStatisticOutputVariable) + * [`RAContactData.CreateTransientCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateTransientCurveOutputVariable) + * [`RAContactData.DisableCollectContactsData()`](RAContactData.md#generated.RAContactData.DisableCollectContactsData) + * [`RAContactData.DisableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.DisableIncludeAdhesiveContacts) + * [`RAContactData.EditCustomCurve()`](RAContactData.md#generated.RAContactData.EditCustomCurve) + * [`RAContactData.EditCustomProperty()`](RAContactData.md#generated.RAContactData.EditCustomProperty) + * [`RAContactData.EnableCollectContactsData()`](RAContactData.md#generated.RAContactData.EnableCollectContactsData) + * [`RAContactData.EnableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.EnableIncludeAdhesiveContacts) + * [`RAContactData.GetActivesArray()`](RAContactData.md#generated.RAContactData.GetActivesArray) + * [`RAContactData.GetBoundingBox()`](RAContactData.md#generated.RAContactData.GetBoundingBox) + * [`RAContactData.GetCellAreaAsArray()`](RAContactData.md#generated.RAContactData.GetCellAreaAsArray) + * [`RAContactData.GetCellCenterAsArray()`](RAContactData.md#generated.RAContactData.GetCellCenterAsArray) + * [`RAContactData.GetCellDzAsArray()`](RAContactData.md#generated.RAContactData.GetCellDzAsArray) + * [`RAContactData.GetCellFromIJK()`](RAContactData.md#generated.RAContactData.GetCellFromIJK) + * [`RAContactData.GetCellIJK()`](RAContactData.md#generated.RAContactData.GetCellIJK) + * [`RAContactData.GetCellNumberOfVertices()`](RAContactData.md#generated.RAContactData.GetCellNumberOfVertices) + * [`RAContactData.GetCellPointsAsFunction()`](RAContactData.md#generated.RAContactData.GetCellPointsAsFunction) + * [`RAContactData.GetCellVolumeAsArray()`](RAContactData.md#generated.RAContactData.GetCellVolumeAsArray) + * [`RAContactData.GetCollectContactsData()`](RAContactData.md#generated.RAContactData.GetCollectContactsData) + * [`RAContactData.GetCurve()`](RAContactData.md#generated.RAContactData.GetCurve) + * [`RAContactData.GetCurveNames()`](RAContactData.md#generated.RAContactData.GetCurveNames) + * [`RAContactData.GetCurveNamesAssociation()`](RAContactData.md#generated.RAContactData.GetCurveNamesAssociation) + * [`RAContactData.GetElementCurve()`](RAContactData.md#generated.RAContactData.GetElementCurve) + * [`RAContactData.GetGeometryQuantity()`](RAContactData.md#generated.RAContactData.GetGeometryQuantity) + * [`RAContactData.GetGeometryUnit()`](RAContactData.md#generated.RAContactData.GetGeometryUnit) + * [`RAContactData.GetGridFunction()`](RAContactData.md#generated.RAContactData.GetGridFunction) + * [`RAContactData.GetGridFunctionNames()`](RAContactData.md#generated.RAContactData.GetGridFunctionNames) + * [`RAContactData.GetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.GetIncludeAdhesiveContacts) + * [`RAContactData.GetMeshColoring()`](RAContactData.md#generated.RAContactData.GetMeshColoring) + * [`RAContactData.GetNumberOfCells()`](RAContactData.md#generated.RAContactData.GetNumberOfCells) + * [`RAContactData.GetNumberOfNodes()`](RAContactData.md#generated.RAContactData.GetNumberOfNodes) + * [`RAContactData.GetNumpyCurve()`](RAContactData.md#generated.RAContactData.GetNumpyCurve) + * [`RAContactData.GetOutputVariableValue()`](RAContactData.md#generated.RAContactData.GetOutputVariableValue) + * [`RAContactData.GetTimeSet()`](RAContactData.md#generated.RAContactData.GetTimeSet) + * [`RAContactData.GetTimeStatistics()`](RAContactData.md#generated.RAContactData.GetTimeStatistics) + * [`RAContactData.GetTimeStep()`](RAContactData.md#generated.RAContactData.GetTimeStep) + * [`RAContactData.GetTopologyShape()`](RAContactData.md#generated.RAContactData.GetTopologyShape) + * [`RAContactData.HasGridFunction()`](RAContactData.md#generated.RAContactData.HasGridFunction) + * [`RAContactData.IsCellActive()`](RAContactData.md#generated.RAContactData.IsCellActive) + * [`RAContactData.IsCollectContactsDataEnabled()`](RAContactData.md#generated.RAContactData.IsCollectContactsDataEnabled) + * [`RAContactData.IsIncludeAdhesiveContactsEnabled()`](RAContactData.md#generated.RAContactData.IsIncludeAdhesiveContactsEnabled) + * [`RAContactData.IterCellVertices()`](RAContactData.md#generated.RAContactData.IterCellVertices) + * [`RAContactData.IterCells()`](RAContactData.md#generated.RAContactData.IterCells) + * [`RAContactData.Modified()`](RAContactData.md#generated.RAContactData.Modified) + * [`RAContactData.RemoveCustomCurve()`](RAContactData.md#generated.RAContactData.RemoveCustomCurve) + * [`RAContactData.RemoveCustomProperty()`](RAContactData.md#generated.RAContactData.RemoveCustomProperty) + * [`RAContactData.RemoveOutputVariable()`](RAContactData.md#generated.RAContactData.RemoveOutputVariable) + * [`RAContactData.RemoveProcess()`](RAContactData.md#generated.RAContactData.RemoveProcess) + * [`RAContactData.SetCollectContactsData()`](RAContactData.md#generated.RAContactData.SetCollectContactsData) + * [`RAContactData.SetCurrentTimeStep()`](RAContactData.md#generated.RAContactData.SetCurrentTimeStep) + * [`RAContactData.SetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.SetIncludeAdhesiveContacts) + * [RAContactToParticleProcess](RAContactToParticleProcess.md) + * [`RAContactToParticleProcess`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess) + * [`RAContactToParticleProcess.AddCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCurve) + * [`RAContactToParticleProcess.AddCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomCurve) + * [`RAContactToParticleProcess.AddCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomProperty) + * [`RAContactToParticleProcess.AddGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddGridFunction) + * [`RAContactToParticleProcess.CreateCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateCurveOutputVariable) + * [`RAContactToParticleProcess.CreateGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunction) + * [`RAContactToParticleProcess.CreateGridFunctionArrayOnCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionArrayOnCells) + * [`RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAContactToParticleProcess.CreateTransientCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateTransientCurveOutputVariable) + * [`RAContactToParticleProcess.EditCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomCurve) + * [`RAContactToParticleProcess.EditCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomProperty) + * [`RAContactToParticleProcess.GetActivesArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetActivesArray) + * [`RAContactToParticleProcess.GetBoundingBox()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetBoundingBox) + * [`RAContactToParticleProcess.GetCellAreaAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellAreaAsArray) + * [`RAContactToParticleProcess.GetCellCenterAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellCenterAsArray) + * [`RAContactToParticleProcess.GetCellDzAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellDzAsArray) + * [`RAContactToParticleProcess.GetCellFromIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellFromIJK) + * [`RAContactToParticleProcess.GetCellIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellIJK) + * [`RAContactToParticleProcess.GetCellNumberOfVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellNumberOfVertices) + * [`RAContactToParticleProcess.GetCellPointsAsFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellPointsAsFunction) + * [`RAContactToParticleProcess.GetCellVolumeAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellVolumeAsArray) + * [`RAContactToParticleProcess.GetCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurve) + * [`RAContactToParticleProcess.GetCurveNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNames) + * [`RAContactToParticleProcess.GetCurveNamesAssociation()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNamesAssociation) + * [`RAContactToParticleProcess.GetElementCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetElementCurve) + * [`RAContactToParticleProcess.GetGeometryQuantity()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryQuantity) + * [`RAContactToParticleProcess.GetGeometryUnit()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryUnit) + * [`RAContactToParticleProcess.GetGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunction) + * [`RAContactToParticleProcess.GetGridFunctionNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunctionNames) + * [`RAContactToParticleProcess.GetMeshColoring()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetMeshColoring) + * [`RAContactToParticleProcess.GetNumberOfCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfCells) + * [`RAContactToParticleProcess.GetNumberOfNodes()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfNodes) + * [`RAContactToParticleProcess.GetNumberOfParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfParticles) + * [`RAContactToParticleProcess.GetNumpyCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumpyCurve) + * [`RAContactToParticleProcess.GetOutputVariableValue()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetOutputVariableValue) + * [`RAContactToParticleProcess.GetTimeSet()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeSet) + * [`RAContactToParticleProcess.GetTimeStatistics()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStatistics) + * [`RAContactToParticleProcess.GetTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStep) + * [`RAContactToParticleProcess.GetTopologyShape()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTopologyShape) + * [`RAContactToParticleProcess.HasGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.HasGridFunction) + * [`RAContactToParticleProcess.IsCellActive()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IsCellActive) + * [`RAContactToParticleProcess.IterCellVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCellVertices) + * [`RAContactToParticleProcess.IterCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCells) + * [`RAContactToParticleProcess.IterParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterParticles) + * [`RAContactToParticleProcess.Modified()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.Modified) + * [`RAContactToParticleProcess.RemoveCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomCurve) + * [`RAContactToParticleProcess.RemoveCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomProperty) + * [`RAContactToParticleProcess.RemoveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveOutputVariable) + * [`RAContactToParticleProcess.RemoveProcess()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveProcess) + * [`RAContactToParticleProcess.SetCurrentTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.SetCurrentTimeStep) + * [RAContactsDataMeshColoring](RAContactsDataMeshColoring.md) + * [`RAContactsDataMeshColoring`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring) + * [`RAContactsDataMeshColoring.GetAvailableGridFunctions()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctions) + * [`RAContactsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctionsNames) + * [`RAContactsDataMeshColoring.GetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsColor) + * [`RAContactsDataMeshColoring.GetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkColor) + * [`RAContactsDataMeshColoring.GetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkLineWidth) + * [`RAContactsDataMeshColoring.GetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkProperty) + * [`RAContactsDataMeshColoring.GetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkVisible) + * [`RAContactsDataMeshColoring.GetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsPointSize) + * [`RAContactsDataMeshColoring.GetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsProperty) + * [`RAContactsDataMeshColoring.GetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsVisible) + * [`RAContactsDataMeshColoring.GetValidColoringModes()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetValidColoringModes) + * [`RAContactsDataMeshColoring.SetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsColor) + * [`RAContactsDataMeshColoring.SetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkColor) + * [`RAContactsDataMeshColoring.SetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkLineWidth) + * [`RAContactsDataMeshColoring.SetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkProperty) + * [`RAContactsDataMeshColoring.SetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkVisible) + * [`RAContactsDataMeshColoring.SetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsPointSize) + * [`RAContactsDataMeshColoring.SetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsProperty) + * [`RAContactsDataMeshColoring.SetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsVisible) + * [RACoupledWall](RACoupledWall.md) + * [`RACoupledWall`](RACoupledWall.md#generated.RACoupledWall) + * [`RACoupledWall.AddCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCurve) + * [`RACoupledWall.AddCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCustomCurve) + * [`RACoupledWall.AddCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.AddCustomProperty) + * [`RACoupledWall.AddGridFunction()`](RACoupledWall.md#generated.RACoupledWall.AddGridFunction) + * [`RACoupledWall.CreateCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateCurveOutputVariable) + * [`RACoupledWall.CreateGridFunction()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunction) + * [`RACoupledWall.CreateGridFunctionArrayOnCells()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionArrayOnCells) + * [`RACoupledWall.CreateGridFunctionStatisticOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionStatisticOutputVariable) + * [`RACoupledWall.CreateTransientCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateTransientCurveOutputVariable) + * [`RACoupledWall.EditCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.EditCustomCurve) + * [`RACoupledWall.EditCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.EditCustomProperty) + * [`RACoupledWall.GetActivesArray()`](RACoupledWall.md#generated.RACoupledWall.GetActivesArray) + * [`RACoupledWall.GetAvailableMaterials()`](RACoupledWall.md#generated.RACoupledWall.GetAvailableMaterials) + * [`RACoupledWall.GetBoundingBox()`](RACoupledWall.md#generated.RACoupledWall.GetBoundingBox) + * [`RACoupledWall.GetCellAreaAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellAreaAsArray) + * [`RACoupledWall.GetCellCenterAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellCenterAsArray) + * [`RACoupledWall.GetCellDzAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellDzAsArray) + * [`RACoupledWall.GetCellFromIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellFromIJK) + * [`RACoupledWall.GetCellIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellIJK) + * [`RACoupledWall.GetCellNumberOfVertices()`](RACoupledWall.md#generated.RACoupledWall.GetCellNumberOfVertices) + * [`RACoupledWall.GetCellPointsAsFunction()`](RACoupledWall.md#generated.RACoupledWall.GetCellPointsAsFunction) + * [`RACoupledWall.GetCellVolumeAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellVolumeAsArray) + * [`RACoupledWall.GetCurve()`](RACoupledWall.md#generated.RACoupledWall.GetCurve) + * [`RACoupledWall.GetCurveNames()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNames) + * [`RACoupledWall.GetCurveNamesAssociation()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNamesAssociation) + * [`RACoupledWall.GetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.GetDisableTime) + * [`RACoupledWall.GetElementCurve()`](RACoupledWall.md#generated.RACoupledWall.GetElementCurve) + * [`RACoupledWall.GetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.GetEnableTime) + * [`RACoupledWall.GetGeometryQuantity()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryQuantity) + * [`RACoupledWall.GetGeometryUnit()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryUnit) + * [`RACoupledWall.GetGridFunction()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunction) + * [`RACoupledWall.GetGridFunctionNames()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunctionNames) + * [`RACoupledWall.GetMaterial()`](RACoupledWall.md#generated.RACoupledWall.GetMaterial) + * [`RACoupledWall.GetMeshColoring()`](RACoupledWall.md#generated.RACoupledWall.GetMeshColoring) + * [`RACoupledWall.GetModuleProperties()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperties) + * [`RACoupledWall.GetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperty) + * [`RACoupledWall.GetNumberOfCells()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfCells) + * [`RACoupledWall.GetNumberOfNodes()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfNodes) + * [`RACoupledWall.GetNumpyCurve()`](RACoupledWall.md#generated.RACoupledWall.GetNumpyCurve) + * [`RACoupledWall.GetOutputVariableValue()`](RACoupledWall.md#generated.RACoupledWall.GetOutputVariableValue) + * [`RACoupledWall.GetTimeSet()`](RACoupledWall.md#generated.RACoupledWall.GetTimeSet) + * [`RACoupledWall.GetTimeStatistics()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStatistics) + * [`RACoupledWall.GetTimeStep()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStep) + * [`RACoupledWall.GetTopologyShape()`](RACoupledWall.md#generated.RACoupledWall.GetTopologyShape) + * [`RACoupledWall.GetValidOptionsForModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetValidOptionsForModuleProperty) + * [`RACoupledWall.HasGridFunction()`](RACoupledWall.md#generated.RACoupledWall.HasGridFunction) + * [`RACoupledWall.HasMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.HasMotionFrame) + * [`RACoupledWall.IsCellActive()`](RACoupledWall.md#generated.RACoupledWall.IsCellActive) + * [`RACoupledWall.IterCellVertices()`](RACoupledWall.md#generated.RACoupledWall.IterCellVertices) + * [`RACoupledWall.IterCells()`](RACoupledWall.md#generated.RACoupledWall.IterCells) + * [`RACoupledWall.Modified()`](RACoupledWall.md#generated.RACoupledWall.Modified) + * [`RACoupledWall.RemoveCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomCurve) + * [`RACoupledWall.RemoveCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomProperty) + * [`RACoupledWall.RemoveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.RemoveOutputVariable) + * [`RACoupledWall.RemoveProcess()`](RACoupledWall.md#generated.RACoupledWall.RemoveProcess) + * [`RACoupledWall.SetCurrentTimeStep()`](RACoupledWall.md#generated.RACoupledWall.SetCurrentTimeStep) + * [`RACoupledWall.SetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.SetDisableTime) + * [`RACoupledWall.SetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.SetEnableTime) + * [`RACoupledWall.SetMaterial()`](RACoupledWall.md#generated.RACoupledWall.SetMaterial) + * [`RACoupledWall.SetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.SetModuleProperty) + * [RACubeGroup](RACubeGroup.md) + * [`RACubeGroup`](RACubeGroup.md#generated.RACubeGroup) + * [`RACubeGroup.AddCurve()`](RACubeGroup.md#generated.RACubeGroup.AddCurve) + * [`RACubeGroup.GetCenter()`](RACubeGroup.md#generated.RACubeGroup.GetCenter) + * [`RACubeGroup.GetCenterAfterMovement()`](RACubeGroup.md#generated.RACubeGroup.GetCenterAfterMovement) + * [`RACubeGroup.GetCurve()`](RACubeGroup.md#generated.RACubeGroup.GetCurve) + * [`RACubeGroup.GetCurveNames()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNames) + * [`RACubeGroup.GetCurveNamesAssociation()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNamesAssociation) + * [`RACubeGroup.GetElementCurve()`](RACubeGroup.md#generated.RACubeGroup.GetElementCurve) + * [`RACubeGroup.GetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.GetMotionFrame) + * [`RACubeGroup.GetNumpyCurve()`](RACubeGroup.md#generated.RACubeGroup.GetNumpyCurve) + * [`RACubeGroup.GetOrientation()`](RACubeGroup.md#generated.RACubeGroup.GetOrientation) + * [`RACubeGroup.GetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngleAndVector) + * [`RACubeGroup.GetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngles) + * [`RACubeGroup.GetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromBasisVector) + * [`RACubeGroup.GetRotation()`](RACubeGroup.md#generated.RACubeGroup.GetRotation) + * [`RACubeGroup.GetSize()`](RACubeGroup.md#generated.RACubeGroup.GetSize) + * [`RACubeGroup.SetCenter()`](RACubeGroup.md#generated.RACubeGroup.SetCenter) + * [`RACubeGroup.SetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.SetMotionFrame) + * [`RACubeGroup.SetOrientation()`](RACubeGroup.md#generated.RACubeGroup.SetOrientation) + * [`RACubeGroup.SetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngleAndVector) + * [`RACubeGroup.SetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngles) + * [`RACubeGroup.SetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromBasisVector) + * [`RACubeGroup.SetRotation()`](RACubeGroup.md#generated.RACubeGroup.SetRotation) + * [`RACubeGroup.SetSize()`](RACubeGroup.md#generated.RACubeGroup.SetSize) + * [RACubeProcess](RACubeProcess.md) + * [`RACubeProcess`](RACubeProcess.md#generated.RACubeProcess) + * [`RACubeProcess.AddCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCurve) + * [`RACubeProcess.AddCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCustomCurve) + * [`RACubeProcess.AddCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.AddCustomProperty) + * [`RACubeProcess.AddGridFunction()`](RACubeProcess.md#generated.RACubeProcess.AddGridFunction) + * [`RACubeProcess.CreateCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateCurveOutputVariable) + * [`RACubeProcess.CreateGridFunction()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunction) + * [`RACubeProcess.CreateGridFunctionArrayOnCells()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionArrayOnCells) + * [`RACubeProcess.CreateGridFunctionStatisticOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionStatisticOutputVariable) + * [`RACubeProcess.CreateTransientCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateTransientCurveOutputVariable) + * [`RACubeProcess.EditCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.EditCustomCurve) + * [`RACubeProcess.EditCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.EditCustomProperty) + * [`RACubeProcess.GetActivesArray()`](RACubeProcess.md#generated.RACubeProcess.GetActivesArray) + * [`RACubeProcess.GetBoundingBox()`](RACubeProcess.md#generated.RACubeProcess.GetBoundingBox) + * [`RACubeProcess.GetCellAreaAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellAreaAsArray) + * [`RACubeProcess.GetCellCenterAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellCenterAsArray) + * [`RACubeProcess.GetCellDzAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellDzAsArray) + * [`RACubeProcess.GetCellFromIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellFromIJK) + * [`RACubeProcess.GetCellIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellIJK) + * [`RACubeProcess.GetCellNumberOfVertices()`](RACubeProcess.md#generated.RACubeProcess.GetCellNumberOfVertices) + * [`RACubeProcess.GetCellPointsAsFunction()`](RACubeProcess.md#generated.RACubeProcess.GetCellPointsAsFunction) + * [`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.GetGeometryQuantity()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryQuantity) + * [`RACubeProcess.GetGeometryUnit()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryUnit) + * [`RACubeProcess.GetGridFunction()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunction) + * [`RACubeProcess.GetGridFunctionNames()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunctionNames) + * [`RACubeProcess.GetMeshColoring()`](RACubeProcess.md#generated.RACubeProcess.GetMeshColoring) + * [`RACubeProcess.GetMotionFrame()`](RACubeProcess.md#generated.RACubeProcess.GetMotionFrame) + * [`RACubeProcess.GetNumberOfCells()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfCells) + * [`RACubeProcess.GetNumberOfNodes()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfNodes) + * [`RACubeProcess.GetNumberOfParticles()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfParticles) + * [`RACubeProcess.GetNumpyCurve()`](RACubeProcess.md#generated.RACubeProcess.GetNumpyCurve) + * [`RACubeProcess.GetOrientation()`](RACubeProcess.md#generated.RACubeProcess.GetOrientation) + * [`RACubeProcess.GetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngleAndVector) + * [`RACubeProcess.GetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngles) + * [`RACubeProcess.GetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromBasisVector) + * [`RACubeProcess.GetOutputVariableValue()`](RACubeProcess.md#generated.RACubeProcess.GetOutputVariableValue) + * [`RACubeProcess.GetRotation()`](RACubeProcess.md#generated.RACubeProcess.GetRotation) + * [`RACubeProcess.GetSize()`](RACubeProcess.md#generated.RACubeProcess.GetSize) + * [`RACubeProcess.GetTimeSet()`](RACubeProcess.md#generated.RACubeProcess.GetTimeSet) + * [`RACubeProcess.GetTimeStatistics()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStatistics) + * [`RACubeProcess.GetTimeStep()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStep) + * [`RACubeProcess.GetTopologyShape()`](RACubeProcess.md#generated.RACubeProcess.GetTopologyShape) + * [`RACubeProcess.HasGridFunction()`](RACubeProcess.md#generated.RACubeProcess.HasGridFunction) + * [`RACubeProcess.IsCellActive()`](RACubeProcess.md#generated.RACubeProcess.IsCellActive) + * [`RACubeProcess.IterCellVertices()`](RACubeProcess.md#generated.RACubeProcess.IterCellVertices) + * [`RACubeProcess.IterCells()`](RACubeProcess.md#generated.RACubeProcess.IterCells) + * [`RACubeProcess.IterParticles()`](RACubeProcess.md#generated.RACubeProcess.IterParticles) + * [`RACubeProcess.Modified()`](RACubeProcess.md#generated.RACubeProcess.Modified) + * [`RACubeProcess.RemoveCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomCurve) + * [`RACubeProcess.RemoveCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomProperty) + * [`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) + * [`RACubeProcess.SetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngleAndVector) + * [`RACubeProcess.SetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngles) + * [`RACubeProcess.SetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromBasisVector) + * [`RACubeProcess.SetRotation()`](RACubeProcess.md#generated.RACubeProcess.SetRotation) + * [`RACubeProcess.SetSize()`](RACubeProcess.md#generated.RACubeProcess.SetSize) + * [RACustomInput](RACustomInput.md) + * [`RACustomInput`](RACustomInput.md#generated.RACustomInput) + * [`RACustomInput.GetAvailableMotionFrames()`](RACustomInput.md#generated.RACustomInput.GetAvailableMotionFrames) + * [`RACustomInput.GetAvailableParticles()`](RACustomInput.md#generated.RACustomInput.GetAvailableParticles) + * [`RACustomInput.GetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.GetDefaultTemperature) + * [`RACustomInput.GetFilePath()`](RACustomInput.md#generated.RACustomInput.GetFilePath) + * [`RACustomInput.GetModuleProperties()`](RACustomInput.md#generated.RACustomInput.GetModuleProperties) + * [`RACustomInput.GetModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetModuleProperty) + * [`RACustomInput.GetMotionFrame()`](RACustomInput.md#generated.RACustomInput.GetMotionFrame) + * [`RACustomInput.GetParticle()`](RACustomInput.md#generated.RACustomInput.GetParticle) + * [`RACustomInput.GetValidOptionsForModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetValidOptionsForModuleProperty) + * [`RACustomInput.SetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.SetDefaultTemperature) + * [`RACustomInput.SetFilePath()`](RACustomInput.md#generated.RACustomInput.SetFilePath) + * [`RACustomInput.SetModuleProperty()`](RACustomInput.md#generated.RACustomInput.SetModuleProperty) + * [`RACustomInput.SetMotionFrame()`](RACustomInput.md#generated.RACustomInput.SetMotionFrame) + * [`RACustomInput.SetParticle()`](RACustomInput.md#generated.RACustomInput.SetParticle) + * [RACylinderGroup](RACylinderGroup.md) + * [`RACylinderGroup`](RACylinderGroup.md#generated.RACylinderGroup) + * [`RACylinderGroup.AddCurve()`](RACylinderGroup.md#generated.RACylinderGroup.AddCurve) + * [`RACylinderGroup.GetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenter) + * [`RACylinderGroup.GetCenterAfterMovement()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenterAfterMovement) + * [`RACylinderGroup.GetCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurve) + * [`RACylinderGroup.GetCurveNames()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNames) + * [`RACylinderGroup.GetCurveNamesAssociation()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNamesAssociation) + * [`RACylinderGroup.GetElementCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetElementCurve) + * [`RACylinderGroup.GetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetFinalAngle) + * [`RACylinderGroup.GetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetInitialAngle) + * [`RACylinderGroup.GetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.GetInternalFactor) + * [`RACylinderGroup.GetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.GetMotionFrame) + * [`RACylinderGroup.GetNumpyCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetNumpyCurve) + * [`RACylinderGroup.GetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientation) + * [`RACylinderGroup.GetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngleAndVector) + * [`RACylinderGroup.GetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngles) + * [`RACylinderGroup.GetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromBasisVector) + * [`RACylinderGroup.GetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.GetRotation) + * [`RACylinderGroup.GetSize()`](RACylinderGroup.md#generated.RACylinderGroup.GetSize) + * [`RACylinderGroup.SetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.SetCenter) + * [`RACylinderGroup.SetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetFinalAngle) + * [`RACylinderGroup.SetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetInitialAngle) + * [`RACylinderGroup.SetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.SetInternalFactor) + * [`RACylinderGroup.SetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.SetMotionFrame) + * [`RACylinderGroup.SetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientation) + * [`RACylinderGroup.SetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngleAndVector) + * [`RACylinderGroup.SetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngles) + * [`RACylinderGroup.SetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromBasisVector) + * [`RACylinderGroup.SetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.SetRotation) + * [`RACylinderGroup.SetSize()`](RACylinderGroup.md#generated.RACylinderGroup.SetSize) + * [RACylinderProcess](RACylinderProcess.md) + * [`RACylinderProcess`](RACylinderProcess.md#generated.RACylinderProcess) + * [`RACylinderProcess.AddCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCurve) + * [`RACylinderProcess.AddCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomCurve) + * [`RACylinderProcess.AddCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomProperty) + * [`RACylinderProcess.AddGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.AddGridFunction) + * [`RACylinderProcess.CreateCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateCurveOutputVariable) + * [`RACylinderProcess.CreateGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunction) + * [`RACylinderProcess.CreateGridFunctionArrayOnCells()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionArrayOnCells) + * [`RACylinderProcess.CreateGridFunctionStatisticOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionStatisticOutputVariable) + * [`RACylinderProcess.CreateTransientCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateTransientCurveOutputVariable) + * [`RACylinderProcess.EditCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomCurve) + * [`RACylinderProcess.EditCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomProperty) + * [`RACylinderProcess.GetActivesArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetActivesArray) + * [`RACylinderProcess.GetBoundingBox()`](RACylinderProcess.md#generated.RACylinderProcess.GetBoundingBox) + * [`RACylinderProcess.GetCellAreaAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellAreaAsArray) + * [`RACylinderProcess.GetCellCenterAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellCenterAsArray) + * [`RACylinderProcess.GetCellDzAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellDzAsArray) + * [`RACylinderProcess.GetCellFromIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellFromIJK) + * [`RACylinderProcess.GetCellIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellIJK) + * [`RACylinderProcess.GetCellNumberOfVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellNumberOfVertices) + * [`RACylinderProcess.GetCellPointsAsFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellPointsAsFunction) + * [`RACylinderProcess.GetCellVolumeAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellVolumeAsArray) + * [`RACylinderProcess.GetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenter) + * [`RACylinderProcess.GetCenterAfterMovement()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenterAfterMovement) + * [`RACylinderProcess.GetCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurve) + * [`RACylinderProcess.GetCurveNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNames) + * [`RACylinderProcess.GetCurveNamesAssociation()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNamesAssociation) + * [`RACylinderProcess.GetElementCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetElementCurve) + * [`RACylinderProcess.GetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetFinalAngle) + * [`RACylinderProcess.GetGeometryQuantity()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryQuantity) + * [`RACylinderProcess.GetGeometryUnit()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryUnit) + * [`RACylinderProcess.GetGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunction) + * [`RACylinderProcess.GetGridFunctionNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunctionNames) + * [`RACylinderProcess.GetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetInitialAngle) + * [`RACylinderProcess.GetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.GetInternalFactor) + * [`RACylinderProcess.GetMeshColoring()`](RACylinderProcess.md#generated.RACylinderProcess.GetMeshColoring) + * [`RACylinderProcess.GetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.GetMotionFrame) + * [`RACylinderProcess.GetNumberOfCells()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfCells) + * [`RACylinderProcess.GetNumberOfNodes()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfNodes) + * [`RACylinderProcess.GetNumberOfParticles()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfParticles) + * [`RACylinderProcess.GetNumpyCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumpyCurve) + * [`RACylinderProcess.GetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientation) + * [`RACylinderProcess.GetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngleAndVector) + * [`RACylinderProcess.GetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngles) + * [`RACylinderProcess.GetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromBasisVector) + * [`RACylinderProcess.GetOutputVariableValue()`](RACylinderProcess.md#generated.RACylinderProcess.GetOutputVariableValue) + * [`RACylinderProcess.GetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.GetRotation) + * [`RACylinderProcess.GetSize()`](RACylinderProcess.md#generated.RACylinderProcess.GetSize) + * [`RACylinderProcess.GetTimeSet()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeSet) + * [`RACylinderProcess.GetTimeStatistics()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStatistics) + * [`RACylinderProcess.GetTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStep) + * [`RACylinderProcess.GetTopologyShape()`](RACylinderProcess.md#generated.RACylinderProcess.GetTopologyShape) + * [`RACylinderProcess.HasGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.HasGridFunction) + * [`RACylinderProcess.IsCellActive()`](RACylinderProcess.md#generated.RACylinderProcess.IsCellActive) + * [`RACylinderProcess.IterCellVertices()`](RACylinderProcess.md#generated.RACylinderProcess.IterCellVertices) + * [`RACylinderProcess.IterCells()`](RACylinderProcess.md#generated.RACylinderProcess.IterCells) + * [`RACylinderProcess.IterParticles()`](RACylinderProcess.md#generated.RACylinderProcess.IterParticles) + * [`RACylinderProcess.Modified()`](RACylinderProcess.md#generated.RACylinderProcess.Modified) + * [`RACylinderProcess.RemoveCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomCurve) + * [`RACylinderProcess.RemoveCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomProperty) + * [`RACylinderProcess.RemoveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveOutputVariable) + * [`RACylinderProcess.RemoveProcess()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveProcess) + * [`RACylinderProcess.SetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.SetCenter) + * [`RACylinderProcess.SetCurrentTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.SetCurrentTimeStep) + * [`RACylinderProcess.SetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetFinalAngle) + * [`RACylinderProcess.SetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetInitialAngle) + * [`RACylinderProcess.SetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.SetInternalFactor) + * [`RACylinderProcess.SetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.SetMotionFrame) + * [`RACylinderProcess.SetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientation) + * [`RACylinderProcess.SetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngleAndVector) + * [`RACylinderProcess.SetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngles) + * [`RACylinderProcess.SetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromBasisVector) + * [`RACylinderProcess.SetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.SetRotation) + * [`RACylinderProcess.SetSize()`](RACylinderProcess.md#generated.RACylinderProcess.SetSize) + * [RADivisionsTagging](RADivisionsTagging.md) + * [`RADivisionsTagging`](RADivisionsTagging.md#generated.RADivisionsTagging) + * [`RADivisionsTagging.GetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsI) + * [`RADivisionsTagging.GetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsJ) + * [`RADivisionsTagging.GetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsK) + * [`RADivisionsTagging.GetGridFunctionName()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetGridFunctionName) + * [`RADivisionsTagging.GetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetNameMask) + * [`RADivisionsTagging.GetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagStride) + * [`RADivisionsTagging.GetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagValue) + * [`RADivisionsTagging.GetTimeRangeFilter()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTimeRangeFilter) + * [`RADivisionsTagging.SetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsI) + * [`RADivisionsTagging.SetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsJ) + * [`RADivisionsTagging.SetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsK) + * [`RADivisionsTagging.SetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetNameMask) + * [`RADivisionsTagging.SetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagStride) + * [`RADivisionsTagging.SetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagValue) + * [RADomainSettings](RADomainSettings.md) + * [`RADomainSettings`](RADomainSettings.md#generated.RADomainSettings) + * [`RADomainSettings.DisablePeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.DisablePeriodicAtGeometryLimits) + * [`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) + * [`RADomainSettings.GetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.GetCylindricalPeriodicDirections) + * [`RADomainSettings.GetDomainType()`](RADomainSettings.md#generated.RADomainSettings.GetDomainType) + * [`RADomainSettings.GetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.GetInitialAngle) + * [`RADomainSettings.GetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.GetNumberOfDivisions) + * [`RADomainSettings.GetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicAtGeometryLimits) + * [`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.SetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCartesianPeriodicDirections) + * [`RADomainSettings.SetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMaxValues) + * [`RADomainSettings.SetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMinValues) + * [`RADomainSettings.SetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCylindricalPeriodicDirections) + * [`RADomainSettings.SetDomainType()`](RADomainSettings.md#generated.RADomainSettings.SetDomainType) + * [`RADomainSettings.SetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.SetInitialAngle) + * [`RADomainSettings.SetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.SetNumberOfDivisions) + * [`RADomainSettings.SetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicAtGeometryLimits) + * [`RADomainSettings.SetPeriodicLimitsMaxCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMaxCoordinates) + * [`RADomainSettings.SetPeriodicLimitsMinCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMinCoordinates) + * [`RADomainSettings.SetUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetUseBoundaryLimits) + * [RAEulerianStatistics](RAEulerianStatistics.md) + * [`RAEulerianStatistics`](RAEulerianStatistics.md#generated.RAEulerianStatistics) + * [`RAEulerianStatistics.AddCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCurve) + * [`RAEulerianStatistics.AddCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomCurve) + * [`RAEulerianStatistics.AddCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomProperty) + * [`RAEulerianStatistics.AddGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddGridFunction) + * [`RAEulerianStatistics.CreateCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateCurveOutputVariable) + * [`RAEulerianStatistics.CreateEulerianGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateEulerianGridFunction) + * [`RAEulerianStatistics.CreateGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunction) + * [`RAEulerianStatistics.CreateGridFunctionArrayOnCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionArrayOnCells) + * [`RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable) + * [`RAEulerianStatistics.CreateTransientCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateTransientCurveOutputVariable) + * [`RAEulerianStatistics.EditCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomCurve) + * [`RAEulerianStatistics.EditCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomProperty) + * [`RAEulerianStatistics.GetActivesArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetActivesArray) + * [`RAEulerianStatistics.GetAvailableOperations()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetAvailableOperations) + * [`RAEulerianStatistics.GetBoundingBox()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetBoundingBox) + * [`RAEulerianStatistics.GetCellAreaAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellAreaAsArray) + * [`RAEulerianStatistics.GetCellCenterAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellCenterAsArray) + * [`RAEulerianStatistics.GetCellDzAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellDzAsArray) + * [`RAEulerianStatistics.GetCellFromIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellFromIJK) + * [`RAEulerianStatistics.GetCellIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellIJK) + * [`RAEulerianStatistics.GetCellNumberOfVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellNumberOfVertices) + * [`RAEulerianStatistics.GetCellPointsAsFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellPointsAsFunction) + * [`RAEulerianStatistics.GetCellVolumeAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellVolumeAsArray) + * [`RAEulerianStatistics.GetCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurve) + * [`RAEulerianStatistics.GetCurveNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNames) + * [`RAEulerianStatistics.GetCurveNamesAssociation()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNamesAssociation) + * [`RAEulerianStatistics.GetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetDivisions) + * [`RAEulerianStatistics.GetElementCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetElementCurve) + * [`RAEulerianStatistics.GetGeometryQuantity()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryQuantity) + * [`RAEulerianStatistics.GetGeometryUnit()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryUnit) + * [`RAEulerianStatistics.GetGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunction) + * [`RAEulerianStatistics.GetGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunctionNames) + * [`RAEulerianStatistics.GetMeshColoring()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetMeshColoring) + * [`RAEulerianStatistics.GetNumberOfCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfCells) + * [`RAEulerianStatistics.GetNumberOfNodes()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfNodes) + * [`RAEulerianStatistics.GetNumberOfParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfParticles) + * [`RAEulerianStatistics.GetNumpyCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumpyCurve) + * [`RAEulerianStatistics.GetOutputVariableValue()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetOutputVariableValue) + * [`RAEulerianStatistics.GetParticleGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetParticleGridFunctionNames) + * [`RAEulerianStatistics.GetTimeSet()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeSet) + * [`RAEulerianStatistics.GetTimeStatistics()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStatistics) + * [`RAEulerianStatistics.GetTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStep) + * [`RAEulerianStatistics.GetTopologyShape()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTopologyShape) + * [`RAEulerianStatistics.HasGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.HasGridFunction) + * [`RAEulerianStatistics.IsCellActive()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IsCellActive) + * [`RAEulerianStatistics.IterCellVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCellVertices) + * [`RAEulerianStatistics.IterCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCells) + * [`RAEulerianStatistics.IterParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterParticles) + * [`RAEulerianStatistics.Modified()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.Modified) + * [`RAEulerianStatistics.RemoveCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomCurve) + * [`RAEulerianStatistics.RemoveCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomProperty) + * [`RAEulerianStatistics.RemoveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveOutputVariable) + * [`RAEulerianStatistics.RemoveProcess()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveProcess) + * [`RAEulerianStatistics.SetCurrentTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetCurrentTimeStep) + * [`RAEulerianStatistics.SetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetDivisions) + * [RAExportToolkit](RAExportToolkit.md) + * [`RAExportToolkit`](RAExportToolkit.md#generated.RAExportToolkit) + * [`RAExportToolkit.ExportFEMForces()`](RAExportToolkit.md#generated.RAExportToolkit.ExportFEMForces) + * [`RAExportToolkit.ExportGeometryLoads()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoads) + * [`RAExportToolkit.ExportGeometryLoadsMultiTime()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoadsMultiTime) + * [`RAExportToolkit.ExportHTC()`](RAExportToolkit.md#generated.RAExportToolkit.ExportHTC) + * [`RAExportToolkit.ExportParticleToStl()`](RAExportToolkit.md#generated.RAExportToolkit.ExportParticleToStl) + * [`RAExportToolkit.ExportToSTL()`](RAExportToolkit.md#generated.RAExportToolkit.ExportToSTL) + * [RAFeedConveyor](RAFeedConveyor.md) + * [`RAFeedConveyor`](RAFeedConveyor.md#generated.RAFeedConveyor) + * [`RAFeedConveyor.AddCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCurve) + * [`RAFeedConveyor.AddCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomCurve) + * [`RAFeedConveyor.AddCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomProperty) + * [`RAFeedConveyor.AddGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddGridFunction) + * [`RAFeedConveyor.CreateCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateCurveOutputVariable) + * [`RAFeedConveyor.CreateGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunction) + * [`RAFeedConveyor.CreateGridFunctionArrayOnCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionArrayOnCells) + * [`RAFeedConveyor.CreateGridFunctionStatisticOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionStatisticOutputVariable) + * [`RAFeedConveyor.CreateTransientCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateTransientCurveOutputVariable) + * [`RAFeedConveyor.EditCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomCurve) + * [`RAFeedConveyor.EditCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomProperty) + * [`RAFeedConveyor.GetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAccelerationPeriod) + * [`RAFeedConveyor.GetActivesArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetActivesArray) + * [`RAFeedConveyor.GetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAlignmentAngle) + * [`RAFeedConveyor.GetAvailableMaterials()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAvailableMaterials) + * [`RAFeedConveyor.GetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStartTime) + * [`RAFeedConveyor.GetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStopTime) + * [`RAFeedConveyor.GetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltInclineAngle) + * [`RAFeedConveyor.GetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfile) + * [`RAFeedConveyor.GetBeltProfileName()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfileName) + * [`RAFeedConveyor.GetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltSpeed) + * [`RAFeedConveyor.GetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltThickness) + * [`RAFeedConveyor.GetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltWidth) + * [`RAFeedConveyor.GetBoundingBox()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBoundingBox) + * [`RAFeedConveyor.GetCellAreaAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellAreaAsArray) + * [`RAFeedConveyor.GetCellCenterAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellCenterAsArray) + * [`RAFeedConveyor.GetCellDzAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellDzAsArray) + * [`RAFeedConveyor.GetCellFromIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellFromIJK) + * [`RAFeedConveyor.GetCellIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellIJK) + * [`RAFeedConveyor.GetCellNumberOfVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellNumberOfVertices) + * [`RAFeedConveyor.GetCellPointsAsFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellPointsAsFunction) + * [`RAFeedConveyor.GetCellVolumeAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellVolumeAsArray) + * [`RAFeedConveyor.GetCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurve) + * [`RAFeedConveyor.GetCurveNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNames) + * [`RAFeedConveyor.GetCurveNamesAssociation()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNamesAssociation) + * [`RAFeedConveyor.GetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDecelerationPeriod) + * [`RAFeedConveyor.GetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDiameter) + * [`RAFeedConveyor.GetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxHeight) + * [`RAFeedConveyor.GetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxLength) + * [`RAFeedConveyor.GetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxWidth) + * [`RAFeedConveyor.GetElementCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetElementCurve) + * [`RAFeedConveyor.GetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceWidth) + * [`RAFeedConveyor.GetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFrontPlateOffset) + * [`RAFeedConveyor.GetGeometryQuantity()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryQuantity) + * [`RAFeedConveyor.GetGeometryUnit()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryUnit) + * [`RAFeedConveyor.GetGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunction) + * [`RAFeedConveyor.GetGridFunctionNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunctionNames) + * [`RAFeedConveyor.GetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHeightOffset) + * [`RAFeedConveyor.GetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHorizontalOffset) + * [`RAFeedConveyor.GetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLengthOffset) + * [`RAFeedConveyor.GetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLoadingLength) + * [`RAFeedConveyor.GetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMaterial) + * [`RAFeedConveyor.GetMeshColoring()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMeshColoring) + * [`RAFeedConveyor.GetModuleProperties()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperties) + * [`RAFeedConveyor.GetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperty) + * [`RAFeedConveyor.GetNumberOfCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfCells) + * [`RAFeedConveyor.GetNumberOfNodes()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfNodes) + * [`RAFeedConveyor.GetNumpyCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumpyCurve) + * [`RAFeedConveyor.GetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOffsetToIdlers) + * [`RAFeedConveyor.GetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutOfPlaneOffset) + * [`RAFeedConveyor.GetOutputVariableValue()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutputVariableValue) + * [`RAFeedConveyor.GetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetReturnBeltAngle) + * [`RAFeedConveyor.GetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardHeight) + * [`RAFeedConveyor.GetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardLength) + * [`RAFeedConveyor.GetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSphBoundaryType) + * [`RAFeedConveyor.GetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSurfaceTensionContactAngle) + * [`RAFeedConveyor.GetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTemperature) + * [`RAFeedConveyor.GetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetThermalBoundaryConditionType) + * [`RAFeedConveyor.GetTimeSet()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeSet) + * [`RAFeedConveyor.GetTimeStatistics()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStatistics) + * [`RAFeedConveyor.GetTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStep) + * [`RAFeedConveyor.GetTopologyShape()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTopologyShape) + * [`RAFeedConveyor.GetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTransitionLength) + * [`RAFeedConveyor.GetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTriangleSize) + * [`RAFeedConveyor.GetValidBeltProfileNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidBeltProfileNames) + * [`RAFeedConveyor.GetValidOptionsForModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidOptionsForModuleProperty) + * [`RAFeedConveyor.GetValidSphBoundaryTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues) + * [`RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues) + * [`RAFeedConveyor.GetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVerticalOffset) + * [`RAFeedConveyor.GetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWallThickness) + * [`RAFeedConveyor.GetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWidth) + * [`RAFeedConveyor.HasGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.HasGridFunction) + * [`RAFeedConveyor.IsCellActive()`](RAFeedConveyor.md#generated.RAFeedConveyor.IsCellActive) + * [`RAFeedConveyor.IterCellVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCellVertices) + * [`RAFeedConveyor.IterCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCells) + * [`RAFeedConveyor.Modified()`](RAFeedConveyor.md#generated.RAFeedConveyor.Modified) + * [`RAFeedConveyor.RemoveCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomCurve) + * [`RAFeedConveyor.RemoveCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomProperty) + * [`RAFeedConveyor.RemoveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveOutputVariable) + * [`RAFeedConveyor.RemoveProcess()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveProcess) + * [`RAFeedConveyor.SetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAccelerationPeriod) + * [`RAFeedConveyor.SetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAlignmentAngle) + * [`RAFeedConveyor.SetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStartTime) + * [`RAFeedConveyor.SetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStopTime) + * [`RAFeedConveyor.SetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltInclineAngle) + * [`RAFeedConveyor.SetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltProfile) + * [`RAFeedConveyor.SetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltSpeed) + * [`RAFeedConveyor.SetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltThickness) + * [`RAFeedConveyor.SetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltWidth) + * [`RAFeedConveyor.SetCurrentTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCurrentTimeStep) + * [`RAFeedConveyor.SetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDecelerationPeriod) + * [`RAFeedConveyor.SetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDiameter) + * [`RAFeedConveyor.SetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxHeight) + * [`RAFeedConveyor.SetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxLength) + * [`RAFeedConveyor.SetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxWidth) + * [`RAFeedConveyor.SetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFaceWidth) + * [`RAFeedConveyor.SetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFrontPlateOffset) + * [`RAFeedConveyor.SetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHeightOffset) + * [`RAFeedConveyor.SetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHorizontalOffset) + * [`RAFeedConveyor.SetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLengthOffset) + * [`RAFeedConveyor.SetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLoadingLength) + * [`RAFeedConveyor.SetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetMaterial) + * [`RAFeedConveyor.SetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetModuleProperty) + * [`RAFeedConveyor.SetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOffsetToIdlers) + * [`RAFeedConveyor.SetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOutOfPlaneOffset) + * [`RAFeedConveyor.SetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetReturnBeltAngle) + * [`RAFeedConveyor.SetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardHeight) + * [`RAFeedConveyor.SetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardLength) + * [`RAFeedConveyor.SetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSphBoundaryType) + * [`RAFeedConveyor.SetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSurfaceTensionContactAngle) + * [`RAFeedConveyor.SetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTemperature) + * [`RAFeedConveyor.SetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetThermalBoundaryConditionType) + * [`RAFeedConveyor.SetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTransitionLength) + * [`RAFeedConveyor.SetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTriangleSize) + * [`RAFeedConveyor.SetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetVerticalOffset) + * [`RAFeedConveyor.SetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWallThickness) + * [`RAFeedConveyor.SetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWidth) + * [RAFilterProcess](RAFilterProcess.md) + * [`RAFilterProcess`](RAFilterProcess.md#generated.RAFilterProcess) + * [`RAFilterProcess.AddCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCurve) + * [`RAFilterProcess.AddCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomCurve) + * [`RAFilterProcess.AddCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomProperty) + * [`RAFilterProcess.AddGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.AddGridFunction) + * [`RAFilterProcess.CreateCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateCurveOutputVariable) + * [`RAFilterProcess.CreateGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunction) + * [`RAFilterProcess.CreateGridFunctionArrayOnCells()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionArrayOnCells) + * [`RAFilterProcess.CreateGridFunctionStatisticOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAFilterProcess.CreateTransientCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateTransientCurveOutputVariable) + * [`RAFilterProcess.EditCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomCurve) + * [`RAFilterProcess.EditCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomProperty) + * [`RAFilterProcess.GetActivesArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetActivesArray) + * [`RAFilterProcess.GetBoundingBox()`](RAFilterProcess.md#generated.RAFilterProcess.GetBoundingBox) + * [`RAFilterProcess.GetCellAreaAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellAreaAsArray) + * [`RAFilterProcess.GetCellCenterAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellCenterAsArray) + * [`RAFilterProcess.GetCellDzAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellDzAsArray) + * [`RAFilterProcess.GetCellFromIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellFromIJK) + * [`RAFilterProcess.GetCellIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellIJK) + * [`RAFilterProcess.GetCellNumberOfVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellNumberOfVertices) + * [`RAFilterProcess.GetCellPointsAsFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellPointsAsFunction) + * [`RAFilterProcess.GetCellVolumeAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellVolumeAsArray) + * [`RAFilterProcess.GetCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurve) + * [`RAFilterProcess.GetCurveNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNames) + * [`RAFilterProcess.GetCurveNamesAssociation()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNamesAssociation) + * [`RAFilterProcess.GetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetCutValue) + * [`RAFilterProcess.GetElementCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetElementCurve) + * [`RAFilterProcess.GetGeometryQuantity()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryQuantity) + * [`RAFilterProcess.GetGeometryUnit()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryUnit) + * [`RAFilterProcess.GetGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunction) + * [`RAFilterProcess.GetGridFunctionNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunctionNames) + * [`RAFilterProcess.GetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMaxValue) + * [`RAFilterProcess.GetMeshColoring()`](RAFilterProcess.md#generated.RAFilterProcess.GetMeshColoring) + * [`RAFilterProcess.GetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMinValue) + * [`RAFilterProcess.GetMode()`](RAFilterProcess.md#generated.RAFilterProcess.GetMode) + * [`RAFilterProcess.GetNumberOfCells()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfCells) + * [`RAFilterProcess.GetNumberOfNodes()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfNodes) + * [`RAFilterProcess.GetNumberOfParticles()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfParticles) + * [`RAFilterProcess.GetNumpyCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumpyCurve) + * [`RAFilterProcess.GetOutputVariableValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetOutputVariableValue) + * [`RAFilterProcess.GetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetPropertyGridFunction) + * [`RAFilterProcess.GetTimeSet()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeSet) + * [`RAFilterProcess.GetTimeStatistics()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStatistics) + * [`RAFilterProcess.GetTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStep) + * [`RAFilterProcess.GetTopologyShape()`](RAFilterProcess.md#generated.RAFilterProcess.GetTopologyShape) + * [`RAFilterProcess.GetType()`](RAFilterProcess.md#generated.RAFilterProcess.GetType) + * [`RAFilterProcess.HasGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.HasGridFunction) + * [`RAFilterProcess.IsCellActive()`](RAFilterProcess.md#generated.RAFilterProcess.IsCellActive) + * [`RAFilterProcess.IterCellVertices()`](RAFilterProcess.md#generated.RAFilterProcess.IterCellVertices) + * [`RAFilterProcess.IterCells()`](RAFilterProcess.md#generated.RAFilterProcess.IterCells) + * [`RAFilterProcess.IterParticles()`](RAFilterProcess.md#generated.RAFilterProcess.IterParticles) + * [`RAFilterProcess.Modified()`](RAFilterProcess.md#generated.RAFilterProcess.Modified) + * [`RAFilterProcess.RemoveCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomCurve) + * [`RAFilterProcess.RemoveCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomProperty) + * [`RAFilterProcess.RemoveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveOutputVariable) + * [`RAFilterProcess.RemoveProcess()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveProcess) + * [`RAFilterProcess.SetCurrentTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.SetCurrentTimeStep) + * [`RAFilterProcess.SetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetCutValue) + * [`RAFilterProcess.SetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMaxValue) + * [`RAFilterProcess.SetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMinValue) + * [`RAFilterProcess.SetMode()`](RAFilterProcess.md#generated.RAFilterProcess.SetMode) + * [`RAFilterProcess.SetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.SetPropertyGridFunction) + * [`RAFilterProcess.SetType()`](RAFilterProcess.md#generated.RAFilterProcess.SetType) + * [RAFiveRollsBeltProfile](RAFiveRollsBeltProfile.md) + * [`RAFiveRollsBeltProfile`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile) + * [`RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths) + * [`RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths) + * [`RAFiveRollsBeltProfile.GetAvailableMaterials()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetAvailableMaterials) + * [`RAFiveRollsBeltProfile.GetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetCenterRollLength) + * [`RAFiveRollsBeltProfile.GetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLastRollAngle) + * [`RAFiveRollsBeltProfile.GetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLowerCornerRadius) + * [`RAFiveRollsBeltProfile.GetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetMaterial) + * [`RAFiveRollsBeltProfile.GetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetSideRollLength) + * [`RAFiveRollsBeltProfile.GetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetTroughingAngle) + * [`RAFiveRollsBeltProfile.GetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUpperCornerRadius) + * [`RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths) + * [`RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled) + * [`RAFiveRollsBeltProfile.SetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetCenterRollLength) + * [`RAFiveRollsBeltProfile.SetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLastRollAngle) + * [`RAFiveRollsBeltProfile.SetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLowerCornerRadius) + * [`RAFiveRollsBeltProfile.SetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetMaterial) + * [`RAFiveRollsBeltProfile.SetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetSideRollLength) + * [`RAFiveRollsBeltProfile.SetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetTroughingAngle) + * [`RAFiveRollsBeltProfile.SetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUpperCornerRadius) + * [`RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths) + * [RAFluentOneWayCoupling](RAFluentOneWayCoupling.md) + * [`RAFluentOneWayCoupling`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling) + * [`RAFluentOneWayCoupling.AddCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCurve) + * [`RAFluentOneWayCoupling.AddCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomCurve) + * [`RAFluentOneWayCoupling.AddCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomProperty) + * [`RAFluentOneWayCoupling.AddGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddGridFunction) + * [`RAFluentOneWayCoupling.CreateCoupledBoundaries()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCoupledBoundaries) + * [`RAFluentOneWayCoupling.CreateCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCurveOutputVariable) + * [`RAFluentOneWayCoupling.CreateGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunction) + * [`RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells) + * [`RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable) + * [`RAFluentOneWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateTransientCurveOutputVariable) + * [`RAFluentOneWayCoupling.EditCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomCurve) + * [`RAFluentOneWayCoupling.EditCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomProperty) + * [`RAFluentOneWayCoupling.GetActivesArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetActivesArray) + * [`RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames) + * [`RAFluentOneWayCoupling.GetBoundingBox()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetBoundingBox) + * [`RAFluentOneWayCoupling.GetCFDParametersList()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCFDParametersList) + * [`RAFluentOneWayCoupling.GetCellAreaAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellAreaAsArray) + * [`RAFluentOneWayCoupling.GetCellCenterAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellCenterAsArray) + * [`RAFluentOneWayCoupling.GetCellDzAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellDzAsArray) + * [`RAFluentOneWayCoupling.GetCellFromIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellFromIJK) + * [`RAFluentOneWayCoupling.GetCellIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellIJK) + * [`RAFluentOneWayCoupling.GetCellNumberOfVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellNumberOfVertices) + * [`RAFluentOneWayCoupling.GetCellPointsAsFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellPointsAsFunction) + * [`RAFluentOneWayCoupling.GetCellVolumeAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellVolumeAsArray) + * [`RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw) + * [`RAFluentOneWayCoupling.GetCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurve) + * [`RAFluentOneWayCoupling.GetCurveNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNames) + * [`RAFluentOneWayCoupling.GetCurveNamesAssociation()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation) + * [`RAFluentOneWayCoupling.GetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetDragLaw) + * [`RAFluentOneWayCoupling.GetElementCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetElementCurve) + * [`RAFluentOneWayCoupling.GetGeometryQuantity()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryQuantity) + * [`RAFluentOneWayCoupling.GetGeometryUnit()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryUnit) + * [`RAFluentOneWayCoupling.GetGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunction) + * [`RAFluentOneWayCoupling.GetGridFunctionNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunctionNames) + * [`RAFluentOneWayCoupling.GetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetIsOneWayPeriodic) + * [`RAFluentOneWayCoupling.GetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetLiftLaw) + * [`RAFluentOneWayCoupling.GetMeshColoring()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMeshColoring) + * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK1) + * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK2) + * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK3) + * [`RAFluentOneWayCoupling.GetNumberOfCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfCells) + * [`RAFluentOneWayCoupling.GetNumberOfNodes()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfNodes) + * [`RAFluentOneWayCoupling.GetNumpyCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumpyCurve) + * [`RAFluentOneWayCoupling.GetOutputVariableValue()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOutputVariableValue) + * [`RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance) + * [`RAFluentOneWayCoupling.GetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetStartTime) + * [`RAFluentOneWayCoupling.GetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienC1) + * [`RAFluentOneWayCoupling.GetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienD1) + * [`RAFluentOneWayCoupling.GetTimeSet()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeSet) + * [`RAFluentOneWayCoupling.GetTimeStatistics()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStatistics) + * [`RAFluentOneWayCoupling.GetTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStep) + * [`RAFluentOneWayCoupling.GetTopologyShape()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTopologyShape) + * [`RAFluentOneWayCoupling.GetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTorqueLaw) + * [`RAFluentOneWayCoupling.GetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion) + * [`RAFluentOneWayCoupling.GetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants) + * [`RAFluentOneWayCoupling.GetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance) + * [`RAFluentOneWayCoupling.GetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVirtualMassLaw) + * [`RAFluentOneWayCoupling.HasGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.HasGridFunction) + * [`RAFluentOneWayCoupling.IsCellActive()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IsCellActive) + * [`RAFluentOneWayCoupling.IterCellVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCellVertices) + * [`RAFluentOneWayCoupling.IterCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCells) + * [`RAFluentOneWayCoupling.Modified()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.Modified) + * [`RAFluentOneWayCoupling.RemoveCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomCurve) + * [`RAFluentOneWayCoupling.RemoveCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomProperty) + * [`RAFluentOneWayCoupling.RemoveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveOutputVariable) + * [`RAFluentOneWayCoupling.RemoveProcess()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveProcess) + * [`RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw) + * [`RAFluentOneWayCoupling.SetCurrentTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetCurrentTimeStep) + * [`RAFluentOneWayCoupling.SetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetDragLaw) + * [`RAFluentOneWayCoupling.SetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetIsOneWayPeriodic) + * [`RAFluentOneWayCoupling.SetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetLiftLaw) + * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK1) + * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK2) + * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK3) + * [`RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance) + * [`RAFluentOneWayCoupling.SetPartIdIfValid()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetPartIdIfValid) + * [`RAFluentOneWayCoupling.SetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetStartTime) + * [`RAFluentOneWayCoupling.SetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienC1) + * [`RAFluentOneWayCoupling.SetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienD1) + * [`RAFluentOneWayCoupling.SetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetTorqueLaw) + * [`RAFluentOneWayCoupling.SetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseTurbulentDispersion) + * [`RAFluentOneWayCoupling.SetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseUserDefinedConstants) + * [`RAFluentOneWayCoupling.SetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUserCfdUpdateDistance) + * [`RAFluentOneWayCoupling.SetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetVirtualMassLaw) + * [`RAFluentOneWayCoupling.SetupStoreFiles()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetupStoreFiles) + * [RAFluentSemiResolvedCoupling](RAFluentSemiResolvedCoupling.md) + * [`RAFluentSemiResolvedCoupling`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling) + * [`RAFluentSemiResolvedCoupling.GetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetCouplingFilesKept) + * [`RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs) + * [`RAFluentSemiResolvedCoupling.GetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentExecutionMode) + * [`RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier) + * [`RAFluentSemiResolvedCoupling.GetFluentReleases()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentReleases) + * [`RAFluentSemiResolvedCoupling.GetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentSolverProcesses) + * [`RAFluentSemiResolvedCoupling.GetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentVersion) + * [`RAFluentSemiResolvedCoupling.GetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetUseDatInitialization) + * [`RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues) + * [`RAFluentSemiResolvedCoupling.SetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetCouplingFilesKept) + * [`RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs) + * [`RAFluentSemiResolvedCoupling.SetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentExecutionMode) + * [`RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier) + * [`RAFluentSemiResolvedCoupling.SetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentSolverProcesses) + * [`RAFluentSemiResolvedCoupling.SetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentVersion) + * [`RAFluentSemiResolvedCoupling.SetPartIdIfValid()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetPartIdIfValid) + * [`RAFluentSemiResolvedCoupling.SetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetUseDatInitialization) + * [`RAFluentSemiResolvedCoupling.SetupStoreFiles()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetupStoreFiles) + * [RAFluentTwoWayCoupling](RAFluentTwoWayCoupling.md) + * [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling) + * [`RAFluentTwoWayCoupling.AddCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCurve) + * [`RAFluentTwoWayCoupling.AddCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomCurve) + * [`RAFluentTwoWayCoupling.AddCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomProperty) + * [`RAFluentTwoWayCoupling.AddGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddGridFunction) + * [`RAFluentTwoWayCoupling.CloseFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CloseFluent) + * [`RAFluentTwoWayCoupling.CreateCoupledBoundaries()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCoupledBoundaries) + * [`RAFluentTwoWayCoupling.CreateCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCurveOutputVariable) + * [`RAFluentTwoWayCoupling.CreateGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunction) + * [`RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells) + * [`RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable) + * [`RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable) + * [`RAFluentTwoWayCoupling.DisableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableBackDiffusion) + * [`RAFluentTwoWayCoupling.DisableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableSubstepping) + * [`RAFluentTwoWayCoupling.EditCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomCurve) + * [`RAFluentTwoWayCoupling.EditCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomProperty) + * [`RAFluentTwoWayCoupling.EnableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableBackDiffusion) + * [`RAFluentTwoWayCoupling.EnableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableSubstepping) + * [`RAFluentTwoWayCoupling.GetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAbsoluteValue) + * [`RAFluentTwoWayCoupling.GetActivesArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetActivesArray) + * [`RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames) + * [`RAFluentTwoWayCoupling.GetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingMethod) + * [`RAFluentTwoWayCoupling.GetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingRadiusType) + * [`RAFluentTwoWayCoupling.GetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBackDiffusion) + * [`RAFluentTwoWayCoupling.GetBoundingBox()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBoundingBox) + * [`RAFluentTwoWayCoupling.GetCFDParametersList()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCFDParametersList) + * [`RAFluentTwoWayCoupling.GetCellAreaAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellAreaAsArray) + * [`RAFluentTwoWayCoupling.GetCellCenterAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellCenterAsArray) + * [`RAFluentTwoWayCoupling.GetCellDzAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellDzAsArray) + * [`RAFluentTwoWayCoupling.GetCellFromIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellFromIJK) + * [`RAFluentTwoWayCoupling.GetCellIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellIJK) + * [`RAFluentTwoWayCoupling.GetCellNumberOfVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellNumberOfVertices) + * [`RAFluentTwoWayCoupling.GetCellPointsAsFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellPointsAsFunction) + * [`RAFluentTwoWayCoupling.GetCellVolumeAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellVolumeAsArray) + * [`RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw) + * [`RAFluentTwoWayCoupling.GetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCouplingFilesKept) + * [`RAFluentTwoWayCoupling.GetCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurve) + * [`RAFluentTwoWayCoupling.GetCurveNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNames) + * [`RAFluentTwoWayCoupling.GetCurveNamesAssociation()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNamesAssociation) + * [`RAFluentTwoWayCoupling.GetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDecompositionFactor) + * [`RAFluentTwoWayCoupling.GetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient) + * [`RAFluentTwoWayCoupling.GetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDragLaw) + * [`RAFluentTwoWayCoupling.GetElementCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetElementCurve) + * [`RAFluentTwoWayCoupling.GetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs) + * [`RAFluentTwoWayCoupling.GetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode) + * [`RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier) + * [`RAFluentTwoWayCoupling.GetFluentReleases()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentReleases) + * [`RAFluentTwoWayCoupling.GetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentSolverProcesses) + * [`RAFluentTwoWayCoupling.GetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentVersion) + * [`RAFluentTwoWayCoupling.GetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFractionParticleSize) + * [`RAFluentTwoWayCoupling.GetGeometryQuantity()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryQuantity) + * [`RAFluentTwoWayCoupling.GetGeometryUnit()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryUnit) + * [`RAFluentTwoWayCoupling.GetGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunction) + * [`RAFluentTwoWayCoupling.GetGridFunctionNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunctionNames) + * [`RAFluentTwoWayCoupling.GetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetLiftLaw) + * [`RAFluentTwoWayCoupling.GetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMappingMethod) + * [`RAFluentTwoWayCoupling.GetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumIterations) + * [`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) + * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1) + * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2) + * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3) + * [`RAFluentTwoWayCoupling.GetNumberOfCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfCells) + * [`RAFluentTwoWayCoupling.GetNumberOfNodes()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfNodes) + * [`RAFluentTwoWayCoupling.GetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfSubsteps) + * [`RAFluentTwoWayCoupling.GetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfThreads) + * [`RAFluentTwoWayCoupling.GetNumpyCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumpyCurve) + * [`RAFluentTwoWayCoupling.GetOutputVariableValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOutputVariableValue) + * [`RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.GetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSubstepping) + * [`RAFluentTwoWayCoupling.GetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienC1) + * [`RAFluentTwoWayCoupling.GetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienD1) + * [`RAFluentTwoWayCoupling.GetTimeSet()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeSet) + * [`RAFluentTwoWayCoupling.GetTimeStatistics()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStatistics) + * [`RAFluentTwoWayCoupling.GetTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStep) + * [`RAFluentTwoWayCoupling.GetTopologyShape()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTopologyShape) + * [`RAFluentTwoWayCoupling.GetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTorqueLaw) + * [`RAFluentTwoWayCoupling.GetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseDatInitialization) + * [`RAFluentTwoWayCoupling.GetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseTurbulentDispersion) + * [`RAFluentTwoWayCoupling.GetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseUserDefinedConstants) + * [`RAFluentTwoWayCoupling.GetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUserCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.GetValidAveragingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingMethodValues) + * [`RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues) + * [`RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues) + * [`RAFluentTwoWayCoupling.GetValidMappingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) + * [`RAFluentTwoWayCoupling.GetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw) + * [`RAFluentTwoWayCoupling.GetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.HasGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.HasGridFunction) + * [`RAFluentTwoWayCoupling.IsBackDiffusionEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsBackDiffusionEnabled) + * [`RAFluentTwoWayCoupling.IsCellActive()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsCellActive) + * [`RAFluentTwoWayCoupling.IsFluentRunning()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsFluentRunning) + * [`RAFluentTwoWayCoupling.IsSubsteppingEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsSubsteppingEnabled) + * [`RAFluentTwoWayCoupling.IterCellVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCellVertices) + * [`RAFluentTwoWayCoupling.IterCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCells) + * [`RAFluentTwoWayCoupling.Modified()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.Modified) + * [`RAFluentTwoWayCoupling.RemoveCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomCurve) + * [`RAFluentTwoWayCoupling.RemoveCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomProperty) + * [`RAFluentTwoWayCoupling.RemoveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveOutputVariable) + * [`RAFluentTwoWayCoupling.RemoveProcess()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveProcess) + * [`RAFluentTwoWayCoupling.SetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAbsoluteValue) + * [`RAFluentTwoWayCoupling.SetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingMethod) + * [`RAFluentTwoWayCoupling.SetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingRadiusType) + * [`RAFluentTwoWayCoupling.SetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetBackDiffusion) + * [`RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw) + * [`RAFluentTwoWayCoupling.SetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCouplingFilesKept) + * [`RAFluentTwoWayCoupling.SetCurrentTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCurrentTimeStep) + * [`RAFluentTwoWayCoupling.SetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDecompositionFactor) + * [`RAFluentTwoWayCoupling.SetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDiffusionCoefficient) + * [`RAFluentTwoWayCoupling.SetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDragLaw) + * [`RAFluentTwoWayCoupling.SetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentAdditionalArgs) + * [`RAFluentTwoWayCoupling.SetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentExecutionMode) + * [`RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier) + * [`RAFluentTwoWayCoupling.SetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentSolverProcesses) + * [`RAFluentTwoWayCoupling.SetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentVersion) + * [`RAFluentTwoWayCoupling.SetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFractionParticleSize) + * [`RAFluentTwoWayCoupling.SetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetLiftLaw) + * [`RAFluentTwoWayCoupling.SetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMappingMethod) + * [`RAFluentTwoWayCoupling.SetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumIterations) + * [`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) + * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2) + * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3) + * [`RAFluentTwoWayCoupling.SetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfSubsteps) + * [`RAFluentTwoWayCoupling.SetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfThreads) + * [`RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.SetPartIdIfValid()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetPartIdIfValid) + * [`RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.SetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSubstepping) + * [`RAFluentTwoWayCoupling.SetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienC1) + * [`RAFluentTwoWayCoupling.SetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienD1) + * [`RAFluentTwoWayCoupling.SetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetTorqueLaw) + * [`RAFluentTwoWayCoupling.SetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseDatInitialization) + * [`RAFluentTwoWayCoupling.SetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseTurbulentDispersion) + * [`RAFluentTwoWayCoupling.SetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseUserDefinedConstants) + * [`RAFluentTwoWayCoupling.SetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUserCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.SetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVirtualMassLaw) + * [`RAFluentTwoWayCoupling.SetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.SetupStoreFiles()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetupStoreFiles) + * [`RAFluentTwoWayCoupling.StartFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.StartFluent) + * [`RAFluentTwoWayCoupling.UpdateFluentInfo()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.UpdateFluentInfo) + * [RAFluidInlet](RAFluidInlet.md) + * [`RAFluidInlet`](RAFluidInlet.md#generated.RAFluidInlet) + * [`RAFluidInlet.GetAvailableEntryPoints()`](RAFluidInlet.md#generated.RAFluidInlet.GetAvailableEntryPoints) + * [`RAFluidInlet.GetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.GetBoundaryCondition) + * [`RAFluidInlet.GetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.GetEntryPoint) + * [`RAFluidInlet.GetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.GetMassFlowRate) + * [`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.SetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.SetBoundaryCondition) + * [`RAFluidInlet.SetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.SetEntryPoint) + * [`RAFluidInlet.SetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.SetMassFlowRate) + * [`RAFluidInlet.SetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStartTime) + * [`RAFluidInlet.SetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStopTime) + * [`RAFluidInlet.SetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.SetTemperature) + * [`RAFluidInlet.SetVelocity()`](RAFluidInlet.md#generated.RAFluidInlet.SetVelocity) + * [RAFluidMaterial](RAFluidMaterial.md) + * [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) + * [`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) + * [RAFreeBodyRotation](RAFreeBodyRotation.md) + * [`RAFreeBodyRotation`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation) + * [`RAFreeBodyRotation.GetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetFreeMotionDirection) + * [`RAFreeBodyRotation.GetValidFreeMotionDirectionValues()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetValidFreeMotionDirectionValues) + * [`RAFreeBodyRotation.SetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.SetFreeMotionDirection) + * [RAFreeBodyTranslation](RAFreeBodyTranslation.md) + * [`RAFreeBodyTranslation`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation) + * [`RAFreeBodyTranslation.GetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetFreeMotionDirection) + * [`RAFreeBodyTranslation.GetValidFreeMotionDirectionValues()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetValidFreeMotionDirectionValues) + * [`RAFreeBodyTranslation.SetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.SetFreeMotionDirection) + * [RAGeometryCollection](RAGeometryCollection.md) + * [`RAGeometryCollection`](RAGeometryCollection.md#generated.RAGeometryCollection) + * [`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.RemoveGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.RemoveGeometry) + * [RAInletGeometry](RAInletGeometry.md) + * [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry) + * [`RAInletGeometry.AddCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCurve) + * [`RAInletGeometry.AddCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomCurve) + * [`RAInletGeometry.AddCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomProperty) + * [`RAInletGeometry.AddGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.AddGridFunction) + * [`RAInletGeometry.CreateCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateCurveOutputVariable) + * [`RAInletGeometry.CreateGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunction) + * [`RAInletGeometry.CreateGridFunctionArrayOnCells()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionArrayOnCells) + * [`RAInletGeometry.CreateGridFunctionStatisticOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionStatisticOutputVariable) + * [`RAInletGeometry.CreateTransientCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateTransientCurveOutputVariable) + * [`RAInletGeometry.EditCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomCurve) + * [`RAInletGeometry.EditCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomProperty) + * [`RAInletGeometry.GetActivesArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetActivesArray) + * [`RAInletGeometry.GetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetAlignmentAngle) + * [`RAInletGeometry.GetBoundingBox()`](RAInletGeometry.md#generated.RAInletGeometry.GetBoundingBox) + * [`RAInletGeometry.GetCellAreaAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellAreaAsArray) + * [`RAInletGeometry.GetCellCenterAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellCenterAsArray) + * [`RAInletGeometry.GetCellDzAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellDzAsArray) + * [`RAInletGeometry.GetCellFromIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellFromIJK) + * [`RAInletGeometry.GetCellIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellIJK) + * [`RAInletGeometry.GetCellNumberOfVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellNumberOfVertices) + * [`RAInletGeometry.GetCellPointsAsFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellPointsAsFunction) + * [`RAInletGeometry.GetCellVolumeAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellVolumeAsArray) + * [`RAInletGeometry.GetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.GetCenter) + * [`RAInletGeometry.GetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.GetCircularMinMaxRadius) + * [`RAInletGeometry.GetCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurve) + * [`RAInletGeometry.GetCurveNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNames) + * [`RAInletGeometry.GetCurveNamesAssociation()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNamesAssociation) + * [`RAInletGeometry.GetElementCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetElementCurve) + * [`RAInletGeometry.GetGeometryQuantity()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryQuantity) + * [`RAInletGeometry.GetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryType) + * [`RAInletGeometry.GetGeometryUnit()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryUnit) + * [`RAInletGeometry.GetGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunction) + * [`RAInletGeometry.GetGridFunctionNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunctionNames) + * [`RAInletGeometry.GetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetInclineAngle) + * [`RAInletGeometry.GetLength()`](RAInletGeometry.md#generated.RAInletGeometry.GetLength) + * [`RAInletGeometry.GetMeshColoring()`](RAInletGeometry.md#generated.RAInletGeometry.GetMeshColoring) + * [`RAInletGeometry.GetNumberOfCells()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfCells) + * [`RAInletGeometry.GetNumberOfNodes()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfNodes) + * [`RAInletGeometry.GetNumpyCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumpyCurve) + * [`RAInletGeometry.GetOutputVariableValue()`](RAInletGeometry.md#generated.RAInletGeometry.GetOutputVariableValue) + * [`RAInletGeometry.GetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.GetRectangularSize) + * [`RAInletGeometry.GetTimeSet()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeSet) + * [`RAInletGeometry.GetTimeStatistics()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStatistics) + * [`RAInletGeometry.GetTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStep) + * [`RAInletGeometry.GetTopologyShape()`](RAInletGeometry.md#generated.RAInletGeometry.GetTopologyShape) + * [`RAInletGeometry.GetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.GetWidth) + * [`RAInletGeometry.HasGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.HasGridFunction) + * [`RAInletGeometry.IsCellActive()`](RAInletGeometry.md#generated.RAInletGeometry.IsCellActive) + * [`RAInletGeometry.IterCellVertices()`](RAInletGeometry.md#generated.RAInletGeometry.IterCellVertices) + * [`RAInletGeometry.IterCells()`](RAInletGeometry.md#generated.RAInletGeometry.IterCells) + * [`RAInletGeometry.Modified()`](RAInletGeometry.md#generated.RAInletGeometry.Modified) + * [`RAInletGeometry.RemoveCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomCurve) + * [`RAInletGeometry.RemoveCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomProperty) + * [`RAInletGeometry.RemoveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveOutputVariable) + * [`RAInletGeometry.RemoveProcess()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveProcess) + * [`RAInletGeometry.SetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetAlignmentAngle) + * [`RAInletGeometry.SetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.SetCenter) + * [`RAInletGeometry.SetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.SetCircularMinMaxRadius) + * [`RAInletGeometry.SetCurrentTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.SetCurrentTimeStep) + * [`RAInletGeometry.SetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.SetGeometryType) + * [`RAInletGeometry.SetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetInclineAngle) + * [`RAInletGeometry.SetLength()`](RAInletGeometry.md#generated.RAInletGeometry.SetLength) + * [`RAInletGeometry.SetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.SetRectangularSize) + * [`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) + * [`RAInletsOutletsCollection.AddParticleInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddParticleInlet) + * [`RAInletsOutletsCollection.AddVolumetricInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddVolumetricInlet) + * [`RAInletsOutletsCollection.Clear()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Clear) + * [`RAInletsOutletsCollection.GetParticleInput()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInput) + * [`RAInletsOutletsCollection.GetParticleInputNames()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInputNames) + * [`RAInletsOutletsCollection.New()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.New) + * [`RAInletsOutletsCollection.Remove()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Remove) + * [RAInputVariables](RAInputVariables.md) + * [`RAInputVariables`](RAInputVariables.md#generated.RAInputVariables) + * [`RAInputVariables.CreateVariable()`](RAInputVariables.md#generated.RAInputVariables.CreateVariable) + * [`RAInputVariables.GetVariableByName()`](RAInputVariables.md#generated.RAInputVariables.GetVariableByName) + * [`RAInputVariables.RemoveVariable()`](RAInputVariables.md#generated.RAInputVariables.RemoveVariable) + * [RAInspectorProcess](RAInspectorProcess.md) + * [`RAInspectorProcess`](RAInspectorProcess.md#generated.RAInspectorProcess) + * [`RAInspectorProcess.AddCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCurve) + * [`RAInspectorProcess.AddCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomCurve) + * [`RAInspectorProcess.AddCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomProperty) + * [`RAInspectorProcess.AddGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddGridFunction) + * [`RAInspectorProcess.CreateCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateCurveOutputVariable) + * [`RAInspectorProcess.CreateGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunction) + * [`RAInspectorProcess.CreateGridFunctionArrayOnCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionArrayOnCells) + * [`RAInspectorProcess.CreateGridFunctionStatisticOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAInspectorProcess.CreateTransientCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateTransientCurveOutputVariable) + * [`RAInspectorProcess.EditCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomCurve) + * [`RAInspectorProcess.EditCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomProperty) + * [`RAInspectorProcess.GetActivesArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetActivesArray) + * [`RAInspectorProcess.GetBoundingBox()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetBoundingBox) + * [`RAInspectorProcess.GetCellAreaAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellAreaAsArray) + * [`RAInspectorProcess.GetCellCenterAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellCenterAsArray) + * [`RAInspectorProcess.GetCellDzAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellDzAsArray) + * [`RAInspectorProcess.GetCellFromIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellFromIJK) + * [`RAInspectorProcess.GetCellIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellIJK) + * [`RAInspectorProcess.GetCellNumberOfVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellNumberOfVertices) + * [`RAInspectorProcess.GetCellPointsAsFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellPointsAsFunction) + * [`RAInspectorProcess.GetCellVolumeAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellVolumeAsArray) + * [`RAInspectorProcess.GetCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurve) + * [`RAInspectorProcess.GetCurveNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNames) + * [`RAInspectorProcess.GetCurveNamesAssociation()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNamesAssociation) + * [`RAInspectorProcess.GetElementCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetElementCurve) + * [`RAInspectorProcess.GetGeometryQuantity()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryQuantity) + * [`RAInspectorProcess.GetGeometryUnit()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryUnit) + * [`RAInspectorProcess.GetGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunction) + * [`RAInspectorProcess.GetGridFunctionNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunctionNames) + * [`RAInspectorProcess.GetMeshColoring()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetMeshColoring) + * [`RAInspectorProcess.GetNumberOfCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfCells) + * [`RAInspectorProcess.GetNumberOfNodes()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfNodes) + * [`RAInspectorProcess.GetNumberOfParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfParticles) + * [`RAInspectorProcess.GetNumpyCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumpyCurve) + * [`RAInspectorProcess.GetOutputVariableValue()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetOutputVariableValue) + * [`RAInspectorProcess.GetTimeSet()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeSet) + * [`RAInspectorProcess.GetTimeStatistics()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStatistics) + * [`RAInspectorProcess.GetTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStep) + * [`RAInspectorProcess.GetTopologyShape()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTopologyShape) + * [`RAInspectorProcess.HasGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.HasGridFunction) + * [`RAInspectorProcess.IsCellActive()`](RAInspectorProcess.md#generated.RAInspectorProcess.IsCellActive) + * [`RAInspectorProcess.IterCellVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCellVertices) + * [`RAInspectorProcess.IterCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCells) + * [`RAInspectorProcess.IterParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterParticles) + * [`RAInspectorProcess.Modified()`](RAInspectorProcess.md#generated.RAInspectorProcess.Modified) + * [`RAInspectorProcess.RemoveCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomCurve) + * [`RAInspectorProcess.RemoveCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomProperty) + * [`RAInspectorProcess.RemoveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveOutputVariable) + * [`RAInspectorProcess.RemoveProcess()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveProcess) + * [`RAInspectorProcess.SetCurrentTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.SetCurrentTimeStep) + * [RAJointsDataMeshColoring](RAJointsDataMeshColoring.md) + * [`RAJointsDataMeshColoring`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring) + * [`RAJointsDataMeshColoring.GetAvailableGridFunctions()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctions) + * [`RAJointsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctionsNames) + * [`RAJointsDataMeshColoring.GetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsColor) + * [`RAJointsDataMeshColoring.GetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityColor) + * [`RAJointsDataMeshColoring.GetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityLineWidth) + * [`RAJointsDataMeshColoring.GetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityProperty) + * [`RAJointsDataMeshColoring.GetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityVisible) + * [`RAJointsDataMeshColoring.GetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsPointSize) + * [`RAJointsDataMeshColoring.GetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsProperty) + * [`RAJointsDataMeshColoring.GetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsVisible) + * [`RAJointsDataMeshColoring.GetValidColoringModes()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetValidColoringModes) + * [`RAJointsDataMeshColoring.SetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsColor) + * [`RAJointsDataMeshColoring.SetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityColor) + * [`RAJointsDataMeshColoring.SetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityLineWidth) + * [`RAJointsDataMeshColoring.SetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityProperty) + * [`RAJointsDataMeshColoring.SetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityVisible) + * [`RAJointsDataMeshColoring.SetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsPointSize) + * [`RAJointsDataMeshColoring.SetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsProperty) + * [`RAJointsDataMeshColoring.SetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsVisible) + * [RALinearTimeVariableForce](RALinearTimeVariableForce.md) + * [`RALinearTimeVariableForce`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce) + * [`RALinearTimeVariableForce.GetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetInitialForceValue) + * [`RALinearTimeVariableForce.GetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetTimeCoefficients) + * [`RALinearTimeVariableForce.SetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetInitialForceValue) + * [`RALinearTimeVariableForce.SetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetTimeCoefficients) + * [RALinearTimeVariableMoment](RALinearTimeVariableMoment.md) + * [`RALinearTimeVariableMoment`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment) + * [`RALinearTimeVariableMoment.GetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetInitialMomentValue) + * [`RALinearTimeVariableMoment.GetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetTimeCoefficients) + * [`RALinearTimeVariableMoment.SetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetInitialMomentValue) + * [`RALinearTimeVariableMoment.SetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetTimeCoefficients) + * [RAMaterialCollection](RAMaterialCollection.md) + * [`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) + * [`RAMaterialCollection.Remove()`](RAMaterialCollection.md#generated.RAMaterialCollection.Remove) + * [`RAMaterialCollection.SetBulkSolidFraction()`](RAMaterialCollection.md#generated.RAMaterialCollection.SetBulkSolidFraction) + * [RAMaterialsInteraction](RAMaterialsInteraction.md) + * [`RAMaterialsInteraction`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction) + * [`RAMaterialsInteraction.GetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveDistance) + * [`RAMaterialsInteraction.GetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveFraction) + * [`RAMaterialsInteraction.GetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetContactStiffnessMultiplier) + * [`RAMaterialsInteraction.GetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetDynamicFriction) + * [`RAMaterialsInteraction.GetFirstMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetFirstMaterial) + * [`RAMaterialsInteraction.GetModuleProperties()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperties) + * [`RAMaterialsInteraction.GetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperty) + * [`RAMaterialsInteraction.GetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetRestitutionCoefficient) + * [`RAMaterialsInteraction.GetSecondMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSecondMaterial) + * [`RAMaterialsInteraction.GetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetStaticFriction) + * [`RAMaterialsInteraction.GetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSurfaceEnergy) + * [`RAMaterialsInteraction.GetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetTangentialStiffnessRatio) + * [`RAMaterialsInteraction.GetValidOptionsForModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetValidOptionsForModuleProperty) + * [`RAMaterialsInteraction.GetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityExponent) + * [`RAMaterialsInteraction.GetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityLimit) + * [`RAMaterialsInteraction.SetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveDistance) + * [`RAMaterialsInteraction.SetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveFraction) + * [`RAMaterialsInteraction.SetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetContactStiffnessMultiplier) + * [`RAMaterialsInteraction.SetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetDynamicFriction) + * [`RAMaterialsInteraction.SetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetModuleProperty) + * [`RAMaterialsInteraction.SetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetRestitutionCoefficient) + * [`RAMaterialsInteraction.SetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetStaticFriction) + * [`RAMaterialsInteraction.SetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetSurfaceEnergy) + * [`RAMaterialsInteraction.SetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetTangentialStiffnessRatio) + * [`RAMaterialsInteraction.SetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityExponent) + * [`RAMaterialsInteraction.SetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityLimit) + * [RAMaterialsInteractionCollection](RAMaterialsInteractionCollection.md) + * [`RAMaterialsInteractionCollection`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection) + * [`RAMaterialsInteractionCollection.Clear()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Clear) + * [`RAMaterialsInteractionCollection.GetMaterialsInteraction()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.GetMaterialsInteraction) + * [`RAMaterialsInteractionCollection.New()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.New) + * [`RAMaterialsInteractionCollection.Remove()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Remove) + * [RAMeshColoring](RAMeshColoring.md) + * [`RAMeshColoring`](RAMeshColoring.md#generated.RAMeshColoring) + * [`RAMeshColoring.GetAvailableGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctions) + * [`RAMeshColoring.GetAvailableGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctionsNames) + * [`RAMeshColoring.GetAvailableVectorGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctions) + * [`RAMeshColoring.GetAvailableVectorGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctionsNames) + * [`RAMeshColoring.GetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeColor) + * [`RAMeshColoring.GetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeGridFunction) + * [`RAMeshColoring.GetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeLineWidth) + * [`RAMeshColoring.GetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeVisible) + * [`RAMeshColoring.GetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceColor) + * [`RAMeshColoring.GetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceCustomStructuredPartitions) + * [`RAMeshColoring.GetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceGridFunction) + * [`RAMeshColoring.GetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceScope) + * [`RAMeshColoring.GetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceShowOnNode) + * [`RAMeshColoring.GetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceStructuredPartitions) + * [`RAMeshColoring.GetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceVisible) + * [`RAMeshColoring.GetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.GetLevelOfDetail) + * [`RAMeshColoring.GetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeColor) + * [`RAMeshColoring.GetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeGridFunction) + * [`RAMeshColoring.GetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodePointSize) + * [`RAMeshColoring.GetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeVisible) + * [`RAMeshColoring.GetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetNormalizedVectorsEnabled) + * [`RAMeshColoring.GetStride()`](RAMeshColoring.md#generated.RAMeshColoring.GetStride) + * [`RAMeshColoring.GetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparency) + * [`RAMeshColoring.GetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparencyEnabled) + * [`RAMeshColoring.GetValidColoringModes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidColoringModes) + * [`RAMeshColoring.GetValidFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceCustomStructuredPartitions) + * [`RAMeshColoring.GetValidFaceScopes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceScopes) + * [`RAMeshColoring.GetValidFaceStructuredPartitionsValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceStructuredPartitionsValues) + * [`RAMeshColoring.GetValidLevelOfDetailValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidLevelOfDetailValues) + * [`RAMeshColoring.GetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorGridFunction) + * [`RAMeshColoring.GetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorScale) + * [`RAMeshColoring.GetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorVisible) + * [`RAMeshColoring.GetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVisible) + * [`RAMeshColoring.SetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeColor) + * [`RAMeshColoring.SetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeGridFunction) + * [`RAMeshColoring.SetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeLineWidth) + * [`RAMeshColoring.SetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeVisible) + * [`RAMeshColoring.SetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceColor) + * [`RAMeshColoring.SetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceCustomStructuredPartitions) + * [`RAMeshColoring.SetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceGridFunction) + * [`RAMeshColoring.SetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceScope) + * [`RAMeshColoring.SetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceShowOnNode) + * [`RAMeshColoring.SetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceStructuredPartitions) + * [`RAMeshColoring.SetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceVisible) + * [`RAMeshColoring.SetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.SetLevelOfDetail) + * [`RAMeshColoring.SetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeColor) + * [`RAMeshColoring.SetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeGridFunction) + * [`RAMeshColoring.SetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodePointSize) + * [`RAMeshColoring.SetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeVisible) + * [`RAMeshColoring.SetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetNormalizedVectorsEnabled) + * [`RAMeshColoring.SetStride()`](RAMeshColoring.md#generated.RAMeshColoring.SetStride) + * [`RAMeshColoring.SetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparency) + * [`RAMeshColoring.SetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparencyEnabled) + * [`RAMeshColoring.SetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorGridFunction) + * [`RAMeshColoring.SetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorScale) + * [`RAMeshColoring.SetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorVisible) + * [`RAMeshColoring.SetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVisible) + * [RAModule](RAModule.md) + * [`RAModule`](RAModule.md#generated.RAModule) + * [`RAModule.DisableModule()`](RAModule.md#generated.RAModule.DisableModule) + * [`RAModule.EnableModule()`](RAModule.md#generated.RAModule.EnableModule) + * [`RAModule.GetModuleProperties()`](RAModule.md#generated.RAModule.GetModuleProperties) + * [`RAModule.GetModuleProperty()`](RAModule.md#generated.RAModule.GetModuleProperty) + * [`RAModule.GetOutputObject()`](RAModule.md#generated.RAModule.GetOutputObject) + * [`RAModule.GetValidOptionsForModuleProperty()`](RAModule.md#generated.RAModule.GetValidOptionsForModuleProperty) + * [`RAModule.IsModuleEnabled()`](RAModule.md#generated.RAModule.IsModuleEnabled) + * [`RAModule.SetModuleEnabled()`](RAModule.md#generated.RAModule.SetModuleEnabled) + * [`RAModule.SetModuleProperty()`](RAModule.md#generated.RAModule.SetModuleProperty) + * [RAModuleCollection](RAModuleCollection.md) + * [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) + * [`RAModuleCollection.GetEnabledModules()`](RAModuleCollection.md#generated.RAModuleCollection.GetEnabledModules) + * [`RAModuleCollection.GetModule()`](RAModuleCollection.md#generated.RAModuleCollection.GetModule) + * [`RAModuleCollection.GetModuleNames()`](RAModuleCollection.md#generated.RAModuleCollection.GetModuleNames) + * [RAModuleOutput](RAModuleOutput.md) + * [`RAModuleOutput`](RAModuleOutput.md#generated.RAModuleOutput) + * [`RAModuleOutput.AddCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCurve) + * [`RAModuleOutput.AddCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomCurve) + * [`RAModuleOutput.AddCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomProperty) + * [`RAModuleOutput.AddGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.AddGridFunction) + * [`RAModuleOutput.CreateCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateCurveOutputVariable) + * [`RAModuleOutput.CreateGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunction) + * [`RAModuleOutput.CreateGridFunctionArrayOnCells()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionArrayOnCells) + * [`RAModuleOutput.CreateGridFunctionStatisticOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionStatisticOutputVariable) + * [`RAModuleOutput.CreateTransientCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateTransientCurveOutputVariable) + * [`RAModuleOutput.EditCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomCurve) + * [`RAModuleOutput.EditCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomProperty) + * [`RAModuleOutput.GetActivesArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetActivesArray) + * [`RAModuleOutput.GetBoundingBox()`](RAModuleOutput.md#generated.RAModuleOutput.GetBoundingBox) + * [`RAModuleOutput.GetCellAreaAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellAreaAsArray) + * [`RAModuleOutput.GetCellCenterAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellCenterAsArray) + * [`RAModuleOutput.GetCellDzAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellDzAsArray) + * [`RAModuleOutput.GetCellFromIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellFromIJK) + * [`RAModuleOutput.GetCellIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellIJK) + * [`RAModuleOutput.GetCellNumberOfVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellNumberOfVertices) + * [`RAModuleOutput.GetCellPointsAsFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellPointsAsFunction) + * [`RAModuleOutput.GetCellVolumeAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellVolumeAsArray) + * [`RAModuleOutput.GetCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurve) + * [`RAModuleOutput.GetCurveNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNames) + * [`RAModuleOutput.GetCurveNamesAssociation()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNamesAssociation) + * [`RAModuleOutput.GetElementCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetElementCurve) + * [`RAModuleOutput.GetGeometryQuantity()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryQuantity) + * [`RAModuleOutput.GetGeometryUnit()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryUnit) + * [`RAModuleOutput.GetGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunction) + * [`RAModuleOutput.GetGridFunctionNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunctionNames) + * [`RAModuleOutput.GetMeshColoring()`](RAModuleOutput.md#generated.RAModuleOutput.GetMeshColoring) + * [`RAModuleOutput.GetNumberOfCells()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfCells) + * [`RAModuleOutput.GetNumberOfNodes()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfNodes) + * [`RAModuleOutput.GetNumpyCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumpyCurve) + * [`RAModuleOutput.GetOutputVariableValue()`](RAModuleOutput.md#generated.RAModuleOutput.GetOutputVariableValue) + * [`RAModuleOutput.GetTimeSet()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeSet) + * [`RAModuleOutput.GetTimeStatistics()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStatistics) + * [`RAModuleOutput.GetTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStep) + * [`RAModuleOutput.GetTopologyShape()`](RAModuleOutput.md#generated.RAModuleOutput.GetTopologyShape) + * [`RAModuleOutput.HasGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.HasGridFunction) + * [`RAModuleOutput.IsCellActive()`](RAModuleOutput.md#generated.RAModuleOutput.IsCellActive) + * [`RAModuleOutput.IterCellVertices()`](RAModuleOutput.md#generated.RAModuleOutput.IterCellVertices) + * [`RAModuleOutput.IterCells()`](RAModuleOutput.md#generated.RAModuleOutput.IterCells) + * [`RAModuleOutput.Modified()`](RAModuleOutput.md#generated.RAModuleOutput.Modified) + * [`RAModuleOutput.RemoveCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomCurve) + * [`RAModuleOutput.RemoveCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomProperty) + * [`RAModuleOutput.RemoveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveOutputVariable) + * [`RAModuleOutput.RemoveProcess()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveProcess) + * [`RAModuleOutput.SetCurrentTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.SetCurrentTimeStep) + * [RAModulePropertyList](RAModulePropertyList.md) + * [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) + * [`RAModulePropertyList.Clear()`](RAModulePropertyList.md#generated.RAModulePropertyList.Clear) + * [`RAModulePropertyList.New()`](RAModulePropertyList.md#generated.RAModulePropertyList.New) + * [`RAModulePropertyList.Remove()`](RAModulePropertyList.md#generated.RAModulePropertyList.Remove) + * [RAModulePropertyListItem](RAModulePropertyListItem.md) + * [`RAModulePropertyListItem`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem) + * [`RAModulePropertyListItem.GetModuleProperties()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperties) + * [`RAModulePropertyListItem.GetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperty) + * [`RAModulePropertyListItem.GetValidOptionsForModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetValidOptionsForModuleProperty) + * [`RAModulePropertyListItem.SetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.SetModuleProperty) + * [RAMotion](RAMotion.md) + * [`RAMotion`](RAMotion.md#generated.RAMotion) + * [`RAMotion.GetStartTime()`](RAMotion.md#generated.RAMotion.GetStartTime) + * [`RAMotion.GetStopTime()`](RAMotion.md#generated.RAMotion.GetStopTime) + * [`RAMotion.GetType()`](RAMotion.md#generated.RAMotion.GetType) + * [`RAMotion.GetTypeObject()`](RAMotion.md#generated.RAMotion.GetTypeObject) + * [`RAMotion.GetValidTypes()`](RAMotion.md#generated.RAMotion.GetValidTypes) + * [`RAMotion.SetStartTime()`](RAMotion.md#generated.RAMotion.SetStartTime) + * [`RAMotion.SetStopTime()`](RAMotion.md#generated.RAMotion.SetStopTime) + * [`RAMotion.SetType()`](RAMotion.md#generated.RAMotion.SetType) + * [RAMotionFrame](RAMotionFrame.md) + * [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame) + * [`RAMotionFrame.AddCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCurve) + * [`RAMotionFrame.AddCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomCurve) + * [`RAMotionFrame.AddCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomProperty) + * [`RAMotionFrame.AddGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.AddGridFunction) + * [`RAMotionFrame.AddPendulumMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddPendulumMotion) + * [`RAMotionFrame.AddRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddRotationMotion) + * [`RAMotionFrame.AddTranslationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddTranslationMotion) + * [`RAMotionFrame.AddVibrationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddVibrationMotion) + * [`RAMotionFrame.ApplyTo()`](RAMotionFrame.md#generated.RAMotionFrame.ApplyTo) + * [`RAMotionFrame.CreateCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateCurveOutputVariable) + * [`RAMotionFrame.CreateGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunction) + * [`RAMotionFrame.CreateGridFunctionArrayOnCells()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionArrayOnCells) + * [`RAMotionFrame.CreateGridFunctionStatisticOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionStatisticOutputVariable) + * [`RAMotionFrame.CreateTransientCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateTransientCurveOutputVariable) + * [`RAMotionFrame.EditCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomCurve) + * [`RAMotionFrame.EditCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomProperty) + * [`RAMotionFrame.GetActivesArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetActivesArray) + * [`RAMotionFrame.GetBoundingBox()`](RAMotionFrame.md#generated.RAMotionFrame.GetBoundingBox) + * [`RAMotionFrame.GetCellAreaAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellAreaAsArray) + * [`RAMotionFrame.GetCellCenterAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellCenterAsArray) + * [`RAMotionFrame.GetCellDzAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellDzAsArray) + * [`RAMotionFrame.GetCellFromIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellFromIJK) + * [`RAMotionFrame.GetCellIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellIJK) + * [`RAMotionFrame.GetCellNumberOfVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellNumberOfVertices) + * [`RAMotionFrame.GetCellPointsAsFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellPointsAsFunction) + * [`RAMotionFrame.GetCellVolumeAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellVolumeAsArray) + * [`RAMotionFrame.GetCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurve) + * [`RAMotionFrame.GetCurveNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNames) + * [`RAMotionFrame.GetCurveNamesAssociation()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNamesAssociation) + * [`RAMotionFrame.GetElementCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetElementCurve) + * [`RAMotionFrame.GetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmAngularLimits) + * [`RAMotionFrame.GetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmLinearLimits) + * [`RAMotionFrame.GetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnablePeriodicMotion) + * [`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.GetGeometryUnit()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryUnit) + * [`RAMotionFrame.GetGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunction) + * [`RAMotionFrame.GetGridFunctionNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunctionNames) + * [`RAMotionFrame.GetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.GetKeepInPlace) + * [`RAMotionFrame.GetMeshColoring()`](RAMotionFrame.md#generated.RAMotionFrame.GetMeshColoring) + * [`RAMotionFrame.GetMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotionFrame) + * [`RAMotionFrame.GetMotions()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotions) + * [`RAMotionFrame.GetNumberOfCells()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfCells) + * [`RAMotionFrame.GetNumberOfNodes()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfNodes) + * [`RAMotionFrame.GetNumpyCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumpyCurve) + * [`RAMotionFrame.GetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientation) + * [`RAMotionFrame.GetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngleAndVector) + * [`RAMotionFrame.GetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngles) + * [`RAMotionFrame.GetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromBasisVector) + * [`RAMotionFrame.GetOutputVariableValue()`](RAMotionFrame.md#generated.RAMotionFrame.GetOutputVariableValue) + * [`RAMotionFrame.GetParentMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetParentMotionFrame) + * [`RAMotionFrame.GetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionPeriod) + * [`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.HasGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.HasGridFunction) + * [`RAMotionFrame.IsCellActive()`](RAMotionFrame.md#generated.RAMotionFrame.IsCellActive) + * [`RAMotionFrame.IterCellVertices()`](RAMotionFrame.md#generated.RAMotionFrame.IterCellVertices) + * [`RAMotionFrame.IterCells()`](RAMotionFrame.md#generated.RAMotionFrame.IterCells) + * [`RAMotionFrame.IterMotionFrames()`](RAMotionFrame.md#generated.RAMotionFrame.IterMotionFrames) + * [`RAMotionFrame.Modified()`](RAMotionFrame.md#generated.RAMotionFrame.Modified) + * [`RAMotionFrame.NewConeCrusherFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewConeCrusherFrame) + * [`RAMotionFrame.NewFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewFrame) + * [`RAMotionFrame.RemoveCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomCurve) + * [`RAMotionFrame.RemoveCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomProperty) + * [`RAMotionFrame.RemoveFrame()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveFrame) + * [`RAMotionFrame.RemoveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveOutputVariable) + * [`RAMotionFrame.RemoveProcess()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveProcess) + * [`RAMotionFrame.SetCurrentTimeStep()`](RAMotionFrame.md#generated.RAMotionFrame.SetCurrentTimeStep) + * [`RAMotionFrame.SetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmAngularLimits) + * [`RAMotionFrame.SetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmLinearLimits) + * [`RAMotionFrame.SetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnablePeriodicMotion) + * [`RAMotionFrame.SetFbmMaxAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxAngularLimits) + * [`RAMotionFrame.SetFbmMaxLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxLinearLimits) + * [`RAMotionFrame.SetFbmMinAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinAngularLimits) + * [`RAMotionFrame.SetFbmMinLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinLinearLimits) + * [`RAMotionFrame.SetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.SetKeepInPlace) + * [`RAMotionFrame.SetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientation) + * [`RAMotionFrame.SetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngleAndVector) + * [`RAMotionFrame.SetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngles) + * [`RAMotionFrame.SetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromBasisVector) + * [`RAMotionFrame.SetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionPeriod) + * [`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) + * [`RAMotionFrameSource.GetParentMotionFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.GetParentMotionFrame) + * [`RAMotionFrameSource.IterMotionFrames()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.IterMotionFrames) + * [`RAMotionFrameSource.NewConeCrusherFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewConeCrusherFrame) + * [`RAMotionFrameSource.NewFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewFrame) + * [`RAMotionFrameSource.RemoveFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.RemoveFrame) + * [RAMotionList](RAMotionList.md) + * [`RAMotionList`](RAMotionList.md#generated.RAMotionList) + * [`RAMotionList.Clear()`](RAMotionList.md#generated.RAMotionList.Clear) + * [`RAMotionList.New()`](RAMotionList.md#generated.RAMotionList.New) + * [`RAMotionList.Remove()`](RAMotionList.md#generated.RAMotionList.Remove) + * [RAOneRollBeltProfile](RAOneRollBeltProfile.md) + * [`RAOneRollBeltProfile`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile) + * [`RAOneRollBeltProfile.GetAvailableMaterials()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetAvailableMaterials) + * [`RAOneRollBeltProfile.GetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetMaterial) + * [`RAOneRollBeltProfile.SetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.SetMaterial) + * [RAOutlet](RAOutlet.md) + * [`RAOutlet`](RAOutlet.md#generated.RAOutlet) + * [`RAOutlet.DisablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.DisablePrescribedPressure) + * [`RAOutlet.EnablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.EnablePrescribedPressure) + * [`RAOutlet.GetAvailableExitPoints()`](RAOutlet.md#generated.RAOutlet.GetAvailableExitPoints) + * [`RAOutlet.GetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.GetEnabledForParticles) + * [`RAOutlet.GetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.GetEnabledForSph) + * [`RAOutlet.GetExitPoint()`](RAOutlet.md#generated.RAOutlet.GetExitPoint) + * [`RAOutlet.GetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.GetPrescribedPressureEnabled) + * [`RAOutlet.GetPressure()`](RAOutlet.md#generated.RAOutlet.GetPressure) + * [`RAOutlet.IsPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.IsPrescribedPressureEnabled) + * [`RAOutlet.SetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.SetEnabledForParticles) + * [`RAOutlet.SetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.SetEnabledForSph) + * [`RAOutlet.SetExitPoint()`](RAOutlet.md#generated.RAOutlet.SetExitPoint) + * [`RAOutlet.SetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.SetPrescribedPressureEnabled) + * [`RAOutlet.SetPressure()`](RAOutlet.md#generated.RAOutlet.SetPressure) + * [RAParametricVar](RAParametricVar.md) + * [`RAParametricVar`](RAParametricVar.md#generated.RAParametricVar) + * [`RAParametricVar.GetValue()`](RAParametricVar.md#generated.RAParametricVar.GetValue) + * [`RAParametricVar.SetValue()`](RAParametricVar.md#generated.RAParametricVar.SetValue) + * [RAParametricVariables](RAParametricVariables.md) + * [`RAParametricVariables`](RAParametricVariables.md#generated.RAParametricVariables) + * [`RAParametricVariables.GetInputVariables()`](RAParametricVariables.md#generated.RAParametricVariables.GetInputVariables) + * [RAParticle](RAParticle.md) + * [`RAParticle`](RAParticle.md#generated.RAParticle) + * [`RAParticle.AddCurve()`](RAParticle.md#generated.RAParticle.AddCurve) + * [`RAParticle.AddCustomCurve()`](RAParticle.md#generated.RAParticle.AddCustomCurve) + * [`RAParticle.AddCustomProperty()`](RAParticle.md#generated.RAParticle.AddCustomProperty) + * [`RAParticle.AddGridFunction()`](RAParticle.md#generated.RAParticle.AddGridFunction) + * [`RAParticle.CreateCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateCurveOutputVariable) + * [`RAParticle.CreateGridFunction()`](RAParticle.md#generated.RAParticle.CreateGridFunction) + * [`RAParticle.CreateGridFunctionArrayOnCells()`](RAParticle.md#generated.RAParticle.CreateGridFunctionArrayOnCells) + * [`RAParticle.CreateGridFunctionStatisticOutputVariable()`](RAParticle.md#generated.RAParticle.CreateGridFunctionStatisticOutputVariable) + * [`RAParticle.CreateTransientCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateTransientCurveOutputVariable) + * [`RAParticle.DisableBreakage()`](RAParticle.md#generated.RAParticle.DisableBreakage) + * [`RAParticle.DisableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.DisableIncludeRotationalDeformations) + * [`RAParticle.DisableRandomOrientation()`](RAParticle.md#generated.RAParticle.DisableRandomOrientation) + * [`RAParticle.EditCustomCurve()`](RAParticle.md#generated.RAParticle.EditCustomCurve) + * [`RAParticle.EditCustomProperty()`](RAParticle.md#generated.RAParticle.EditCustomProperty) + * [`RAParticle.EnableBreakage()`](RAParticle.md#generated.RAParticle.EnableBreakage) + * [`RAParticle.EnableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.EnableIncludeRotationalDeformations) + * [`RAParticle.EnableRandomOrientation()`](RAParticle.md#generated.RAParticle.EnableRandomOrientation) + * [`RAParticle.GetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.GetAbt10MaximumT10Value) + * [`RAParticle.GetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10MinimumSpecificEnergy) + * [`RAParticle.GetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) + * [`RAParticle.GetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceSize) + * [`RAParticle.GetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.GetAbt10SelectFunctionCoefficient) + * [`RAParticle.GetActivesArray()`](RAParticle.md#generated.RAParticle.GetActivesArray) + * [`RAParticle.GetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) + * [`RAParticle.GetAnisotropic()`](RAParticle.md#generated.RAParticle.GetAnisotropic) + * [`RAParticle.GetAvailableMaterials()`](RAParticle.md#generated.RAParticle.GetAvailableMaterials) + * [`RAParticle.GetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetBendingAngleLimit) + * [`RAParticle.GetBoundingBox()`](RAParticle.md#generated.RAParticle.GetBoundingBox) + * [`RAParticle.GetBreakageModel()`](RAParticle.md#generated.RAParticle.GetBreakageModel) + * [`RAParticle.GetCellAreaAsArray()`](RAParticle.md#generated.RAParticle.GetCellAreaAsArray) + * [`RAParticle.GetCellCenterAsArray()`](RAParticle.md#generated.RAParticle.GetCellCenterAsArray) + * [`RAParticle.GetCellDzAsArray()`](RAParticle.md#generated.RAParticle.GetCellDzAsArray) + * [`RAParticle.GetCellFromIJK()`](RAParticle.md#generated.RAParticle.GetCellFromIJK) + * [`RAParticle.GetCellIJK()`](RAParticle.md#generated.RAParticle.GetCellIJK) + * [`RAParticle.GetCellNumberOfVertices()`](RAParticle.md#generated.RAParticle.GetCellNumberOfVertices) + * [`RAParticle.GetCellPointsAsFunction()`](RAParticle.md#generated.RAParticle.GetCellPointsAsFunction) + * [`RAParticle.GetCellVolumeAsArray()`](RAParticle.md#generated.RAParticle.GetCellVolumeAsArray) + * [`RAParticle.GetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.GetCenterOfMassOffset) + * [`RAParticle.GetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.GetCgmScaleFactor) + * [`RAParticle.GetChangeMassProperties()`](RAParticle.md#generated.RAParticle.GetChangeMassProperties) + * [`RAParticle.GetCurve()`](RAParticle.md#generated.RAParticle.GetCurve) + * [`RAParticle.GetCurveNames()`](RAParticle.md#generated.RAParticle.GetCurveNames) + * [`RAParticle.GetCurveNamesAssociation()`](RAParticle.md#generated.RAParticle.GetCurveNamesAssociation) + * [`RAParticle.GetDeformationModel()`](RAParticle.md#generated.RAParticle.GetDeformationModel) + * [`RAParticle.GetDistributionModel()`](RAParticle.md#generated.RAParticle.GetDistributionModel) + * [`RAParticle.GetEdgeAngle()`](RAParticle.md#generated.RAParticle.GetEdgeAngle) + * [`RAParticle.GetElasticRatioBending()`](RAParticle.md#generated.RAParticle.GetElasticRatioBending) + * [`RAParticle.GetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.GetElasticRatioNormal) + * [`RAParticle.GetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.GetElasticRatioTangential) + * [`RAParticle.GetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.GetElasticRatioTorsion) + * [`RAParticle.GetElasticity()`](RAParticle.md#generated.RAParticle.GetElasticity) + * [`RAParticle.GetElementCurve()`](RAParticle.md#generated.RAParticle.GetElementCurve) + * [`RAParticle.GetElementDampingRatio()`](RAParticle.md#generated.RAParticle.GetElementDampingRatio) + * [`RAParticle.GetEnableBreakage()`](RAParticle.md#generated.RAParticle.GetEnableBreakage) + * [`RAParticle.GetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.GetEnableRandomAngle) + * [`RAParticle.GetEnableRotations()`](RAParticle.md#generated.RAParticle.GetEnableRotations) + * [`RAParticle.GetFailureRatio()`](RAParticle.md#generated.RAParticle.GetFailureRatio) + * [`RAParticle.GetFlexible()`](RAParticle.md#generated.RAParticle.GetFlexible) + * [`RAParticle.GetGeometryQuantity()`](RAParticle.md#generated.RAParticle.GetGeometryQuantity) + * [`RAParticle.GetGeometryUnit()`](RAParticle.md#generated.RAParticle.GetGeometryUnit) + * [`RAParticle.GetGridFunction()`](RAParticle.md#generated.RAParticle.GetGridFunction) + * [`RAParticle.GetGridFunctionNames()`](RAParticle.md#generated.RAParticle.GetGridFunctionNames) + * [`RAParticle.GetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.GetHorizontalAspectRatio) + * [`RAParticle.GetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.GetIncludeRotationalDeformations) + * [`RAParticle.GetInternalFriction()`](RAParticle.md#generated.RAParticle.GetInternalFriction) + * [`RAParticle.GetJointDampingRatio()`](RAParticle.md#generated.RAParticle.GetJointDampingRatio) + * [`RAParticle.GetJointElasticRatio()`](RAParticle.md#generated.RAParticle.GetJointElasticRatio) + * [`RAParticle.GetJointThermalRatio()`](RAParticle.md#generated.RAParticle.GetJointThermalRatio) + * [`RAParticle.GetMaterial()`](RAParticle.md#generated.RAParticle.GetMaterial) + * [`RAParticle.GetMeshColoring()`](RAParticle.md#generated.RAParticle.GetMeshColoring) + * [`RAParticle.GetMinimumSize()`](RAParticle.md#generated.RAParticle.GetMinimumSize) + * [`RAParticle.GetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.GetMinimumSizeRatio) + * [`RAParticle.GetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.GetMinimumVolumeFractionForFragmentDisabling) + * [`RAParticle.GetModuleProperties()`](RAParticle.md#generated.RAParticle.GetModuleProperties) + * [`RAParticle.GetModuleProperty()`](RAParticle.md#generated.RAParticle.GetModuleProperty) + * [`RAParticle.GetNumberOfCells()`](RAParticle.md#generated.RAParticle.GetNumberOfCells) + * [`RAParticle.GetNumberOfCorners()`](RAParticle.md#generated.RAParticle.GetNumberOfCorners) + * [`RAParticle.GetNumberOfNodes()`](RAParticle.md#generated.RAParticle.GetNumberOfNodes) + * [`RAParticle.GetNumpyCurve()`](RAParticle.md#generated.RAParticle.GetNumpyCurve) + * [`RAParticle.GetOrientation()`](RAParticle.md#generated.RAParticle.GetOrientation) + * [`RAParticle.GetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngleAndVector) + * [`RAParticle.GetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngles) + * [`RAParticle.GetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromBasisVector) + * [`RAParticle.GetOutputVariableValue()`](RAParticle.md#generated.RAParticle.GetOutputVariableValue) + * [`RAParticle.GetPlasticLimit()`](RAParticle.md#generated.RAParticle.GetPlasticLimit) + * [`RAParticle.GetPlasticRatio()`](RAParticle.md#generated.RAParticle.GetPlasticRatio) + * [`RAParticle.GetPlasticityModel()`](RAParticle.md#generated.RAParticle.GetPlasticityModel) + * [`RAParticle.GetPorosity()`](RAParticle.md#generated.RAParticle.GetPorosity) + * [`RAParticle.GetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.GetPrincipalMomentOfInertia) + * [`RAParticle.GetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.GetRandomAnglesHalfRange) + * [`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) + * [`RAParticle.GetSideAngle()`](RAParticle.md#generated.RAParticle.GetSideAngle) + * [`RAParticle.GetSizeDistributionList()`](RAParticle.md#generated.RAParticle.GetSizeDistributionList) + * [`RAParticle.GetSizeType()`](RAParticle.md#generated.RAParticle.GetSizeType) + * [`RAParticle.GetSmoothness()`](RAParticle.md#generated.RAParticle.GetSmoothness) + * [`RAParticle.GetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.GetSuperquadricDegree) + * [`RAParticle.GetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.GetSurfaceEnergy) + * [`RAParticle.GetT10Formula()`](RAParticle.md#generated.RAParticle.GetT10Formula) + * [`RAParticle.GetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.GetTargetNumberOfElements) + * [`RAParticle.GetTavaresA()`](RAParticle.md#generated.RAParticle.GetTavaresA) + * [`RAParticle.GetTavaresB()`](RAParticle.md#generated.RAParticle.GetTavaresB) + * [`RAParticle.GetTavaresD0()`](RAParticle.md#generated.RAParticle.GetTavaresD0) + * [`RAParticle.GetTavaresEInf()`](RAParticle.md#generated.RAParticle.GetTavaresEInf) + * [`RAParticle.GetTavaresGamma()`](RAParticle.md#generated.RAParticle.GetTavaresGamma) + * [`RAParticle.GetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.GetTavaresMinimumEnergy) + * [`RAParticle.GetTavaresPhi()`](RAParticle.md#generated.RAParticle.GetTavaresPhi) + * [`RAParticle.GetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.GetTavaresRatioEmax) + * [`RAParticle.GetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.GetTavaresSigmaSquared) + * [`RAParticle.GetTensileStressLimit()`](RAParticle.md#generated.RAParticle.GetTensileStressLimit) + * [`RAParticle.GetThickness()`](RAParticle.md#generated.RAParticle.GetThickness) + * [`RAParticle.GetTimeSet()`](RAParticle.md#generated.RAParticle.GetTimeSet) + * [`RAParticle.GetTimeStatistics()`](RAParticle.md#generated.RAParticle.GetTimeStatistics) + * [`RAParticle.GetTimeStep()`](RAParticle.md#generated.RAParticle.GetTimeStep) + * [`RAParticle.GetTopologyShape()`](RAParticle.md#generated.RAParticle.GetTopologyShape) + * [`RAParticle.GetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.GetTorsionAngleLimit) + * [`RAParticle.GetUseMultipleElements()`](RAParticle.md#generated.RAParticle.GetUseMultipleElements) + * [`RAParticle.GetValidBreakageModelValues()`](RAParticle.md#generated.RAParticle.GetValidBreakageModelValues) + * [`RAParticle.GetValidDeformationModelValues()`](RAParticle.md#generated.RAParticle.GetValidDeformationModelValues) + * [`RAParticle.GetValidDistributionModelValues()`](RAParticle.md#generated.RAParticle.GetValidDistributionModelValues) + * [`RAParticle.GetValidElasticityValues()`](RAParticle.md#generated.RAParticle.GetValidElasticityValues) + * [`RAParticle.GetValidOptionsForModuleProperty()`](RAParticle.md#generated.RAParticle.GetValidOptionsForModuleProperty) + * [`RAParticle.GetValidPlasticityModelValues()`](RAParticle.md#generated.RAParticle.GetValidPlasticityModelValues) + * [`RAParticle.GetValidShapeValues()`](RAParticle.md#generated.RAParticle.GetValidShapeValues) + * [`RAParticle.GetValidSizeTypeValues()`](RAParticle.md#generated.RAParticle.GetValidSizeTypeValues) + * [`RAParticle.GetValidT10FormulaValues()`](RAParticle.md#generated.RAParticle.GetValidT10FormulaValues) + * [`RAParticle.GetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.GetVerticalAspectRatio) + * [`RAParticle.GetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.GetVonMisesStressLimit) + * [`RAParticle.GetWithFailure()`](RAParticle.md#generated.RAParticle.GetWithFailure) + * [`RAParticle.GetXDirection()`](RAParticle.md#generated.RAParticle.GetXDirection) + * [`RAParticle.GetYDirection()`](RAParticle.md#generated.RAParticle.GetYDirection) + * [`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) + * [`RAParticle.IsConcave()`](RAParticle.md#generated.RAParticle.IsConcave) + * [`RAParticle.IsIncludeRotationalDeformationsEnabled()`](RAParticle.md#generated.RAParticle.IsIncludeRotationalDeformationsEnabled) + * [`RAParticle.IsRandomOrientationEnabled()`](RAParticle.md#generated.RAParticle.IsRandomOrientationEnabled) + * [`RAParticle.IterCellVertices()`](RAParticle.md#generated.RAParticle.IterCellVertices) + * [`RAParticle.IterCells()`](RAParticle.md#generated.RAParticle.IterCells) + * [`RAParticle.Modified()`](RAParticle.md#generated.RAParticle.Modified) + * [`RAParticle.RemoveCustomCurve()`](RAParticle.md#generated.RAParticle.RemoveCustomCurve) + * [`RAParticle.RemoveCustomProperty()`](RAParticle.md#generated.RAParticle.RemoveCustomProperty) + * [`RAParticle.RemoveOutputVariable()`](RAParticle.md#generated.RAParticle.RemoveOutputVariable) + * [`RAParticle.RemoveProcess()`](RAParticle.md#generated.RAParticle.RemoveProcess) + * [`RAParticle.SetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.SetAbt10MaximumT10Value) + * [`RAParticle.SetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10MinimumSpecificEnergy) + * [`RAParticle.SetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) + * [`RAParticle.SetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceSize) + * [`RAParticle.SetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.SetAbt10SelectFunctionCoefficient) + * [`RAParticle.SetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.SetAllowSelfContacts) + * [`RAParticle.SetAnisotropic()`](RAParticle.md#generated.RAParticle.SetAnisotropic) + * [`RAParticle.SetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.SetBendingAngleLimit) + * [`RAParticle.SetBreakageModel()`](RAParticle.md#generated.RAParticle.SetBreakageModel) + * [`RAParticle.SetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.SetCenterOfMassOffset) + * [`RAParticle.SetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.SetCgmScaleFactor) + * [`RAParticle.SetChangeMassProperties()`](RAParticle.md#generated.RAParticle.SetChangeMassProperties) + * [`RAParticle.SetCurrentTimeStep()`](RAParticle.md#generated.RAParticle.SetCurrentTimeStep) + * [`RAParticle.SetDeformationModel()`](RAParticle.md#generated.RAParticle.SetDeformationModel) + * [`RAParticle.SetDistributionModel()`](RAParticle.md#generated.RAParticle.SetDistributionModel) + * [`RAParticle.SetEdgeAngle()`](RAParticle.md#generated.RAParticle.SetEdgeAngle) + * [`RAParticle.SetElasticRatioBending()`](RAParticle.md#generated.RAParticle.SetElasticRatioBending) + * [`RAParticle.SetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.SetElasticRatioNormal) + * [`RAParticle.SetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.SetElasticRatioTangential) + * [`RAParticle.SetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.SetElasticRatioTorsion) + * [`RAParticle.SetElasticity()`](RAParticle.md#generated.RAParticle.SetElasticity) + * [`RAParticle.SetElementDampingRatio()`](RAParticle.md#generated.RAParticle.SetElementDampingRatio) + * [`RAParticle.SetEnableBreakage()`](RAParticle.md#generated.RAParticle.SetEnableBreakage) + * [`RAParticle.SetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.SetEnableRandomAngle) + * [`RAParticle.SetEnableRotations()`](RAParticle.md#generated.RAParticle.SetEnableRotations) + * [`RAParticle.SetFailureRatio()`](RAParticle.md#generated.RAParticle.SetFailureRatio) + * [`RAParticle.SetFlexible()`](RAParticle.md#generated.RAParticle.SetFlexible) + * [`RAParticle.SetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.SetHorizontalAspectRatio) + * [`RAParticle.SetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.SetIncludeRotationalDeformations) + * [`RAParticle.SetInternalFriction()`](RAParticle.md#generated.RAParticle.SetInternalFriction) + * [`RAParticle.SetJointDampingRatio()`](RAParticle.md#generated.RAParticle.SetJointDampingRatio) + * [`RAParticle.SetJointElasticRatio()`](RAParticle.md#generated.RAParticle.SetJointElasticRatio) + * [`RAParticle.SetJointThermalRatio()`](RAParticle.md#generated.RAParticle.SetJointThermalRatio) + * [`RAParticle.SetMaterial()`](RAParticle.md#generated.RAParticle.SetMaterial) + * [`RAParticle.SetMinimumSize()`](RAParticle.md#generated.RAParticle.SetMinimumSize) + * [`RAParticle.SetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.SetMinimumSizeRatio) + * [`RAParticle.SetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.SetMinimumVolumeFractionForFragmentDisabling) + * [`RAParticle.SetModuleProperty()`](RAParticle.md#generated.RAParticle.SetModuleProperty) + * [`RAParticle.SetNumberOfCorners()`](RAParticle.md#generated.RAParticle.SetNumberOfCorners) + * [`RAParticle.SetOrientation()`](RAParticle.md#generated.RAParticle.SetOrientation) + * [`RAParticle.SetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngleAndVector) + * [`RAParticle.SetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngles) + * [`RAParticle.SetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromBasisVector) + * [`RAParticle.SetPlasticLimit()`](RAParticle.md#generated.RAParticle.SetPlasticLimit) + * [`RAParticle.SetPlasticRatio()`](RAParticle.md#generated.RAParticle.SetPlasticRatio) + * [`RAParticle.SetPlasticityModel()`](RAParticle.md#generated.RAParticle.SetPlasticityModel) + * [`RAParticle.SetPorosity()`](RAParticle.md#generated.RAParticle.SetPorosity) + * [`RAParticle.SetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.SetPrincipalMomentOfInertia) + * [`RAParticle.SetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.SetRandomAnglesHalfRange) + * [`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) + * [`RAParticle.SetSideAngle()`](RAParticle.md#generated.RAParticle.SetSideAngle) + * [`RAParticle.SetSizeType()`](RAParticle.md#generated.RAParticle.SetSizeType) + * [`RAParticle.SetSmoothness()`](RAParticle.md#generated.RAParticle.SetSmoothness) + * [`RAParticle.SetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.SetSuperquadricDegree) + * [`RAParticle.SetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.SetSurfaceEnergy) + * [`RAParticle.SetT10Formula()`](RAParticle.md#generated.RAParticle.SetT10Formula) + * [`RAParticle.SetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.SetTargetNumberOfElements) + * [`RAParticle.SetTavaresA()`](RAParticle.md#generated.RAParticle.SetTavaresA) + * [`RAParticle.SetTavaresB()`](RAParticle.md#generated.RAParticle.SetTavaresB) + * [`RAParticle.SetTavaresD0()`](RAParticle.md#generated.RAParticle.SetTavaresD0) + * [`RAParticle.SetTavaresEInf()`](RAParticle.md#generated.RAParticle.SetTavaresEInf) + * [`RAParticle.SetTavaresGamma()`](RAParticle.md#generated.RAParticle.SetTavaresGamma) + * [`RAParticle.SetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.SetTavaresMinimumEnergy) + * [`RAParticle.SetTavaresPhi()`](RAParticle.md#generated.RAParticle.SetTavaresPhi) + * [`RAParticle.SetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.SetTavaresRatioEmax) + * [`RAParticle.SetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.SetTavaresSigmaSquared) + * [`RAParticle.SetTensileStressLimit()`](RAParticle.md#generated.RAParticle.SetTensileStressLimit) + * [`RAParticle.SetThickness()`](RAParticle.md#generated.RAParticle.SetThickness) + * [`RAParticle.SetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.SetTorsionAngleLimit) + * [`RAParticle.SetUseMultipleElements()`](RAParticle.md#generated.RAParticle.SetUseMultipleElements) + * [`RAParticle.SetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.SetVerticalAspectRatio) + * [`RAParticle.SetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.SetVonMisesStressLimit) + * [`RAParticle.SetWithFailure()`](RAParticle.md#generated.RAParticle.SetWithFailure) + * [`RAParticle.SetXDirection()`](RAParticle.md#generated.RAParticle.SetXDirection) + * [`RAParticle.SetYDirection()`](RAParticle.md#generated.RAParticle.SetYDirection) + * [`RAParticle.SetZDirection()`](RAParticle.md#generated.RAParticle.SetZDirection) + * [RAParticleAssemblyPart](RAParticleAssemblyPart.md) + * [`RAParticleAssemblyPart`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart) + * [`RAParticleAssemblyPart.GetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAngle) + * [`RAParticleAssemblyPart.GetAvailableParticles()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAvailableParticles) + * [`RAParticleAssemblyPart.GetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetParticle) + * [`RAParticleAssemblyPart.GetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionX) + * [`RAParticleAssemblyPart.GetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionY) + * [`RAParticleAssemblyPart.GetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionZ) + * [`RAParticleAssemblyPart.GetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationX) + * [`RAParticleAssemblyPart.GetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationY) + * [`RAParticleAssemblyPart.GetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationZ) + * [`RAParticleAssemblyPart.GetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetScale) + * [`RAParticleAssemblyPart.SetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetAngle) + * [`RAParticleAssemblyPart.SetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetParticle) + * [`RAParticleAssemblyPart.SetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionX) + * [`RAParticleAssemblyPart.SetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionY) + * [`RAParticleAssemblyPart.SetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionZ) + * [`RAParticleAssemblyPart.SetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationX) + * [`RAParticleAssemblyPart.SetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationY) + * [`RAParticleAssemblyPart.SetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationZ) + * [`RAParticleAssemblyPart.SetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetScale) + * [RAParticleAssemblyPartList](RAParticleAssemblyPartList.md) + * [`RAParticleAssemblyPartList`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList) + * [`RAParticleAssemblyPartList.Clear()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Clear) + * [`RAParticleAssemblyPartList.New()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.New) + * [`RAParticleAssemblyPartList.Remove()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Remove) + * [RAParticleCollection](RAParticleCollection.md) + * [`RAParticleCollection`](RAParticleCollection.md#generated.RAParticleCollection) + * [`RAParticleCollection.Clear()`](RAParticleCollection.md#generated.RAParticleCollection.Clear) + * [`RAParticleCollection.GetParticle()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticle) + * [`RAParticleCollection.GetParticleNames()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticleNames) + * [`RAParticleCollection.New()`](RAParticleCollection.md#generated.RAParticleCollection.New) + * [`RAParticleCollection.Remove()`](RAParticleCollection.md#generated.RAParticleCollection.Remove) + * [RAParticleInlet](RAParticleInlet.md) + * [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) + * [`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.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) + * [`RAParticleInlet.SetStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopAllAtStopTime) + * [`RAParticleInlet.SetStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopTime) + * [`RAParticleInlet.SetTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetTargetNormalVelocity) + * [`RAParticleInlet.SetUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetUseTargetNormalVelocity) + * [`RAParticleInlet.SetUxLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUxLocal) + * [`RAParticleInlet.SetUzLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUzLocal) + * [RAParticleInletProperties](RAParticleInletProperties.md) + * [`RAParticleInletProperties`](RAParticleInletProperties.md#generated.RAParticleInletProperties) + * [`RAParticleInletProperties.GetAvailableParticles()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetAvailableParticles) + * [`RAParticleInletProperties.GetMassFlowRate()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetMassFlowRate) + * [`RAParticleInletProperties.GetModuleProperties()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetModuleProperties) + * [`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) + * [`RAParticleInletPropertiesList.New()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.New) + * [`RAParticleInletPropertiesList.Remove()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.Remove) + * [RAParticleJointsData](RAParticleJointsData.md) + * [`RAParticleJointsData`](RAParticleJointsData.md#generated.RAParticleJointsData) + * [`RAParticleJointsData.AddCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCurve) + * [`RAParticleJointsData.AddCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomCurve) + * [`RAParticleJointsData.AddCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomProperty) + * [`RAParticleJointsData.AddGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddGridFunction) + * [`RAParticleJointsData.CreateCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateCurveOutputVariable) + * [`RAParticleJointsData.CreateGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunction) + * [`RAParticleJointsData.CreateGridFunctionArrayOnCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionArrayOnCells) + * [`RAParticleJointsData.CreateGridFunctionStatisticOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionStatisticOutputVariable) + * [`RAParticleJointsData.CreateTransientCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateTransientCurveOutputVariable) + * [`RAParticleJointsData.DisableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.DisableCollectJointData) + * [`RAParticleJointsData.EditCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomCurve) + * [`RAParticleJointsData.EditCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomProperty) + * [`RAParticleJointsData.EnableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.EnableCollectJointData) + * [`RAParticleJointsData.GetActivesArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetActivesArray) + * [`RAParticleJointsData.GetBoundingBox()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetBoundingBox) + * [`RAParticleJointsData.GetCellAreaAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellAreaAsArray) + * [`RAParticleJointsData.GetCellCenterAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellCenterAsArray) + * [`RAParticleJointsData.GetCellDzAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellDzAsArray) + * [`RAParticleJointsData.GetCellFromIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellFromIJK) + * [`RAParticleJointsData.GetCellIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellIJK) + * [`RAParticleJointsData.GetCellNumberOfVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellNumberOfVertices) + * [`RAParticleJointsData.GetCellPointsAsFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellPointsAsFunction) + * [`RAParticleJointsData.GetCellVolumeAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellVolumeAsArray) + * [`RAParticleJointsData.GetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCollectJointData) + * [`RAParticleJointsData.GetCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurve) + * [`RAParticleJointsData.GetCurveNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNames) + * [`RAParticleJointsData.GetCurveNamesAssociation()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNamesAssociation) + * [`RAParticleJointsData.GetElementCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetElementCurve) + * [`RAParticleJointsData.GetGeometryQuantity()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryQuantity) + * [`RAParticleJointsData.GetGeometryUnit()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryUnit) + * [`RAParticleJointsData.GetGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunction) + * [`RAParticleJointsData.GetGridFunctionNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunctionNames) + * [`RAParticleJointsData.GetMeshColoring()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetMeshColoring) + * [`RAParticleJointsData.GetNumberOfCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfCells) + * [`RAParticleJointsData.GetNumberOfNodes()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfNodes) + * [`RAParticleJointsData.GetNumpyCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumpyCurve) + * [`RAParticleJointsData.GetOutputVariableValue()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetOutputVariableValue) + * [`RAParticleJointsData.GetTimeSet()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeSet) + * [`RAParticleJointsData.GetTimeStatistics()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStatistics) + * [`RAParticleJointsData.GetTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStep) + * [`RAParticleJointsData.GetTopologyShape()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTopologyShape) + * [`RAParticleJointsData.HasGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.HasGridFunction) + * [`RAParticleJointsData.IsCellActive()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCellActive) + * [`RAParticleJointsData.IsCollectJointDataEnabled()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCollectJointDataEnabled) + * [`RAParticleJointsData.IterCellVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCellVertices) + * [`RAParticleJointsData.IterCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCells) + * [`RAParticleJointsData.Modified()`](RAParticleJointsData.md#generated.RAParticleJointsData.Modified) + * [`RAParticleJointsData.RemoveCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomCurve) + * [`RAParticleJointsData.RemoveCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomProperty) + * [`RAParticleJointsData.RemoveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveOutputVariable) + * [`RAParticleJointsData.RemoveProcess()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveProcess) + * [`RAParticleJointsData.SetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCollectJointData) + * [`RAParticleJointsData.SetCurrentTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCurrentTimeStep) + * [RAParticleTimeSelectionProcess](RAParticleTimeSelectionProcess.md) + * [`RAParticleTimeSelectionProcess`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess) + * [`RAParticleTimeSelectionProcess.AddCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCurve) + * [`RAParticleTimeSelectionProcess.AddCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomCurve) + * [`RAParticleTimeSelectionProcess.AddCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomProperty) + * [`RAParticleTimeSelectionProcess.AddGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddGridFunction) + * [`RAParticleTimeSelectionProcess.CreateCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateCurveOutputVariable) + * [`RAParticleTimeSelectionProcess.CreateGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunction) + * [`RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells) + * [`RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable) + * [`RAParticleTimeSelectionProcess.EditCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomCurve) + * [`RAParticleTimeSelectionProcess.EditCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomProperty) + * [`RAParticleTimeSelectionProcess.GetActivesArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetActivesArray) + * [`RAParticleTimeSelectionProcess.GetBoundingBox()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetBoundingBox) + * [`RAParticleTimeSelectionProcess.GetCellAreaAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellAreaAsArray) + * [`RAParticleTimeSelectionProcess.GetCellCenterAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellCenterAsArray) + * [`RAParticleTimeSelectionProcess.GetCellDzAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellDzAsArray) + * [`RAParticleTimeSelectionProcess.GetCellFromIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellFromIJK) + * [`RAParticleTimeSelectionProcess.GetCellIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellIJK) + * [`RAParticleTimeSelectionProcess.GetCellNumberOfVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellNumberOfVertices) + * [`RAParticleTimeSelectionProcess.GetCellPointsAsFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellPointsAsFunction) + * [`RAParticleTimeSelectionProcess.GetCellVolumeAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellVolumeAsArray) + * [`RAParticleTimeSelectionProcess.GetCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurve) + * [`RAParticleTimeSelectionProcess.GetCurveNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNames) + * [`RAParticleTimeSelectionProcess.GetCurveNamesAssociation()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation) + * [`RAParticleTimeSelectionProcess.GetElementCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetElementCurve) + * [`RAParticleTimeSelectionProcess.GetGeometryQuantity()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity) + * [`RAParticleTimeSelectionProcess.GetGeometryUnit()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryUnit) + * [`RAParticleTimeSelectionProcess.GetGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunction) + * [`RAParticleTimeSelectionProcess.GetGridFunctionNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames) + * [`RAParticleTimeSelectionProcess.GetMeshColoring()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetMeshColoring) + * [`RAParticleTimeSelectionProcess.GetNumberOfCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfCells) + * [`RAParticleTimeSelectionProcess.GetNumberOfNodes()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfNodes) + * [`RAParticleTimeSelectionProcess.GetNumberOfParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfParticles) + * [`RAParticleTimeSelectionProcess.GetNumpyCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumpyCurve) + * [`RAParticleTimeSelectionProcess.GetOutputVariableValue()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetOutputVariableValue) + * [`RAParticleTimeSelectionProcess.GetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeRange) + * [`RAParticleTimeSelectionProcess.GetTimeSet()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeSet) + * [`RAParticleTimeSelectionProcess.GetTimeStatistics()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStatistics) + * [`RAParticleTimeSelectionProcess.GetTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStep) + * [`RAParticleTimeSelectionProcess.GetTopologyShape()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTopologyShape) + * [`RAParticleTimeSelectionProcess.HasGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.HasGridFunction) + * [`RAParticleTimeSelectionProcess.IsCellActive()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IsCellActive) + * [`RAParticleTimeSelectionProcess.IterCellVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCellVertices) + * [`RAParticleTimeSelectionProcess.IterCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCells) + * [`RAParticleTimeSelectionProcess.IterParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterParticles) + * [`RAParticleTimeSelectionProcess.Modified()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.Modified) + * [`RAParticleTimeSelectionProcess.RemoveCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomCurve) + * [`RAParticleTimeSelectionProcess.RemoveCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomProperty) + * [`RAParticleTimeSelectionProcess.RemoveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveOutputVariable) + * [`RAParticleTimeSelectionProcess.RemoveProcess()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveProcess) + * [`RAParticleTimeSelectionProcess.SetAbsoluteTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetAbsoluteTimeRange) + * [`RAParticleTimeSelectionProcess.SetCurrentTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetCurrentTimeStep) + * [`RAParticleTimeSelectionProcess.SetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetTimeRange) + * [RAParticleToContactProcess](RAParticleToContactProcess.md) + * [`RAParticleToContactProcess`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess) + * [`RAParticleToContactProcess.AddCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCurve) + * [`RAParticleToContactProcess.AddCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomCurve) + * [`RAParticleToContactProcess.AddCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomProperty) + * [`RAParticleToContactProcess.AddGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddGridFunction) + * [`RAParticleToContactProcess.CreateCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateCurveOutputVariable) + * [`RAParticleToContactProcess.CreateGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunction) + * [`RAParticleToContactProcess.CreateGridFunctionArrayOnCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionArrayOnCells) + * [`RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAParticleToContactProcess.CreateTransientCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateTransientCurveOutputVariable) + * [`RAParticleToContactProcess.EditCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomCurve) + * [`RAParticleToContactProcess.EditCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomProperty) + * [`RAParticleToContactProcess.GetActivesArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetActivesArray) + * [`RAParticleToContactProcess.GetBoundingBox()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetBoundingBox) + * [`RAParticleToContactProcess.GetCellAreaAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellAreaAsArray) + * [`RAParticleToContactProcess.GetCellCenterAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellCenterAsArray) + * [`RAParticleToContactProcess.GetCellDzAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellDzAsArray) + * [`RAParticleToContactProcess.GetCellFromIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellFromIJK) + * [`RAParticleToContactProcess.GetCellIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellIJK) + * [`RAParticleToContactProcess.GetCellNumberOfVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellNumberOfVertices) + * [`RAParticleToContactProcess.GetCellPointsAsFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellPointsAsFunction) + * [`RAParticleToContactProcess.GetCellVolumeAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellVolumeAsArray) + * [`RAParticleToContactProcess.GetCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurve) + * [`RAParticleToContactProcess.GetCurveNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNames) + * [`RAParticleToContactProcess.GetCurveNamesAssociation()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNamesAssociation) + * [`RAParticleToContactProcess.GetElementCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetElementCurve) + * [`RAParticleToContactProcess.GetGeometryQuantity()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryQuantity) + * [`RAParticleToContactProcess.GetGeometryUnit()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryUnit) + * [`RAParticleToContactProcess.GetGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunction) + * [`RAParticleToContactProcess.GetGridFunctionNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunctionNames) + * [`RAParticleToContactProcess.GetMeshColoring()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetMeshColoring) + * [`RAParticleToContactProcess.GetNumberOfCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfCells) + * [`RAParticleToContactProcess.GetNumberOfNodes()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfNodes) + * [`RAParticleToContactProcess.GetNumberOfParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfParticles) + * [`RAParticleToContactProcess.GetNumpyCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumpyCurve) + * [`RAParticleToContactProcess.GetOutputVariableValue()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetOutputVariableValue) + * [`RAParticleToContactProcess.GetTimeSet()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeSet) + * [`RAParticleToContactProcess.GetTimeStatistics()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStatistics) + * [`RAParticleToContactProcess.GetTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStep) + * [`RAParticleToContactProcess.GetTopologyShape()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTopologyShape) + * [`RAParticleToContactProcess.HasGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.HasGridFunction) + * [`RAParticleToContactProcess.IsCellActive()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IsCellActive) + * [`RAParticleToContactProcess.IterCellVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCellVertices) + * [`RAParticleToContactProcess.IterCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCells) + * [`RAParticleToContactProcess.IterParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterParticles) + * [`RAParticleToContactProcess.Modified()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.Modified) + * [`RAParticleToContactProcess.RemoveCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomCurve) + * [`RAParticleToContactProcess.RemoveCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomProperty) + * [`RAParticleToContactProcess.RemoveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveOutputVariable) + * [`RAParticleToContactProcess.RemoveProcess()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveProcess) + * [`RAParticleToContactProcess.SetCurrentTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.SetCurrentTimeStep) + * [RAParticles](RAParticles.md) + * [`RAParticles`](RAParticles.md#generated.RAParticles) + * [`RAParticles.AddCurve()`](RAParticles.md#generated.RAParticles.AddCurve) + * [`RAParticles.AddCustomCurve()`](RAParticles.md#generated.RAParticles.AddCustomCurve) + * [`RAParticles.AddCustomProperty()`](RAParticles.md#generated.RAParticles.AddCustomProperty) + * [`RAParticles.AddGridFunction()`](RAParticles.md#generated.RAParticles.AddGridFunction) + * [`RAParticles.CreateCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateCurveOutputVariable) + * [`RAParticles.CreateGridFunction()`](RAParticles.md#generated.RAParticles.CreateGridFunction) + * [`RAParticles.CreateGridFunctionArrayOnCells()`](RAParticles.md#generated.RAParticles.CreateGridFunctionArrayOnCells) + * [`RAParticles.CreateGridFunctionStatisticOutputVariable()`](RAParticles.md#generated.RAParticles.CreateGridFunctionStatisticOutputVariable) + * [`RAParticles.CreateTransientCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateTransientCurveOutputVariable) + * [`RAParticles.EditCustomCurve()`](RAParticles.md#generated.RAParticles.EditCustomCurve) + * [`RAParticles.EditCustomProperty()`](RAParticles.md#generated.RAParticles.EditCustomProperty) + * [`RAParticles.GetActivesArray()`](RAParticles.md#generated.RAParticles.GetActivesArray) + * [`RAParticles.GetBoundingBox()`](RAParticles.md#generated.RAParticles.GetBoundingBox) + * [`RAParticles.GetCellAreaAsArray()`](RAParticles.md#generated.RAParticles.GetCellAreaAsArray) + * [`RAParticles.GetCellCenterAsArray()`](RAParticles.md#generated.RAParticles.GetCellCenterAsArray) + * [`RAParticles.GetCellDzAsArray()`](RAParticles.md#generated.RAParticles.GetCellDzAsArray) + * [`RAParticles.GetCellFromIJK()`](RAParticles.md#generated.RAParticles.GetCellFromIJK) + * [`RAParticles.GetCellIJK()`](RAParticles.md#generated.RAParticles.GetCellIJK) + * [`RAParticles.GetCellNumberOfVertices()`](RAParticles.md#generated.RAParticles.GetCellNumberOfVertices) + * [`RAParticles.GetCellPointsAsFunction()`](RAParticles.md#generated.RAParticles.GetCellPointsAsFunction) + * [`RAParticles.GetCellVolumeAsArray()`](RAParticles.md#generated.RAParticles.GetCellVolumeAsArray) + * [`RAParticles.GetCurve()`](RAParticles.md#generated.RAParticles.GetCurve) + * [`RAParticles.GetCurveNames()`](RAParticles.md#generated.RAParticles.GetCurveNames) + * [`RAParticles.GetCurveNamesAssociation()`](RAParticles.md#generated.RAParticles.GetCurveNamesAssociation) + * [`RAParticles.GetElementCurve()`](RAParticles.md#generated.RAParticles.GetElementCurve) + * [`RAParticles.GetGeometryQuantity()`](RAParticles.md#generated.RAParticles.GetGeometryQuantity) + * [`RAParticles.GetGeometryUnit()`](RAParticles.md#generated.RAParticles.GetGeometryUnit) + * [`RAParticles.GetGridFunction()`](RAParticles.md#generated.RAParticles.GetGridFunction) + * [`RAParticles.GetGridFunctionNames()`](RAParticles.md#generated.RAParticles.GetGridFunctionNames) + * [`RAParticles.GetMeshColoring()`](RAParticles.md#generated.RAParticles.GetMeshColoring) + * [`RAParticles.GetNumberOfCells()`](RAParticles.md#generated.RAParticles.GetNumberOfCells) + * [`RAParticles.GetNumberOfNodes()`](RAParticles.md#generated.RAParticles.GetNumberOfNodes) + * [`RAParticles.GetNumberOfParticles()`](RAParticles.md#generated.RAParticles.GetNumberOfParticles) + * [`RAParticles.GetNumpyCurve()`](RAParticles.md#generated.RAParticles.GetNumpyCurve) + * [`RAParticles.GetOutputVariableValue()`](RAParticles.md#generated.RAParticles.GetOutputVariableValue) + * [`RAParticles.GetTimeSet()`](RAParticles.md#generated.RAParticles.GetTimeSet) + * [`RAParticles.GetTimeStatistics()`](RAParticles.md#generated.RAParticles.GetTimeStatistics) + * [`RAParticles.GetTimeStep()`](RAParticles.md#generated.RAParticles.GetTimeStep) + * [`RAParticles.GetTopologyShape()`](RAParticles.md#generated.RAParticles.GetTopologyShape) + * [`RAParticles.HasGridFunction()`](RAParticles.md#generated.RAParticles.HasGridFunction) + * [`RAParticles.IsCellActive()`](RAParticles.md#generated.RAParticles.IsCellActive) + * [`RAParticles.IterCellVertices()`](RAParticles.md#generated.RAParticles.IterCellVertices) + * [`RAParticles.IterCells()`](RAParticles.md#generated.RAParticles.IterCells) + * [`RAParticles.IterParticles()`](RAParticles.md#generated.RAParticles.IterParticles) + * [`RAParticles.Modified()`](RAParticles.md#generated.RAParticles.Modified) + * [`RAParticles.RemoveCustomCurve()`](RAParticles.md#generated.RAParticles.RemoveCustomCurve) + * [`RAParticles.RemoveCustomProperty()`](RAParticles.md#generated.RAParticles.RemoveCustomProperty) + * [`RAParticles.RemoveOutputVariable()`](RAParticles.md#generated.RAParticles.RemoveOutputVariable) + * [`RAParticles.RemoveProcess()`](RAParticles.md#generated.RAParticles.RemoveProcess) + * [`RAParticles.SetCurrentTimeStep()`](RAParticles.md#generated.RAParticles.SetCurrentTimeStep) + * [RAPendulum](RAPendulum.md) + * [`RAPendulum`](RAPendulum.md#generated.RAPendulum) + * [`RAPendulum.GetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.GetAmplitudeVariation) + * [`RAPendulum.GetDirection()`](RAPendulum.md#generated.RAPendulum.GetDirection) + * [`RAPendulum.GetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.GetFrequencyVariation) + * [`RAPendulum.GetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.GetInitialAmplitude) + * [`RAPendulum.GetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.GetInitialFrequency) + * [`RAPendulum.GetInitialPhase()`](RAPendulum.md#generated.RAPendulum.GetInitialPhase) + * [`RAPendulum.SetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.SetAmplitudeVariation) + * [`RAPendulum.SetDirection()`](RAPendulum.md#generated.RAPendulum.SetDirection) + * [`RAPendulum.SetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.SetFrequencyVariation) + * [`RAPendulum.SetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.SetInitialAmplitude) + * [`RAPendulum.SetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.SetInitialFrequency) + * [`RAPendulum.SetInitialPhase()`](RAPendulum.md#generated.RAPendulum.SetInitialPhase) + * [RAPhysics](RAPhysics.md) + * [`RAPhysics`](RAPhysics.md#generated.RAPhysics) + * [`RAPhysics.GetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.GetAdhesionModel) + * [`RAPhysics.GetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.GetClosePackingVolumeFraction) + * [`RAPhysics.GetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.GetEnableCoarseGrainModeling) + * [`RAPhysics.GetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.GetEnableThermalModel) + * [`RAPhysics.GetExponentLimit()`](RAPhysics.md#generated.RAPhysics.GetExponentLimit) + * [`RAPhysics.GetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStartTime) + * [`RAPhysics.GetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStopTime) + * [`RAPhysics.GetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityXDirection) + * [`RAPhysics.GetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityYDirection) + * [`RAPhysics.GetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityZDirection) + * [`RAPhysics.GetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.GetImpactEnergyModel) + * [`RAPhysics.GetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.GetNormalForceModel) + * [`RAPhysics.GetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.GetNumericalSofteningFactor) + * [`RAPhysics.GetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.GetRestitutionModel) + * [`RAPhysics.GetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.GetRollingResistanceModel) + * [`RAPhysics.GetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetSearchDistanceMultiplier) + * [`RAPhysics.GetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.GetSphThermalTransferModel) + * [`RAPhysics.GetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.GetTangentialForceModel) + * [`RAPhysics.GetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.GetThermalCorrectionModel) + * [`RAPhysics.GetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetUpdateDistanceMultiplier) + * [`RAPhysics.GetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.GetUseRadlEtAl) + * [`RAPhysics.GetValidAdhesionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidAdhesionModelValues) + * [`RAPhysics.GetValidImpactEnergyModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidImpactEnergyModelValues) + * [`RAPhysics.GetValidNormalForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidNormalForceModelValues) + * [`RAPhysics.GetValidRestitutionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRestitutionModelValues) + * [`RAPhysics.GetValidRollingResistanceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRollingResistanceModelValues) + * [`RAPhysics.GetValidSphThermalTransferModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidSphThermalTransferModelValues) + * [`RAPhysics.GetValidTangentialForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidTangentialForceModelValues) + * [`RAPhysics.GetValidThermalCorrectionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidThermalCorrectionModelValues) + * [`RAPhysics.GetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.GetVolumeFractionLimit) + * [`RAPhysics.SetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.SetAdhesionModel) + * [`RAPhysics.SetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.SetClosePackingVolumeFraction) + * [`RAPhysics.SetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.SetEnableCoarseGrainModeling) + * [`RAPhysics.SetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.SetEnableThermalModel) + * [`RAPhysics.SetExponentLimit()`](RAPhysics.md#generated.RAPhysics.SetExponentLimit) + * [`RAPhysics.SetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStartTime) + * [`RAPhysics.SetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStopTime) + * [`RAPhysics.SetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityXDirection) + * [`RAPhysics.SetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityYDirection) + * [`RAPhysics.SetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityZDirection) + * [`RAPhysics.SetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.SetImpactEnergyModel) + * [`RAPhysics.SetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.SetNormalForceModel) + * [`RAPhysics.SetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.SetNumericalSofteningFactor) + * [`RAPhysics.SetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.SetRestitutionModel) + * [`RAPhysics.SetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.SetRollingResistanceModel) + * [`RAPhysics.SetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetSearchDistanceMultiplier) + * [`RAPhysics.SetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.SetSphThermalTransferModel) + * [`RAPhysics.SetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.SetTangentialForceModel) + * [`RAPhysics.SetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.SetThermalCorrectionModel) + * [`RAPhysics.SetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetUpdateDistanceMultiplier) + * [`RAPhysics.SetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.SetUseRadlEtAl) + * [`RAPhysics.SetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.SetVolumeFractionLimit) + * [RAPlaneProcess](RAPlaneProcess.md) + * [`RAPlaneProcess`](RAPlaneProcess.md#generated.RAPlaneProcess) + * [`RAPlaneProcess.AddCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCurve) + * [`RAPlaneProcess.AddCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomCurve) + * [`RAPlaneProcess.AddCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomProperty) + * [`RAPlaneProcess.AddGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddGridFunction) + * [`RAPlaneProcess.CreateCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateCurveOutputVariable) + * [`RAPlaneProcess.CreateGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunction) + * [`RAPlaneProcess.CreateGridFunctionArrayOnCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionArrayOnCells) + * [`RAPlaneProcess.CreateGridFunctionStatisticOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAPlaneProcess.CreateTransientCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateTransientCurveOutputVariable) + * [`RAPlaneProcess.EditCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomCurve) + * [`RAPlaneProcess.EditCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomProperty) + * [`RAPlaneProcess.GetActivesArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetActivesArray) + * [`RAPlaneProcess.GetBoundingBox()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetBoundingBox) + * [`RAPlaneProcess.GetCellAreaAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellAreaAsArray) + * [`RAPlaneProcess.GetCellCenterAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellCenterAsArray) + * [`RAPlaneProcess.GetCellDzAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellDzAsArray) + * [`RAPlaneProcess.GetCellFromIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellFromIJK) + * [`RAPlaneProcess.GetCellIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellIJK) + * [`RAPlaneProcess.GetCellNumberOfVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellNumberOfVertices) + * [`RAPlaneProcess.GetCellPointsAsFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellPointsAsFunction) + * [`RAPlaneProcess.GetCellVolumeAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellVolumeAsArray) + * [`RAPlaneProcess.GetCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurve) + * [`RAPlaneProcess.GetCurveNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNames) + * [`RAPlaneProcess.GetCurveNamesAssociation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNamesAssociation) + * [`RAPlaneProcess.GetElementCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetElementCurve) + * [`RAPlaneProcess.GetGeometryQuantity()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryQuantity) + * [`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) + * [`RAPlaneProcess.GetNumpyCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumpyCurve) + * [`RAPlaneProcess.GetOrientation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientation) + * [`RAPlaneProcess.GetOrientationFromAngleAndVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngleAndVector) + * [`RAPlaneProcess.GetOrientationFromAngles()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngles) + * [`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.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.HasGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.HasGridFunction) + * [`RAPlaneProcess.IsCellActive()`](RAPlaneProcess.md#generated.RAPlaneProcess.IsCellActive) + * [`RAPlaneProcess.IterCellVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCellVertices) + * [`RAPlaneProcess.IterCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCells) + * [`RAPlaneProcess.IterParticles()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterParticles) + * [`RAPlaneProcess.Modified()`](RAPlaneProcess.md#generated.RAPlaneProcess.Modified) + * [`RAPlaneProcess.RemoveCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomCurve) + * [`RAPlaneProcess.RemoveCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomProperty) + * [`RAPlaneProcess.RemoveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveOutputVariable) + * [`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.SetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetType) + * [RAPointCloud](RAPointCloud.md) + * [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud) + * [`RAPointCloud.AddCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCurve) + * [`RAPointCloud.AddCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCustomCurve) + * [`RAPointCloud.AddCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.AddCustomProperty) + * [`RAPointCloud.AddGridFunction()`](RAPointCloud.md#generated.RAPointCloud.AddGridFunction) + * [`RAPointCloud.CreateCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateCurveOutputVariable) + * [`RAPointCloud.CreateGridFunction()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunction) + * [`RAPointCloud.CreateGridFunctionArrayOnCells()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionArrayOnCells) + * [`RAPointCloud.CreateGridFunctionStatisticOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionStatisticOutputVariable) + * [`RAPointCloud.CreateTransientCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateTransientCurveOutputVariable) + * [`RAPointCloud.DisablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.DisablePeriodic) + * [`RAPointCloud.EditCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.EditCustomCurve) + * [`RAPointCloud.EditCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.EditCustomProperty) + * [`RAPointCloud.EnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.EnablePeriodic) + * [`RAPointCloud.GetActivesArray()`](RAPointCloud.md#generated.RAPointCloud.GetActivesArray) + * [`RAPointCloud.GetBoundingBox()`](RAPointCloud.md#generated.RAPointCloud.GetBoundingBox) + * [`RAPointCloud.GetCellAreaAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellAreaAsArray) + * [`RAPointCloud.GetCellCenterAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellCenterAsArray) + * [`RAPointCloud.GetCellDzAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellDzAsArray) + * [`RAPointCloud.GetCellFromIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellFromIJK) + * [`RAPointCloud.GetCellIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellIJK) + * [`RAPointCloud.GetCellNumberOfVertices()`](RAPointCloud.md#generated.RAPointCloud.GetCellNumberOfVertices) + * [`RAPointCloud.GetCellPointsAsFunction()`](RAPointCloud.md#generated.RAPointCloud.GetCellPointsAsFunction) + * [`RAPointCloud.GetCellVolumeAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellVolumeAsArray) + * [`RAPointCloud.GetCurve()`](RAPointCloud.md#generated.RAPointCloud.GetCurve) + * [`RAPointCloud.GetCurveNames()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNames) + * [`RAPointCloud.GetCurveNamesAssociation()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNamesAssociation) + * [`RAPointCloud.GetElementCurve()`](RAPointCloud.md#generated.RAPointCloud.GetElementCurve) + * [`RAPointCloud.GetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.GetEnablePeriodic) + * [`RAPointCloud.GetFilePath()`](RAPointCloud.md#generated.RAPointCloud.GetFilePath) + * [`RAPointCloud.GetGeometryQuantity()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryQuantity) + * [`RAPointCloud.GetGeometryUnit()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryUnit) + * [`RAPointCloud.GetGridFunction()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunction) + * [`RAPointCloud.GetGridFunctionNames()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunctionNames) + * [`RAPointCloud.GetMeshColoring()`](RAPointCloud.md#generated.RAPointCloud.GetMeshColoring) + * [`RAPointCloud.GetModuleProperties()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperties) + * [`RAPointCloud.GetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperty) + * [`RAPointCloud.GetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.GetMotionFrame) + * [`RAPointCloud.GetNumberOfCells()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfCells) + * [`RAPointCloud.GetNumberOfNodes()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfNodes) + * [`RAPointCloud.GetNumpyCurve()`](RAPointCloud.md#generated.RAPointCloud.GetNumpyCurve) + * [`RAPointCloud.GetOutputVariableValue()`](RAPointCloud.md#generated.RAPointCloud.GetOutputVariableValue) + * [`RAPointCloud.GetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStartTime) + * [`RAPointCloud.GetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStopTime) + * [`RAPointCloud.GetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOff) + * [`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.HasGridFunction()`](RAPointCloud.md#generated.RAPointCloud.HasGridFunction) + * [`RAPointCloud.IsCellActive()`](RAPointCloud.md#generated.RAPointCloud.IsCellActive) + * [`RAPointCloud.IsPeriodicEnabled()`](RAPointCloud.md#generated.RAPointCloud.IsPeriodicEnabled) + * [`RAPointCloud.IsTransient()`](RAPointCloud.md#generated.RAPointCloud.IsTransient) + * [`RAPointCloud.IterCellVertices()`](RAPointCloud.md#generated.RAPointCloud.IterCellVertices) + * [`RAPointCloud.IterCells()`](RAPointCloud.md#generated.RAPointCloud.IterCells) + * [`RAPointCloud.Modified()`](RAPointCloud.md#generated.RAPointCloud.Modified) + * [`RAPointCloud.RemoveCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomCurve) + * [`RAPointCloud.RemoveCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomProperty) + * [`RAPointCloud.RemoveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.RemoveOutputVariable) + * [`RAPointCloud.RemoveProcess()`](RAPointCloud.md#generated.RAPointCloud.RemoveProcess) + * [`RAPointCloud.SetCurrentTimeStep()`](RAPointCloud.md#generated.RAPointCloud.SetCurrentTimeStep) + * [`RAPointCloud.SetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.SetEnablePeriodic) + * [`RAPointCloud.SetFilePath()`](RAPointCloud.md#generated.RAPointCloud.SetFilePath) + * [`RAPointCloud.SetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.SetModuleProperty) + * [`RAPointCloud.SetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.SetMotionFrame) + * [`RAPointCloud.SetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStartTime) + * [`RAPointCloud.SetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStopTime) + * [`RAPointCloud.SetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOff) + * [RAPointCloudCollection](RAPointCloudCollection.md) + * [`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) + * [`RAPointCloudCollection.Clear()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Clear) + * [`RAPointCloudCollection.New()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.New) + * [`RAPointCloudCollection.Remove()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Remove) + * [RAPolyhedronProcess](RAPolyhedronProcess.md) + * [`RAPolyhedronProcess`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess) + * [`RAPolyhedronProcess.AddCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCurve) + * [`RAPolyhedronProcess.AddCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomCurve) + * [`RAPolyhedronProcess.AddCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomProperty) + * [`RAPolyhedronProcess.AddGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddGridFunction) + * [`RAPolyhedronProcess.CreateCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateCurveOutputVariable) + * [`RAPolyhedronProcess.CreateGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunction) + * [`RAPolyhedronProcess.CreateGridFunctionArrayOnCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionArrayOnCells) + * [`RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAPolyhedronProcess.CreateTransientCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateTransientCurveOutputVariable) + * [`RAPolyhedronProcess.EditCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomCurve) + * [`RAPolyhedronProcess.EditCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomProperty) + * [`RAPolyhedronProcess.GetActivesArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetActivesArray) + * [`RAPolyhedronProcess.GetBoundingBox()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetBoundingBox) + * [`RAPolyhedronProcess.GetCellAreaAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellAreaAsArray) + * [`RAPolyhedronProcess.GetCellCenterAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellCenterAsArray) + * [`RAPolyhedronProcess.GetCellDzAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellDzAsArray) + * [`RAPolyhedronProcess.GetCellFromIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellFromIJK) + * [`RAPolyhedronProcess.GetCellIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellIJK) + * [`RAPolyhedronProcess.GetCellNumberOfVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellNumberOfVertices) + * [`RAPolyhedronProcess.GetCellPointsAsFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellPointsAsFunction) + * [`RAPolyhedronProcess.GetCellVolumeAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellVolumeAsArray) + * [`RAPolyhedronProcess.GetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenter) + * [`RAPolyhedronProcess.GetCenterAfterMovement()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenterAfterMovement) + * [`RAPolyhedronProcess.GetCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurve) + * [`RAPolyhedronProcess.GetCurveNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNames) + * [`RAPolyhedronProcess.GetCurveNamesAssociation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNamesAssociation) + * [`RAPolyhedronProcess.GetElementCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetElementCurve) + * [`RAPolyhedronProcess.GetGeometryQuantity()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryQuantity) + * [`RAPolyhedronProcess.GetGeometryUnit()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryUnit) + * [`RAPolyhedronProcess.GetGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunction) + * [`RAPolyhedronProcess.GetGridFunctionNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunctionNames) + * [`RAPolyhedronProcess.GetMeshColoring()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMeshColoring) + * [`RAPolyhedronProcess.GetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMotionFrame) + * [`RAPolyhedronProcess.GetNumberOfCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfCells) + * [`RAPolyhedronProcess.GetNumberOfNodes()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfNodes) + * [`RAPolyhedronProcess.GetNumberOfParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfParticles) + * [`RAPolyhedronProcess.GetNumpyCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumpyCurve) + * [`RAPolyhedronProcess.GetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientation) + * [`RAPolyhedronProcess.GetOrientationFromAngleAndVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromAngleAndVector) + * [`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.HasGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.HasGridFunction) + * [`RAPolyhedronProcess.IsCellActive()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IsCellActive) + * [`RAPolyhedronProcess.IterCellVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCellVertices) + * [`RAPolyhedronProcess.IterCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCells) + * [`RAPolyhedronProcess.IterParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterParticles) + * [`RAPolyhedronProcess.Modified()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.Modified) + * [`RAPolyhedronProcess.RemoveCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomCurve) + * [`RAPolyhedronProcess.RemoveCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomProperty) + * [`RAPolyhedronProcess.RemoveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveOutputVariable) + * [`RAPolyhedronProcess.RemoveProcess()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveProcess) + * [`RAPolyhedronProcess.SetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCenter) + * [`RAPolyhedronProcess.SetCurrentTimeStep()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCurrentTimeStep) + * [`RAPolyhedronProcess.SetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetMotionFrame) + * [`RAPolyhedronProcess.SetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientation) + * [`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) + * [`RAPrescribedForce.SetForceValue()`](RAPrescribedForce.md#generated.RAPrescribedForce.SetForceValue) + * [RAPrescribedMoment](RAPrescribedMoment.md) + * [`RAPrescribedMoment`](RAPrescribedMoment.md#generated.RAPrescribedMoment) + * [`RAPrescribedMoment.GetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.GetMomentValue) + * [`RAPrescribedMoment.SetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.SetMomentValue) + * [RAProject](RAProject.md) + * [`RAProject`](RAProject.md#generated.RAProject) + * [`RAProject.CloseProject()`](RAProject.md#generated.RAProject.CloseProject) + * [`RAProject.CreateStudy()`](RAProject.md#generated.RAProject.CreateStudy) + * [`RAProject.GetInputVariables()`](RAProject.md#generated.RAProject.GetInputVariables) + * [`RAProject.GetModelElement()`](RAProject.md#generated.RAProject.GetModelElement) + * [`RAProject.GetModelStudy()`](RAProject.md#generated.RAProject.GetModelStudy) + * [`RAProject.GetParametricVariables()`](RAProject.md#generated.RAProject.GetParametricVariables) + * [`RAProject.GetProjectFilename()`](RAProject.md#generated.RAProject.GetProjectFilename) + * [`RAProject.GetStudy()`](RAProject.md#generated.RAProject.GetStudy) + * [`RAProject.GetTimeFilter()`](RAProject.md#generated.RAProject.GetTimeFilter) + * [`RAProject.GetUserProcessCollection()`](RAProject.md#generated.RAProject.GetUserProcessCollection) + * [`RAProject.RemoveProcess()`](RAProject.md#generated.RAProject.RemoveProcess) + * [`RAProject.SaveProject()`](RAProject.md#generated.RAProject.SaveProject) + * [`RAProject.SaveProjectForRestart()`](RAProject.md#generated.RAProject.SaveProjectForRestart) + * [RAReceivingConveyor](RAReceivingConveyor.md) + * [`RAReceivingConveyor`](RAReceivingConveyor.md#generated.RAReceivingConveyor) + * [`RAReceivingConveyor.AddCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCurve) + * [`RAReceivingConveyor.AddCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomCurve) + * [`RAReceivingConveyor.AddCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomProperty) + * [`RAReceivingConveyor.AddGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddGridFunction) + * [`RAReceivingConveyor.CreateCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateCurveOutputVariable) + * [`RAReceivingConveyor.CreateGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunction) + * [`RAReceivingConveyor.CreateGridFunctionArrayOnCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionArrayOnCells) + * [`RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable) + * [`RAReceivingConveyor.CreateTransientCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateTransientCurveOutputVariable) + * [`RAReceivingConveyor.EditCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomCurve) + * [`RAReceivingConveyor.EditCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomProperty) + * [`RAReceivingConveyor.GetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAccelerationPeriod) + * [`RAReceivingConveyor.GetActivesArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetActivesArray) + * [`RAReceivingConveyor.GetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAlignmentAngle) + * [`RAReceivingConveyor.GetAvailableMaterials()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAvailableMaterials) + * [`RAReceivingConveyor.GetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStartTime) + * [`RAReceivingConveyor.GetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStopTime) + * [`RAReceivingConveyor.GetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltInclineAngle) + * [`RAReceivingConveyor.GetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfile) + * [`RAReceivingConveyor.GetBeltProfileName()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfileName) + * [`RAReceivingConveyor.GetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltSpeed) + * [`RAReceivingConveyor.GetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltThickness) + * [`RAReceivingConveyor.GetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltWidth) + * [`RAReceivingConveyor.GetBoundingBox()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBoundingBox) + * [`RAReceivingConveyor.GetCellAreaAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellAreaAsArray) + * [`RAReceivingConveyor.GetCellCenterAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellCenterAsArray) + * [`RAReceivingConveyor.GetCellDzAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellDzAsArray) + * [`RAReceivingConveyor.GetCellFromIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellFromIJK) + * [`RAReceivingConveyor.GetCellIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellIJK) + * [`RAReceivingConveyor.GetCellNumberOfVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellNumberOfVertices) + * [`RAReceivingConveyor.GetCellPointsAsFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellPointsAsFunction) + * [`RAReceivingConveyor.GetCellVolumeAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellVolumeAsArray) + * [`RAReceivingConveyor.GetCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurve) + * [`RAReceivingConveyor.GetCurveNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNames) + * [`RAReceivingConveyor.GetCurveNamesAssociation()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNamesAssociation) + * [`RAReceivingConveyor.GetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetDecelerationPeriod) + * [`RAReceivingConveyor.GetElementCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetElementCurve) + * [`RAReceivingConveyor.GetGeometryQuantity()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryQuantity) + * [`RAReceivingConveyor.GetGeometryUnit()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryUnit) + * [`RAReceivingConveyor.GetGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunction) + * [`RAReceivingConveyor.GetGridFunctionNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunctionNames) + * [`RAReceivingConveyor.GetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHeightOffset) + * [`RAReceivingConveyor.GetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHorizontalOffset) + * [`RAReceivingConveyor.GetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLength) + * [`RAReceivingConveyor.GetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLengthOffset) + * [`RAReceivingConveyor.GetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMaterial) + * [`RAReceivingConveyor.GetMeshColoring()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMeshColoring) + * [`RAReceivingConveyor.GetModuleProperties()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperties) + * [`RAReceivingConveyor.GetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperty) + * [`RAReceivingConveyor.GetNumberOfCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfCells) + * [`RAReceivingConveyor.GetNumberOfNodes()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfNodes) + * [`RAReceivingConveyor.GetNumpyCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumpyCurve) + * [`RAReceivingConveyor.GetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutOfPlaneOffset) + * [`RAReceivingConveyor.GetOutputVariableValue()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutputVariableValue) + * [`RAReceivingConveyor.GetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetReturnBeltAngle) + * [`RAReceivingConveyor.GetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardHeight) + * [`RAReceivingConveyor.GetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardLength) + * [`RAReceivingConveyor.GetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSphBoundaryType) + * [`RAReceivingConveyor.GetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSurfaceTensionContactAngle) + * [`RAReceivingConveyor.GetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTemperature) + * [`RAReceivingConveyor.GetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetThermalBoundaryConditionType) + * [`RAReceivingConveyor.GetTimeSet()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeSet) + * [`RAReceivingConveyor.GetTimeStatistics()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStatistics) + * [`RAReceivingConveyor.GetTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStep) + * [`RAReceivingConveyor.GetTopologyShape()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTopologyShape) + * [`RAReceivingConveyor.GetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTriangleSize) + * [`RAReceivingConveyor.GetValidBeltProfileNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidBeltProfileNames) + * [`RAReceivingConveyor.GetValidOptionsForModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidOptionsForModuleProperty) + * [`RAReceivingConveyor.GetValidSphBoundaryTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues) + * [`RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues) + * [`RAReceivingConveyor.GetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVerticalOffset) + * [`RAReceivingConveyor.GetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetWidth) + * [`RAReceivingConveyor.HasGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.HasGridFunction) + * [`RAReceivingConveyor.IsCellActive()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IsCellActive) + * [`RAReceivingConveyor.IterCellVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCellVertices) + * [`RAReceivingConveyor.IterCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCells) + * [`RAReceivingConveyor.Modified()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.Modified) + * [`RAReceivingConveyor.RemoveCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomCurve) + * [`RAReceivingConveyor.RemoveCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomProperty) + * [`RAReceivingConveyor.RemoveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveOutputVariable) + * [`RAReceivingConveyor.RemoveProcess()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveProcess) + * [`RAReceivingConveyor.SetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAccelerationPeriod) + * [`RAReceivingConveyor.SetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAlignmentAngle) + * [`RAReceivingConveyor.SetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStartTime) + * [`RAReceivingConveyor.SetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStopTime) + * [`RAReceivingConveyor.SetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltInclineAngle) + * [`RAReceivingConveyor.SetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltProfile) + * [`RAReceivingConveyor.SetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltSpeed) + * [`RAReceivingConveyor.SetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltThickness) + * [`RAReceivingConveyor.SetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltWidth) + * [`RAReceivingConveyor.SetCurrentTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCurrentTimeStep) + * [`RAReceivingConveyor.SetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetDecelerationPeriod) + * [`RAReceivingConveyor.SetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHeightOffset) + * [`RAReceivingConveyor.SetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHorizontalOffset) + * [`RAReceivingConveyor.SetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLength) + * [`RAReceivingConveyor.SetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLengthOffset) + * [`RAReceivingConveyor.SetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetMaterial) + * [`RAReceivingConveyor.SetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetModuleProperty) + * [`RAReceivingConveyor.SetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetOutOfPlaneOffset) + * [`RAReceivingConveyor.SetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetReturnBeltAngle) + * [`RAReceivingConveyor.SetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardHeight) + * [`RAReceivingConveyor.SetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardLength) + * [`RAReceivingConveyor.SetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSphBoundaryType) + * [`RAReceivingConveyor.SetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSurfaceTensionContactAngle) + * [`RAReceivingConveyor.SetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTemperature) + * [`RAReceivingConveyor.SetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetThermalBoundaryConditionType) + * [`RAReceivingConveyor.SetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTriangleSize) + * [`RAReceivingConveyor.SetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetVerticalOffset) + * [`RAReceivingConveyor.SetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetWidth) + * [RARectangularSurface](RARectangularSurface.md) + * [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface) + * [`RARectangularSurface.AddCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCurve) + * [`RARectangularSurface.AddCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomCurve) + * [`RARectangularSurface.AddCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomProperty) + * [`RARectangularSurface.AddGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.AddGridFunction) + * [`RARectangularSurface.CreateCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateCurveOutputVariable) + * [`RARectangularSurface.CreateGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunction) + * [`RARectangularSurface.CreateGridFunctionArrayOnCells()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionArrayOnCells) + * [`RARectangularSurface.CreateGridFunctionStatisticOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionStatisticOutputVariable) + * [`RARectangularSurface.CreateTransientCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateTransientCurveOutputVariable) + * [`RARectangularSurface.EditCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomCurve) + * [`RARectangularSurface.EditCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomProperty) + * [`RARectangularSurface.GetActivesArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetActivesArray) + * [`RARectangularSurface.GetBoundingBox()`](RARectangularSurface.md#generated.RARectangularSurface.GetBoundingBox) + * [`RARectangularSurface.GetCellAreaAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellAreaAsArray) + * [`RARectangularSurface.GetCellCenterAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellCenterAsArray) + * [`RARectangularSurface.GetCellDzAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellDzAsArray) + * [`RARectangularSurface.GetCellFromIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellFromIJK) + * [`RARectangularSurface.GetCellIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellIJK) + * [`RARectangularSurface.GetCellNumberOfVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellNumberOfVertices) + * [`RARectangularSurface.GetCellPointsAsFunction()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellPointsAsFunction) + * [`RARectangularSurface.GetCellVolumeAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellVolumeAsArray) + * [`RARectangularSurface.GetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.GetCenter) + * [`RARectangularSurface.GetCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurve) + * [`RARectangularSurface.GetCurveNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNames) + * [`RARectangularSurface.GetCurveNamesAssociation()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNamesAssociation) + * [`RARectangularSurface.GetElementCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetElementCurve) + * [`RARectangularSurface.GetGeometryQuantity()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryQuantity) + * [`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.GetNumberOfCells()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfCells) + * [`RARectangularSurface.GetNumberOfNodes()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfNodes) + * [`RARectangularSurface.GetNumpyCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumpyCurve) + * [`RARectangularSurface.GetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientation) + * [`RARectangularSurface.GetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngleAndVector) + * [`RARectangularSurface.GetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngles) + * [`RARectangularSurface.GetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromBasisVector) + * [`RARectangularSurface.GetOutputVariableValue()`](RARectangularSurface.md#generated.RARectangularSurface.GetOutputVariableValue) + * [`RARectangularSurface.GetTimeSet()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeSet) + * [`RARectangularSurface.GetTimeStatistics()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStatistics) + * [`RARectangularSurface.GetTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStep) + * [`RARectangularSurface.GetTopologyShape()`](RARectangularSurface.md#generated.RARectangularSurface.GetTopologyShape) + * [`RARectangularSurface.GetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.GetWidth) + * [`RARectangularSurface.HasGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.HasGridFunction) + * [`RARectangularSurface.HasMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.HasMotionFrame) + * [`RARectangularSurface.IsCellActive()`](RARectangularSurface.md#generated.RARectangularSurface.IsCellActive) + * [`RARectangularSurface.IterCellVertices()`](RARectangularSurface.md#generated.RARectangularSurface.IterCellVertices) + * [`RARectangularSurface.IterCells()`](RARectangularSurface.md#generated.RARectangularSurface.IterCells) + * [`RARectangularSurface.Modified()`](RARectangularSurface.md#generated.RARectangularSurface.Modified) + * [`RARectangularSurface.RemoveCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomCurve) + * [`RARectangularSurface.RemoveCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomProperty) + * [`RARectangularSurface.RemoveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveOutputVariable) + * [`RARectangularSurface.RemoveProcess()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveProcess) + * [`RARectangularSurface.SetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.SetCenter) + * [`RARectangularSurface.SetCurrentTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.SetCurrentTimeStep) + * [`RARectangularSurface.SetLength()`](RARectangularSurface.md#generated.RARectangularSurface.SetLength) + * [`RARectangularSurface.SetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientation) + * [`RARectangularSurface.SetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngleAndVector) + * [`RARectangularSurface.SetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngles) + * [`RARectangularSurface.SetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromBasisVector) + * [`RARectangularSurface.SetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.SetWidth) + * [RARegionOfInterestCube](RARegionOfInterestCube.md) + * [`RARegionOfInterestCube`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube) + * [`RARegionOfInterestCube.AddCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCurve) + * [`RARegionOfInterestCube.AddCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomCurve) + * [`RARegionOfInterestCube.AddCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomProperty) + * [`RARegionOfInterestCube.AddGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddGridFunction) + * [`RARegionOfInterestCube.CreateCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateCurveOutputVariable) + * [`RARegionOfInterestCube.CreateGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunction) + * [`RARegionOfInterestCube.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionArrayOnCells) + * [`RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable) + * [`RARegionOfInterestCube.CreateTransientCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateTransientCurveOutputVariable) + * [`RARegionOfInterestCube.EditCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomCurve) + * [`RARegionOfInterestCube.EditCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomProperty) + * [`RARegionOfInterestCube.GetActivesArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetActivesArray) + * [`RARegionOfInterestCube.GetBoundingBox()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetBoundingBox) + * [`RARegionOfInterestCube.GetCellAreaAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellAreaAsArray) + * [`RARegionOfInterestCube.GetCellCenterAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellCenterAsArray) + * [`RARegionOfInterestCube.GetCellDzAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellDzAsArray) + * [`RARegionOfInterestCube.GetCellFromIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellFromIJK) + * [`RARegionOfInterestCube.GetCellIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellIJK) + * [`RARegionOfInterestCube.GetCellNumberOfVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellNumberOfVertices) + * [`RARegionOfInterestCube.GetCellPointsAsFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellPointsAsFunction) + * [`RARegionOfInterestCube.GetCellVolumeAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellVolumeAsArray) + * [`RARegionOfInterestCube.GetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenter) + * [`RARegionOfInterestCube.GetCenterAfterMovement()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenterAfterMovement) + * [`RARegionOfInterestCube.GetCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurve) + * [`RARegionOfInterestCube.GetCurveNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNames) + * [`RARegionOfInterestCube.GetCurveNamesAssociation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNamesAssociation) + * [`RARegionOfInterestCube.GetElementCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetElementCurve) + * [`RARegionOfInterestCube.GetGeometryQuantity()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryQuantity) + * [`RARegionOfInterestCube.GetGeometryUnit()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryUnit) + * [`RARegionOfInterestCube.GetGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunction) + * [`RARegionOfInterestCube.GetGridFunctionNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunctionNames) + * [`RARegionOfInterestCube.GetMeshColoring()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMeshColoring) + * [`RARegionOfInterestCube.GetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMotionFrame) + * [`RARegionOfInterestCube.GetNumberOfCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfCells) + * [`RARegionOfInterestCube.GetNumberOfNodes()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfNodes) + * [`RARegionOfInterestCube.GetNumpyCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumpyCurve) + * [`RARegionOfInterestCube.GetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientation) + * [`RARegionOfInterestCube.GetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngleAndVector) + * [`RARegionOfInterestCube.GetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngles) + * [`RARegionOfInterestCube.GetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromBasisVector) + * [`RARegionOfInterestCube.GetOutputVariableValue()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOutputVariableValue) + * [`RARegionOfInterestCube.GetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetSize) + * [`RARegionOfInterestCube.GetTimeSet()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeSet) + * [`RARegionOfInterestCube.GetTimeStatistics()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStatistics) + * [`RARegionOfInterestCube.GetTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStep) + * [`RARegionOfInterestCube.GetTopologyShape()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTopologyShape) + * [`RARegionOfInterestCube.HasGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.HasGridFunction) + * [`RARegionOfInterestCube.IsCellActive()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IsCellActive) + * [`RARegionOfInterestCube.IterCellVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCellVertices) + * [`RARegionOfInterestCube.IterCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCells) + * [`RARegionOfInterestCube.Modified()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.Modified) + * [`RARegionOfInterestCube.RemoveCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomCurve) + * [`RARegionOfInterestCube.RemoveCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomProperty) + * [`RARegionOfInterestCube.RemoveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveOutputVariable) + * [`RARegionOfInterestCube.RemoveProcess()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveProcess) + * [`RARegionOfInterestCube.SetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCenter) + * [`RARegionOfInterestCube.SetCurrentTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCurrentTimeStep) + * [`RARegionOfInterestCube.SetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetMotionFrame) + * [`RARegionOfInterestCube.SetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientation) + * [`RARegionOfInterestCube.SetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngleAndVector) + * [`RARegionOfInterestCube.SetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngles) + * [`RARegionOfInterestCube.SetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromBasisVector) + * [`RARegionOfInterestCube.SetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetSize) + * [RARegionOfInterestCylinder](RARegionOfInterestCylinder.md) + * [`RARegionOfInterestCylinder`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder) + * [`RARegionOfInterestCylinder.AddCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCurve) + * [`RARegionOfInterestCylinder.AddCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomCurve) + * [`RARegionOfInterestCylinder.AddCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomProperty) + * [`RARegionOfInterestCylinder.AddGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddGridFunction) + * [`RARegionOfInterestCylinder.CreateCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateCurveOutputVariable) + * [`RARegionOfInterestCylinder.CreateGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunction) + * [`RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells) + * [`RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable) + * [`RARegionOfInterestCylinder.CreateTransientCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateTransientCurveOutputVariable) + * [`RARegionOfInterestCylinder.EditCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomCurve) + * [`RARegionOfInterestCylinder.EditCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomProperty) + * [`RARegionOfInterestCylinder.GetActivesArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetActivesArray) + * [`RARegionOfInterestCylinder.GetBoundingBox()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetBoundingBox) + * [`RARegionOfInterestCylinder.GetCellAreaAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellAreaAsArray) + * [`RARegionOfInterestCylinder.GetCellCenterAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellCenterAsArray) + * [`RARegionOfInterestCylinder.GetCellDzAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellDzAsArray) + * [`RARegionOfInterestCylinder.GetCellFromIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellFromIJK) + * [`RARegionOfInterestCylinder.GetCellIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellIJK) + * [`RARegionOfInterestCylinder.GetCellNumberOfVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellNumberOfVertices) + * [`RARegionOfInterestCylinder.GetCellPointsAsFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellPointsAsFunction) + * [`RARegionOfInterestCylinder.GetCellVolumeAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellVolumeAsArray) + * [`RARegionOfInterestCylinder.GetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenter) + * [`RARegionOfInterestCylinder.GetCenterAfterMovement()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenterAfterMovement) + * [`RARegionOfInterestCylinder.GetCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurve) + * [`RARegionOfInterestCylinder.GetCurveNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNames) + * [`RARegionOfInterestCylinder.GetCurveNamesAssociation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation) + * [`RARegionOfInterestCylinder.GetElementCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetElementCurve) + * [`RARegionOfInterestCylinder.GetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFinalAngle) + * [`RARegionOfInterestCylinder.GetGeometryQuantity()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryQuantity) + * [`RARegionOfInterestCylinder.GetGeometryUnit()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryUnit) + * [`RARegionOfInterestCylinder.GetGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunction) + * [`RARegionOfInterestCylinder.GetGridFunctionNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunctionNames) + * [`RARegionOfInterestCylinder.GetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetHeight) + * [`RARegionOfInterestCylinder.GetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInitialAngle) + * [`RARegionOfInterestCylinder.GetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInternalFactor) + * [`RARegionOfInterestCylinder.GetMeshColoring()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMeshColoring) + * [`RARegionOfInterestCylinder.GetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMotionFrame) + * [`RARegionOfInterestCylinder.GetNumberOfCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfCells) + * [`RARegionOfInterestCylinder.GetNumberOfNodes()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfNodes) + * [`RARegionOfInterestCylinder.GetNumpyCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumpyCurve) + * [`RARegionOfInterestCylinder.GetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientation) + * [`RARegionOfInterestCylinder.GetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngleAndVector) + * [`RARegionOfInterestCylinder.GetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngles) + * [`RARegionOfInterestCylinder.GetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromBasisVector) + * [`RARegionOfInterestCylinder.GetOutputVariableValue()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOutputVariableValue) + * [`RARegionOfInterestCylinder.GetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetRadius) + * [`RARegionOfInterestCylinder.GetTimeSet()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeSet) + * [`RARegionOfInterestCylinder.GetTimeStatistics()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStatistics) + * [`RARegionOfInterestCylinder.GetTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStep) + * [`RARegionOfInterestCylinder.GetTopologyShape()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTopologyShape) + * [`RARegionOfInterestCylinder.HasGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.HasGridFunction) + * [`RARegionOfInterestCylinder.IsCellActive()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IsCellActive) + * [`RARegionOfInterestCylinder.IterCellVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCellVertices) + * [`RARegionOfInterestCylinder.IterCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCells) + * [`RARegionOfInterestCylinder.Modified()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.Modified) + * [`RARegionOfInterestCylinder.RemoveCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomCurve) + * [`RARegionOfInterestCylinder.RemoveCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomProperty) + * [`RARegionOfInterestCylinder.RemoveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveOutputVariable) + * [`RARegionOfInterestCylinder.RemoveProcess()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveProcess) + * [`RARegionOfInterestCylinder.SetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCenter) + * [`RARegionOfInterestCylinder.SetCurrentTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCurrentTimeStep) + * [`RARegionOfInterestCylinder.SetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetFinalAngle) + * [`RARegionOfInterestCylinder.SetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetHeight) + * [`RARegionOfInterestCylinder.SetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInitialAngle) + * [`RARegionOfInterestCylinder.SetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInternalFactor) + * [`RARegionOfInterestCylinder.SetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetMotionFrame) + * [`RARegionOfInterestCylinder.SetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientation) + * [`RARegionOfInterestCylinder.SetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngleAndVector) + * [`RARegionOfInterestCylinder.SetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngles) + * [`RARegionOfInterestCylinder.SetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromBasisVector) + * [`RARegionOfInterestCylinder.SetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetRadius) + * [RARegionsOfInterestCollection](RARegionsOfInterestCollection.md) + * [`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) + * [`RARegionsOfInterestCollection.AddCube()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCube) + * [`RARegionsOfInterestCollection.AddCylinder()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCylinder) + * [`RARegionsOfInterestCollection.Clear()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Clear) + * [`RARegionsOfInterestCollection.New()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.New) + * [`RARegionsOfInterestCollection.Remove()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Remove) + * [RARotation](RARotation.md) + * [`RARotation`](RARotation.md#generated.RARotation) + * [`RARotation.GetAngularAcceleration()`](RARotation.md#generated.RARotation.GetAngularAcceleration) + * [`RARotation.GetInitialAngularVelocity()`](RARotation.md#generated.RARotation.GetInitialAngularVelocity) + * [`RARotation.SetAngularAcceleration()`](RARotation.md#generated.RARotation.SetAngularAcceleration) + * [`RARotation.SetInitialAngularVelocity()`](RARotation.md#generated.RARotation.SetInitialAngularVelocity) + * [RASPHEulerianSolution](RASPHEulerianSolution.md) + * [`RASPHEulerianSolution`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution) + * [`RASPHEulerianSolution.DisableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.DisableEulerianSolution) + * [`RASPHEulerianSolution.EnableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.EnableEulerianSolution) + * [`RASPHEulerianSolution.GetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetEulerianSolutionEnabled) + * [`RASPHEulerianSolution.GetMeshColoring()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetMeshColoring) + * [`RASPHEulerianSolution.IsEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.IsEulerianSolutionEnabled) + * [`RASPHEulerianSolution.SetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.SetEulerianSolutionEnabled) + * [RASPHSettings](RASPHSettings.md) + * [`RASPHSettings`](RASPHSettings.md#generated.RASPHSettings) + * [`RASPHSettings.AddCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCurve) + * [`RASPHSettings.AddCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCustomCurve) + * [`RASPHSettings.AddCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.AddCustomProperty) + * [`RASPHSettings.AddGridFunction()`](RASPHSettings.md#generated.RASPHSettings.AddGridFunction) + * [`RASPHSettings.CreateCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateCurveOutputVariable) + * [`RASPHSettings.CreateGridFunction()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunction) + * [`RASPHSettings.CreateGridFunctionArrayOnCells()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionArrayOnCells) + * [`RASPHSettings.CreateGridFunctionStatisticOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable) + * [`RASPHSettings.CreateTransientCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateTransientCurveOutputVariable) + * [`RASPHSettings.DisableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.DisableEulerianSolution) + * [`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.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) + * [`RASPHSettings.GetCellCenterAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellCenterAsArray) + * [`RASPHSettings.GetCellDzAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellDzAsArray) + * [`RASPHSettings.GetCellFromIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellFromIJK) + * [`RASPHSettings.GetCellIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellIJK) + * [`RASPHSettings.GetCellNumberOfVertices()`](RASPHSettings.md#generated.RASPHSettings.GetCellNumberOfVertices) + * [`RASPHSettings.GetCellPointsAsFunction()`](RASPHSettings.md#generated.RASPHSettings.GetCellPointsAsFunction) + * [`RASPHSettings.GetCellVolumeAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellVolumeAsArray) + * [`RASPHSettings.GetClearyFactor()`](RASPHSettings.md#generated.RASPHSettings.GetClearyFactor) + * [`RASPHSettings.GetCurve()`](RASPHSettings.md#generated.RASPHSettings.GetCurve) + * [`RASPHSettings.GetCurveNames()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNames) + * [`RASPHSettings.GetCurveNamesAssociation()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNamesAssociation) + * [`RASPHSettings.GetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevMinus) + * [`RASPHSettings.GetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevPlus) + * [`RASPHSettings.GetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.GetDensityRelativeErrorTolerance) + * [`RASPHSettings.GetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.GetDissFactor) + * [`RASPHSettings.GetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorNorm) + * [`RASPHSettings.GetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorTang) + * [`RASPHSettings.GetElementCurve()`](RASPHSettings.md#generated.RASPHSettings.GetElementCurve) + * [`RASPHSettings.GetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEulerianSolutionEnabled) + * [`RASPHSettings.GetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.GetFluidMaterial) + * [`RASPHSettings.GetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit) + * [`RASPHSettings.GetGeometryQuantity()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryQuantity) + * [`RASPHSettings.GetGeometryUnit()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryUnit) + * [`RASPHSettings.GetGridFunction()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunction) + * [`RASPHSettings.GetGridFunctionNames()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunctionNames) + * [`RASPHSettings.GetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetKernelDistFactor) + * [`RASPHSettings.GetKernelType()`](RASPHSettings.md#generated.RASPHSettings.GetKernelType) + * [`RASPHSettings.GetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.GetLimitTurbulentViscosity) + * [`RASPHSettings.GetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumExpectedVelocity) + * [`RASPHSettings.GetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumNumberOfIterations) + * [`RASPHSettings.GetMeshColoring()`](RASPHSettings.md#generated.RASPHSettings.GetMeshColoring) + * [`RASPHSettings.GetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetMinDistFactor) + * [`RASPHSettings.GetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.GetNegativePressureFactor) + * [`RASPHSettings.GetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumCellSteps) + * [`RASPHSettings.GetNumberOfCells()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfCells) + * [`RASPHSettings.GetNumberOfNodes()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfNodes) + * [`RASPHSettings.GetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfSteps) + * [`RASPHSettings.GetNumpyCurve()`](RASPHSettings.md#generated.RASPHSettings.GetNumpyCurve) + * [`RASPHSettings.GetOutputVariableValue()`](RASPHSettings.md#generated.RASPHSettings.GetOutputVariableValue) + * [`RASPHSettings.GetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.GetPosCorrectionType) + * [`RASPHSettings.GetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.GetPressureDeg) + * [`RASPHSettings.GetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetPressureUnderRelaxationFactor) + * [`RASPHSettings.GetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) + * [`RASPHSettings.GetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) + * [`RASPHSettings.GetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.GetShiftingFactor) + * [`RASPHSettings.GetSize()`](RASPHSettings.md#generated.RASPHSettings.GetSize) + * [`RASPHSettings.GetSolver()`](RASPHSettings.md#generated.RASPHSettings.GetSolver) + * [`RASPHSettings.GetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.GetSolverModel) + * [`RASPHSettings.GetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.GetSoundSpeed) + * [`RASPHSettings.GetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityDegree) + * [`RASPHSettings.GetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityNegFactor) + * [`RASPHSettings.GetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityPosFactor) + * [`RASPHSettings.GetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStiffFactor) + * [`RASPHSettings.GetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryAngle) + * [`RASPHSettings.GetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryFraction) + * [`RASPHSettings.GetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionCoefficient) + * [`RASPHSettings.GetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionType) + * [`RASPHSettings.GetTimeSet()`](RASPHSettings.md#generated.RASPHSettings.GetTimeSet) + * [`RASPHSettings.GetTimeStatistics()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStatistics) + * [`RASPHSettings.GetTimeStep()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStep) + * [`RASPHSettings.GetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.GetTimestepFactor) + * [`RASPHSettings.GetTopologyShape()`](RASPHSettings.md#generated.RASPHSettings.GetTopologyShape) + * [`RASPHSettings.GetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.GetTurbDistanceFraction) + * [`RASPHSettings.GetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulenceType) + * [`RASPHSettings.GetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentPrandtl) + * [`RASPHSettings.GetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentViscosityMaximumRatio) + * [`RASPHSettings.GetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.GetUpdateCoupledDensity) + * [`RASPHSettings.GetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.GetUseParticlesNeighborsList) + * [`RASPHSettings.GetValidKernelTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidKernelTypeValues) + * [`RASPHSettings.GetValidPosCorrectionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidPosCorrectionTypeValues) + * [`RASPHSettings.GetValidSolverModelValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSolverModelValues) + * [`RASPHSettings.GetValidSurfaceTensionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSurfaceTensionTypeValues) + * [`RASPHSettings.GetValidTurbulenceTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidTurbulenceTypeValues) + * [`RASPHSettings.GetValidViscosityTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscosityTypeValues) + * [`RASPHSettings.GetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.GetViscosityType) + * [`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.IsShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) + * [`RASPHSettings.IsShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) + * [`RASPHSettings.IterCellVertices()`](RASPHSettings.md#generated.RASPHSettings.IterCellVertices) + * [`RASPHSettings.IterCells()`](RASPHSettings.md#generated.RASPHSettings.IterCells) + * [`RASPHSettings.Modified()`](RASPHSettings.md#generated.RASPHSettings.Modified) + * [`RASPHSettings.RemoveCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.RemoveCustomCurve) + * [`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) + * [`RASPHSettings.SetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevMinus) + * [`RASPHSettings.SetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevPlus) + * [`RASPHSettings.SetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.SetDensityRelativeErrorTolerance) + * [`RASPHSettings.SetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.SetDissFactor) + * [`RASPHSettings.SetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorNorm) + * [`RASPHSettings.SetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorTang) + * [`RASPHSettings.SetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEulerianSolutionEnabled) + * [`RASPHSettings.SetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.SetFluidMaterial) + * [`RASPHSettings.SetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit) + * [`RASPHSettings.SetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetKernelDistFactor) + * [`RASPHSettings.SetKernelType()`](RASPHSettings.md#generated.RASPHSettings.SetKernelType) + * [`RASPHSettings.SetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.SetLimitTurbulentViscosity) + * [`RASPHSettings.SetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumExpectedVelocity) + * [`RASPHSettings.SetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumNumberOfIterations) + * [`RASPHSettings.SetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetMinDistFactor) + * [`RASPHSettings.SetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.SetNegativePressureFactor) + * [`RASPHSettings.SetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumCellSteps) + * [`RASPHSettings.SetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumberOfSteps) + * [`RASPHSettings.SetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.SetPosCorrectionType) + * [`RASPHSettings.SetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.SetPressureDeg) + * [`RASPHSettings.SetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetPressureUnderRelaxationFactor) + * [`RASPHSettings.SetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) + * [`RASPHSettings.SetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) + * [`RASPHSettings.SetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.SetShiftingFactor) + * [`RASPHSettings.SetSize()`](RASPHSettings.md#generated.RASPHSettings.SetSize) + * [`RASPHSettings.SetSolver()`](RASPHSettings.md#generated.RASPHSettings.SetSolver) + * [`RASPHSettings.SetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.SetSolverModel) + * [`RASPHSettings.SetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.SetSoundSpeed) + * [`RASPHSettings.SetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityDegree) + * [`RASPHSettings.SetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityNegFactor) + * [`RASPHSettings.SetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityPosFactor) + * [`RASPHSettings.SetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStiffFactor) + * [`RASPHSettings.SetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryAngle) + * [`RASPHSettings.SetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryFraction) + * [`RASPHSettings.SetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionCoefficient) + * [`RASPHSettings.SetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionType) + * [`RASPHSettings.SetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.SetTimestepFactor) + * [`RASPHSettings.SetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.SetTurbDistanceFraction) + * [`RASPHSettings.SetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulenceType) + * [`RASPHSettings.SetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentPrandtl) + * [`RASPHSettings.SetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentViscosityMaximumRatio) + * [`RASPHSettings.SetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.SetUpdateCoupledDensity) + * [`RASPHSettings.SetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.SetUseParticlesNeighborsList) + * [`RASPHSettings.SetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.SetViscosityType) + * [`RASPHSettings.SetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.SetXsphFactor) + * [RASimulatorRun](RASimulatorRun.md) + * [`RASimulatorRun`](RASimulatorRun.md#generated.RASimulatorRun) + * [`RASimulatorRun.AddCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCurve) + * [`RASimulatorRun.AddCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomCurve) + * [`RASimulatorRun.AddCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomProperty) + * [`RASimulatorRun.AddGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.AddGridFunction) + * [`RASimulatorRun.CreateCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateCurveOutputVariable) + * [`RASimulatorRun.CreateGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunction) + * [`RASimulatorRun.CreateGridFunctionArrayOnCells()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionArrayOnCells) + * [`RASimulatorRun.CreateGridFunctionStatisticOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionStatisticOutputVariable) + * [`RASimulatorRun.CreateTransientCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateTransientCurveOutputVariable) + * [`RASimulatorRun.DisableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.DisableCompressedFile) + * [`RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.DisableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.DisableFEMForces) + * [`RASimulatorRun.DisableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.DisableHtcCalculator) + * [`RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.DisableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.DisableNegateInitialOverlaps) + * [`RASimulatorRun.DisableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.DisableSortingDistanceFactor) + * [`RASimulatorRun.DisableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.DisableUse3RdPowerForCfdCgm) + * [`RASimulatorRun.EditCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomCurve) + * [`RASimulatorRun.EditCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomProperty) + * [`RASimulatorRun.EnableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.EnableCompressedFile) + * [`RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.EnableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.EnableFEMForces) + * [`RASimulatorRun.EnableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.EnableHtcCalculator) + * [`RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.EnableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.EnableNegateInitialOverlaps) + * [`RASimulatorRun.EnableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.EnableSortingDistanceFactor) + * [`RASimulatorRun.EnableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.EnableUse3RdPowerForCfdCgm) + * [`RASimulatorRun.GetActivesArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetActivesArray) + * [`RASimulatorRun.GetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetArraysGrowthRate) + * [`RASimulatorRun.GetAvailableModulesOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableModulesOutputProperties) + * [`RASimulatorRun.GetAvailableOutputRootProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRootProperties) + * [`RASimulatorRun.GetAvailableOutputRoots()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRoots) + * [`RASimulatorRun.GetAvailableStandardOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableStandardOutputProperties) + * [`RASimulatorRun.GetBoundingBox()`](RASimulatorRun.md#generated.RASimulatorRun.GetBoundingBox) + * [`RASimulatorRun.GetBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageDelayAfterRelease) + * [`RASimulatorRun.GetBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageOverlapFactor) + * [`RASimulatorRun.GetBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageStart) + * [`RASimulatorRun.GetCellAreaAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellAreaAsArray) + * [`RASimulatorRun.GetCellCenterAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellCenterAsArray) + * [`RASimulatorRun.GetCellDzAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellDzAsArray) + * [`RASimulatorRun.GetCellFromIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellFromIJK) + * [`RASimulatorRun.GetCellIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellIJK) + * [`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) + * [`RASimulatorRun.GetCurveNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNames) + * [`RASimulatorRun.GetCurveNamesAssociation()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNamesAssociation) + * [`RASimulatorRun.GetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.GetDeformableMassMatrixType) + * [`RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries) + * [`RASimulatorRun.GetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetDragLimiterFactor) + * [`RASimulatorRun.GetElementCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetElementCurve) + * [`RASimulatorRun.GetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetFixedTimestep) + * [`RASimulatorRun.GetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.GetFluentOutputsMultiplier) + * [`RASimulatorRun.GetGeometryQuantity()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryQuantity) + * [`RASimulatorRun.GetGeometryUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryUnit) + * [`RASimulatorRun.GetGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunction) + * [`RASimulatorRun.GetGridFunctionNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunctionNames) + * [`RASimulatorRun.GetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.GetJointElasticRatio) + * [`RASimulatorRun.GetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.GetLinearHystDamp) + * [`RASimulatorRun.GetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.GetLoadingNSteps) + * [`RASimulatorRun.GetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.GetMaximumNumberOfIterations) + * [`RASimulatorRun.GetMeshColoring()`](RASimulatorRun.md#generated.RASimulatorRun.GetMeshColoring) + * [`RASimulatorRun.GetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumLengthDeformationTolerance) + * [`RASimulatorRun.GetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumVolumeTolerance) + * [`RASimulatorRun.GetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertiesData) + * [`RASimulatorRun.GetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertyEnabled) + * [`RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.GetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.GetMultiGpuSlicingDirection) + * [`RASimulatorRun.GetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.GetNegateInitialOverlaps) + * [`RASimulatorRun.GetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetNeighborSearchModel) + * [`RASimulatorRun.GetNumberOfCells()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfCells) + * [`RASimulatorRun.GetNumberOfNodes()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfNodes) + * [`RASimulatorRun.GetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfProcessors) + * [`RASimulatorRun.GetNumpyCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumpyCurve) + * [`RASimulatorRun.GetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputPropertyEnabled) + * [`RASimulatorRun.GetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputRootEnabled) + * [`RASimulatorRun.GetOutputVariableValue()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputVariableValue) + * [`RASimulatorRun.GetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverRelaxationCoefficient) + * [`RASimulatorRun.GetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverlapParticlesDelay) + * [`RASimulatorRun.GetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.GetParticleSizeLimitForReordering) + * [`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) + * [`RASimulatorRun.GetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetStandardOutputPropertyEnabled) + * [`RASimulatorRun.GetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetSuccessiveOverRelaxationTolerance) + * [`RASimulatorRun.GetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpu) + * [`RASimulatorRun.GetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpus) + * [`RASimulatorRun.GetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeInterval) + * [`RASimulatorRun.GetTimeSet()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeSet) + * [`RASimulatorRun.GetTimeStatistics()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStatistics) + * [`RASimulatorRun.GetTimeStep()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStep) + * [`RASimulatorRun.GetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimestepModel) + * [`RASimulatorRun.GetTopologyShape()`](RASimulatorRun.md#generated.RASimulatorRun.GetTopologyShape) + * [`RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach) + * [`RASimulatorRun.GetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2SourceTermsApproach) + * [`RASimulatorRun.GetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse3RdPowerForCfdCgm) + * [`RASimulatorRun.GetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseArraysGrowthRate) + * [`RASimulatorRun.GetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseBreakageOverlapFactor) + * [`RASimulatorRun.GetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseCompressedFiles) + * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles) + * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles) + * [`RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.GetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDragLimiterFactor) + * [`RASimulatorRun.GetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseFixedTimestep) + * [`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.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.GetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateInterval) + * [`RASimulatorRun.GetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearStart) + * [`RASimulatorRun.HasFEMForcesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.HasFEMForcesEnabled) + * [`RASimulatorRun.HasGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.HasGridFunction) + * [`RASimulatorRun.HasHtcCalculatedData()`](RASimulatorRun.md#generated.RASimulatorRun.HasHtcCalculatedData) + * [`RASimulatorRun.IsCellActive()`](RASimulatorRun.md#generated.RASimulatorRun.IsCellActive) + * [`RASimulatorRun.IsCompressedFileEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsCompressedFileEnabled) + * [`RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled) + * [`RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled) + * [`RASimulatorRun.IsNegateInitialOverlapsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsNegateInitialOverlapsEnabled) + * [`RASimulatorRun.IsSortingDistanceFactorEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsSortingDistanceFactorEnabled) + * [`RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled) + * [`RASimulatorRun.IterCellVertices()`](RASimulatorRun.md#generated.RASimulatorRun.IterCellVertices) + * [`RASimulatorRun.IterCells()`](RASimulatorRun.md#generated.RASimulatorRun.IterCells) + * [`RASimulatorRun.Modified()`](RASimulatorRun.md#generated.RASimulatorRun.Modified) + * [`RASimulatorRun.RemoveCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomCurve) + * [`RASimulatorRun.RemoveCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomProperty) + * [`RASimulatorRun.RemoveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveOutputVariable) + * [`RASimulatorRun.RemoveProcess()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveProcess) + * [`RASimulatorRun.RestoreOutputPropertiesDefaults()`](RASimulatorRun.md#generated.RASimulatorRun.RestoreOutputPropertiesDefaults) + * [`RASimulatorRun.SetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetArraysGrowthRate) + * [`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) + * [`RASimulatorRun.SetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.SetDeformableMassMatrixType) + * [`RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries) + * [`RASimulatorRun.SetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetDragLimiterFactor) + * [`RASimulatorRun.SetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetFixedTimestep) + * [`RASimulatorRun.SetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.SetFluentOutputsMultiplier) + * [`RASimulatorRun.SetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.SetJointElasticRatio) + * [`RASimulatorRun.SetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.SetLinearHystDamp) + * [`RASimulatorRun.SetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.SetLoadingNSteps) + * [`RASimulatorRun.SetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.SetMaximumNumberOfIterations) + * [`RASimulatorRun.SetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumLengthDeformationTolerance) + * [`RASimulatorRun.SetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumVolumeTolerance) + * [`RASimulatorRun.SetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertiesData) + * [`RASimulatorRun.SetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertyEnabled) + * [`RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.SetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.SetMultiGpuSlicingDirection) + * [`RASimulatorRun.SetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.SetNegateInitialOverlaps) + * [`RASimulatorRun.SetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetNeighborSearchModel) + * [`RASimulatorRun.SetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.SetNumberOfProcessors) + * [`RASimulatorRun.SetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputPropertyEnabled) + * [`RASimulatorRun.SetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputRootEnabled) + * [`RASimulatorRun.SetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverRelaxationCoefficient) + * [`RASimulatorRun.SetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverlapParticlesDelay) + * [`RASimulatorRun.SetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.SetParticleSizeLimitForReordering) + * [`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) + * [`RASimulatorRun.SetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetStandardOutputPropertyEnabled) + * [`RASimulatorRun.SetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetSuccessiveOverRelaxationTolerance) + * [`RASimulatorRun.SetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpu) + * [`RASimulatorRun.SetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpus) + * [`RASimulatorRun.SetTimeConfiguration()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeConfiguration) + * [`RASimulatorRun.SetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeInterval) + * [`RASimulatorRun.SetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimestepModel) + * [`RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach) + * [`RASimulatorRun.SetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2SourceTermsApproach) + * [`RASimulatorRun.SetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse3RdPowerForCfdCgm) + * [`RASimulatorRun.SetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseArraysGrowthRate) + * [`RASimulatorRun.SetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseBreakageOverlapFactor) + * [`RASimulatorRun.SetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseCompressedFiles) + * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles) + * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles) + * [`RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.SetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDragLimiterFactor) + * [`RASimulatorRun.SetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseFixedTimestep) + * [`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) + * [`RASizeDistribution`](RASizeDistribution.md#generated.RASizeDistribution) + * [`RASizeDistribution.GetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.GetCumulativePercentage) + * [`RASizeDistribution.GetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.GetScaleFactor) + * [`RASizeDistribution.GetSize()`](RASizeDistribution.md#generated.RASizeDistribution.GetSize) + * [`RASizeDistribution.SetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.SetCumulativePercentage) + * [`RASizeDistribution.SetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.SetScaleFactor) + * [`RASizeDistribution.SetSize()`](RASizeDistribution.md#generated.RASizeDistribution.SetSize) + * [RASizeDistributionList](RASizeDistributionList.md) + * [`RASizeDistributionList`](RASizeDistributionList.md#generated.RASizeDistributionList) + * [`RASizeDistributionList.Clear()`](RASizeDistributionList.md#generated.RASizeDistributionList.Clear) + * [`RASizeDistributionList.GetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetCgmScaleFactor) + * [`RASizeDistributionList.GetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetSizeType) + * [`RASizeDistributionList.GetValidSizeTypeValues()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetValidSizeTypeValues) + * [`RASizeDistributionList.New()`](RASizeDistributionList.md#generated.RASizeDistributionList.New) + * [`RASizeDistributionList.Remove()`](RASizeDistributionList.md#generated.RASizeDistributionList.Remove) + * [`RASizeDistributionList.SetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetCgmScaleFactor) + * [`RASizeDistributionList.SetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetSizeType) + * [RASolidMaterial](RASolidMaterial.md) + * [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + * [`RASolidMaterial.GetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkDensity) + * [`RASolidMaterial.GetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkSolidFraction) + * [`RASolidMaterial.GetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetCurrentDensity) + * [`RASolidMaterial.GetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetDensity) + * [`RASolidMaterial.GetModuleProperties()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperties) + * [`RASolidMaterial.GetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperty) + * [`RASolidMaterial.GetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.GetPoissonRatio) + * [`RASolidMaterial.GetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.GetSpecificHeat) + * [`RASolidMaterial.GetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.GetThermalConductivity) + * [`RASolidMaterial.GetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetUseBulkDensity) + * [`RASolidMaterial.GetValidOptionsForModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetValidOptionsForModuleProperty) + * [`RASolidMaterial.GetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.GetYoungsModulus) + * [`RASolidMaterial.SetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkDensity) + * [`RASolidMaterial.SetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkSolidFraction) + * [`RASolidMaterial.SetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetCurrentDensity) + * [`RASolidMaterial.SetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetDensity) + * [`RASolidMaterial.SetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.SetModuleProperty) + * [`RASolidMaterial.SetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.SetPoissonRatio) + * [`RASolidMaterial.SetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.SetSpecificHeat) + * [`RASolidMaterial.SetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.SetThermalConductivity) + * [`RASolidMaterial.SetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetUseBulkDensity) + * [`RASolidMaterial.SetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.SetYoungsModulus) + * [RASpringDashpotForce](RASpringDashpotForce.md) + * [`RASpringDashpotForce`](RASpringDashpotForce.md#generated.RASpringDashpotForce) + * [`RASpringDashpotForce.GetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDashpotCoefficient) + * [`RASpringDashpotForce.GetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDirection) + * [`RASpringDashpotForce.GetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetSpringCoefficient) + * [`RASpringDashpotForce.GetValidDirectionValues()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetValidDirectionValues) + * [`RASpringDashpotForce.SetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDashpotCoefficient) + * [`RASpringDashpotForce.SetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDirection) + * [`RASpringDashpotForce.SetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetSpringCoefficient) + * [RASpringDashpotMoment](RASpringDashpotMoment.md) + * [`RASpringDashpotMoment`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment) + * [`RASpringDashpotMoment.GetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDashpotCoefficient) + * [`RASpringDashpotMoment.GetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDirection) + * [`RASpringDashpotMoment.GetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetSpringCoefficient) + * [`RASpringDashpotMoment.GetValidDirectionValues()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetValidDirectionValues) + * [`RASpringDashpotMoment.SetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDashpotCoefficient) + * [`RASpringDashpotMoment.SetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDirection) + * [`RASpringDashpotMoment.SetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetSpringCoefficient) + * [RAStreamlinesUserProcess](RAStreamlinesUserProcess.md) + * [`RAStreamlinesUserProcess`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess) + * [`RAStreamlinesUserProcess.AddCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCurve) + * [`RAStreamlinesUserProcess.AddCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomCurve) + * [`RAStreamlinesUserProcess.AddCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomProperty) + * [`RAStreamlinesUserProcess.AddGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddGridFunction) + * [`RAStreamlinesUserProcess.CreateCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateCurveOutputVariable) + * [`RAStreamlinesUserProcess.CreateGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunction) + * [`RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells) + * [`RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAStreamlinesUserProcess.CreateTransientCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateTransientCurveOutputVariable) + * [`RAStreamlinesUserProcess.EditCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomCurve) + * [`RAStreamlinesUserProcess.EditCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomProperty) + * [`RAStreamlinesUserProcess.GetActivesArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetActivesArray) + * [`RAStreamlinesUserProcess.GetAvailableSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetAvailableSources) + * [`RAStreamlinesUserProcess.GetBoundingBox()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetBoundingBox) + * [`RAStreamlinesUserProcess.GetCellAreaAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellAreaAsArray) + * [`RAStreamlinesUserProcess.GetCellCenterAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellCenterAsArray) + * [`RAStreamlinesUserProcess.GetCellDzAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellDzAsArray) + * [`RAStreamlinesUserProcess.GetCellFromIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellFromIJK) + * [`RAStreamlinesUserProcess.GetCellIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellIJK) + * [`RAStreamlinesUserProcess.GetCellNumberOfVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellNumberOfVertices) + * [`RAStreamlinesUserProcess.GetCellPointsAsFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellPointsAsFunction) + * [`RAStreamlinesUserProcess.GetCellVolumeAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellVolumeAsArray) + * [`RAStreamlinesUserProcess.GetCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurve) + * [`RAStreamlinesUserProcess.GetCurveNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNames) + * [`RAStreamlinesUserProcess.GetCurveNamesAssociation()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation) + * [`RAStreamlinesUserProcess.GetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetDirection) + * [`RAStreamlinesUserProcess.GetElementCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetElementCurve) + * [`RAStreamlinesUserProcess.GetGeometryQuantity()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryQuantity) + * [`RAStreamlinesUserProcess.GetGeometryUnit()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryUnit) + * [`RAStreamlinesUserProcess.GetGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunction) + * [`RAStreamlinesUserProcess.GetGridFunctionNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunctionNames) + * [`RAStreamlinesUserProcess.GetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMaximumLength) + * [`RAStreamlinesUserProcess.GetMeshColoring()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMeshColoring) + * [`RAStreamlinesUserProcess.GetNumberOfCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfCells) + * [`RAStreamlinesUserProcess.GetNumberOfNodes()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfNodes) + * [`RAStreamlinesUserProcess.GetNumberOfParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfParticles) + * [`RAStreamlinesUserProcess.GetNumpyCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumpyCurve) + * [`RAStreamlinesUserProcess.GetOutputVariableValue()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetOutputVariableValue) + * [`RAStreamlinesUserProcess.GetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSources) + * [`RAStreamlinesUserProcess.GetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSpacing) + * [`RAStreamlinesUserProcess.GetTimeSet()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeSet) + * [`RAStreamlinesUserProcess.GetTimeStatistics()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStatistics) + * [`RAStreamlinesUserProcess.GetTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStep) + * [`RAStreamlinesUserProcess.GetTopologyShape()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTopologyShape) + * [`RAStreamlinesUserProcess.GetValidDirectionValues()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetValidDirectionValues) + * [`RAStreamlinesUserProcess.HasGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.HasGridFunction) + * [`RAStreamlinesUserProcess.IsCellActive()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IsCellActive) + * [`RAStreamlinesUserProcess.IterCellVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCellVertices) + * [`RAStreamlinesUserProcess.IterCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCells) + * [`RAStreamlinesUserProcess.IterParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterParticles) + * [`RAStreamlinesUserProcess.Modified()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.Modified) + * [`RAStreamlinesUserProcess.RemoveCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomCurve) + * [`RAStreamlinesUserProcess.RemoveCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomProperty) + * [`RAStreamlinesUserProcess.RemoveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveOutputVariable) + * [`RAStreamlinesUserProcess.RemoveProcess()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveProcess) + * [`RAStreamlinesUserProcess.SetCurrentTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetCurrentTimeStep) + * [`RAStreamlinesUserProcess.SetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetDirection) + * [`RAStreamlinesUserProcess.SetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetMaximumLength) + * [`RAStreamlinesUserProcess.SetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSources) + * [`RAStreamlinesUserProcess.SetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSpacing) + * [`RAStreamlinesUserProcess.UpdateStreamlines()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.UpdateStreamlines) + * [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) + * [`RAStudy.GetAirFlow()`](RAStudy.md#generated.RAStudy.GetAirFlow) + * [`RAStudy.GetCFDCoupling()`](RAStudy.md#generated.RAStudy.GetCFDCoupling) + * [`RAStudy.GetCalculations()`](RAStudy.md#generated.RAStudy.GetCalculations) + * [`RAStudy.GetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.GetCollectForcesForFemAnalysis) + * [`RAStudy.GetContactData()`](RAStudy.md#generated.RAStudy.GetContactData) + * [`RAStudy.GetCustomerName()`](RAStudy.md#generated.RAStudy.GetCustomerName) + * [`RAStudy.GetDescription()`](RAStudy.md#generated.RAStudy.GetDescription) + * [`RAStudy.GetDomainSettings()`](RAStudy.md#generated.RAStudy.GetDomainSettings) + * [`RAStudy.GetElementCurve()`](RAStudy.md#generated.RAStudy.GetElementCurve) + * [`RAStudy.GetExportToolkit()`](RAStudy.md#generated.RAStudy.GetExportToolkit) + * [`RAStudy.GetFEMForcesAnalysisModules()`](RAStudy.md#generated.RAStudy.GetFEMForcesAnalysisModules) + * [`RAStudy.GetGeometry()`](RAStudy.md#generated.RAStudy.GetGeometry) + * [`RAStudy.GetGeometryCollection()`](RAStudy.md#generated.RAStudy.GetGeometryCollection) + * [`RAStudy.GetInletsOutletsCollection()`](RAStudy.md#generated.RAStudy.GetInletsOutletsCollection) + * [`RAStudy.GetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.GetIntraParticleCollisionStatistics) + * [`RAStudy.GetJointsData()`](RAStudy.md#generated.RAStudy.GetJointsData) + * [`RAStudy.GetMaterialCollection()`](RAStudy.md#generated.RAStudy.GetMaterialCollection) + * [`RAStudy.GetMaterialsInteractionCollection()`](RAStudy.md#generated.RAStudy.GetMaterialsInteractionCollection) + * [`RAStudy.GetMeshedParticlesUpscalingEnabled()`](RAStudy.md#generated.RAStudy.GetMeshedParticlesUpscalingEnabled) + * [`RAStudy.GetModuleCollection()`](RAStudy.md#generated.RAStudy.GetModuleCollection) + * [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource) + * [`RAStudy.GetParticleCollection()`](RAStudy.md#generated.RAStudy.GetParticleCollection) + * [`RAStudy.GetParticleInput()`](RAStudy.md#generated.RAStudy.GetParticleInput) + * [`RAStudy.GetParticles()`](RAStudy.md#generated.RAStudy.GetParticles) + * [`RAStudy.GetPhysics()`](RAStudy.md#generated.RAStudy.GetPhysics) + * [`RAStudy.GetPointCloudCollection()`](RAStudy.md#generated.RAStudy.GetPointCloudCollection) + * [`RAStudy.GetProgress()`](RAStudy.md#generated.RAStudy.GetProgress) + * [`RAStudy.GetSimulatorRun()`](RAStudy.md#generated.RAStudy.GetSimulatorRun) + * [`RAStudy.GetSolver()`](RAStudy.md#generated.RAStudy.GetSolver) + * [`RAStudy.GetStatus()`](RAStudy.md#generated.RAStudy.GetStatus) + * [`RAStudy.GetSurfaceFromFilename()`](RAStudy.md#generated.RAStudy.GetSurfaceFromFilename) + * [`RAStudy.GetTimeSet()`](RAStudy.md#generated.RAStudy.GetTimeSet) + * [`RAStudy.GetWallFromFilename()`](RAStudy.md#generated.RAStudy.GetWallFromFilename) + * [`RAStudy.HasCalculatedHTC()`](RAStudy.md#generated.RAStudy.HasCalculatedHTC) + * [`RAStudy.HasResults()`](RAStudy.md#generated.RAStudy.HasResults) + * [`RAStudy.ImportSurface()`](RAStudy.md#generated.RAStudy.ImportSurface) + * [`RAStudy.ImportSystemCouplingWall()`](RAStudy.md#generated.RAStudy.ImportSystemCouplingWall) + * [`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) + * [`RAStudy.SetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.SetCollectForcesForFemAnalysis) + * [`RAStudy.SetCustomerName()`](RAStudy.md#generated.RAStudy.SetCustomerName) + * [`RAStudy.SetDescription()`](RAStudy.md#generated.RAStudy.SetDescription) + * [`RAStudy.SetHTCCalculatorEnabled()`](RAStudy.md#generated.RAStudy.SetHTCCalculatorEnabled) + * [`RAStudy.SetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.SetIntraParticleCollisionStatistics) + * [`RAStudy.SetVariable()`](RAStudy.md#generated.RAStudy.SetVariable) + * [`RAStudy.StartSimulation()`](RAStudy.md#generated.RAStudy.StartSimulation) + * [`RAStudy.StopSimulation()`](RAStudy.md#generated.RAStudy.StopSimulation) + * [`RAStudy.customer_name`](RAStudy.md#generated.RAStudy.customer_name) + * [`RAStudy.description`](RAStudy.md#generated.RAStudy.description) + * [RASurface](RASurface.md) + * [`RASurface`](RASurface.md#generated.RASurface) + * [`RASurface.AddCurve()`](RASurface.md#generated.RASurface.AddCurve) + * [`RASurface.AddCustomCurve()`](RASurface.md#generated.RASurface.AddCustomCurve) + * [`RASurface.AddCustomProperty()`](RASurface.md#generated.RASurface.AddCustomProperty) + * [`RASurface.AddGridFunction()`](RASurface.md#generated.RASurface.AddGridFunction) + * [`RASurface.CreateCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateCurveOutputVariable) + * [`RASurface.CreateGridFunction()`](RASurface.md#generated.RASurface.CreateGridFunction) + * [`RASurface.CreateGridFunctionArrayOnCells()`](RASurface.md#generated.RASurface.CreateGridFunctionArrayOnCells) + * [`RASurface.CreateGridFunctionStatisticOutputVariable()`](RASurface.md#generated.RASurface.CreateGridFunctionStatisticOutputVariable) + * [`RASurface.CreateTransientCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateTransientCurveOutputVariable) + * [`RASurface.EditCustomCurve()`](RASurface.md#generated.RASurface.EditCustomCurve) + * [`RASurface.EditCustomProperty()`](RASurface.md#generated.RASurface.EditCustomProperty) + * [`RASurface.GetActivesArray()`](RASurface.md#generated.RASurface.GetActivesArray) + * [`RASurface.GetBoundingBox()`](RASurface.md#generated.RASurface.GetBoundingBox) + * [`RASurface.GetCellAreaAsArray()`](RASurface.md#generated.RASurface.GetCellAreaAsArray) + * [`RASurface.GetCellCenterAsArray()`](RASurface.md#generated.RASurface.GetCellCenterAsArray) + * [`RASurface.GetCellDzAsArray()`](RASurface.md#generated.RASurface.GetCellDzAsArray) + * [`RASurface.GetCellFromIJK()`](RASurface.md#generated.RASurface.GetCellFromIJK) + * [`RASurface.GetCellIJK()`](RASurface.md#generated.RASurface.GetCellIJK) + * [`RASurface.GetCellNumberOfVertices()`](RASurface.md#generated.RASurface.GetCellNumberOfVertices) + * [`RASurface.GetCellPointsAsFunction()`](RASurface.md#generated.RASurface.GetCellPointsAsFunction) + * [`RASurface.GetCellVolumeAsArray()`](RASurface.md#generated.RASurface.GetCellVolumeAsArray) + * [`RASurface.GetCurve()`](RASurface.md#generated.RASurface.GetCurve) + * [`RASurface.GetCurveNames()`](RASurface.md#generated.RASurface.GetCurveNames) + * [`RASurface.GetCurveNamesAssociation()`](RASurface.md#generated.RASurface.GetCurveNamesAssociation) + * [`RASurface.GetElementCurve()`](RASurface.md#generated.RASurface.GetElementCurve) + * [`RASurface.GetGeometryQuantity()`](RASurface.md#generated.RASurface.GetGeometryQuantity) + * [`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.GetNumberOfCells()`](RASurface.md#generated.RASurface.GetNumberOfCells) + * [`RASurface.GetNumberOfNodes()`](RASurface.md#generated.RASurface.GetNumberOfNodes) + * [`RASurface.GetNumpyCurve()`](RASurface.md#generated.RASurface.GetNumpyCurve) + * [`RASurface.GetOrientation()`](RASurface.md#generated.RASurface.GetOrientation) + * [`RASurface.GetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.GetOrientationFromAngleAndVector) + * [`RASurface.GetOrientationFromAngles()`](RASurface.md#generated.RASurface.GetOrientationFromAngles) + * [`RASurface.GetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.GetOrientationFromBasisVector) + * [`RASurface.GetOutputVariableValue()`](RASurface.md#generated.RASurface.GetOutputVariableValue) + * [`RASurface.GetPivotPoint()`](RASurface.md#generated.RASurface.GetPivotPoint) + * [`RASurface.GetTimeSet()`](RASurface.md#generated.RASurface.GetTimeSet) + * [`RASurface.GetTimeStatistics()`](RASurface.md#generated.RASurface.GetTimeStatistics) + * [`RASurface.GetTimeStep()`](RASurface.md#generated.RASurface.GetTimeStep) + * [`RASurface.GetTopologyShape()`](RASurface.md#generated.RASurface.GetTopologyShape) + * [`RASurface.GetTranslation()`](RASurface.md#generated.RASurface.GetTranslation) + * [`RASurface.HasGridFunction()`](RASurface.md#generated.RASurface.HasGridFunction) + * [`RASurface.HasMotionFrame()`](RASurface.md#generated.RASurface.HasMotionFrame) + * [`RASurface.IsCellActive()`](RASurface.md#generated.RASurface.IsCellActive) + * [`RASurface.IterCellVertices()`](RASurface.md#generated.RASurface.IterCellVertices) + * [`RASurface.IterCells()`](RASurface.md#generated.RASurface.IterCells) + * [`RASurface.Modified()`](RASurface.md#generated.RASurface.Modified) + * [`RASurface.RemoveCustomCurve()`](RASurface.md#generated.RASurface.RemoveCustomCurve) + * [`RASurface.RemoveCustomProperty()`](RASurface.md#generated.RASurface.RemoveCustomProperty) + * [`RASurface.RemoveOutputVariable()`](RASurface.md#generated.RASurface.RemoveOutputVariable) + * [`RASurface.RemoveProcess()`](RASurface.md#generated.RASurface.RemoveProcess) + * [`RASurface.SetCurrentTimeStep()`](RASurface.md#generated.RASurface.SetCurrentTimeStep) + * [`RASurface.SetInvertNormal()`](RASurface.md#generated.RASurface.SetInvertNormal) + * [`RASurface.SetOrientation()`](RASurface.md#generated.RASurface.SetOrientation) + * [`RASurface.SetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.SetOrientationFromAngleAndVector) + * [`RASurface.SetOrientationFromAngles()`](RASurface.md#generated.RASurface.SetOrientationFromAngles) + * [`RASurface.SetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.SetOrientationFromBasisVector) + * [`RASurface.SetPivotPoint()`](RASurface.md#generated.RASurface.SetPivotPoint) + * [`RASurface.SetTranslation()`](RASurface.md#generated.RASurface.SetTranslation) + * [RASurfaceUserProcess](RASurfaceUserProcess.md) + * [`RASurfaceUserProcess`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess) + * [`RASurfaceUserProcess.AddCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCurve) + * [`RASurfaceUserProcess.AddCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomCurve) + * [`RASurfaceUserProcess.AddCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomProperty) + * [`RASurfaceUserProcess.AddGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddGridFunction) + * [`RASurfaceUserProcess.CreateCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateCurveOutputVariable) + * [`RASurfaceUserProcess.CreateGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunction) + * [`RASurfaceUserProcess.CreateGridFunctionArrayOnCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionArrayOnCells) + * [`RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable) + * [`RASurfaceUserProcess.CreateTransientCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateTransientCurveOutputVariable) + * [`RASurfaceUserProcess.EditCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomCurve) + * [`RASurfaceUserProcess.EditCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomProperty) + * [`RASurfaceUserProcess.GetActivesArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetActivesArray) + * [`RASurfaceUserProcess.GetBoundingBox()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetBoundingBox) + * [`RASurfaceUserProcess.GetCellAreaAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellAreaAsArray) + * [`RASurfaceUserProcess.GetCellCenterAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellCenterAsArray) + * [`RASurfaceUserProcess.GetCellDzAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellDzAsArray) + * [`RASurfaceUserProcess.GetCellFromIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellFromIJK) + * [`RASurfaceUserProcess.GetCellIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellIJK) + * [`RASurfaceUserProcess.GetCellNumberOfVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellNumberOfVertices) + * [`RASurfaceUserProcess.GetCellPointsAsFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellPointsAsFunction) + * [`RASurfaceUserProcess.GetCellVolumeAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellVolumeAsArray) + * [`RASurfaceUserProcess.GetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCenter) + * [`RASurfaceUserProcess.GetCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurve) + * [`RASurfaceUserProcess.GetCurveNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNames) + * [`RASurfaceUserProcess.GetCurveNamesAssociation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNamesAssociation) + * [`RASurfaceUserProcess.GetElementCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetElementCurve) + * [`RASurfaceUserProcess.GetGeometryQuantity()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryQuantity) + * [`RASurfaceUserProcess.GetGeometryUnit()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryUnit) + * [`RASurfaceUserProcess.GetGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunction) + * [`RASurfaceUserProcess.GetGridFunctionNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunctionNames) + * [`RASurfaceUserProcess.GetMeshColoring()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMeshColoring) + * [`RASurfaceUserProcess.GetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMotionFrame) + * [`RASurfaceUserProcess.GetNumberOfCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfCells) + * [`RASurfaceUserProcess.GetNumberOfNodes()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfNodes) + * [`RASurfaceUserProcess.GetNumberOfParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfParticles) + * [`RASurfaceUserProcess.GetNumpyCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumpyCurve) + * [`RASurfaceUserProcess.GetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientation) + * [`RASurfaceUserProcess.GetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngleAndVector) + * [`RASurfaceUserProcess.GetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngles) + * [`RASurfaceUserProcess.GetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromBasisVector) + * [`RASurfaceUserProcess.GetOutputVariableValue()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOutputVariableValue) + * [`RASurfaceUserProcess.GetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetScale) + * [`RASurfaceUserProcess.GetTimeSet()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeSet) + * [`RASurfaceUserProcess.GetTimeStatistics()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStatistics) + * [`RASurfaceUserProcess.GetTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStep) + * [`RASurfaceUserProcess.GetTopologyShape()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTopologyShape) + * [`RASurfaceUserProcess.HasGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.HasGridFunction) + * [`RASurfaceUserProcess.IsCellActive()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IsCellActive) + * [`RASurfaceUserProcess.IterCellVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCellVertices) + * [`RASurfaceUserProcess.IterCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCells) + * [`RASurfaceUserProcess.IterParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterParticles) + * [`RASurfaceUserProcess.Modified()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.Modified) + * [`RASurfaceUserProcess.RemoveCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomCurve) + * [`RASurfaceUserProcess.RemoveCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomProperty) + * [`RASurfaceUserProcess.RemoveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveOutputVariable) + * [`RASurfaceUserProcess.RemoveProcess()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveProcess) + * [`RASurfaceUserProcess.SetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCenter) + * [`RASurfaceUserProcess.SetCurrentTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCurrentTimeStep) + * [`RASurfaceUserProcess.SetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetMotionFrame) + * [`RASurfaceUserProcess.SetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientation) + * [`RASurfaceUserProcess.SetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngleAndVector) + * [`RASurfaceUserProcess.SetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngles) + * [`RASurfaceUserProcess.SetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromBasisVector) + * [`RASurfaceUserProcess.SetSTL()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetSTL) + * [`RASurfaceUserProcess.SetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetScale) + * [RASystemCouplingWall](RASystemCouplingWall.md) + * [`RASystemCouplingWall`](RASystemCouplingWall.md#generated.RASystemCouplingWall) + * [`RASystemCouplingWall.AddCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCurve) + * [`RASystemCouplingWall.AddCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomCurve) + * [`RASystemCouplingWall.AddCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomProperty) + * [`RASystemCouplingWall.AddGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddGridFunction) + * [`RASystemCouplingWall.CreateCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateCurveOutputVariable) + * [`RASystemCouplingWall.CreateGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunction) + * [`RASystemCouplingWall.CreateGridFunctionArrayOnCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionArrayOnCells) + * [`RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable) + * [`RASystemCouplingWall.CreateTransientCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateTransientCurveOutputVariable) + * [`RASystemCouplingWall.DisableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableStructuralCouplingType) + * [`RASystemCouplingWall.DisableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableThermalCouplingType) + * [`RASystemCouplingWall.EditCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomCurve) + * [`RASystemCouplingWall.EditCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomProperty) + * [`RASystemCouplingWall.EnableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableStructuralCouplingType) + * [`RASystemCouplingWall.EnableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableThermalCouplingType) + * [`RASystemCouplingWall.GetActivesArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetActivesArray) + * [`RASystemCouplingWall.GetAvailableMaterials()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetAvailableMaterials) + * [`RASystemCouplingWall.GetBoundingBox()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetBoundingBox) + * [`RASystemCouplingWall.GetCellAreaAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellAreaAsArray) + * [`RASystemCouplingWall.GetCellCenterAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellCenterAsArray) + * [`RASystemCouplingWall.GetCellDzAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellDzAsArray) + * [`RASystemCouplingWall.GetCellFromIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellFromIJK) + * [`RASystemCouplingWall.GetCellIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellIJK) + * [`RASystemCouplingWall.GetCellNumberOfVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellNumberOfVertices) + * [`RASystemCouplingWall.GetCellPointsAsFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellPointsAsFunction) + * [`RASystemCouplingWall.GetCellVolumeAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellVolumeAsArray) + * [`RASystemCouplingWall.GetCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurve) + * [`RASystemCouplingWall.GetCurveNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNames) + * [`RASystemCouplingWall.GetCurveNamesAssociation()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNamesAssociation) + * [`RASystemCouplingWall.GetElementCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetElementCurve) + * [`RASystemCouplingWall.GetGeometryQuantity()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryQuantity) + * [`RASystemCouplingWall.GetGeometryUnit()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryUnit) + * [`RASystemCouplingWall.GetGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunction) + * [`RASystemCouplingWall.GetGridFunctionNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunctionNames) + * [`RASystemCouplingWall.GetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMaterial) + * [`RASystemCouplingWall.GetMeshColoring()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMeshColoring) + * [`RASystemCouplingWall.GetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMotionFrame) + * [`RASystemCouplingWall.GetNumberOfCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfCells) + * [`RASystemCouplingWall.GetNumberOfNodes()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfNodes) + * [`RASystemCouplingWall.GetNumpyCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumpyCurve) + * [`RASystemCouplingWall.GetOutputVariableValue()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetOutputVariableValue) + * [`RASystemCouplingWall.GetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSphBoundaryType) + * [`RASystemCouplingWall.GetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetStructuralCouplingTypeEnabled) + * [`RASystemCouplingWall.GetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSurfaceTensionContactAngle) + * [`RASystemCouplingWall.GetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetThermalCouplingTypeEnabled) + * [`RASystemCouplingWall.GetTimeSet()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeSet) + * [`RASystemCouplingWall.GetTimeStatistics()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStatistics) + * [`RASystemCouplingWall.GetTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStep) + * [`RASystemCouplingWall.GetTopologyShape()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTopologyShape) + * [`RASystemCouplingWall.GetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTriangleSize) + * [`RASystemCouplingWall.GetValidSphBoundaryTypeValues()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues) + * [`RASystemCouplingWall.HasGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasGridFunction) + * [`RASystemCouplingWall.HasMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasMotionFrame) + * [`RASystemCouplingWall.IsCellActive()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsCellActive) + * [`RASystemCouplingWall.IsStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsStructuralCouplingTypeEnabled) + * [`RASystemCouplingWall.IsThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsThermalCouplingTypeEnabled) + * [`RASystemCouplingWall.IterCellVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCellVertices) + * [`RASystemCouplingWall.IterCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCells) + * [`RASystemCouplingWall.Modified()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.Modified) + * [`RASystemCouplingWall.RemoveCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomCurve) + * [`RASystemCouplingWall.RemoveCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomProperty) + * [`RASystemCouplingWall.RemoveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveOutputVariable) + * [`RASystemCouplingWall.RemoveProcess()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveProcess) + * [`RASystemCouplingWall.SetCurrentTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCurrentTimeStep) + * [`RASystemCouplingWall.SetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMaterial) + * [`RASystemCouplingWall.SetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMotionFrame) + * [`RASystemCouplingWall.SetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSphBoundaryType) + * [`RASystemCouplingWall.SetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetStructuralCouplingTypeEnabled) + * [`RASystemCouplingWall.SetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSurfaceTensionContactAngle) + * [`RASystemCouplingWall.SetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetThermalCouplingTypeEnabled) + * [`RASystemCouplingWall.SetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetTriangleSize) + * [RATagging](RATagging.md) + * [`RATagging`](RATagging.md#generated.RATagging) + * [`RATagging.GetGridFunctionName()`](RATagging.md#generated.RATagging.GetGridFunctionName) + * [`RATagging.GetNameMask()`](RATagging.md#generated.RATagging.GetNameMask) + * [`RATagging.GetTagValue()`](RATagging.md#generated.RATagging.GetTagValue) + * [`RATagging.GetTimeRangeFilter()`](RATagging.md#generated.RATagging.GetTimeRangeFilter) + * [`RATagging.SetNameMask()`](RATagging.md#generated.RATagging.SetNameMask) + * [`RATagging.SetTagValue()`](RATagging.md#generated.RATagging.SetTagValue) + * [RAThreeRollsBeltProfile](RAThreeRollsBeltProfile.md) + * [`RAThreeRollsBeltProfile`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile) + * [`RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths) + * [`RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths) + * [`RAThreeRollsBeltProfile.GetAvailableMaterials()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetAvailableMaterials) + * [`RAThreeRollsBeltProfile.GetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetCenterRollLength) + * [`RAThreeRollsBeltProfile.GetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetLowerCornerRadius) + * [`RAThreeRollsBeltProfile.GetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetMaterial) + * [`RAThreeRollsBeltProfile.GetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetTroughingAngle) + * [`RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths) + * [`RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled) + * [`RAThreeRollsBeltProfile.SetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetCenterRollLength) + * [`RAThreeRollsBeltProfile.SetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetLowerCornerRadius) + * [`RAThreeRollsBeltProfile.SetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetMaterial) + * [`RAThreeRollsBeltProfile.SetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetTroughingAngle) + * [`RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths) + * [RATimeRangeFilter](RATimeRangeFilter.md) + * [`RATimeRangeFilter`](RATimeRangeFilter.md#generated.RATimeRangeFilter) + * [`RATimeRangeFilter.GetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetDomainRange) + * [`RATimeRangeFilter.GetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetFinal) + * [`RATimeRangeFilter.GetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetInitial) + * [`RATimeRangeFilter.GetValidDomainRangeValues()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetValidDomainRangeValues) + * [`RATimeRangeFilter.SetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetDomainRange) + * [`RATimeRangeFilter.SetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetFinal) + * [`RATimeRangeFilter.SetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetInitial) + * [RATimeSeriesRotation](RATimeSeriesRotation.md) + * [`RATimeSeriesRotation`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation) + * [`RATimeSeriesRotation.ImportTimeSeriesMotion()`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation.ImportTimeSeriesMotion) + * [RATimeSeriesTranslation](RATimeSeriesTranslation.md) + * [`RATimeSeriesTranslation`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation) + * [`RATimeSeriesTranslation.ImportTimeSeriesMotion()`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation.ImportTimeSeriesMotion) + * [RATrajectoryProcess](RATrajectoryProcess.md) + * [`RATrajectoryProcess`](RATrajectoryProcess.md#generated.RATrajectoryProcess) + * [`RATrajectoryProcess.AddCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCurve) + * [`RATrajectoryProcess.AddCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomCurve) + * [`RATrajectoryProcess.AddCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomProperty) + * [`RATrajectoryProcess.AddGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddGridFunction) + * [`RATrajectoryProcess.CreateCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateCurveOutputVariable) + * [`RATrajectoryProcess.CreateGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunction) + * [`RATrajectoryProcess.CreateGridFunctionArrayOnCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionArrayOnCells) + * [`RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable) + * [`RATrajectoryProcess.CreateTransientCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateTransientCurveOutputVariable) + * [`RATrajectoryProcess.EditCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomCurve) + * [`RATrajectoryProcess.EditCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomProperty) + * [`RATrajectoryProcess.GetActivesArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetActivesArray) + * [`RATrajectoryProcess.GetBoundingBox()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetBoundingBox) + * [`RATrajectoryProcess.GetCellAreaAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellAreaAsArray) + * [`RATrajectoryProcess.GetCellCenterAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellCenterAsArray) + * [`RATrajectoryProcess.GetCellDzAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellDzAsArray) + * [`RATrajectoryProcess.GetCellFromIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellFromIJK) + * [`RATrajectoryProcess.GetCellIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellIJK) + * [`RATrajectoryProcess.GetCellNumberOfVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellNumberOfVertices) + * [`RATrajectoryProcess.GetCellPointsAsFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellPointsAsFunction) + * [`RATrajectoryProcess.GetCellVolumeAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellVolumeAsArray) + * [`RATrajectoryProcess.GetCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurve) + * [`RATrajectoryProcess.GetCurveNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNames) + * [`RATrajectoryProcess.GetCurveNamesAssociation()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNamesAssociation) + * [`RATrajectoryProcess.GetElementCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetElementCurve) + * [`RATrajectoryProcess.GetGeometryQuantity()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryQuantity) + * [`RATrajectoryProcess.GetGeometryUnit()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryUnit) + * [`RATrajectoryProcess.GetGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunction) + * [`RATrajectoryProcess.GetGridFunctionNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunctionNames) + * [`RATrajectoryProcess.GetMeshColoring()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetMeshColoring) + * [`RATrajectoryProcess.GetNumberOfCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfCells) + * [`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.HasGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.HasGridFunction) + * [`RATrajectoryProcess.IsCellActive()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IsCellActive) + * [`RATrajectoryProcess.IterCellVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCellVertices) + * [`RATrajectoryProcess.IterCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCells) + * [`RATrajectoryProcess.IterParticles()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterParticles) + * [`RATrajectoryProcess.Modified()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.Modified) + * [`RATrajectoryProcess.RemoveCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomCurve) + * [`RATrajectoryProcess.RemoveCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomProperty) + * [`RATrajectoryProcess.RemoveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveOutputVariable) + * [`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) + * [`RATranslation.GetAcceleration()`](RATranslation.md#generated.RATranslation.GetAcceleration) + * [`RATranslation.GetFinalVelocity()`](RATranslation.md#generated.RATranslation.GetFinalVelocity) + * [`RATranslation.GetInput()`](RATranslation.md#generated.RATranslation.GetInput) + * [`RATranslation.GetValidInputValues()`](RATranslation.md#generated.RATranslation.GetValidInputValues) + * [`RATranslation.GetVelocity()`](RATranslation.md#generated.RATranslation.GetVelocity) + * [`RATranslation.SetAcceleration()`](RATranslation.md#generated.RATranslation.SetAcceleration) + * [`RATranslation.SetFinalVelocity()`](RATranslation.md#generated.RATranslation.SetFinalVelocity) + * [`RATranslation.SetInput()`](RATranslation.md#generated.RATranslation.SetInput) + * [`RATranslation.SetVelocity()`](RATranslation.md#generated.RATranslation.SetVelocity) + * [RATwoRollsBeltProfile](RATwoRollsBeltProfile.md) + * [`RATwoRollsBeltProfile`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile) + * [`RATwoRollsBeltProfile.GetAvailableMaterials()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetAvailableMaterials) + * [`RATwoRollsBeltProfile.GetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetLowerCornerRadius) + * [`RATwoRollsBeltProfile.GetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetMaterial) + * [`RATwoRollsBeltProfile.GetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetTroughingAngle) + * [`RATwoRollsBeltProfile.SetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetLowerCornerRadius) + * [`RATwoRollsBeltProfile.SetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetMaterial) + * [`RATwoRollsBeltProfile.SetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetTroughingAngle) + * [RAUserProcessCollection](RAUserProcessCollection.md) + * [`RAUserProcessCollection`](RAUserProcessCollection.md#generated.RAUserProcessCollection) + * [`RAUserProcessCollection.CreateContactToParticleProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateContactToParticleProcess) + * [`RAUserProcessCollection.CreateCubeProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCubeProcess) + * [`RAUserProcessCollection.CreateCylinderProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCylinderProcess) + * [`RAUserProcessCollection.CreateEulerianStatistics()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateEulerianStatistics) + * [`RAUserProcessCollection.CreateFilterProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateFilterProcess) + * [`RAUserProcessCollection.CreateInspectorProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateInspectorProcess) + * [`RAUserProcessCollection.CreateParticleTimeSelectionProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleTimeSelectionProcess) + * [`RAUserProcessCollection.CreateParticleToContactProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleToContactProcess) + * [`RAUserProcessCollection.CreatePlaneProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePlaneProcess) + * [`RAUserProcessCollection.CreatePolyhedronProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePolyhedronProcess) + * [`RAUserProcessCollection.CreatePropertyProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePropertyProcess) + * [`RAUserProcessCollection.CreateStreamlinesUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateStreamlinesUserProcess) + * [`RAUserProcessCollection.CreateSurfaceUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateSurfaceUserProcess) + * [`RAUserProcessCollection.CreateTrajectoryProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateTrajectoryProcess) + * [`RAUserProcessCollection.GetContactToParticleProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetContactToParticleProcessNames) + * [`RAUserProcessCollection.GetCubeProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCubeProcessNames) + * [`RAUserProcessCollection.GetCylinderProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCylinderProcessNames) + * [`RAUserProcessCollection.GetEulerianStatisticsNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetEulerianStatisticsNames) + * [`RAUserProcessCollection.GetFilterProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetFilterProcessNames) + * [`RAUserProcessCollection.GetInspectorProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetInspectorProcessNames) + * [`RAUserProcessCollection.GetParticleTimeSelectionProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleTimeSelectionProcessNames) + * [`RAUserProcessCollection.GetParticleToContactProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleToContactProcessNames) + * [`RAUserProcessCollection.GetPlaneProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPlaneProcessNames) + * [`RAUserProcessCollection.GetPolyhedronProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPolyhedronProcessNames) + * [`RAUserProcessCollection.GetProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcess) + * [`RAUserProcessCollection.GetProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcessNames) + * [`RAUserProcessCollection.GetPropertyProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPropertyProcessNames) + * [`RAUserProcessCollection.GetStreamlinesUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetStreamlinesUserProcessNames) + * [`RAUserProcessCollection.GetSurfaceUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetSurfaceUserProcessNames) + * [`RAUserProcessCollection.GetTrajectoryProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetTrajectoryProcessNames) + * [RAVibration](RAVibration.md) + * [`RAVibration`](RAVibration.md#generated.RAVibration) + * [`RAVibration.GetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.GetAmplitudeVariation) + * [`RAVibration.GetDirection()`](RAVibration.md#generated.RAVibration.GetDirection) + * [`RAVibration.GetFrequencyVariation()`](RAVibration.md#generated.RAVibration.GetFrequencyVariation) + * [`RAVibration.GetInitialAmplitude()`](RAVibration.md#generated.RAVibration.GetInitialAmplitude) + * [`RAVibration.GetInitialFrequency()`](RAVibration.md#generated.RAVibration.GetInitialFrequency) + * [`RAVibration.GetInitialPhase()`](RAVibration.md#generated.RAVibration.GetInitialPhase) + * [`RAVibration.SetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.SetAmplitudeVariation) + * [`RAVibration.SetDirection()`](RAVibration.md#generated.RAVibration.SetDirection) + * [`RAVibration.SetFrequencyVariation()`](RAVibration.md#generated.RAVibration.SetFrequencyVariation) + * [`RAVibration.SetInitialAmplitude()`](RAVibration.md#generated.RAVibration.SetInitialAmplitude) + * [`RAVibration.SetInitialFrequency()`](RAVibration.md#generated.RAVibration.SetInitialFrequency) + * [`RAVibration.SetInitialPhase()`](RAVibration.md#generated.RAVibration.SetInitialPhase) + * [RAVolumetricInlet](RAVolumetricInlet.md) + * [`RAVolumetricInlet`](RAVolumetricInlet.md#generated.RAVolumetricInlet) + * [`RAVolumetricInlet.DisablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisablePeriodic) + * [`RAVolumetricInlet.EnablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnablePeriodic) + * [`RAVolumetricInlet.GetAvailableGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetAvailableGeometries) + * [`RAVolumetricInlet.GetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxCenter) + * [`RAVolumetricInlet.GetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxDimensions) + * [`RAVolumetricInlet.GetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGapScaleFactor) + * [`RAVolumetricInlet.GetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGeometries) + * [`RAVolumetricInlet.GetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInitialVelocity) + * [`RAVolumetricInlet.GetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInjectionTime) + * [`RAVolumetricInlet.GetInputPropertiesList()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInputPropertiesList) + * [`RAVolumetricInlet.GetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientation) + * [`RAVolumetricInlet.GetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngleAndVector) + * [`RAVolumetricInlet.GetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngles) + * [`RAVolumetricInlet.GetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromBasisVector) + * [`RAVolumetricInlet.GetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriod) + * [`RAVolumetricInlet.GetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriodic) + * [`RAVolumetricInlet.GetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSeedCoordinates) + * [`RAVolumetricInlet.GetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphMass) + * [`RAVolumetricInlet.GetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphTemperature) + * [`RAVolumetricInlet.GetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetStopTime) + * [`RAVolumetricInlet.GetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseGeometriesToCompute) + * [`RAVolumetricInlet.IsPeriodicEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled) + * [`RAVolumetricInlet.SetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxCenter) + * [`RAVolumetricInlet.SetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxDimensions) + * [`RAVolumetricInlet.SetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGapScaleFactor) + * [`RAVolumetricInlet.SetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGeometries) + * [`RAVolumetricInlet.SetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInitialVelocity) + * [`RAVolumetricInlet.SetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInjectionTime) + * [`RAVolumetricInlet.SetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientation) + * [`RAVolumetricInlet.SetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngleAndVector) + * [`RAVolumetricInlet.SetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngles) + * [`RAVolumetricInlet.SetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromBasisVector) + * [`RAVolumetricInlet.SetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriod) + * [`RAVolumetricInlet.SetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriodic) + * [`RAVolumetricInlet.SetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSeedCoordinates) + * [`RAVolumetricInlet.SetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphMass) + * [`RAVolumetricInlet.SetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphTemperature) + * [`RAVolumetricInlet.SetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetStopTime) + * [`RAVolumetricInlet.SetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseGeometriesToCompute) + * [RAVolumetricInletProperties](RAVolumetricInletProperties.md) + * [`RAVolumetricInletProperties`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties) + * [`RAVolumetricInletProperties.GetAvailableParticles()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetAvailableParticles) + * [`RAVolumetricInletProperties.GetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetMass) + * [`RAVolumetricInletProperties.GetModuleProperties()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperties) + * [`RAVolumetricInletProperties.GetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperty) + * [`RAVolumetricInletProperties.GetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetParticle) + * [`RAVolumetricInletProperties.GetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetTemperature) + * [`RAVolumetricInletProperties.GetValidOptionsForModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetValidOptionsForModuleProperty) + * [`RAVolumetricInletProperties.SetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetMass) + * [`RAVolumetricInletProperties.SetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetModuleProperty) + * [`RAVolumetricInletProperties.SetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetParticle) + * [`RAVolumetricInletProperties.SetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetTemperature) + * [RAVolumetricInletPropertiesList](RAVolumetricInletPropertiesList.md) + * [`RAVolumetricInletPropertiesList`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList) + * [`RAVolumetricInletPropertiesList.Clear()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Clear) + * [`RAVolumetricInletPropertiesList.New()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.New) + * [`RAVolumetricInletPropertiesList.Remove()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Remove) + * [RAWall](RAWall.md) + * [`RAWall`](RAWall.md#generated.RAWall) + * [`RAWall.AddCurve()`](RAWall.md#generated.RAWall.AddCurve) + * [`RAWall.AddCustomCurve()`](RAWall.md#generated.RAWall.AddCustomCurve) + * [`RAWall.AddCustomProperty()`](RAWall.md#generated.RAWall.AddCustomProperty) + * [`RAWall.AddGridFunction()`](RAWall.md#generated.RAWall.AddGridFunction) + * [`RAWall.CreateCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateCurveOutputVariable) + * [`RAWall.CreateGridFunction()`](RAWall.md#generated.RAWall.CreateGridFunction) + * [`RAWall.CreateGridFunctionArrayOnCells()`](RAWall.md#generated.RAWall.CreateGridFunctionArrayOnCells) + * [`RAWall.CreateGridFunctionStatisticOutputVariable()`](RAWall.md#generated.RAWall.CreateGridFunctionStatisticOutputVariable) + * [`RAWall.CreateTransientCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateTransientCurveOutputVariable) + * [`RAWall.EditCustomCurve()`](RAWall.md#generated.RAWall.EditCustomCurve) + * [`RAWall.EditCustomProperty()`](RAWall.md#generated.RAWall.EditCustomProperty) + * [`RAWall.GetActivesArray()`](RAWall.md#generated.RAWall.GetActivesArray) + * [`RAWall.GetAvailableMaterials()`](RAWall.md#generated.RAWall.GetAvailableMaterials) + * [`RAWall.GetBoundaryMass()`](RAWall.md#generated.RAWall.GetBoundaryMass) + * [`RAWall.GetBoundingBox()`](RAWall.md#generated.RAWall.GetBoundingBox) + * [`RAWall.GetCellAreaAsArray()`](RAWall.md#generated.RAWall.GetCellAreaAsArray) + * [`RAWall.GetCellCenterAsArray()`](RAWall.md#generated.RAWall.GetCellCenterAsArray) + * [`RAWall.GetCellDzAsArray()`](RAWall.md#generated.RAWall.GetCellDzAsArray) + * [`RAWall.GetCellFromIJK()`](RAWall.md#generated.RAWall.GetCellFromIJK) + * [`RAWall.GetCellIJK()`](RAWall.md#generated.RAWall.GetCellIJK) + * [`RAWall.GetCellNumberOfVertices()`](RAWall.md#generated.RAWall.GetCellNumberOfVertices) + * [`RAWall.GetCellPointsAsFunction()`](RAWall.md#generated.RAWall.GetCellPointsAsFunction) + * [`RAWall.GetCellVolumeAsArray()`](RAWall.md#generated.RAWall.GetCellVolumeAsArray) + * [`RAWall.GetCurve()`](RAWall.md#generated.RAWall.GetCurve) + * [`RAWall.GetCurveNames()`](RAWall.md#generated.RAWall.GetCurveNames) + * [`RAWall.GetCurveNamesAssociation()`](RAWall.md#generated.RAWall.GetCurveNamesAssociation) + * [`RAWall.GetDisableTime()`](RAWall.md#generated.RAWall.GetDisableTime) + * [`RAWall.GetElementCurve()`](RAWall.md#generated.RAWall.GetElementCurve) + * [`RAWall.GetEnableTime()`](RAWall.md#generated.RAWall.GetEnableTime) + * [`RAWall.GetGeometryQuantity()`](RAWall.md#generated.RAWall.GetGeometryQuantity) + * [`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) + * [`RAWall.GetModuleProperty()`](RAWall.md#generated.RAWall.GetModuleProperty) + * [`RAWall.GetMomentXDirection()`](RAWall.md#generated.RAWall.GetMomentXDirection) + * [`RAWall.GetMomentYDirection()`](RAWall.md#generated.RAWall.GetMomentYDirection) + * [`RAWall.GetMomentZDirection()`](RAWall.md#generated.RAWall.GetMomentZDirection) + * [`RAWall.GetNumberOfCells()`](RAWall.md#generated.RAWall.GetNumberOfCells) + * [`RAWall.GetNumberOfNodes()`](RAWall.md#generated.RAWall.GetNumberOfNodes) + * [`RAWall.GetNumberOfReplications()`](RAWall.md#generated.RAWall.GetNumberOfReplications) + * [`RAWall.GetNumpyCurve()`](RAWall.md#generated.RAWall.GetNumpyCurve) + * [`RAWall.GetOrientation()`](RAWall.md#generated.RAWall.GetOrientation) + * [`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) + * [`RAWall.GetPrincipalMomentOfInertia()`](RAWall.md#generated.RAWall.GetPrincipalMomentOfInertia) + * [`RAWall.GetReplicateGeometry()`](RAWall.md#generated.RAWall.GetReplicateGeometry) + * [`RAWall.GetReplicateTime()`](RAWall.md#generated.RAWall.GetReplicateTime) + * [`RAWall.GetSphBoundaryType()`](RAWall.md#generated.RAWall.GetSphBoundaryType) + * [`RAWall.GetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.GetSurfaceTensionContactAngle) + * [`RAWall.GetTemperature()`](RAWall.md#generated.RAWall.GetTemperature) + * [`RAWall.GetThermalBoundaryConditionType()`](RAWall.md#generated.RAWall.GetThermalBoundaryConditionType) + * [`RAWall.GetTimeSet()`](RAWall.md#generated.RAWall.GetTimeSet) + * [`RAWall.GetTimeStatistics()`](RAWall.md#generated.RAWall.GetTimeStatistics) + * [`RAWall.GetTimeStep()`](RAWall.md#generated.RAWall.GetTimeStep) + * [`RAWall.GetTopologyShape()`](RAWall.md#generated.RAWall.GetTopologyShape) + * [`RAWall.GetTranslation()`](RAWall.md#generated.RAWall.GetTranslation) + * [`RAWall.GetTriangleSize()`](RAWall.md#generated.RAWall.GetTriangleSize) + * [`RAWall.GetValidOptionsForModuleProperty()`](RAWall.md#generated.RAWall.GetValidOptionsForModuleProperty) + * [`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.GetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.GetVolumeShearWorkRatio) + * [`RAWall.GetWearModel()`](RAWall.md#generated.RAWall.GetWearModel) + * [`RAWall.HasGridFunction()`](RAWall.md#generated.RAWall.HasGridFunction) + * [`RAWall.HasMotionFrame()`](RAWall.md#generated.RAWall.HasMotionFrame) + * [`RAWall.IsCellActive()`](RAWall.md#generated.RAWall.IsCellActive) + * [`RAWall.IterCellVertices()`](RAWall.md#generated.RAWall.IterCellVertices) + * [`RAWall.IterCells()`](RAWall.md#generated.RAWall.IterCells) + * [`RAWall.LoadFile()`](RAWall.md#generated.RAWall.LoadFile) + * [`RAWall.Modified()`](RAWall.md#generated.RAWall.Modified) + * [`RAWall.OrientationAnglesOrder`](RAWall.md#generated.RAWall.OrientationAnglesOrder) + * [`RAWall.RemoveCustomCurve()`](RAWall.md#generated.RAWall.RemoveCustomCurve) + * [`RAWall.RemoveCustomProperty()`](RAWall.md#generated.RAWall.RemoveCustomProperty) + * [`RAWall.RemoveOutputVariable()`](RAWall.md#generated.RAWall.RemoveOutputVariable) + * [`RAWall.RemoveProcess()`](RAWall.md#generated.RAWall.RemoveProcess) + * [`RAWall.SetBoundaryMass()`](RAWall.md#generated.RAWall.SetBoundaryMass) + * [`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.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) + * [`RAWall.SetReplicateGeometry()`](RAWall.md#generated.RAWall.SetReplicateGeometry) + * [`RAWall.SetReplicateTime()`](RAWall.md#generated.RAWall.SetReplicateTime) + * [`RAWall.SetSphBoundaryType()`](RAWall.md#generated.RAWall.SetSphBoundaryType) + * [`RAWall.SetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.SetSurfaceTensionContactAngle) + * [`RAWall.SetTemperature()`](RAWall.md#generated.RAWall.SetTemperature) + * [`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) + * [Added](changelog.md#added) + * [New Methods](changelog.md#new-methods) + * [New Classes](changelog.md#new-classes) + * [Changed](changelog.md#changed) + * [Deprecated](changelog.md#deprecated) + * [Removed](changelog.md#removed) diff --git a/2025R2/rocky-prepost-scripting-manual/prepost-scripting-reference.md b/2025R2/rocky-prepost-scripting-manual/prepost-scripting-reference.md index 0ceaa146c5..c4f622174f 100644 --- a/2025R2/rocky-prepost-scripting-manual/prepost-scripting-reference.md +++ b/2025R2/rocky-prepost-scripting-manual/prepost-scripting-reference.md @@ -1,4224 +1,4224 @@ - - -# Class Reference - -These are the classes and methods available to the user when executing scripts: - -* [RAAirFlow](RAAirFlow.md) - * [`RAAirFlow`](RAAirFlow.md#generated.RAAirFlow) - * [`RAAirFlow.AddCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCurve) - * [`RAAirFlow.AddCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCustomCurve) - * [`RAAirFlow.AddCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.AddCustomProperty) - * [`RAAirFlow.AddGridFunction()`](RAAirFlow.md#generated.RAAirFlow.AddGridFunction) - * [`RAAirFlow.CreateCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateCurveOutputVariable) - * [`RAAirFlow.CreateGridFunction()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunction) - * [`RAAirFlow.CreateGridFunctionArrayOnCells()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionArrayOnCells) - * [`RAAirFlow.CreateGridFunctionStatisticOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionStatisticOutputVariable) - * [`RAAirFlow.CreateTransientCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateTransientCurveOutputVariable) - * [`RAAirFlow.EditCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.EditCustomCurve) - * [`RAAirFlow.EditCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.EditCustomProperty) - * [`RAAirFlow.GetActivesArray()`](RAAirFlow.md#generated.RAAirFlow.GetActivesArray) - * [`RAAirFlow.GetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.GetAirDensity) - * [`RAAirFlow.GetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.GetAirKinematicViscosity) - * [`RAAirFlow.GetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.GetBoundaryConditionType) - * [`RAAirFlow.GetBoundingBox()`](RAAirFlow.md#generated.RAAirFlow.GetBoundingBox) - * [`RAAirFlow.GetCellAreaAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellAreaAsArray) - * [`RAAirFlow.GetCellCenterAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellCenterAsArray) - * [`RAAirFlow.GetCellDzAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellDzAsArray) - * [`RAAirFlow.GetCellFromIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellFromIJK) - * [`RAAirFlow.GetCellIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellIJK) - * [`RAAirFlow.GetCellNumberOfVertices()`](RAAirFlow.md#generated.RAAirFlow.GetCellNumberOfVertices) - * [`RAAirFlow.GetCellPointsAsFunction()`](RAAirFlow.md#generated.RAAirFlow.GetCellPointsAsFunction) - * [`RAAirFlow.GetCellSize()`](RAAirFlow.md#generated.RAAirFlow.GetCellSize) - * [`RAAirFlow.GetCellVolumeAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellVolumeAsArray) - * [`RAAirFlow.GetCurve()`](RAAirFlow.md#generated.RAAirFlow.GetCurve) - * [`RAAirFlow.GetCurveNames()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNames) - * [`RAAirFlow.GetCurveNamesAssociation()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNamesAssociation) - * [`RAAirFlow.GetElementCurve()`](RAAirFlow.md#generated.RAAirFlow.GetElementCurve) - * [`RAAirFlow.GetGeometryQuantity()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryQuantity) - * [`RAAirFlow.GetGeometryUnit()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryUnit) - * [`RAAirFlow.GetGridFunction()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunction) - * [`RAAirFlow.GetGridFunctionNames()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunctionNames) - * [`RAAirFlow.GetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.GetInteractionScale) - * [`RAAirFlow.GetMaxX()`](RAAirFlow.md#generated.RAAirFlow.GetMaxX) - * [`RAAirFlow.GetMaxY()`](RAAirFlow.md#generated.RAAirFlow.GetMaxY) - * [`RAAirFlow.GetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.GetMaxZ) - * [`RAAirFlow.GetMeshColoring()`](RAAirFlow.md#generated.RAAirFlow.GetMeshColoring) - * [`RAAirFlow.GetMinX()`](RAAirFlow.md#generated.RAAirFlow.GetMinX) - * [`RAAirFlow.GetMinY()`](RAAirFlow.md#generated.RAAirFlow.GetMinY) - * [`RAAirFlow.GetMinZ()`](RAAirFlow.md#generated.RAAirFlow.GetMinZ) - * [`RAAirFlow.GetNumberOfCells()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfCells) - * [`RAAirFlow.GetNumberOfNodes()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfNodes) - * [`RAAirFlow.GetNumpyCurve()`](RAAirFlow.md#generated.RAAirFlow.GetNumpyCurve) - * [`RAAirFlow.GetOutputVariableValue()`](RAAirFlow.md#generated.RAAirFlow.GetOutputVariableValue) - * [`RAAirFlow.GetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.GetSpeedOfSound) - * [`RAAirFlow.GetStartTime()`](RAAirFlow.md#generated.RAAirFlow.GetStartTime) - * [`RAAirFlow.GetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.GetStartWhenParticlesEnter) - * [`RAAirFlow.GetTimeSet()`](RAAirFlow.md#generated.RAAirFlow.GetTimeSet) - * [`RAAirFlow.GetTimeStatistics()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStatistics) - * [`RAAirFlow.GetTimeStep()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStep) - * [`RAAirFlow.GetTopologyShape()`](RAAirFlow.md#generated.RAAirFlow.GetTopologyShape) - * [`RAAirFlow.GetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.GetUseAirflow) - * [`RAAirFlow.GetValidBoundaryConditionTypeValues()`](RAAirFlow.md#generated.RAAirFlow.GetValidBoundaryConditionTypeValues) - * [`RAAirFlow.HasGridFunction()`](RAAirFlow.md#generated.RAAirFlow.HasGridFunction) - * [`RAAirFlow.IsCellActive()`](RAAirFlow.md#generated.RAAirFlow.IsCellActive) - * [`RAAirFlow.IterCellVertices()`](RAAirFlow.md#generated.RAAirFlow.IterCellVertices) - * [`RAAirFlow.IterCells()`](RAAirFlow.md#generated.RAAirFlow.IterCells) - * [`RAAirFlow.Modified()`](RAAirFlow.md#generated.RAAirFlow.Modified) - * [`RAAirFlow.RemoveCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomCurve) - * [`RAAirFlow.RemoveCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomProperty) - * [`RAAirFlow.RemoveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.RemoveOutputVariable) - * [`RAAirFlow.RemoveProcess()`](RAAirFlow.md#generated.RAAirFlow.RemoveProcess) - * [`RAAirFlow.SetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.SetAirDensity) - * [`RAAirFlow.SetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.SetAirKinematicViscosity) - * [`RAAirFlow.SetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.SetBoundaryConditionType) - * [`RAAirFlow.SetCellSize()`](RAAirFlow.md#generated.RAAirFlow.SetCellSize) - * [`RAAirFlow.SetCurrentTimeStep()`](RAAirFlow.md#generated.RAAirFlow.SetCurrentTimeStep) - * [`RAAirFlow.SetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.SetInteractionScale) - * [`RAAirFlow.SetMaxX()`](RAAirFlow.md#generated.RAAirFlow.SetMaxX) - * [`RAAirFlow.SetMaxY()`](RAAirFlow.md#generated.RAAirFlow.SetMaxY) - * [`RAAirFlow.SetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.SetMaxZ) - * [`RAAirFlow.SetMinX()`](RAAirFlow.md#generated.RAAirFlow.SetMinX) - * [`RAAirFlow.SetMinY()`](RAAirFlow.md#generated.RAAirFlow.SetMinY) - * [`RAAirFlow.SetMinZ()`](RAAirFlow.md#generated.RAAirFlow.SetMinZ) - * [`RAAirFlow.SetPartIdIfValid()`](RAAirFlow.md#generated.RAAirFlow.SetPartIdIfValid) - * [`RAAirFlow.SetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.SetSpeedOfSound) - * [`RAAirFlow.SetStartTime()`](RAAirFlow.md#generated.RAAirFlow.SetStartTime) - * [`RAAirFlow.SetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.SetStartWhenParticlesEnter) - * [`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) - * [`RACFDParametersList`](RACFDParametersList.md#generated.RACFDParametersList) - * [`RACFDParametersList.Clear()`](RACFDParametersList.md#generated.RACFDParametersList.Clear) - * [`RACFDParametersList.GetParametersFor()`](RACFDParametersList.md#generated.RACFDParametersList.GetParametersFor) - * [`RACFDParametersList.New()`](RACFDParametersList.md#generated.RACFDParametersList.New) - * [`RACFDParametersList.Remove()`](RACFDParametersList.md#generated.RACFDParametersList.Remove) -* [RACFDPerParticleParameters](RACFDPerParticleParameters.md) - * [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) - * [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) - * [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) - * [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) - * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) - * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) - * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) - * [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) - * [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) - * [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) - * [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) - * [`RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues) - * [`RACFDPerParticleParameters.GetValidDragLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidDragLawValues) - * [`RACFDPerParticleParameters.GetValidLiftLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidLiftLawValues) - * [`RACFDPerParticleParameters.GetValidTorqueLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidTorqueLawValues) - * [`RACFDPerParticleParameters.GetValidVirtualMassLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidVirtualMassLawValues) - * [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) - * [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) - * [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) - * [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) - * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) - * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) - * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) - * [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) - * [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) - * [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) - * [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) - * [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) -* [RACalculations](RACalculations.md) - * [`RACalculations`](RACalculations.md#generated.RACalculations) - * [`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) - * [`RACalculations.GetTagging()`](RACalculations.md#generated.RACalculations.GetTagging) - * [`RACalculations.GetTaggingNames()`](RACalculations.md#generated.RACalculations.GetTaggingNames) -* [RACircularSurface](RACircularSurface.md) - * [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface) - * [`RACircularSurface.AddCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCurve) - * [`RACircularSurface.AddCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCustomCurve) - * [`RACircularSurface.AddCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.AddCustomProperty) - * [`RACircularSurface.AddGridFunction()`](RACircularSurface.md#generated.RACircularSurface.AddGridFunction) - * [`RACircularSurface.CreateCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateCurveOutputVariable) - * [`RACircularSurface.CreateGridFunction()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunction) - * [`RACircularSurface.CreateGridFunctionArrayOnCells()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionArrayOnCells) - * [`RACircularSurface.CreateGridFunctionStatisticOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionStatisticOutputVariable) - * [`RACircularSurface.CreateTransientCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateTransientCurveOutputVariable) - * [`RACircularSurface.EditCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.EditCustomCurve) - * [`RACircularSurface.EditCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.EditCustomProperty) - * [`RACircularSurface.GetActivesArray()`](RACircularSurface.md#generated.RACircularSurface.GetActivesArray) - * [`RACircularSurface.GetBoundingBox()`](RACircularSurface.md#generated.RACircularSurface.GetBoundingBox) - * [`RACircularSurface.GetCellAreaAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellAreaAsArray) - * [`RACircularSurface.GetCellCenterAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellCenterAsArray) - * [`RACircularSurface.GetCellDzAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellDzAsArray) - * [`RACircularSurface.GetCellFromIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellFromIJK) - * [`RACircularSurface.GetCellIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellIJK) - * [`RACircularSurface.GetCellNumberOfVertices()`](RACircularSurface.md#generated.RACircularSurface.GetCellNumberOfVertices) - * [`RACircularSurface.GetCellPointsAsFunction()`](RACircularSurface.md#generated.RACircularSurface.GetCellPointsAsFunction) - * [`RACircularSurface.GetCellVolumeAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellVolumeAsArray) - * [`RACircularSurface.GetCenter()`](RACircularSurface.md#generated.RACircularSurface.GetCenter) - * [`RACircularSurface.GetCurve()`](RACircularSurface.md#generated.RACircularSurface.GetCurve) - * [`RACircularSurface.GetCurveNames()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNames) - * [`RACircularSurface.GetCurveNamesAssociation()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNamesAssociation) - * [`RACircularSurface.GetElementCurve()`](RACircularSurface.md#generated.RACircularSurface.GetElementCurve) - * [`RACircularSurface.GetGeometryQuantity()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryQuantity) - * [`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.GetNumberOfCells()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfCells) - * [`RACircularSurface.GetNumberOfNodes()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfNodes) - * [`RACircularSurface.GetNumpyCurve()`](RACircularSurface.md#generated.RACircularSurface.GetNumpyCurve) - * [`RACircularSurface.GetOrientation()`](RACircularSurface.md#generated.RACircularSurface.GetOrientation) - * [`RACircularSurface.GetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngleAndVector) - * [`RACircularSurface.GetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngles) - * [`RACircularSurface.GetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromBasisVector) - * [`RACircularSurface.GetOutputVariableValue()`](RACircularSurface.md#generated.RACircularSurface.GetOutputVariableValue) - * [`RACircularSurface.GetTimeSet()`](RACircularSurface.md#generated.RACircularSurface.GetTimeSet) - * [`RACircularSurface.GetTimeStatistics()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStatistics) - * [`RACircularSurface.GetTimeStep()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStep) - * [`RACircularSurface.GetTopologyShape()`](RACircularSurface.md#generated.RACircularSurface.GetTopologyShape) - * [`RACircularSurface.HasGridFunction()`](RACircularSurface.md#generated.RACircularSurface.HasGridFunction) - * [`RACircularSurface.HasMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.HasMotionFrame) - * [`RACircularSurface.IsCellActive()`](RACircularSurface.md#generated.RACircularSurface.IsCellActive) - * [`RACircularSurface.IterCellVertices()`](RACircularSurface.md#generated.RACircularSurface.IterCellVertices) - * [`RACircularSurface.IterCells()`](RACircularSurface.md#generated.RACircularSurface.IterCells) - * [`RACircularSurface.Modified()`](RACircularSurface.md#generated.RACircularSurface.Modified) - * [`RACircularSurface.RemoveCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomCurve) - * [`RACircularSurface.RemoveCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomProperty) - * [`RACircularSurface.RemoveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.RemoveOutputVariable) - * [`RACircularSurface.RemoveProcess()`](RACircularSurface.md#generated.RACircularSurface.RemoveProcess) - * [`RACircularSurface.SetCenter()`](RACircularSurface.md#generated.RACircularSurface.SetCenter) - * [`RACircularSurface.SetCurrentTimeStep()`](RACircularSurface.md#generated.RACircularSurface.SetCurrentTimeStep) - * [`RACircularSurface.SetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMaxRadius) - * [`RACircularSurface.SetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMinRadius) - * [`RACircularSurface.SetOrientation()`](RACircularSurface.md#generated.RACircularSurface.SetOrientation) - * [`RACircularSurface.SetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngleAndVector) - * [`RACircularSurface.SetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngles) - * [`RACircularSurface.SetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromBasisVector) -* [RAConeCrusherFrame](RAConeCrusherFrame.md) - * [`RAConeCrusherFrame`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) - * [`RAConeCrusherFrame.GetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetInitialOrientation) - * [`RAConeCrusherFrame.GetMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetMotionFrame) - * [`RAConeCrusherFrame.GetParentMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetParentMotionFrame) - * [`RAConeCrusherFrame.GetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetPivotPoint) - * [`RAConeCrusherFrame.GetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationAxis) - * [`RAConeCrusherFrame.GetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationalVelocity) - * [`RAConeCrusherFrame.GetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStartTime) - * [`RAConeCrusherFrame.GetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStopTime) - * [`RAConeCrusherFrame.IterMotionFrames()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.IterMotionFrames) - * [`RAConeCrusherFrame.NewConeCrusherFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewConeCrusherFrame) - * [`RAConeCrusherFrame.NewFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewFrame) - * [`RAConeCrusherFrame.RemoveFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.RemoveFrame) - * [`RAConeCrusherFrame.SetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetInitialOrientation) - * [`RAConeCrusherFrame.SetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetPivotPoint) - * [`RAConeCrusherFrame.SetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationAxis) - * [`RAConeCrusherFrame.SetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationalVelocity) - * [`RAConeCrusherFrame.SetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStartTime) - * [`RAConeCrusherFrame.SetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStopTime) -* [RAConstantOneWayCoupling](RAConstantOneWayCoupling.md) - * [`RAConstantOneWayCoupling`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling) - * [`RAConstantOneWayCoupling.AddCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCurve) - * [`RAConstantOneWayCoupling.AddCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomCurve) - * [`RAConstantOneWayCoupling.AddCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomProperty) - * [`RAConstantOneWayCoupling.AddGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddGridFunction) - * [`RAConstantOneWayCoupling.CreateCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateCurveOutputVariable) - * [`RAConstantOneWayCoupling.CreateGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunction) - * [`RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells) - * [`RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable) - * [`RAConstantOneWayCoupling.CreateTransientCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateTransientCurveOutputVariable) - * [`RAConstantOneWayCoupling.DisableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.DisableTurbulentDispersion) - * [`RAConstantOneWayCoupling.EditCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomCurve) - * [`RAConstantOneWayCoupling.EditCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomProperty) - * [`RAConstantOneWayCoupling.EnableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EnableTurbulentDispersion) - * [`RAConstantOneWayCoupling.GetActivesArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetActivesArray) - * [`RAConstantOneWayCoupling.GetBoundingBox()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetBoundingBox) - * [`RAConstantOneWayCoupling.GetCFDParametersList()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCFDParametersList) - * [`RAConstantOneWayCoupling.GetCellAreaAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellAreaAsArray) - * [`RAConstantOneWayCoupling.GetCellCenterAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellCenterAsArray) - * [`RAConstantOneWayCoupling.GetCellDzAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellDzAsArray) - * [`RAConstantOneWayCoupling.GetCellFromIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellFromIJK) - * [`RAConstantOneWayCoupling.GetCellIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellIJK) - * [`RAConstantOneWayCoupling.GetCellNumberOfVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellNumberOfVertices) - * [`RAConstantOneWayCoupling.GetCellPointsAsFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellPointsAsFunction) - * [`RAConstantOneWayCoupling.GetCellVolumeAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellVolumeAsArray) - * [`RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw) - * [`RAConstantOneWayCoupling.GetCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurve) - * [`RAConstantOneWayCoupling.GetCurveNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNames) - * [`RAConstantOneWayCoupling.GetCurveNamesAssociation()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNamesAssociation) - * [`RAConstantOneWayCoupling.GetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDensity) - * [`RAConstantOneWayCoupling.GetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDragLaw) - * [`RAConstantOneWayCoupling.GetElementCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetElementCurve) - * [`RAConstantOneWayCoupling.GetGeometryQuantity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryQuantity) - * [`RAConstantOneWayCoupling.GetGeometryUnit()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryUnit) - * [`RAConstantOneWayCoupling.GetGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunction) - * [`RAConstantOneWayCoupling.GetGridFunctionNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunctionNames) - * [`RAConstantOneWayCoupling.GetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetLiftLaw) - * [`RAConstantOneWayCoupling.GetMeshColoring()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMeshColoring) - * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK1) - * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK2) - * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK3) - * [`RAConstantOneWayCoupling.GetNumberOfCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfCells) - * [`RAConstantOneWayCoupling.GetNumberOfNodes()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfNodes) - * [`RAConstantOneWayCoupling.GetNumpyCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumpyCurve) - * [`RAConstantOneWayCoupling.GetOutputVariableValue()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetOutputVariableValue) - * [`RAConstantOneWayCoupling.GetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSpecificHeat) - * [`RAConstantOneWayCoupling.GetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetStartTime) - * [`RAConstantOneWayCoupling.GetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienC1) - * [`RAConstantOneWayCoupling.GetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienD1) - * [`RAConstantOneWayCoupling.GetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTemperature) - * [`RAConstantOneWayCoupling.GetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetThermalConductivity) - * [`RAConstantOneWayCoupling.GetTimeSet()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeSet) - * [`RAConstantOneWayCoupling.GetTimeStatistics()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStatistics) - * [`RAConstantOneWayCoupling.GetTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStep) - * [`RAConstantOneWayCoupling.GetTopologyShape()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTopologyShape) - * [`RAConstantOneWayCoupling.GetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTorqueLaw) - * [`RAConstantOneWayCoupling.GetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentDissipationRate) - * [`RAConstantOneWayCoupling.GetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentKineticEnergy) - * [`RAConstantOneWayCoupling.GetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion) - * [`RAConstantOneWayCoupling.GetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants) - * [`RAConstantOneWayCoupling.GetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVelocity) - * [`RAConstantOneWayCoupling.GetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVirtualMassLaw) - * [`RAConstantOneWayCoupling.GetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetViscosity) - * [`RAConstantOneWayCoupling.HasGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.HasGridFunction) - * [`RAConstantOneWayCoupling.IsCellActive()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsCellActive) - * [`RAConstantOneWayCoupling.IsTurbulentDispersionEnabled()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsTurbulentDispersionEnabled) - * [`RAConstantOneWayCoupling.IterCellVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCellVertices) - * [`RAConstantOneWayCoupling.IterCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCells) - * [`RAConstantOneWayCoupling.Modified()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.Modified) - * [`RAConstantOneWayCoupling.RemoveCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomCurve) - * [`RAConstantOneWayCoupling.RemoveCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomProperty) - * [`RAConstantOneWayCoupling.RemoveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveOutputVariable) - * [`RAConstantOneWayCoupling.RemoveProcess()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveProcess) - * [`RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw) - * [`RAConstantOneWayCoupling.SetCurrentTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetCurrentTimeStep) - * [`RAConstantOneWayCoupling.SetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDensity) - * [`RAConstantOneWayCoupling.SetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDragLaw) - * [`RAConstantOneWayCoupling.SetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetLiftLaw) - * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK1) - * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK2) - * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK3) - * [`RAConstantOneWayCoupling.SetPartIdIfValid()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetPartIdIfValid) - * [`RAConstantOneWayCoupling.SetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSpecificHeat) - * [`RAConstantOneWayCoupling.SetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetStartTime) - * [`RAConstantOneWayCoupling.SetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienC1) - * [`RAConstantOneWayCoupling.SetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienD1) - * [`RAConstantOneWayCoupling.SetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTemperature) - * [`RAConstantOneWayCoupling.SetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetThermalConductivity) - * [`RAConstantOneWayCoupling.SetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTorqueLaw) - * [`RAConstantOneWayCoupling.SetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentDissipationRate) - * [`RAConstantOneWayCoupling.SetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentKineticEnergy) - * [`RAConstantOneWayCoupling.SetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseTurbulentDispersion) - * [`RAConstantOneWayCoupling.SetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseUserDefinedConstants) - * [`RAConstantOneWayCoupling.SetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVelocity) - * [`RAConstantOneWayCoupling.SetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVirtualMassLaw) - * [`RAConstantOneWayCoupling.SetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetViscosity) -* [RAContactData](RAContactData.md) - * [`RAContactData`](RAContactData.md#generated.RAContactData) - * [`RAContactData.AddCurve()`](RAContactData.md#generated.RAContactData.AddCurve) - * [`RAContactData.AddCustomCurve()`](RAContactData.md#generated.RAContactData.AddCustomCurve) - * [`RAContactData.AddCustomProperty()`](RAContactData.md#generated.RAContactData.AddCustomProperty) - * [`RAContactData.AddGridFunction()`](RAContactData.md#generated.RAContactData.AddGridFunction) - * [`RAContactData.CreateCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateCurveOutputVariable) - * [`RAContactData.CreateGridFunction()`](RAContactData.md#generated.RAContactData.CreateGridFunction) - * [`RAContactData.CreateGridFunctionArrayOnCells()`](RAContactData.md#generated.RAContactData.CreateGridFunctionArrayOnCells) - * [`RAContactData.CreateGridFunctionStatisticOutputVariable()`](RAContactData.md#generated.RAContactData.CreateGridFunctionStatisticOutputVariable) - * [`RAContactData.CreateTransientCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateTransientCurveOutputVariable) - * [`RAContactData.DisableCollectContactsData()`](RAContactData.md#generated.RAContactData.DisableCollectContactsData) - * [`RAContactData.DisableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.DisableIncludeAdhesiveContacts) - * [`RAContactData.EditCustomCurve()`](RAContactData.md#generated.RAContactData.EditCustomCurve) - * [`RAContactData.EditCustomProperty()`](RAContactData.md#generated.RAContactData.EditCustomProperty) - * [`RAContactData.EnableCollectContactsData()`](RAContactData.md#generated.RAContactData.EnableCollectContactsData) - * [`RAContactData.EnableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.EnableIncludeAdhesiveContacts) - * [`RAContactData.GetActivesArray()`](RAContactData.md#generated.RAContactData.GetActivesArray) - * [`RAContactData.GetBoundingBox()`](RAContactData.md#generated.RAContactData.GetBoundingBox) - * [`RAContactData.GetCellAreaAsArray()`](RAContactData.md#generated.RAContactData.GetCellAreaAsArray) - * [`RAContactData.GetCellCenterAsArray()`](RAContactData.md#generated.RAContactData.GetCellCenterAsArray) - * [`RAContactData.GetCellDzAsArray()`](RAContactData.md#generated.RAContactData.GetCellDzAsArray) - * [`RAContactData.GetCellFromIJK()`](RAContactData.md#generated.RAContactData.GetCellFromIJK) - * [`RAContactData.GetCellIJK()`](RAContactData.md#generated.RAContactData.GetCellIJK) - * [`RAContactData.GetCellNumberOfVertices()`](RAContactData.md#generated.RAContactData.GetCellNumberOfVertices) - * [`RAContactData.GetCellPointsAsFunction()`](RAContactData.md#generated.RAContactData.GetCellPointsAsFunction) - * [`RAContactData.GetCellVolumeAsArray()`](RAContactData.md#generated.RAContactData.GetCellVolumeAsArray) - * [`RAContactData.GetCollectContactsData()`](RAContactData.md#generated.RAContactData.GetCollectContactsData) - * [`RAContactData.GetCurve()`](RAContactData.md#generated.RAContactData.GetCurve) - * [`RAContactData.GetCurveNames()`](RAContactData.md#generated.RAContactData.GetCurveNames) - * [`RAContactData.GetCurveNamesAssociation()`](RAContactData.md#generated.RAContactData.GetCurveNamesAssociation) - * [`RAContactData.GetElementCurve()`](RAContactData.md#generated.RAContactData.GetElementCurve) - * [`RAContactData.GetGeometryQuantity()`](RAContactData.md#generated.RAContactData.GetGeometryQuantity) - * [`RAContactData.GetGeometryUnit()`](RAContactData.md#generated.RAContactData.GetGeometryUnit) - * [`RAContactData.GetGridFunction()`](RAContactData.md#generated.RAContactData.GetGridFunction) - * [`RAContactData.GetGridFunctionNames()`](RAContactData.md#generated.RAContactData.GetGridFunctionNames) - * [`RAContactData.GetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.GetIncludeAdhesiveContacts) - * [`RAContactData.GetMeshColoring()`](RAContactData.md#generated.RAContactData.GetMeshColoring) - * [`RAContactData.GetNumberOfCells()`](RAContactData.md#generated.RAContactData.GetNumberOfCells) - * [`RAContactData.GetNumberOfNodes()`](RAContactData.md#generated.RAContactData.GetNumberOfNodes) - * [`RAContactData.GetNumpyCurve()`](RAContactData.md#generated.RAContactData.GetNumpyCurve) - * [`RAContactData.GetOutputVariableValue()`](RAContactData.md#generated.RAContactData.GetOutputVariableValue) - * [`RAContactData.GetTimeSet()`](RAContactData.md#generated.RAContactData.GetTimeSet) - * [`RAContactData.GetTimeStatistics()`](RAContactData.md#generated.RAContactData.GetTimeStatistics) - * [`RAContactData.GetTimeStep()`](RAContactData.md#generated.RAContactData.GetTimeStep) - * [`RAContactData.GetTopologyShape()`](RAContactData.md#generated.RAContactData.GetTopologyShape) - * [`RAContactData.HasGridFunction()`](RAContactData.md#generated.RAContactData.HasGridFunction) - * [`RAContactData.IsCellActive()`](RAContactData.md#generated.RAContactData.IsCellActive) - * [`RAContactData.IsCollectContactsDataEnabled()`](RAContactData.md#generated.RAContactData.IsCollectContactsDataEnabled) - * [`RAContactData.IsIncludeAdhesiveContactsEnabled()`](RAContactData.md#generated.RAContactData.IsIncludeAdhesiveContactsEnabled) - * [`RAContactData.IterCellVertices()`](RAContactData.md#generated.RAContactData.IterCellVertices) - * [`RAContactData.IterCells()`](RAContactData.md#generated.RAContactData.IterCells) - * [`RAContactData.Modified()`](RAContactData.md#generated.RAContactData.Modified) - * [`RAContactData.RemoveCustomCurve()`](RAContactData.md#generated.RAContactData.RemoveCustomCurve) - * [`RAContactData.RemoveCustomProperty()`](RAContactData.md#generated.RAContactData.RemoveCustomProperty) - * [`RAContactData.RemoveOutputVariable()`](RAContactData.md#generated.RAContactData.RemoveOutputVariable) - * [`RAContactData.RemoveProcess()`](RAContactData.md#generated.RAContactData.RemoveProcess) - * [`RAContactData.SetCollectContactsData()`](RAContactData.md#generated.RAContactData.SetCollectContactsData) - * [`RAContactData.SetCurrentTimeStep()`](RAContactData.md#generated.RAContactData.SetCurrentTimeStep) - * [`RAContactData.SetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.SetIncludeAdhesiveContacts) -* [RAContactToParticleProcess](RAContactToParticleProcess.md) - * [`RAContactToParticleProcess`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess) - * [`RAContactToParticleProcess.AddCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCurve) - * [`RAContactToParticleProcess.AddCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomCurve) - * [`RAContactToParticleProcess.AddCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomProperty) - * [`RAContactToParticleProcess.AddGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddGridFunction) - * [`RAContactToParticleProcess.CreateCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateCurveOutputVariable) - * [`RAContactToParticleProcess.CreateGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunction) - * [`RAContactToParticleProcess.CreateGridFunctionArrayOnCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionArrayOnCells) - * [`RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAContactToParticleProcess.CreateTransientCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateTransientCurveOutputVariable) - * [`RAContactToParticleProcess.EditCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomCurve) - * [`RAContactToParticleProcess.EditCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomProperty) - * [`RAContactToParticleProcess.GetActivesArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetActivesArray) - * [`RAContactToParticleProcess.GetBoundingBox()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetBoundingBox) - * [`RAContactToParticleProcess.GetCellAreaAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellAreaAsArray) - * [`RAContactToParticleProcess.GetCellCenterAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellCenterAsArray) - * [`RAContactToParticleProcess.GetCellDzAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellDzAsArray) - * [`RAContactToParticleProcess.GetCellFromIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellFromIJK) - * [`RAContactToParticleProcess.GetCellIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellIJK) - * [`RAContactToParticleProcess.GetCellNumberOfVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellNumberOfVertices) - * [`RAContactToParticleProcess.GetCellPointsAsFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellPointsAsFunction) - * [`RAContactToParticleProcess.GetCellVolumeAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellVolumeAsArray) - * [`RAContactToParticleProcess.GetCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurve) - * [`RAContactToParticleProcess.GetCurveNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNames) - * [`RAContactToParticleProcess.GetCurveNamesAssociation()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNamesAssociation) - * [`RAContactToParticleProcess.GetElementCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetElementCurve) - * [`RAContactToParticleProcess.GetGeometryQuantity()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryQuantity) - * [`RAContactToParticleProcess.GetGeometryUnit()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryUnit) - * [`RAContactToParticleProcess.GetGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunction) - * [`RAContactToParticleProcess.GetGridFunctionNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunctionNames) - * [`RAContactToParticleProcess.GetMeshColoring()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetMeshColoring) - * [`RAContactToParticleProcess.GetNumberOfCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfCells) - * [`RAContactToParticleProcess.GetNumberOfNodes()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfNodes) - * [`RAContactToParticleProcess.GetNumberOfParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfParticles) - * [`RAContactToParticleProcess.GetNumpyCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumpyCurve) - * [`RAContactToParticleProcess.GetOutputVariableValue()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetOutputVariableValue) - * [`RAContactToParticleProcess.GetTimeSet()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeSet) - * [`RAContactToParticleProcess.GetTimeStatistics()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStatistics) - * [`RAContactToParticleProcess.GetTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStep) - * [`RAContactToParticleProcess.GetTopologyShape()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTopologyShape) - * [`RAContactToParticleProcess.HasGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.HasGridFunction) - * [`RAContactToParticleProcess.IsCellActive()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IsCellActive) - * [`RAContactToParticleProcess.IterCellVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCellVertices) - * [`RAContactToParticleProcess.IterCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCells) - * [`RAContactToParticleProcess.IterParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterParticles) - * [`RAContactToParticleProcess.Modified()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.Modified) - * [`RAContactToParticleProcess.RemoveCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomCurve) - * [`RAContactToParticleProcess.RemoveCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomProperty) - * [`RAContactToParticleProcess.RemoveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveOutputVariable) - * [`RAContactToParticleProcess.RemoveProcess()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveProcess) - * [`RAContactToParticleProcess.SetCurrentTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.SetCurrentTimeStep) -* [RAContactsDataMeshColoring](RAContactsDataMeshColoring.md) - * [`RAContactsDataMeshColoring`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring) - * [`RAContactsDataMeshColoring.GetAvailableGridFunctions()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctions) - * [`RAContactsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctionsNames) - * [`RAContactsDataMeshColoring.GetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsColor) - * [`RAContactsDataMeshColoring.GetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkColor) - * [`RAContactsDataMeshColoring.GetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkLineWidth) - * [`RAContactsDataMeshColoring.GetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkProperty) - * [`RAContactsDataMeshColoring.GetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkVisible) - * [`RAContactsDataMeshColoring.GetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsPointSize) - * [`RAContactsDataMeshColoring.GetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsProperty) - * [`RAContactsDataMeshColoring.GetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsVisible) - * [`RAContactsDataMeshColoring.GetValidColoringModes()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetValidColoringModes) - * [`RAContactsDataMeshColoring.SetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsColor) - * [`RAContactsDataMeshColoring.SetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkColor) - * [`RAContactsDataMeshColoring.SetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkLineWidth) - * [`RAContactsDataMeshColoring.SetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkProperty) - * [`RAContactsDataMeshColoring.SetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkVisible) - * [`RAContactsDataMeshColoring.SetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsPointSize) - * [`RAContactsDataMeshColoring.SetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsProperty) - * [`RAContactsDataMeshColoring.SetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsVisible) -* [RACoupledWall](RACoupledWall.md) - * [`RACoupledWall`](RACoupledWall.md#generated.RACoupledWall) - * [`RACoupledWall.AddCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCurve) - * [`RACoupledWall.AddCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCustomCurve) - * [`RACoupledWall.AddCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.AddCustomProperty) - * [`RACoupledWall.AddGridFunction()`](RACoupledWall.md#generated.RACoupledWall.AddGridFunction) - * [`RACoupledWall.CreateCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateCurveOutputVariable) - * [`RACoupledWall.CreateGridFunction()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunction) - * [`RACoupledWall.CreateGridFunctionArrayOnCells()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionArrayOnCells) - * [`RACoupledWall.CreateGridFunctionStatisticOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionStatisticOutputVariable) - * [`RACoupledWall.CreateTransientCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateTransientCurveOutputVariable) - * [`RACoupledWall.EditCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.EditCustomCurve) - * [`RACoupledWall.EditCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.EditCustomProperty) - * [`RACoupledWall.GetActivesArray()`](RACoupledWall.md#generated.RACoupledWall.GetActivesArray) - * [`RACoupledWall.GetAvailableMaterials()`](RACoupledWall.md#generated.RACoupledWall.GetAvailableMaterials) - * [`RACoupledWall.GetBoundingBox()`](RACoupledWall.md#generated.RACoupledWall.GetBoundingBox) - * [`RACoupledWall.GetCellAreaAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellAreaAsArray) - * [`RACoupledWall.GetCellCenterAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellCenterAsArray) - * [`RACoupledWall.GetCellDzAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellDzAsArray) - * [`RACoupledWall.GetCellFromIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellFromIJK) - * [`RACoupledWall.GetCellIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellIJK) - * [`RACoupledWall.GetCellNumberOfVertices()`](RACoupledWall.md#generated.RACoupledWall.GetCellNumberOfVertices) - * [`RACoupledWall.GetCellPointsAsFunction()`](RACoupledWall.md#generated.RACoupledWall.GetCellPointsAsFunction) - * [`RACoupledWall.GetCellVolumeAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellVolumeAsArray) - * [`RACoupledWall.GetCurve()`](RACoupledWall.md#generated.RACoupledWall.GetCurve) - * [`RACoupledWall.GetCurveNames()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNames) - * [`RACoupledWall.GetCurveNamesAssociation()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNamesAssociation) - * [`RACoupledWall.GetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.GetDisableTime) - * [`RACoupledWall.GetElementCurve()`](RACoupledWall.md#generated.RACoupledWall.GetElementCurve) - * [`RACoupledWall.GetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.GetEnableTime) - * [`RACoupledWall.GetGeometryQuantity()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryQuantity) - * [`RACoupledWall.GetGeometryUnit()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryUnit) - * [`RACoupledWall.GetGridFunction()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunction) - * [`RACoupledWall.GetGridFunctionNames()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunctionNames) - * [`RACoupledWall.GetMaterial()`](RACoupledWall.md#generated.RACoupledWall.GetMaterial) - * [`RACoupledWall.GetMeshColoring()`](RACoupledWall.md#generated.RACoupledWall.GetMeshColoring) - * [`RACoupledWall.GetModuleProperties()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperties) - * [`RACoupledWall.GetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperty) - * [`RACoupledWall.GetNumberOfCells()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfCells) - * [`RACoupledWall.GetNumberOfNodes()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfNodes) - * [`RACoupledWall.GetNumpyCurve()`](RACoupledWall.md#generated.RACoupledWall.GetNumpyCurve) - * [`RACoupledWall.GetOutputVariableValue()`](RACoupledWall.md#generated.RACoupledWall.GetOutputVariableValue) - * [`RACoupledWall.GetTimeSet()`](RACoupledWall.md#generated.RACoupledWall.GetTimeSet) - * [`RACoupledWall.GetTimeStatistics()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStatistics) - * [`RACoupledWall.GetTimeStep()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStep) - * [`RACoupledWall.GetTopologyShape()`](RACoupledWall.md#generated.RACoupledWall.GetTopologyShape) - * [`RACoupledWall.GetValidOptionsForModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetValidOptionsForModuleProperty) - * [`RACoupledWall.HasGridFunction()`](RACoupledWall.md#generated.RACoupledWall.HasGridFunction) - * [`RACoupledWall.HasMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.HasMotionFrame) - * [`RACoupledWall.IsCellActive()`](RACoupledWall.md#generated.RACoupledWall.IsCellActive) - * [`RACoupledWall.IterCellVertices()`](RACoupledWall.md#generated.RACoupledWall.IterCellVertices) - * [`RACoupledWall.IterCells()`](RACoupledWall.md#generated.RACoupledWall.IterCells) - * [`RACoupledWall.Modified()`](RACoupledWall.md#generated.RACoupledWall.Modified) - * [`RACoupledWall.RemoveCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomCurve) - * [`RACoupledWall.RemoveCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomProperty) - * [`RACoupledWall.RemoveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.RemoveOutputVariable) - * [`RACoupledWall.RemoveProcess()`](RACoupledWall.md#generated.RACoupledWall.RemoveProcess) - * [`RACoupledWall.SetCurrentTimeStep()`](RACoupledWall.md#generated.RACoupledWall.SetCurrentTimeStep) - * [`RACoupledWall.SetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.SetDisableTime) - * [`RACoupledWall.SetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.SetEnableTime) - * [`RACoupledWall.SetMaterial()`](RACoupledWall.md#generated.RACoupledWall.SetMaterial) - * [`RACoupledWall.SetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.SetModuleProperty) -* [RACubeGroup](RACubeGroup.md) - * [`RACubeGroup`](RACubeGroup.md#generated.RACubeGroup) - * [`RACubeGroup.AddCurve()`](RACubeGroup.md#generated.RACubeGroup.AddCurve) - * [`RACubeGroup.GetCenter()`](RACubeGroup.md#generated.RACubeGroup.GetCenter) - * [`RACubeGroup.GetCenterAfterMovement()`](RACubeGroup.md#generated.RACubeGroup.GetCenterAfterMovement) - * [`RACubeGroup.GetCurve()`](RACubeGroup.md#generated.RACubeGroup.GetCurve) - * [`RACubeGroup.GetCurveNames()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNames) - * [`RACubeGroup.GetCurveNamesAssociation()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNamesAssociation) - * [`RACubeGroup.GetElementCurve()`](RACubeGroup.md#generated.RACubeGroup.GetElementCurve) - * [`RACubeGroup.GetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.GetMotionFrame) - * [`RACubeGroup.GetNumpyCurve()`](RACubeGroup.md#generated.RACubeGroup.GetNumpyCurve) - * [`RACubeGroup.GetOrientation()`](RACubeGroup.md#generated.RACubeGroup.GetOrientation) - * [`RACubeGroup.GetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngleAndVector) - * [`RACubeGroup.GetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngles) - * [`RACubeGroup.GetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromBasisVector) - * [`RACubeGroup.GetRotation()`](RACubeGroup.md#generated.RACubeGroup.GetRotation) - * [`RACubeGroup.GetSize()`](RACubeGroup.md#generated.RACubeGroup.GetSize) - * [`RACubeGroup.SetCenter()`](RACubeGroup.md#generated.RACubeGroup.SetCenter) - * [`RACubeGroup.SetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.SetMotionFrame) - * [`RACubeGroup.SetOrientation()`](RACubeGroup.md#generated.RACubeGroup.SetOrientation) - * [`RACubeGroup.SetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngleAndVector) - * [`RACubeGroup.SetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngles) - * [`RACubeGroup.SetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromBasisVector) - * [`RACubeGroup.SetRotation()`](RACubeGroup.md#generated.RACubeGroup.SetRotation) - * [`RACubeGroup.SetSize()`](RACubeGroup.md#generated.RACubeGroup.SetSize) -* [RACubeProcess](RACubeProcess.md) - * [`RACubeProcess`](RACubeProcess.md#generated.RACubeProcess) - * [`RACubeProcess.AddCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCurve) - * [`RACubeProcess.AddCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCustomCurve) - * [`RACubeProcess.AddCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.AddCustomProperty) - * [`RACubeProcess.AddGridFunction()`](RACubeProcess.md#generated.RACubeProcess.AddGridFunction) - * [`RACubeProcess.CreateCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateCurveOutputVariable) - * [`RACubeProcess.CreateGridFunction()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunction) - * [`RACubeProcess.CreateGridFunctionArrayOnCells()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionArrayOnCells) - * [`RACubeProcess.CreateGridFunctionStatisticOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionStatisticOutputVariable) - * [`RACubeProcess.CreateTransientCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateTransientCurveOutputVariable) - * [`RACubeProcess.EditCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.EditCustomCurve) - * [`RACubeProcess.EditCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.EditCustomProperty) - * [`RACubeProcess.GetActivesArray()`](RACubeProcess.md#generated.RACubeProcess.GetActivesArray) - * [`RACubeProcess.GetBoundingBox()`](RACubeProcess.md#generated.RACubeProcess.GetBoundingBox) - * [`RACubeProcess.GetCellAreaAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellAreaAsArray) - * [`RACubeProcess.GetCellCenterAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellCenterAsArray) - * [`RACubeProcess.GetCellDzAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellDzAsArray) - * [`RACubeProcess.GetCellFromIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellFromIJK) - * [`RACubeProcess.GetCellIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellIJK) - * [`RACubeProcess.GetCellNumberOfVertices()`](RACubeProcess.md#generated.RACubeProcess.GetCellNumberOfVertices) - * [`RACubeProcess.GetCellPointsAsFunction()`](RACubeProcess.md#generated.RACubeProcess.GetCellPointsAsFunction) - * [`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.GetGeometryQuantity()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryQuantity) - * [`RACubeProcess.GetGeometryUnit()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryUnit) - * [`RACubeProcess.GetGridFunction()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunction) - * [`RACubeProcess.GetGridFunctionNames()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunctionNames) - * [`RACubeProcess.GetMeshColoring()`](RACubeProcess.md#generated.RACubeProcess.GetMeshColoring) - * [`RACubeProcess.GetMotionFrame()`](RACubeProcess.md#generated.RACubeProcess.GetMotionFrame) - * [`RACubeProcess.GetNumberOfCells()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfCells) - * [`RACubeProcess.GetNumberOfNodes()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfNodes) - * [`RACubeProcess.GetNumberOfParticles()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfParticles) - * [`RACubeProcess.GetNumpyCurve()`](RACubeProcess.md#generated.RACubeProcess.GetNumpyCurve) - * [`RACubeProcess.GetOrientation()`](RACubeProcess.md#generated.RACubeProcess.GetOrientation) - * [`RACubeProcess.GetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngleAndVector) - * [`RACubeProcess.GetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngles) - * [`RACubeProcess.GetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromBasisVector) - * [`RACubeProcess.GetOutputVariableValue()`](RACubeProcess.md#generated.RACubeProcess.GetOutputVariableValue) - * [`RACubeProcess.GetRotation()`](RACubeProcess.md#generated.RACubeProcess.GetRotation) - * [`RACubeProcess.GetSize()`](RACubeProcess.md#generated.RACubeProcess.GetSize) - * [`RACubeProcess.GetTimeSet()`](RACubeProcess.md#generated.RACubeProcess.GetTimeSet) - * [`RACubeProcess.GetTimeStatistics()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStatistics) - * [`RACubeProcess.GetTimeStep()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStep) - * [`RACubeProcess.GetTopologyShape()`](RACubeProcess.md#generated.RACubeProcess.GetTopologyShape) - * [`RACubeProcess.HasGridFunction()`](RACubeProcess.md#generated.RACubeProcess.HasGridFunction) - * [`RACubeProcess.IsCellActive()`](RACubeProcess.md#generated.RACubeProcess.IsCellActive) - * [`RACubeProcess.IterCellVertices()`](RACubeProcess.md#generated.RACubeProcess.IterCellVertices) - * [`RACubeProcess.IterCells()`](RACubeProcess.md#generated.RACubeProcess.IterCells) - * [`RACubeProcess.IterParticles()`](RACubeProcess.md#generated.RACubeProcess.IterParticles) - * [`RACubeProcess.Modified()`](RACubeProcess.md#generated.RACubeProcess.Modified) - * [`RACubeProcess.RemoveCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomCurve) - * [`RACubeProcess.RemoveCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomProperty) - * [`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) - * [`RACubeProcess.SetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngleAndVector) - * [`RACubeProcess.SetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngles) - * [`RACubeProcess.SetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromBasisVector) - * [`RACubeProcess.SetRotation()`](RACubeProcess.md#generated.RACubeProcess.SetRotation) - * [`RACubeProcess.SetSize()`](RACubeProcess.md#generated.RACubeProcess.SetSize) -* [RACustomInput](RACustomInput.md) - * [`RACustomInput`](RACustomInput.md#generated.RACustomInput) - * [`RACustomInput.GetAvailableMotionFrames()`](RACustomInput.md#generated.RACustomInput.GetAvailableMotionFrames) - * [`RACustomInput.GetAvailableParticles()`](RACustomInput.md#generated.RACustomInput.GetAvailableParticles) - * [`RACustomInput.GetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.GetDefaultTemperature) - * [`RACustomInput.GetFilePath()`](RACustomInput.md#generated.RACustomInput.GetFilePath) - * [`RACustomInput.GetModuleProperties()`](RACustomInput.md#generated.RACustomInput.GetModuleProperties) - * [`RACustomInput.GetModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetModuleProperty) - * [`RACustomInput.GetMotionFrame()`](RACustomInput.md#generated.RACustomInput.GetMotionFrame) - * [`RACustomInput.GetParticle()`](RACustomInput.md#generated.RACustomInput.GetParticle) - * [`RACustomInput.GetValidOptionsForModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetValidOptionsForModuleProperty) - * [`RACustomInput.SetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.SetDefaultTemperature) - * [`RACustomInput.SetFilePath()`](RACustomInput.md#generated.RACustomInput.SetFilePath) - * [`RACustomInput.SetModuleProperty()`](RACustomInput.md#generated.RACustomInput.SetModuleProperty) - * [`RACustomInput.SetMotionFrame()`](RACustomInput.md#generated.RACustomInput.SetMotionFrame) - * [`RACustomInput.SetParticle()`](RACustomInput.md#generated.RACustomInput.SetParticle) -* [RACylinderGroup](RACylinderGroup.md) - * [`RACylinderGroup`](RACylinderGroup.md#generated.RACylinderGroup) - * [`RACylinderGroup.AddCurve()`](RACylinderGroup.md#generated.RACylinderGroup.AddCurve) - * [`RACylinderGroup.GetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenter) - * [`RACylinderGroup.GetCenterAfterMovement()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenterAfterMovement) - * [`RACylinderGroup.GetCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurve) - * [`RACylinderGroup.GetCurveNames()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNames) - * [`RACylinderGroup.GetCurveNamesAssociation()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNamesAssociation) - * [`RACylinderGroup.GetElementCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetElementCurve) - * [`RACylinderGroup.GetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetFinalAngle) - * [`RACylinderGroup.GetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetInitialAngle) - * [`RACylinderGroup.GetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.GetInternalFactor) - * [`RACylinderGroup.GetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.GetMotionFrame) - * [`RACylinderGroup.GetNumpyCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetNumpyCurve) - * [`RACylinderGroup.GetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientation) - * [`RACylinderGroup.GetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngleAndVector) - * [`RACylinderGroup.GetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngles) - * [`RACylinderGroup.GetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromBasisVector) - * [`RACylinderGroup.GetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.GetRotation) - * [`RACylinderGroup.GetSize()`](RACylinderGroup.md#generated.RACylinderGroup.GetSize) - * [`RACylinderGroup.SetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.SetCenter) - * [`RACylinderGroup.SetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetFinalAngle) - * [`RACylinderGroup.SetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetInitialAngle) - * [`RACylinderGroup.SetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.SetInternalFactor) - * [`RACylinderGroup.SetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.SetMotionFrame) - * [`RACylinderGroup.SetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientation) - * [`RACylinderGroup.SetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngleAndVector) - * [`RACylinderGroup.SetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngles) - * [`RACylinderGroup.SetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromBasisVector) - * [`RACylinderGroup.SetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.SetRotation) - * [`RACylinderGroup.SetSize()`](RACylinderGroup.md#generated.RACylinderGroup.SetSize) -* [RACylinderProcess](RACylinderProcess.md) - * [`RACylinderProcess`](RACylinderProcess.md#generated.RACylinderProcess) - * [`RACylinderProcess.AddCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCurve) - * [`RACylinderProcess.AddCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomCurve) - * [`RACylinderProcess.AddCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomProperty) - * [`RACylinderProcess.AddGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.AddGridFunction) - * [`RACylinderProcess.CreateCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateCurveOutputVariable) - * [`RACylinderProcess.CreateGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunction) - * [`RACylinderProcess.CreateGridFunctionArrayOnCells()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionArrayOnCells) - * [`RACylinderProcess.CreateGridFunctionStatisticOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionStatisticOutputVariable) - * [`RACylinderProcess.CreateTransientCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateTransientCurveOutputVariable) - * [`RACylinderProcess.EditCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomCurve) - * [`RACylinderProcess.EditCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomProperty) - * [`RACylinderProcess.GetActivesArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetActivesArray) - * [`RACylinderProcess.GetBoundingBox()`](RACylinderProcess.md#generated.RACylinderProcess.GetBoundingBox) - * [`RACylinderProcess.GetCellAreaAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellAreaAsArray) - * [`RACylinderProcess.GetCellCenterAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellCenterAsArray) - * [`RACylinderProcess.GetCellDzAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellDzAsArray) - * [`RACylinderProcess.GetCellFromIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellFromIJK) - * [`RACylinderProcess.GetCellIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellIJK) - * [`RACylinderProcess.GetCellNumberOfVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellNumberOfVertices) - * [`RACylinderProcess.GetCellPointsAsFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellPointsAsFunction) - * [`RACylinderProcess.GetCellVolumeAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellVolumeAsArray) - * [`RACylinderProcess.GetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenter) - * [`RACylinderProcess.GetCenterAfterMovement()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenterAfterMovement) - * [`RACylinderProcess.GetCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurve) - * [`RACylinderProcess.GetCurveNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNames) - * [`RACylinderProcess.GetCurveNamesAssociation()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNamesAssociation) - * [`RACylinderProcess.GetElementCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetElementCurve) - * [`RACylinderProcess.GetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetFinalAngle) - * [`RACylinderProcess.GetGeometryQuantity()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryQuantity) - * [`RACylinderProcess.GetGeometryUnit()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryUnit) - * [`RACylinderProcess.GetGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunction) - * [`RACylinderProcess.GetGridFunctionNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunctionNames) - * [`RACylinderProcess.GetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetInitialAngle) - * [`RACylinderProcess.GetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.GetInternalFactor) - * [`RACylinderProcess.GetMeshColoring()`](RACylinderProcess.md#generated.RACylinderProcess.GetMeshColoring) - * [`RACylinderProcess.GetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.GetMotionFrame) - * [`RACylinderProcess.GetNumberOfCells()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfCells) - * [`RACylinderProcess.GetNumberOfNodes()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfNodes) - * [`RACylinderProcess.GetNumberOfParticles()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfParticles) - * [`RACylinderProcess.GetNumpyCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumpyCurve) - * [`RACylinderProcess.GetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientation) - * [`RACylinderProcess.GetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngleAndVector) - * [`RACylinderProcess.GetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngles) - * [`RACylinderProcess.GetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromBasisVector) - * [`RACylinderProcess.GetOutputVariableValue()`](RACylinderProcess.md#generated.RACylinderProcess.GetOutputVariableValue) - * [`RACylinderProcess.GetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.GetRotation) - * [`RACylinderProcess.GetSize()`](RACylinderProcess.md#generated.RACylinderProcess.GetSize) - * [`RACylinderProcess.GetTimeSet()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeSet) - * [`RACylinderProcess.GetTimeStatistics()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStatistics) - * [`RACylinderProcess.GetTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStep) - * [`RACylinderProcess.GetTopologyShape()`](RACylinderProcess.md#generated.RACylinderProcess.GetTopologyShape) - * [`RACylinderProcess.HasGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.HasGridFunction) - * [`RACylinderProcess.IsCellActive()`](RACylinderProcess.md#generated.RACylinderProcess.IsCellActive) - * [`RACylinderProcess.IterCellVertices()`](RACylinderProcess.md#generated.RACylinderProcess.IterCellVertices) - * [`RACylinderProcess.IterCells()`](RACylinderProcess.md#generated.RACylinderProcess.IterCells) - * [`RACylinderProcess.IterParticles()`](RACylinderProcess.md#generated.RACylinderProcess.IterParticles) - * [`RACylinderProcess.Modified()`](RACylinderProcess.md#generated.RACylinderProcess.Modified) - * [`RACylinderProcess.RemoveCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomCurve) - * [`RACylinderProcess.RemoveCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomProperty) - * [`RACylinderProcess.RemoveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveOutputVariable) - * [`RACylinderProcess.RemoveProcess()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveProcess) - * [`RACylinderProcess.SetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.SetCenter) - * [`RACylinderProcess.SetCurrentTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.SetCurrentTimeStep) - * [`RACylinderProcess.SetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetFinalAngle) - * [`RACylinderProcess.SetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetInitialAngle) - * [`RACylinderProcess.SetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.SetInternalFactor) - * [`RACylinderProcess.SetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.SetMotionFrame) - * [`RACylinderProcess.SetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientation) - * [`RACylinderProcess.SetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngleAndVector) - * [`RACylinderProcess.SetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngles) - * [`RACylinderProcess.SetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromBasisVector) - * [`RACylinderProcess.SetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.SetRotation) - * [`RACylinderProcess.SetSize()`](RACylinderProcess.md#generated.RACylinderProcess.SetSize) -* [RADivisionsTagging](RADivisionsTagging.md) - * [`RADivisionsTagging`](RADivisionsTagging.md#generated.RADivisionsTagging) - * [`RADivisionsTagging.GetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsI) - * [`RADivisionsTagging.GetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsJ) - * [`RADivisionsTagging.GetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsK) - * [`RADivisionsTagging.GetGridFunctionName()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetGridFunctionName) - * [`RADivisionsTagging.GetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetNameMask) - * [`RADivisionsTagging.GetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagStride) - * [`RADivisionsTagging.GetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagValue) - * [`RADivisionsTagging.GetTimeRangeFilter()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTimeRangeFilter) - * [`RADivisionsTagging.SetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsI) - * [`RADivisionsTagging.SetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsJ) - * [`RADivisionsTagging.SetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsK) - * [`RADivisionsTagging.SetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetNameMask) - * [`RADivisionsTagging.SetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagStride) - * [`RADivisionsTagging.SetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagValue) -* [RADomainSettings](RADomainSettings.md) - * [`RADomainSettings`](RADomainSettings.md#generated.RADomainSettings) - * [`RADomainSettings.DisablePeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.DisablePeriodicAtGeometryLimits) - * [`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) - * [`RADomainSettings.GetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.GetCylindricalPeriodicDirections) - * [`RADomainSettings.GetDomainType()`](RADomainSettings.md#generated.RADomainSettings.GetDomainType) - * [`RADomainSettings.GetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.GetInitialAngle) - * [`RADomainSettings.GetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.GetNumberOfDivisions) - * [`RADomainSettings.GetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicAtGeometryLimits) - * [`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.SetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCartesianPeriodicDirections) - * [`RADomainSettings.SetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMaxValues) - * [`RADomainSettings.SetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMinValues) - * [`RADomainSettings.SetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCylindricalPeriodicDirections) - * [`RADomainSettings.SetDomainType()`](RADomainSettings.md#generated.RADomainSettings.SetDomainType) - * [`RADomainSettings.SetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.SetInitialAngle) - * [`RADomainSettings.SetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.SetNumberOfDivisions) - * [`RADomainSettings.SetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicAtGeometryLimits) - * [`RADomainSettings.SetPeriodicLimitsMaxCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMaxCoordinates) - * [`RADomainSettings.SetPeriodicLimitsMinCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMinCoordinates) - * [`RADomainSettings.SetUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetUseBoundaryLimits) -* [RAEulerianStatistics](RAEulerianStatistics.md) - * [`RAEulerianStatistics`](RAEulerianStatistics.md#generated.RAEulerianStatistics) - * [`RAEulerianStatistics.AddCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCurve) - * [`RAEulerianStatistics.AddCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomCurve) - * [`RAEulerianStatistics.AddCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomProperty) - * [`RAEulerianStatistics.AddGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddGridFunction) - * [`RAEulerianStatistics.CreateCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateCurveOutputVariable) - * [`RAEulerianStatistics.CreateEulerianGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateEulerianGridFunction) - * [`RAEulerianStatistics.CreateGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunction) - * [`RAEulerianStatistics.CreateGridFunctionArrayOnCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionArrayOnCells) - * [`RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable) - * [`RAEulerianStatistics.CreateTransientCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateTransientCurveOutputVariable) - * [`RAEulerianStatistics.EditCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomCurve) - * [`RAEulerianStatistics.EditCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomProperty) - * [`RAEulerianStatistics.GetActivesArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetActivesArray) - * [`RAEulerianStatistics.GetAvailableOperations()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetAvailableOperations) - * [`RAEulerianStatistics.GetBoundingBox()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetBoundingBox) - * [`RAEulerianStatistics.GetCellAreaAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellAreaAsArray) - * [`RAEulerianStatistics.GetCellCenterAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellCenterAsArray) - * [`RAEulerianStatistics.GetCellDzAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellDzAsArray) - * [`RAEulerianStatistics.GetCellFromIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellFromIJK) - * [`RAEulerianStatistics.GetCellIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellIJK) - * [`RAEulerianStatistics.GetCellNumberOfVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellNumberOfVertices) - * [`RAEulerianStatistics.GetCellPointsAsFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellPointsAsFunction) - * [`RAEulerianStatistics.GetCellVolumeAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellVolumeAsArray) - * [`RAEulerianStatistics.GetCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurve) - * [`RAEulerianStatistics.GetCurveNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNames) - * [`RAEulerianStatistics.GetCurveNamesAssociation()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNamesAssociation) - * [`RAEulerianStatistics.GetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetDivisions) - * [`RAEulerianStatistics.GetElementCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetElementCurve) - * [`RAEulerianStatistics.GetGeometryQuantity()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryQuantity) - * [`RAEulerianStatistics.GetGeometryUnit()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryUnit) - * [`RAEulerianStatistics.GetGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunction) - * [`RAEulerianStatistics.GetGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunctionNames) - * [`RAEulerianStatistics.GetMeshColoring()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetMeshColoring) - * [`RAEulerianStatistics.GetNumberOfCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfCells) - * [`RAEulerianStatistics.GetNumberOfNodes()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfNodes) - * [`RAEulerianStatistics.GetNumberOfParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfParticles) - * [`RAEulerianStatistics.GetNumpyCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumpyCurve) - * [`RAEulerianStatistics.GetOutputVariableValue()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetOutputVariableValue) - * [`RAEulerianStatistics.GetParticleGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetParticleGridFunctionNames) - * [`RAEulerianStatistics.GetTimeSet()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeSet) - * [`RAEulerianStatistics.GetTimeStatistics()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStatistics) - * [`RAEulerianStatistics.GetTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStep) - * [`RAEulerianStatistics.GetTopologyShape()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTopologyShape) - * [`RAEulerianStatistics.HasGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.HasGridFunction) - * [`RAEulerianStatistics.IsCellActive()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IsCellActive) - * [`RAEulerianStatistics.IterCellVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCellVertices) - * [`RAEulerianStatistics.IterCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCells) - * [`RAEulerianStatistics.IterParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterParticles) - * [`RAEulerianStatistics.Modified()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.Modified) - * [`RAEulerianStatistics.RemoveCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomCurve) - * [`RAEulerianStatistics.RemoveCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomProperty) - * [`RAEulerianStatistics.RemoveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveOutputVariable) - * [`RAEulerianStatistics.RemoveProcess()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveProcess) - * [`RAEulerianStatistics.SetCurrentTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetCurrentTimeStep) - * [`RAEulerianStatistics.SetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetDivisions) -* [RAExportToolkit](RAExportToolkit.md) - * [`RAExportToolkit`](RAExportToolkit.md#generated.RAExportToolkit) - * [`RAExportToolkit.ExportFEMForces()`](RAExportToolkit.md#generated.RAExportToolkit.ExportFEMForces) - * [`RAExportToolkit.ExportGeometryLoads()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoads) - * [`RAExportToolkit.ExportGeometryLoadsMultiTime()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoadsMultiTime) - * [`RAExportToolkit.ExportHTC()`](RAExportToolkit.md#generated.RAExportToolkit.ExportHTC) - * [`RAExportToolkit.ExportParticleToStl()`](RAExportToolkit.md#generated.RAExportToolkit.ExportParticleToStl) - * [`RAExportToolkit.ExportToSTL()`](RAExportToolkit.md#generated.RAExportToolkit.ExportToSTL) -* [RAFeedConveyor](RAFeedConveyor.md) - * [`RAFeedConveyor`](RAFeedConveyor.md#generated.RAFeedConveyor) - * [`RAFeedConveyor.AddCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCurve) - * [`RAFeedConveyor.AddCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomCurve) - * [`RAFeedConveyor.AddCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomProperty) - * [`RAFeedConveyor.AddGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddGridFunction) - * [`RAFeedConveyor.CreateCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateCurveOutputVariable) - * [`RAFeedConveyor.CreateGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunction) - * [`RAFeedConveyor.CreateGridFunctionArrayOnCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionArrayOnCells) - * [`RAFeedConveyor.CreateGridFunctionStatisticOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionStatisticOutputVariable) - * [`RAFeedConveyor.CreateTransientCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateTransientCurveOutputVariable) - * [`RAFeedConveyor.EditCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomCurve) - * [`RAFeedConveyor.EditCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomProperty) - * [`RAFeedConveyor.GetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAccelerationPeriod) - * [`RAFeedConveyor.GetActivesArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetActivesArray) - * [`RAFeedConveyor.GetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAlignmentAngle) - * [`RAFeedConveyor.GetAvailableMaterials()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAvailableMaterials) - * [`RAFeedConveyor.GetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStartTime) - * [`RAFeedConveyor.GetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStopTime) - * [`RAFeedConveyor.GetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltInclineAngle) - * [`RAFeedConveyor.GetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfile) - * [`RAFeedConveyor.GetBeltProfileName()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfileName) - * [`RAFeedConveyor.GetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltSpeed) - * [`RAFeedConveyor.GetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltThickness) - * [`RAFeedConveyor.GetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltWidth) - * [`RAFeedConveyor.GetBoundingBox()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBoundingBox) - * [`RAFeedConveyor.GetCellAreaAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellAreaAsArray) - * [`RAFeedConveyor.GetCellCenterAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellCenterAsArray) - * [`RAFeedConveyor.GetCellDzAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellDzAsArray) - * [`RAFeedConveyor.GetCellFromIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellFromIJK) - * [`RAFeedConveyor.GetCellIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellIJK) - * [`RAFeedConveyor.GetCellNumberOfVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellNumberOfVertices) - * [`RAFeedConveyor.GetCellPointsAsFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellPointsAsFunction) - * [`RAFeedConveyor.GetCellVolumeAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellVolumeAsArray) - * [`RAFeedConveyor.GetCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurve) - * [`RAFeedConveyor.GetCurveNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNames) - * [`RAFeedConveyor.GetCurveNamesAssociation()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNamesAssociation) - * [`RAFeedConveyor.GetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDecelerationPeriod) - * [`RAFeedConveyor.GetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDiameter) - * [`RAFeedConveyor.GetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxHeight) - * [`RAFeedConveyor.GetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxLength) - * [`RAFeedConveyor.GetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxWidth) - * [`RAFeedConveyor.GetElementCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetElementCurve) - * [`RAFeedConveyor.GetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceWidth) - * [`RAFeedConveyor.GetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFrontPlateOffset) - * [`RAFeedConveyor.GetGeometryQuantity()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryQuantity) - * [`RAFeedConveyor.GetGeometryUnit()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryUnit) - * [`RAFeedConveyor.GetGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunction) - * [`RAFeedConveyor.GetGridFunctionNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunctionNames) - * [`RAFeedConveyor.GetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHeightOffset) - * [`RAFeedConveyor.GetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHorizontalOffset) - * [`RAFeedConveyor.GetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLengthOffset) - * [`RAFeedConveyor.GetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLoadingLength) - * [`RAFeedConveyor.GetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMaterial) - * [`RAFeedConveyor.GetMeshColoring()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMeshColoring) - * [`RAFeedConveyor.GetModuleProperties()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperties) - * [`RAFeedConveyor.GetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperty) - * [`RAFeedConveyor.GetNumberOfCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfCells) - * [`RAFeedConveyor.GetNumberOfNodes()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfNodes) - * [`RAFeedConveyor.GetNumpyCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumpyCurve) - * [`RAFeedConveyor.GetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOffsetToIdlers) - * [`RAFeedConveyor.GetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutOfPlaneOffset) - * [`RAFeedConveyor.GetOutputVariableValue()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutputVariableValue) - * [`RAFeedConveyor.GetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetReturnBeltAngle) - * [`RAFeedConveyor.GetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardHeight) - * [`RAFeedConveyor.GetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardLength) - * [`RAFeedConveyor.GetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSphBoundaryType) - * [`RAFeedConveyor.GetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSurfaceTensionContactAngle) - * [`RAFeedConveyor.GetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTemperature) - * [`RAFeedConveyor.GetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetThermalBoundaryConditionType) - * [`RAFeedConveyor.GetTimeSet()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeSet) - * [`RAFeedConveyor.GetTimeStatistics()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStatistics) - * [`RAFeedConveyor.GetTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStep) - * [`RAFeedConveyor.GetTopologyShape()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTopologyShape) - * [`RAFeedConveyor.GetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTransitionLength) - * [`RAFeedConveyor.GetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTriangleSize) - * [`RAFeedConveyor.GetValidBeltProfileNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidBeltProfileNames) - * [`RAFeedConveyor.GetValidOptionsForModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidOptionsForModuleProperty) - * [`RAFeedConveyor.GetValidSphBoundaryTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues) - * [`RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues) - * [`RAFeedConveyor.GetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVerticalOffset) - * [`RAFeedConveyor.GetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWallThickness) - * [`RAFeedConveyor.GetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWidth) - * [`RAFeedConveyor.HasGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.HasGridFunction) - * [`RAFeedConveyor.IsCellActive()`](RAFeedConveyor.md#generated.RAFeedConveyor.IsCellActive) - * [`RAFeedConveyor.IterCellVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCellVertices) - * [`RAFeedConveyor.IterCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCells) - * [`RAFeedConveyor.Modified()`](RAFeedConveyor.md#generated.RAFeedConveyor.Modified) - * [`RAFeedConveyor.RemoveCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomCurve) - * [`RAFeedConveyor.RemoveCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomProperty) - * [`RAFeedConveyor.RemoveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveOutputVariable) - * [`RAFeedConveyor.RemoveProcess()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveProcess) - * [`RAFeedConveyor.SetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAccelerationPeriod) - * [`RAFeedConveyor.SetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAlignmentAngle) - * [`RAFeedConveyor.SetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStartTime) - * [`RAFeedConveyor.SetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStopTime) - * [`RAFeedConveyor.SetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltInclineAngle) - * [`RAFeedConveyor.SetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltProfile) - * [`RAFeedConveyor.SetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltSpeed) - * [`RAFeedConveyor.SetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltThickness) - * [`RAFeedConveyor.SetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltWidth) - * [`RAFeedConveyor.SetCurrentTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCurrentTimeStep) - * [`RAFeedConveyor.SetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDecelerationPeriod) - * [`RAFeedConveyor.SetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDiameter) - * [`RAFeedConveyor.SetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxHeight) - * [`RAFeedConveyor.SetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxLength) - * [`RAFeedConveyor.SetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxWidth) - * [`RAFeedConveyor.SetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFaceWidth) - * [`RAFeedConveyor.SetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFrontPlateOffset) - * [`RAFeedConveyor.SetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHeightOffset) - * [`RAFeedConveyor.SetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHorizontalOffset) - * [`RAFeedConveyor.SetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLengthOffset) - * [`RAFeedConveyor.SetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLoadingLength) - * [`RAFeedConveyor.SetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetMaterial) - * [`RAFeedConveyor.SetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetModuleProperty) - * [`RAFeedConveyor.SetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOffsetToIdlers) - * [`RAFeedConveyor.SetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOutOfPlaneOffset) - * [`RAFeedConveyor.SetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetReturnBeltAngle) - * [`RAFeedConveyor.SetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardHeight) - * [`RAFeedConveyor.SetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardLength) - * [`RAFeedConveyor.SetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSphBoundaryType) - * [`RAFeedConveyor.SetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSurfaceTensionContactAngle) - * [`RAFeedConveyor.SetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTemperature) - * [`RAFeedConveyor.SetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetThermalBoundaryConditionType) - * [`RAFeedConveyor.SetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTransitionLength) - * [`RAFeedConveyor.SetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTriangleSize) - * [`RAFeedConveyor.SetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetVerticalOffset) - * [`RAFeedConveyor.SetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWallThickness) - * [`RAFeedConveyor.SetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWidth) -* [RAFilterProcess](RAFilterProcess.md) - * [`RAFilterProcess`](RAFilterProcess.md#generated.RAFilterProcess) - * [`RAFilterProcess.AddCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCurve) - * [`RAFilterProcess.AddCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomCurve) - * [`RAFilterProcess.AddCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomProperty) - * [`RAFilterProcess.AddGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.AddGridFunction) - * [`RAFilterProcess.CreateCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateCurveOutputVariable) - * [`RAFilterProcess.CreateGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunction) - * [`RAFilterProcess.CreateGridFunctionArrayOnCells()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionArrayOnCells) - * [`RAFilterProcess.CreateGridFunctionStatisticOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAFilterProcess.CreateTransientCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateTransientCurveOutputVariable) - * [`RAFilterProcess.EditCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomCurve) - * [`RAFilterProcess.EditCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomProperty) - * [`RAFilterProcess.GetActivesArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetActivesArray) - * [`RAFilterProcess.GetBoundingBox()`](RAFilterProcess.md#generated.RAFilterProcess.GetBoundingBox) - * [`RAFilterProcess.GetCellAreaAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellAreaAsArray) - * [`RAFilterProcess.GetCellCenterAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellCenterAsArray) - * [`RAFilterProcess.GetCellDzAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellDzAsArray) - * [`RAFilterProcess.GetCellFromIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellFromIJK) - * [`RAFilterProcess.GetCellIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellIJK) - * [`RAFilterProcess.GetCellNumberOfVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellNumberOfVertices) - * [`RAFilterProcess.GetCellPointsAsFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellPointsAsFunction) - * [`RAFilterProcess.GetCellVolumeAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellVolumeAsArray) - * [`RAFilterProcess.GetCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurve) - * [`RAFilterProcess.GetCurveNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNames) - * [`RAFilterProcess.GetCurveNamesAssociation()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNamesAssociation) - * [`RAFilterProcess.GetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetCutValue) - * [`RAFilterProcess.GetElementCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetElementCurve) - * [`RAFilterProcess.GetGeometryQuantity()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryQuantity) - * [`RAFilterProcess.GetGeometryUnit()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryUnit) - * [`RAFilterProcess.GetGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunction) - * [`RAFilterProcess.GetGridFunctionNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunctionNames) - * [`RAFilterProcess.GetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMaxValue) - * [`RAFilterProcess.GetMeshColoring()`](RAFilterProcess.md#generated.RAFilterProcess.GetMeshColoring) - * [`RAFilterProcess.GetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMinValue) - * [`RAFilterProcess.GetMode()`](RAFilterProcess.md#generated.RAFilterProcess.GetMode) - * [`RAFilterProcess.GetNumberOfCells()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfCells) - * [`RAFilterProcess.GetNumberOfNodes()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfNodes) - * [`RAFilterProcess.GetNumberOfParticles()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfParticles) - * [`RAFilterProcess.GetNumpyCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumpyCurve) - * [`RAFilterProcess.GetOutputVariableValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetOutputVariableValue) - * [`RAFilterProcess.GetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetPropertyGridFunction) - * [`RAFilterProcess.GetTimeSet()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeSet) - * [`RAFilterProcess.GetTimeStatistics()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStatistics) - * [`RAFilterProcess.GetTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStep) - * [`RAFilterProcess.GetTopologyShape()`](RAFilterProcess.md#generated.RAFilterProcess.GetTopologyShape) - * [`RAFilterProcess.GetType()`](RAFilterProcess.md#generated.RAFilterProcess.GetType) - * [`RAFilterProcess.HasGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.HasGridFunction) - * [`RAFilterProcess.IsCellActive()`](RAFilterProcess.md#generated.RAFilterProcess.IsCellActive) - * [`RAFilterProcess.IterCellVertices()`](RAFilterProcess.md#generated.RAFilterProcess.IterCellVertices) - * [`RAFilterProcess.IterCells()`](RAFilterProcess.md#generated.RAFilterProcess.IterCells) - * [`RAFilterProcess.IterParticles()`](RAFilterProcess.md#generated.RAFilterProcess.IterParticles) - * [`RAFilterProcess.Modified()`](RAFilterProcess.md#generated.RAFilterProcess.Modified) - * [`RAFilterProcess.RemoveCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomCurve) - * [`RAFilterProcess.RemoveCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomProperty) - * [`RAFilterProcess.RemoveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveOutputVariable) - * [`RAFilterProcess.RemoveProcess()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveProcess) - * [`RAFilterProcess.SetCurrentTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.SetCurrentTimeStep) - * [`RAFilterProcess.SetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetCutValue) - * [`RAFilterProcess.SetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMaxValue) - * [`RAFilterProcess.SetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMinValue) - * [`RAFilterProcess.SetMode()`](RAFilterProcess.md#generated.RAFilterProcess.SetMode) - * [`RAFilterProcess.SetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.SetPropertyGridFunction) - * [`RAFilterProcess.SetType()`](RAFilterProcess.md#generated.RAFilterProcess.SetType) -* [RAFiveRollsBeltProfile](RAFiveRollsBeltProfile.md) - * [`RAFiveRollsBeltProfile`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile) - * [`RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths) - * [`RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths) - * [`RAFiveRollsBeltProfile.GetAvailableMaterials()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetAvailableMaterials) - * [`RAFiveRollsBeltProfile.GetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetCenterRollLength) - * [`RAFiveRollsBeltProfile.GetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLastRollAngle) - * [`RAFiveRollsBeltProfile.GetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLowerCornerRadius) - * [`RAFiveRollsBeltProfile.GetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetMaterial) - * [`RAFiveRollsBeltProfile.GetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetSideRollLength) - * [`RAFiveRollsBeltProfile.GetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetTroughingAngle) - * [`RAFiveRollsBeltProfile.GetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUpperCornerRadius) - * [`RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths) - * [`RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled) - * [`RAFiveRollsBeltProfile.SetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetCenterRollLength) - * [`RAFiveRollsBeltProfile.SetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLastRollAngle) - * [`RAFiveRollsBeltProfile.SetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLowerCornerRadius) - * [`RAFiveRollsBeltProfile.SetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetMaterial) - * [`RAFiveRollsBeltProfile.SetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetSideRollLength) - * [`RAFiveRollsBeltProfile.SetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetTroughingAngle) - * [`RAFiveRollsBeltProfile.SetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUpperCornerRadius) - * [`RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths) -* [RAFluentOneWayCoupling](RAFluentOneWayCoupling.md) - * [`RAFluentOneWayCoupling`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling) - * [`RAFluentOneWayCoupling.AddCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCurve) - * [`RAFluentOneWayCoupling.AddCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomCurve) - * [`RAFluentOneWayCoupling.AddCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomProperty) - * [`RAFluentOneWayCoupling.AddGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddGridFunction) - * [`RAFluentOneWayCoupling.CreateCoupledBoundaries()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCoupledBoundaries) - * [`RAFluentOneWayCoupling.CreateCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCurveOutputVariable) - * [`RAFluentOneWayCoupling.CreateGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunction) - * [`RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells) - * [`RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable) - * [`RAFluentOneWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateTransientCurveOutputVariable) - * [`RAFluentOneWayCoupling.EditCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomCurve) - * [`RAFluentOneWayCoupling.EditCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomProperty) - * [`RAFluentOneWayCoupling.GetActivesArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetActivesArray) - * [`RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames) - * [`RAFluentOneWayCoupling.GetBoundingBox()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetBoundingBox) - * [`RAFluentOneWayCoupling.GetCFDParametersList()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCFDParametersList) - * [`RAFluentOneWayCoupling.GetCellAreaAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellAreaAsArray) - * [`RAFluentOneWayCoupling.GetCellCenterAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellCenterAsArray) - * [`RAFluentOneWayCoupling.GetCellDzAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellDzAsArray) - * [`RAFluentOneWayCoupling.GetCellFromIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellFromIJK) - * [`RAFluentOneWayCoupling.GetCellIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellIJK) - * [`RAFluentOneWayCoupling.GetCellNumberOfVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellNumberOfVertices) - * [`RAFluentOneWayCoupling.GetCellPointsAsFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellPointsAsFunction) - * [`RAFluentOneWayCoupling.GetCellVolumeAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellVolumeAsArray) - * [`RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw) - * [`RAFluentOneWayCoupling.GetCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurve) - * [`RAFluentOneWayCoupling.GetCurveNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNames) - * [`RAFluentOneWayCoupling.GetCurveNamesAssociation()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation) - * [`RAFluentOneWayCoupling.GetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetDragLaw) - * [`RAFluentOneWayCoupling.GetElementCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetElementCurve) - * [`RAFluentOneWayCoupling.GetGeometryQuantity()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryQuantity) - * [`RAFluentOneWayCoupling.GetGeometryUnit()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryUnit) - * [`RAFluentOneWayCoupling.GetGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunction) - * [`RAFluentOneWayCoupling.GetGridFunctionNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunctionNames) - * [`RAFluentOneWayCoupling.GetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetIsOneWayPeriodic) - * [`RAFluentOneWayCoupling.GetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetLiftLaw) - * [`RAFluentOneWayCoupling.GetMeshColoring()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMeshColoring) - * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK1) - * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK2) - * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK3) - * [`RAFluentOneWayCoupling.GetNumberOfCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfCells) - * [`RAFluentOneWayCoupling.GetNumberOfNodes()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfNodes) - * [`RAFluentOneWayCoupling.GetNumpyCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumpyCurve) - * [`RAFluentOneWayCoupling.GetOutputVariableValue()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOutputVariableValue) - * [`RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance) - * [`RAFluentOneWayCoupling.GetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetStartTime) - * [`RAFluentOneWayCoupling.GetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienC1) - * [`RAFluentOneWayCoupling.GetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienD1) - * [`RAFluentOneWayCoupling.GetTimeSet()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeSet) - * [`RAFluentOneWayCoupling.GetTimeStatistics()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStatistics) - * [`RAFluentOneWayCoupling.GetTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStep) - * [`RAFluentOneWayCoupling.GetTopologyShape()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTopologyShape) - * [`RAFluentOneWayCoupling.GetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTorqueLaw) - * [`RAFluentOneWayCoupling.GetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion) - * [`RAFluentOneWayCoupling.GetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants) - * [`RAFluentOneWayCoupling.GetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance) - * [`RAFluentOneWayCoupling.GetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVirtualMassLaw) - * [`RAFluentOneWayCoupling.HasGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.HasGridFunction) - * [`RAFluentOneWayCoupling.IsCellActive()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IsCellActive) - * [`RAFluentOneWayCoupling.IterCellVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCellVertices) - * [`RAFluentOneWayCoupling.IterCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCells) - * [`RAFluentOneWayCoupling.Modified()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.Modified) - * [`RAFluentOneWayCoupling.RemoveCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomCurve) - * [`RAFluentOneWayCoupling.RemoveCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomProperty) - * [`RAFluentOneWayCoupling.RemoveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveOutputVariable) - * [`RAFluentOneWayCoupling.RemoveProcess()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveProcess) - * [`RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw) - * [`RAFluentOneWayCoupling.SetCurrentTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetCurrentTimeStep) - * [`RAFluentOneWayCoupling.SetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetDragLaw) - * [`RAFluentOneWayCoupling.SetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetIsOneWayPeriodic) - * [`RAFluentOneWayCoupling.SetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetLiftLaw) - * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK1) - * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK2) - * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK3) - * [`RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance) - * [`RAFluentOneWayCoupling.SetPartIdIfValid()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetPartIdIfValid) - * [`RAFluentOneWayCoupling.SetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetStartTime) - * [`RAFluentOneWayCoupling.SetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienC1) - * [`RAFluentOneWayCoupling.SetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienD1) - * [`RAFluentOneWayCoupling.SetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetTorqueLaw) - * [`RAFluentOneWayCoupling.SetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseTurbulentDispersion) - * [`RAFluentOneWayCoupling.SetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseUserDefinedConstants) - * [`RAFluentOneWayCoupling.SetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUserCfdUpdateDistance) - * [`RAFluentOneWayCoupling.SetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetVirtualMassLaw) - * [`RAFluentOneWayCoupling.SetupStoreFiles()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetupStoreFiles) -* [RAFluentSemiResolvedCoupling](RAFluentSemiResolvedCoupling.md) - * [`RAFluentSemiResolvedCoupling`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling) - * [`RAFluentSemiResolvedCoupling.GetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetCouplingFilesKept) - * [`RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs) - * [`RAFluentSemiResolvedCoupling.GetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentExecutionMode) - * [`RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier) - * [`RAFluentSemiResolvedCoupling.GetFluentReleases()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentReleases) - * [`RAFluentSemiResolvedCoupling.GetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentSolverProcesses) - * [`RAFluentSemiResolvedCoupling.GetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentVersion) - * [`RAFluentSemiResolvedCoupling.GetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetUseDatInitialization) - * [`RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues) - * [`RAFluentSemiResolvedCoupling.SetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetCouplingFilesKept) - * [`RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs) - * [`RAFluentSemiResolvedCoupling.SetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentExecutionMode) - * [`RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier) - * [`RAFluentSemiResolvedCoupling.SetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentSolverProcesses) - * [`RAFluentSemiResolvedCoupling.SetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentVersion) - * [`RAFluentSemiResolvedCoupling.SetPartIdIfValid()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetPartIdIfValid) - * [`RAFluentSemiResolvedCoupling.SetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetUseDatInitialization) - * [`RAFluentSemiResolvedCoupling.SetupStoreFiles()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetupStoreFiles) -* [RAFluentTwoWayCoupling](RAFluentTwoWayCoupling.md) - * [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling) - * [`RAFluentTwoWayCoupling.AddCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCurve) - * [`RAFluentTwoWayCoupling.AddCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomCurve) - * [`RAFluentTwoWayCoupling.AddCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomProperty) - * [`RAFluentTwoWayCoupling.AddGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddGridFunction) - * [`RAFluentTwoWayCoupling.CloseFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CloseFluent) - * [`RAFluentTwoWayCoupling.CreateCoupledBoundaries()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCoupledBoundaries) - * [`RAFluentTwoWayCoupling.CreateCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCurveOutputVariable) - * [`RAFluentTwoWayCoupling.CreateGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunction) - * [`RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells) - * [`RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable) - * [`RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable) - * [`RAFluentTwoWayCoupling.DisableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableBackDiffusion) - * [`RAFluentTwoWayCoupling.DisableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableSubstepping) - * [`RAFluentTwoWayCoupling.EditCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomCurve) - * [`RAFluentTwoWayCoupling.EditCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomProperty) - * [`RAFluentTwoWayCoupling.EnableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableBackDiffusion) - * [`RAFluentTwoWayCoupling.EnableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableSubstepping) - * [`RAFluentTwoWayCoupling.GetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAbsoluteValue) - * [`RAFluentTwoWayCoupling.GetActivesArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetActivesArray) - * [`RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames) - * [`RAFluentTwoWayCoupling.GetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingMethod) - * [`RAFluentTwoWayCoupling.GetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingRadiusType) - * [`RAFluentTwoWayCoupling.GetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBackDiffusion) - * [`RAFluentTwoWayCoupling.GetBoundingBox()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBoundingBox) - * [`RAFluentTwoWayCoupling.GetCFDParametersList()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCFDParametersList) - * [`RAFluentTwoWayCoupling.GetCellAreaAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellAreaAsArray) - * [`RAFluentTwoWayCoupling.GetCellCenterAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellCenterAsArray) - * [`RAFluentTwoWayCoupling.GetCellDzAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellDzAsArray) - * [`RAFluentTwoWayCoupling.GetCellFromIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellFromIJK) - * [`RAFluentTwoWayCoupling.GetCellIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellIJK) - * [`RAFluentTwoWayCoupling.GetCellNumberOfVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellNumberOfVertices) - * [`RAFluentTwoWayCoupling.GetCellPointsAsFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellPointsAsFunction) - * [`RAFluentTwoWayCoupling.GetCellVolumeAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellVolumeAsArray) - * [`RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw) - * [`RAFluentTwoWayCoupling.GetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCouplingFilesKept) - * [`RAFluentTwoWayCoupling.GetCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurve) - * [`RAFluentTwoWayCoupling.GetCurveNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNames) - * [`RAFluentTwoWayCoupling.GetCurveNamesAssociation()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNamesAssociation) - * [`RAFluentTwoWayCoupling.GetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDecompositionFactor) - * [`RAFluentTwoWayCoupling.GetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient) - * [`RAFluentTwoWayCoupling.GetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDragLaw) - * [`RAFluentTwoWayCoupling.GetElementCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetElementCurve) - * [`RAFluentTwoWayCoupling.GetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs) - * [`RAFluentTwoWayCoupling.GetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode) - * [`RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier) - * [`RAFluentTwoWayCoupling.GetFluentReleases()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentReleases) - * [`RAFluentTwoWayCoupling.GetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentSolverProcesses) - * [`RAFluentTwoWayCoupling.GetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentVersion) - * [`RAFluentTwoWayCoupling.GetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFractionParticleSize) - * [`RAFluentTwoWayCoupling.GetGeometryQuantity()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryQuantity) - * [`RAFluentTwoWayCoupling.GetGeometryUnit()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryUnit) - * [`RAFluentTwoWayCoupling.GetGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunction) - * [`RAFluentTwoWayCoupling.GetGridFunctionNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunctionNames) - * [`RAFluentTwoWayCoupling.GetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetLiftLaw) - * [`RAFluentTwoWayCoupling.GetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMappingMethod) - * [`RAFluentTwoWayCoupling.GetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumIterations) - * [`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) - * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1) - * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2) - * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3) - * [`RAFluentTwoWayCoupling.GetNumberOfCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfCells) - * [`RAFluentTwoWayCoupling.GetNumberOfNodes()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfNodes) - * [`RAFluentTwoWayCoupling.GetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfSubsteps) - * [`RAFluentTwoWayCoupling.GetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfThreads) - * [`RAFluentTwoWayCoupling.GetNumpyCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumpyCurve) - * [`RAFluentTwoWayCoupling.GetOutputVariableValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOutputVariableValue) - * [`RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.GetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSubstepping) - * [`RAFluentTwoWayCoupling.GetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienC1) - * [`RAFluentTwoWayCoupling.GetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienD1) - * [`RAFluentTwoWayCoupling.GetTimeSet()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeSet) - * [`RAFluentTwoWayCoupling.GetTimeStatistics()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStatistics) - * [`RAFluentTwoWayCoupling.GetTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStep) - * [`RAFluentTwoWayCoupling.GetTopologyShape()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTopologyShape) - * [`RAFluentTwoWayCoupling.GetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTorqueLaw) - * [`RAFluentTwoWayCoupling.GetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseDatInitialization) - * [`RAFluentTwoWayCoupling.GetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseTurbulentDispersion) - * [`RAFluentTwoWayCoupling.GetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseUserDefinedConstants) - * [`RAFluentTwoWayCoupling.GetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUserCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.GetValidAveragingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingMethodValues) - * [`RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues) - * [`RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues) - * [`RAFluentTwoWayCoupling.GetValidMappingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) - * [`RAFluentTwoWayCoupling.GetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw) - * [`RAFluentTwoWayCoupling.GetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.HasGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.HasGridFunction) - * [`RAFluentTwoWayCoupling.IsBackDiffusionEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsBackDiffusionEnabled) - * [`RAFluentTwoWayCoupling.IsCellActive()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsCellActive) - * [`RAFluentTwoWayCoupling.IsFluentRunning()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsFluentRunning) - * [`RAFluentTwoWayCoupling.IsSubsteppingEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsSubsteppingEnabled) - * [`RAFluentTwoWayCoupling.IterCellVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCellVertices) - * [`RAFluentTwoWayCoupling.IterCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCells) - * [`RAFluentTwoWayCoupling.Modified()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.Modified) - * [`RAFluentTwoWayCoupling.RemoveCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomCurve) - * [`RAFluentTwoWayCoupling.RemoveCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomProperty) - * [`RAFluentTwoWayCoupling.RemoveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveOutputVariable) - * [`RAFluentTwoWayCoupling.RemoveProcess()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveProcess) - * [`RAFluentTwoWayCoupling.SetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAbsoluteValue) - * [`RAFluentTwoWayCoupling.SetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingMethod) - * [`RAFluentTwoWayCoupling.SetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingRadiusType) - * [`RAFluentTwoWayCoupling.SetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetBackDiffusion) - * [`RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw) - * [`RAFluentTwoWayCoupling.SetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCouplingFilesKept) - * [`RAFluentTwoWayCoupling.SetCurrentTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCurrentTimeStep) - * [`RAFluentTwoWayCoupling.SetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDecompositionFactor) - * [`RAFluentTwoWayCoupling.SetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDiffusionCoefficient) - * [`RAFluentTwoWayCoupling.SetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDragLaw) - * [`RAFluentTwoWayCoupling.SetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentAdditionalArgs) - * [`RAFluentTwoWayCoupling.SetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentExecutionMode) - * [`RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier) - * [`RAFluentTwoWayCoupling.SetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentSolverProcesses) - * [`RAFluentTwoWayCoupling.SetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentVersion) - * [`RAFluentTwoWayCoupling.SetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFractionParticleSize) - * [`RAFluentTwoWayCoupling.SetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetLiftLaw) - * [`RAFluentTwoWayCoupling.SetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMappingMethod) - * [`RAFluentTwoWayCoupling.SetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumIterations) - * [`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) - * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2) - * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3) - * [`RAFluentTwoWayCoupling.SetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfSubsteps) - * [`RAFluentTwoWayCoupling.SetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfThreads) - * [`RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.SetPartIdIfValid()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetPartIdIfValid) - * [`RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.SetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSubstepping) - * [`RAFluentTwoWayCoupling.SetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienC1) - * [`RAFluentTwoWayCoupling.SetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienD1) - * [`RAFluentTwoWayCoupling.SetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetTorqueLaw) - * [`RAFluentTwoWayCoupling.SetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseDatInitialization) - * [`RAFluentTwoWayCoupling.SetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseTurbulentDispersion) - * [`RAFluentTwoWayCoupling.SetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseUserDefinedConstants) - * [`RAFluentTwoWayCoupling.SetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUserCfdUpdateDistance) - * [`RAFluentTwoWayCoupling.SetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVirtualMassLaw) - * [`RAFluentTwoWayCoupling.SetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVolumeFractionTarget) - * [`RAFluentTwoWayCoupling.SetupStoreFiles()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetupStoreFiles) - * [`RAFluentTwoWayCoupling.StartFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.StartFluent) - * [`RAFluentTwoWayCoupling.UpdateFluentInfo()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.UpdateFluentInfo) -* [RAFluidInlet](RAFluidInlet.md) - * [`RAFluidInlet`](RAFluidInlet.md#generated.RAFluidInlet) - * [`RAFluidInlet.GetAvailableEntryPoints()`](RAFluidInlet.md#generated.RAFluidInlet.GetAvailableEntryPoints) - * [`RAFluidInlet.GetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.GetBoundaryCondition) - * [`RAFluidInlet.GetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.GetEntryPoint) - * [`RAFluidInlet.GetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.GetMassFlowRate) - * [`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.SetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.SetBoundaryCondition) - * [`RAFluidInlet.SetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.SetEntryPoint) - * [`RAFluidInlet.SetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.SetMassFlowRate) - * [`RAFluidInlet.SetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStartTime) - * [`RAFluidInlet.SetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStopTime) - * [`RAFluidInlet.SetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.SetTemperature) - * [`RAFluidInlet.SetVelocity()`](RAFluidInlet.md#generated.RAFluidInlet.SetVelocity) -* [RAFluidMaterial](RAFluidMaterial.md) - * [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) - * [`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) -* [RAFreeBodyRotation](RAFreeBodyRotation.md) - * [`RAFreeBodyRotation`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation) - * [`RAFreeBodyRotation.GetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetFreeMotionDirection) - * [`RAFreeBodyRotation.GetValidFreeMotionDirectionValues()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetValidFreeMotionDirectionValues) - * [`RAFreeBodyRotation.SetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.SetFreeMotionDirection) -* [RAFreeBodyTranslation](RAFreeBodyTranslation.md) - * [`RAFreeBodyTranslation`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation) - * [`RAFreeBodyTranslation.GetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetFreeMotionDirection) - * [`RAFreeBodyTranslation.GetValidFreeMotionDirectionValues()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetValidFreeMotionDirectionValues) - * [`RAFreeBodyTranslation.SetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.SetFreeMotionDirection) -* [RAGeometryCollection](RAGeometryCollection.md) - * [`RAGeometryCollection`](RAGeometryCollection.md#generated.RAGeometryCollection) - * [`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.RemoveGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.RemoveGeometry) -* [RAInletGeometry](RAInletGeometry.md) - * [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry) - * [`RAInletGeometry.AddCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCurve) - * [`RAInletGeometry.AddCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomCurve) - * [`RAInletGeometry.AddCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomProperty) - * [`RAInletGeometry.AddGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.AddGridFunction) - * [`RAInletGeometry.CreateCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateCurveOutputVariable) - * [`RAInletGeometry.CreateGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunction) - * [`RAInletGeometry.CreateGridFunctionArrayOnCells()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionArrayOnCells) - * [`RAInletGeometry.CreateGridFunctionStatisticOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionStatisticOutputVariable) - * [`RAInletGeometry.CreateTransientCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateTransientCurveOutputVariable) - * [`RAInletGeometry.EditCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomCurve) - * [`RAInletGeometry.EditCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomProperty) - * [`RAInletGeometry.GetActivesArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetActivesArray) - * [`RAInletGeometry.GetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetAlignmentAngle) - * [`RAInletGeometry.GetBoundingBox()`](RAInletGeometry.md#generated.RAInletGeometry.GetBoundingBox) - * [`RAInletGeometry.GetCellAreaAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellAreaAsArray) - * [`RAInletGeometry.GetCellCenterAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellCenterAsArray) - * [`RAInletGeometry.GetCellDzAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellDzAsArray) - * [`RAInletGeometry.GetCellFromIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellFromIJK) - * [`RAInletGeometry.GetCellIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellIJK) - * [`RAInletGeometry.GetCellNumberOfVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellNumberOfVertices) - * [`RAInletGeometry.GetCellPointsAsFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellPointsAsFunction) - * [`RAInletGeometry.GetCellVolumeAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellVolumeAsArray) - * [`RAInletGeometry.GetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.GetCenter) - * [`RAInletGeometry.GetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.GetCircularMinMaxRadius) - * [`RAInletGeometry.GetCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurve) - * [`RAInletGeometry.GetCurveNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNames) - * [`RAInletGeometry.GetCurveNamesAssociation()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNamesAssociation) - * [`RAInletGeometry.GetElementCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetElementCurve) - * [`RAInletGeometry.GetGeometryQuantity()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryQuantity) - * [`RAInletGeometry.GetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryType) - * [`RAInletGeometry.GetGeometryUnit()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryUnit) - * [`RAInletGeometry.GetGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunction) - * [`RAInletGeometry.GetGridFunctionNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunctionNames) - * [`RAInletGeometry.GetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetInclineAngle) - * [`RAInletGeometry.GetLength()`](RAInletGeometry.md#generated.RAInletGeometry.GetLength) - * [`RAInletGeometry.GetMeshColoring()`](RAInletGeometry.md#generated.RAInletGeometry.GetMeshColoring) - * [`RAInletGeometry.GetNumberOfCells()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfCells) - * [`RAInletGeometry.GetNumberOfNodes()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfNodes) - * [`RAInletGeometry.GetNumpyCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumpyCurve) - * [`RAInletGeometry.GetOutputVariableValue()`](RAInletGeometry.md#generated.RAInletGeometry.GetOutputVariableValue) - * [`RAInletGeometry.GetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.GetRectangularSize) - * [`RAInletGeometry.GetTimeSet()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeSet) - * [`RAInletGeometry.GetTimeStatistics()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStatistics) - * [`RAInletGeometry.GetTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStep) - * [`RAInletGeometry.GetTopologyShape()`](RAInletGeometry.md#generated.RAInletGeometry.GetTopologyShape) - * [`RAInletGeometry.GetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.GetWidth) - * [`RAInletGeometry.HasGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.HasGridFunction) - * [`RAInletGeometry.IsCellActive()`](RAInletGeometry.md#generated.RAInletGeometry.IsCellActive) - * [`RAInletGeometry.IterCellVertices()`](RAInletGeometry.md#generated.RAInletGeometry.IterCellVertices) - * [`RAInletGeometry.IterCells()`](RAInletGeometry.md#generated.RAInletGeometry.IterCells) - * [`RAInletGeometry.Modified()`](RAInletGeometry.md#generated.RAInletGeometry.Modified) - * [`RAInletGeometry.RemoveCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomCurve) - * [`RAInletGeometry.RemoveCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomProperty) - * [`RAInletGeometry.RemoveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveOutputVariable) - * [`RAInletGeometry.RemoveProcess()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveProcess) - * [`RAInletGeometry.SetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetAlignmentAngle) - * [`RAInletGeometry.SetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.SetCenter) - * [`RAInletGeometry.SetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.SetCircularMinMaxRadius) - * [`RAInletGeometry.SetCurrentTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.SetCurrentTimeStep) - * [`RAInletGeometry.SetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.SetGeometryType) - * [`RAInletGeometry.SetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetInclineAngle) - * [`RAInletGeometry.SetLength()`](RAInletGeometry.md#generated.RAInletGeometry.SetLength) - * [`RAInletGeometry.SetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.SetRectangularSize) - * [`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) - * [`RAInletsOutletsCollection.AddParticleInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddParticleInlet) - * [`RAInletsOutletsCollection.AddVolumetricInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddVolumetricInlet) - * [`RAInletsOutletsCollection.Clear()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Clear) - * [`RAInletsOutletsCollection.GetParticleInput()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInput) - * [`RAInletsOutletsCollection.GetParticleInputNames()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInputNames) - * [`RAInletsOutletsCollection.New()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.New) - * [`RAInletsOutletsCollection.Remove()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Remove) -* [RAInputVariables](RAInputVariables.md) - * [`RAInputVariables`](RAInputVariables.md#generated.RAInputVariables) - * [`RAInputVariables.CreateVariable()`](RAInputVariables.md#generated.RAInputVariables.CreateVariable) - * [`RAInputVariables.GetVariableByName()`](RAInputVariables.md#generated.RAInputVariables.GetVariableByName) - * [`RAInputVariables.RemoveVariable()`](RAInputVariables.md#generated.RAInputVariables.RemoveVariable) -* [RAInspectorProcess](RAInspectorProcess.md) - * [`RAInspectorProcess`](RAInspectorProcess.md#generated.RAInspectorProcess) - * [`RAInspectorProcess.AddCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCurve) - * [`RAInspectorProcess.AddCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomCurve) - * [`RAInspectorProcess.AddCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomProperty) - * [`RAInspectorProcess.AddGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddGridFunction) - * [`RAInspectorProcess.CreateCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateCurveOutputVariable) - * [`RAInspectorProcess.CreateGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunction) - * [`RAInspectorProcess.CreateGridFunctionArrayOnCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionArrayOnCells) - * [`RAInspectorProcess.CreateGridFunctionStatisticOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAInspectorProcess.CreateTransientCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateTransientCurveOutputVariable) - * [`RAInspectorProcess.EditCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomCurve) - * [`RAInspectorProcess.EditCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomProperty) - * [`RAInspectorProcess.GetActivesArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetActivesArray) - * [`RAInspectorProcess.GetBoundingBox()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetBoundingBox) - * [`RAInspectorProcess.GetCellAreaAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellAreaAsArray) - * [`RAInspectorProcess.GetCellCenterAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellCenterAsArray) - * [`RAInspectorProcess.GetCellDzAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellDzAsArray) - * [`RAInspectorProcess.GetCellFromIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellFromIJK) - * [`RAInspectorProcess.GetCellIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellIJK) - * [`RAInspectorProcess.GetCellNumberOfVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellNumberOfVertices) - * [`RAInspectorProcess.GetCellPointsAsFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellPointsAsFunction) - * [`RAInspectorProcess.GetCellVolumeAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellVolumeAsArray) - * [`RAInspectorProcess.GetCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurve) - * [`RAInspectorProcess.GetCurveNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNames) - * [`RAInspectorProcess.GetCurveNamesAssociation()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNamesAssociation) - * [`RAInspectorProcess.GetElementCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetElementCurve) - * [`RAInspectorProcess.GetGeometryQuantity()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryQuantity) - * [`RAInspectorProcess.GetGeometryUnit()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryUnit) - * [`RAInspectorProcess.GetGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunction) - * [`RAInspectorProcess.GetGridFunctionNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunctionNames) - * [`RAInspectorProcess.GetMeshColoring()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetMeshColoring) - * [`RAInspectorProcess.GetNumberOfCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfCells) - * [`RAInspectorProcess.GetNumberOfNodes()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfNodes) - * [`RAInspectorProcess.GetNumberOfParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfParticles) - * [`RAInspectorProcess.GetNumpyCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumpyCurve) - * [`RAInspectorProcess.GetOutputVariableValue()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetOutputVariableValue) - * [`RAInspectorProcess.GetTimeSet()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeSet) - * [`RAInspectorProcess.GetTimeStatistics()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStatistics) - * [`RAInspectorProcess.GetTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStep) - * [`RAInspectorProcess.GetTopologyShape()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTopologyShape) - * [`RAInspectorProcess.HasGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.HasGridFunction) - * [`RAInspectorProcess.IsCellActive()`](RAInspectorProcess.md#generated.RAInspectorProcess.IsCellActive) - * [`RAInspectorProcess.IterCellVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCellVertices) - * [`RAInspectorProcess.IterCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCells) - * [`RAInspectorProcess.IterParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterParticles) - * [`RAInspectorProcess.Modified()`](RAInspectorProcess.md#generated.RAInspectorProcess.Modified) - * [`RAInspectorProcess.RemoveCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomCurve) - * [`RAInspectorProcess.RemoveCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomProperty) - * [`RAInspectorProcess.RemoveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveOutputVariable) - * [`RAInspectorProcess.RemoveProcess()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveProcess) - * [`RAInspectorProcess.SetCurrentTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.SetCurrentTimeStep) -* [RAJointsDataMeshColoring](RAJointsDataMeshColoring.md) - * [`RAJointsDataMeshColoring`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring) - * [`RAJointsDataMeshColoring.GetAvailableGridFunctions()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctions) - * [`RAJointsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctionsNames) - * [`RAJointsDataMeshColoring.GetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsColor) - * [`RAJointsDataMeshColoring.GetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityColor) - * [`RAJointsDataMeshColoring.GetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityLineWidth) - * [`RAJointsDataMeshColoring.GetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityProperty) - * [`RAJointsDataMeshColoring.GetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityVisible) - * [`RAJointsDataMeshColoring.GetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsPointSize) - * [`RAJointsDataMeshColoring.GetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsProperty) - * [`RAJointsDataMeshColoring.GetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsVisible) - * [`RAJointsDataMeshColoring.GetValidColoringModes()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetValidColoringModes) - * [`RAJointsDataMeshColoring.SetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsColor) - * [`RAJointsDataMeshColoring.SetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityColor) - * [`RAJointsDataMeshColoring.SetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityLineWidth) - * [`RAJointsDataMeshColoring.SetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityProperty) - * [`RAJointsDataMeshColoring.SetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityVisible) - * [`RAJointsDataMeshColoring.SetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsPointSize) - * [`RAJointsDataMeshColoring.SetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsProperty) - * [`RAJointsDataMeshColoring.SetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsVisible) -* [RALinearTimeVariableForce](RALinearTimeVariableForce.md) - * [`RALinearTimeVariableForce`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce) - * [`RALinearTimeVariableForce.GetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetInitialForceValue) - * [`RALinearTimeVariableForce.GetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetTimeCoefficients) - * [`RALinearTimeVariableForce.SetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetInitialForceValue) - * [`RALinearTimeVariableForce.SetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetTimeCoefficients) -* [RALinearTimeVariableMoment](RALinearTimeVariableMoment.md) - * [`RALinearTimeVariableMoment`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment) - * [`RALinearTimeVariableMoment.GetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetInitialMomentValue) - * [`RALinearTimeVariableMoment.GetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetTimeCoefficients) - * [`RALinearTimeVariableMoment.SetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetInitialMomentValue) - * [`RALinearTimeVariableMoment.SetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetTimeCoefficients) -* [RAMaterialCollection](RAMaterialCollection.md) - * [`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) - * [`RAMaterialCollection.Remove()`](RAMaterialCollection.md#generated.RAMaterialCollection.Remove) - * [`RAMaterialCollection.SetBulkSolidFraction()`](RAMaterialCollection.md#generated.RAMaterialCollection.SetBulkSolidFraction) -* [RAMaterialsInteraction](RAMaterialsInteraction.md) - * [`RAMaterialsInteraction`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction) - * [`RAMaterialsInteraction.GetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveDistance) - * [`RAMaterialsInteraction.GetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveFraction) - * [`RAMaterialsInteraction.GetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetContactStiffnessMultiplier) - * [`RAMaterialsInteraction.GetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetDynamicFriction) - * [`RAMaterialsInteraction.GetFirstMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetFirstMaterial) - * [`RAMaterialsInteraction.GetModuleProperties()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperties) - * [`RAMaterialsInteraction.GetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperty) - * [`RAMaterialsInteraction.GetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetRestitutionCoefficient) - * [`RAMaterialsInteraction.GetSecondMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSecondMaterial) - * [`RAMaterialsInteraction.GetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetStaticFriction) - * [`RAMaterialsInteraction.GetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSurfaceEnergy) - * [`RAMaterialsInteraction.GetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetTangentialStiffnessRatio) - * [`RAMaterialsInteraction.GetValidOptionsForModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetValidOptionsForModuleProperty) - * [`RAMaterialsInteraction.GetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityExponent) - * [`RAMaterialsInteraction.GetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityLimit) - * [`RAMaterialsInteraction.SetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveDistance) - * [`RAMaterialsInteraction.SetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveFraction) - * [`RAMaterialsInteraction.SetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetContactStiffnessMultiplier) - * [`RAMaterialsInteraction.SetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetDynamicFriction) - * [`RAMaterialsInteraction.SetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetModuleProperty) - * [`RAMaterialsInteraction.SetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetRestitutionCoefficient) - * [`RAMaterialsInteraction.SetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetStaticFriction) - * [`RAMaterialsInteraction.SetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetSurfaceEnergy) - * [`RAMaterialsInteraction.SetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetTangentialStiffnessRatio) - * [`RAMaterialsInteraction.SetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityExponent) - * [`RAMaterialsInteraction.SetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityLimit) -* [RAMaterialsInteractionCollection](RAMaterialsInteractionCollection.md) - * [`RAMaterialsInteractionCollection`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection) - * [`RAMaterialsInteractionCollection.Clear()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Clear) - * [`RAMaterialsInteractionCollection.GetMaterialsInteraction()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.GetMaterialsInteraction) - * [`RAMaterialsInteractionCollection.New()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.New) - * [`RAMaterialsInteractionCollection.Remove()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Remove) -* [RAMeshColoring](RAMeshColoring.md) - * [`RAMeshColoring`](RAMeshColoring.md#generated.RAMeshColoring) - * [`RAMeshColoring.GetAvailableGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctions) - * [`RAMeshColoring.GetAvailableGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctionsNames) - * [`RAMeshColoring.GetAvailableVectorGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctions) - * [`RAMeshColoring.GetAvailableVectorGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctionsNames) - * [`RAMeshColoring.GetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeColor) - * [`RAMeshColoring.GetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeGridFunction) - * [`RAMeshColoring.GetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeLineWidth) - * [`RAMeshColoring.GetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeVisible) - * [`RAMeshColoring.GetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceColor) - * [`RAMeshColoring.GetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceCustomStructuredPartitions) - * [`RAMeshColoring.GetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceGridFunction) - * [`RAMeshColoring.GetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceScope) - * [`RAMeshColoring.GetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceShowOnNode) - * [`RAMeshColoring.GetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceStructuredPartitions) - * [`RAMeshColoring.GetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceVisible) - * [`RAMeshColoring.GetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.GetLevelOfDetail) - * [`RAMeshColoring.GetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeColor) - * [`RAMeshColoring.GetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeGridFunction) - * [`RAMeshColoring.GetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodePointSize) - * [`RAMeshColoring.GetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeVisible) - * [`RAMeshColoring.GetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetNormalizedVectorsEnabled) - * [`RAMeshColoring.GetStride()`](RAMeshColoring.md#generated.RAMeshColoring.GetStride) - * [`RAMeshColoring.GetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparency) - * [`RAMeshColoring.GetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparencyEnabled) - * [`RAMeshColoring.GetValidColoringModes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidColoringModes) - * [`RAMeshColoring.GetValidFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceCustomStructuredPartitions) - * [`RAMeshColoring.GetValidFaceScopes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceScopes) - * [`RAMeshColoring.GetValidFaceStructuredPartitionsValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceStructuredPartitionsValues) - * [`RAMeshColoring.GetValidLevelOfDetailValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidLevelOfDetailValues) - * [`RAMeshColoring.GetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorGridFunction) - * [`RAMeshColoring.GetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorScale) - * [`RAMeshColoring.GetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorVisible) - * [`RAMeshColoring.GetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVisible) - * [`RAMeshColoring.SetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeColor) - * [`RAMeshColoring.SetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeGridFunction) - * [`RAMeshColoring.SetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeLineWidth) - * [`RAMeshColoring.SetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeVisible) - * [`RAMeshColoring.SetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceColor) - * [`RAMeshColoring.SetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceCustomStructuredPartitions) - * [`RAMeshColoring.SetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceGridFunction) - * [`RAMeshColoring.SetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceScope) - * [`RAMeshColoring.SetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceShowOnNode) - * [`RAMeshColoring.SetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceStructuredPartitions) - * [`RAMeshColoring.SetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceVisible) - * [`RAMeshColoring.SetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.SetLevelOfDetail) - * [`RAMeshColoring.SetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeColor) - * [`RAMeshColoring.SetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeGridFunction) - * [`RAMeshColoring.SetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodePointSize) - * [`RAMeshColoring.SetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeVisible) - * [`RAMeshColoring.SetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetNormalizedVectorsEnabled) - * [`RAMeshColoring.SetStride()`](RAMeshColoring.md#generated.RAMeshColoring.SetStride) - * [`RAMeshColoring.SetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparency) - * [`RAMeshColoring.SetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparencyEnabled) - * [`RAMeshColoring.SetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorGridFunction) - * [`RAMeshColoring.SetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorScale) - * [`RAMeshColoring.SetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorVisible) - * [`RAMeshColoring.SetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVisible) -* [RAModule](RAModule.md) - * [`RAModule`](RAModule.md#generated.RAModule) - * [`RAModule.DisableModule()`](RAModule.md#generated.RAModule.DisableModule) - * [`RAModule.EnableModule()`](RAModule.md#generated.RAModule.EnableModule) - * [`RAModule.GetModuleProperties()`](RAModule.md#generated.RAModule.GetModuleProperties) - * [`RAModule.GetModuleProperty()`](RAModule.md#generated.RAModule.GetModuleProperty) - * [`RAModule.GetOutputObject()`](RAModule.md#generated.RAModule.GetOutputObject) - * [`RAModule.GetValidOptionsForModuleProperty()`](RAModule.md#generated.RAModule.GetValidOptionsForModuleProperty) - * [`RAModule.IsModuleEnabled()`](RAModule.md#generated.RAModule.IsModuleEnabled) - * [`RAModule.SetModuleEnabled()`](RAModule.md#generated.RAModule.SetModuleEnabled) - * [`RAModule.SetModuleProperty()`](RAModule.md#generated.RAModule.SetModuleProperty) -* [RAModuleCollection](RAModuleCollection.md) - * [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) - * [`RAModuleCollection.GetEnabledModules()`](RAModuleCollection.md#generated.RAModuleCollection.GetEnabledModules) - * [`RAModuleCollection.GetModule()`](RAModuleCollection.md#generated.RAModuleCollection.GetModule) - * [`RAModuleCollection.GetModuleNames()`](RAModuleCollection.md#generated.RAModuleCollection.GetModuleNames) -* [RAModuleOutput](RAModuleOutput.md) - * [`RAModuleOutput`](RAModuleOutput.md#generated.RAModuleOutput) - * [`RAModuleOutput.AddCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCurve) - * [`RAModuleOutput.AddCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomCurve) - * [`RAModuleOutput.AddCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomProperty) - * [`RAModuleOutput.AddGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.AddGridFunction) - * [`RAModuleOutput.CreateCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateCurveOutputVariable) - * [`RAModuleOutput.CreateGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunction) - * [`RAModuleOutput.CreateGridFunctionArrayOnCells()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionArrayOnCells) - * [`RAModuleOutput.CreateGridFunctionStatisticOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionStatisticOutputVariable) - * [`RAModuleOutput.CreateTransientCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateTransientCurveOutputVariable) - * [`RAModuleOutput.EditCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomCurve) - * [`RAModuleOutput.EditCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomProperty) - * [`RAModuleOutput.GetActivesArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetActivesArray) - * [`RAModuleOutput.GetBoundingBox()`](RAModuleOutput.md#generated.RAModuleOutput.GetBoundingBox) - * [`RAModuleOutput.GetCellAreaAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellAreaAsArray) - * [`RAModuleOutput.GetCellCenterAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellCenterAsArray) - * [`RAModuleOutput.GetCellDzAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellDzAsArray) - * [`RAModuleOutput.GetCellFromIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellFromIJK) - * [`RAModuleOutput.GetCellIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellIJK) - * [`RAModuleOutput.GetCellNumberOfVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellNumberOfVertices) - * [`RAModuleOutput.GetCellPointsAsFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellPointsAsFunction) - * [`RAModuleOutput.GetCellVolumeAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellVolumeAsArray) - * [`RAModuleOutput.GetCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurve) - * [`RAModuleOutput.GetCurveNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNames) - * [`RAModuleOutput.GetCurveNamesAssociation()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNamesAssociation) - * [`RAModuleOutput.GetElementCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetElementCurve) - * [`RAModuleOutput.GetGeometryQuantity()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryQuantity) - * [`RAModuleOutput.GetGeometryUnit()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryUnit) - * [`RAModuleOutput.GetGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunction) - * [`RAModuleOutput.GetGridFunctionNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunctionNames) - * [`RAModuleOutput.GetMeshColoring()`](RAModuleOutput.md#generated.RAModuleOutput.GetMeshColoring) - * [`RAModuleOutput.GetNumberOfCells()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfCells) - * [`RAModuleOutput.GetNumberOfNodes()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfNodes) - * [`RAModuleOutput.GetNumpyCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumpyCurve) - * [`RAModuleOutput.GetOutputVariableValue()`](RAModuleOutput.md#generated.RAModuleOutput.GetOutputVariableValue) - * [`RAModuleOutput.GetTimeSet()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeSet) - * [`RAModuleOutput.GetTimeStatistics()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStatistics) - * [`RAModuleOutput.GetTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStep) - * [`RAModuleOutput.GetTopologyShape()`](RAModuleOutput.md#generated.RAModuleOutput.GetTopologyShape) - * [`RAModuleOutput.HasGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.HasGridFunction) - * [`RAModuleOutput.IsCellActive()`](RAModuleOutput.md#generated.RAModuleOutput.IsCellActive) - * [`RAModuleOutput.IterCellVertices()`](RAModuleOutput.md#generated.RAModuleOutput.IterCellVertices) - * [`RAModuleOutput.IterCells()`](RAModuleOutput.md#generated.RAModuleOutput.IterCells) - * [`RAModuleOutput.Modified()`](RAModuleOutput.md#generated.RAModuleOutput.Modified) - * [`RAModuleOutput.RemoveCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomCurve) - * [`RAModuleOutput.RemoveCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomProperty) - * [`RAModuleOutput.RemoveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveOutputVariable) - * [`RAModuleOutput.RemoveProcess()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveProcess) - * [`RAModuleOutput.SetCurrentTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.SetCurrentTimeStep) -* [RAModulePropertyList](RAModulePropertyList.md) - * [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) - * [`RAModulePropertyList.Clear()`](RAModulePropertyList.md#generated.RAModulePropertyList.Clear) - * [`RAModulePropertyList.New()`](RAModulePropertyList.md#generated.RAModulePropertyList.New) - * [`RAModulePropertyList.Remove()`](RAModulePropertyList.md#generated.RAModulePropertyList.Remove) -* [RAModulePropertyListItem](RAModulePropertyListItem.md) - * [`RAModulePropertyListItem`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem) - * [`RAModulePropertyListItem.GetModuleProperties()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperties) - * [`RAModulePropertyListItem.GetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperty) - * [`RAModulePropertyListItem.GetValidOptionsForModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetValidOptionsForModuleProperty) - * [`RAModulePropertyListItem.SetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.SetModuleProperty) -* [RAMotion](RAMotion.md) - * [`RAMotion`](RAMotion.md#generated.RAMotion) - * [`RAMotion.GetStartTime()`](RAMotion.md#generated.RAMotion.GetStartTime) - * [`RAMotion.GetStopTime()`](RAMotion.md#generated.RAMotion.GetStopTime) - * [`RAMotion.GetType()`](RAMotion.md#generated.RAMotion.GetType) - * [`RAMotion.GetTypeObject()`](RAMotion.md#generated.RAMotion.GetTypeObject) - * [`RAMotion.GetValidTypes()`](RAMotion.md#generated.RAMotion.GetValidTypes) - * [`RAMotion.SetStartTime()`](RAMotion.md#generated.RAMotion.SetStartTime) - * [`RAMotion.SetStopTime()`](RAMotion.md#generated.RAMotion.SetStopTime) - * [`RAMotion.SetType()`](RAMotion.md#generated.RAMotion.SetType) -* [RAMotionFrame](RAMotionFrame.md) - * [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame) - * [`RAMotionFrame.AddCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCurve) - * [`RAMotionFrame.AddCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomCurve) - * [`RAMotionFrame.AddCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomProperty) - * [`RAMotionFrame.AddGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.AddGridFunction) - * [`RAMotionFrame.AddPendulumMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddPendulumMotion) - * [`RAMotionFrame.AddRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddRotationMotion) - * [`RAMotionFrame.AddTranslationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddTranslationMotion) - * [`RAMotionFrame.AddVibrationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddVibrationMotion) - * [`RAMotionFrame.ApplyTo()`](RAMotionFrame.md#generated.RAMotionFrame.ApplyTo) - * [`RAMotionFrame.CreateCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateCurveOutputVariable) - * [`RAMotionFrame.CreateGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunction) - * [`RAMotionFrame.CreateGridFunctionArrayOnCells()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionArrayOnCells) - * [`RAMotionFrame.CreateGridFunctionStatisticOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionStatisticOutputVariable) - * [`RAMotionFrame.CreateTransientCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateTransientCurveOutputVariable) - * [`RAMotionFrame.EditCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomCurve) - * [`RAMotionFrame.EditCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomProperty) - * [`RAMotionFrame.GetActivesArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetActivesArray) - * [`RAMotionFrame.GetBoundingBox()`](RAMotionFrame.md#generated.RAMotionFrame.GetBoundingBox) - * [`RAMotionFrame.GetCellAreaAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellAreaAsArray) - * [`RAMotionFrame.GetCellCenterAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellCenterAsArray) - * [`RAMotionFrame.GetCellDzAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellDzAsArray) - * [`RAMotionFrame.GetCellFromIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellFromIJK) - * [`RAMotionFrame.GetCellIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellIJK) - * [`RAMotionFrame.GetCellNumberOfVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellNumberOfVertices) - * [`RAMotionFrame.GetCellPointsAsFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellPointsAsFunction) - * [`RAMotionFrame.GetCellVolumeAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellVolumeAsArray) - * [`RAMotionFrame.GetCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurve) - * [`RAMotionFrame.GetCurveNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNames) - * [`RAMotionFrame.GetCurveNamesAssociation()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNamesAssociation) - * [`RAMotionFrame.GetElementCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetElementCurve) - * [`RAMotionFrame.GetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmAngularLimits) - * [`RAMotionFrame.GetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmLinearLimits) - * [`RAMotionFrame.GetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnablePeriodicMotion) - * [`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.GetGeometryUnit()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryUnit) - * [`RAMotionFrame.GetGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunction) - * [`RAMotionFrame.GetGridFunctionNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunctionNames) - * [`RAMotionFrame.GetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.GetKeepInPlace) - * [`RAMotionFrame.GetMeshColoring()`](RAMotionFrame.md#generated.RAMotionFrame.GetMeshColoring) - * [`RAMotionFrame.GetMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotionFrame) - * [`RAMotionFrame.GetMotions()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotions) - * [`RAMotionFrame.GetNumberOfCells()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfCells) - * [`RAMotionFrame.GetNumberOfNodes()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfNodes) - * [`RAMotionFrame.GetNumpyCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumpyCurve) - * [`RAMotionFrame.GetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientation) - * [`RAMotionFrame.GetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngleAndVector) - * [`RAMotionFrame.GetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngles) - * [`RAMotionFrame.GetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromBasisVector) - * [`RAMotionFrame.GetOutputVariableValue()`](RAMotionFrame.md#generated.RAMotionFrame.GetOutputVariableValue) - * [`RAMotionFrame.GetParentMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetParentMotionFrame) - * [`RAMotionFrame.GetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionPeriod) - * [`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.HasGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.HasGridFunction) - * [`RAMotionFrame.IsCellActive()`](RAMotionFrame.md#generated.RAMotionFrame.IsCellActive) - * [`RAMotionFrame.IterCellVertices()`](RAMotionFrame.md#generated.RAMotionFrame.IterCellVertices) - * [`RAMotionFrame.IterCells()`](RAMotionFrame.md#generated.RAMotionFrame.IterCells) - * [`RAMotionFrame.IterMotionFrames()`](RAMotionFrame.md#generated.RAMotionFrame.IterMotionFrames) - * [`RAMotionFrame.Modified()`](RAMotionFrame.md#generated.RAMotionFrame.Modified) - * [`RAMotionFrame.NewConeCrusherFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewConeCrusherFrame) - * [`RAMotionFrame.NewFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewFrame) - * [`RAMotionFrame.RemoveCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomCurve) - * [`RAMotionFrame.RemoveCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomProperty) - * [`RAMotionFrame.RemoveFrame()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveFrame) - * [`RAMotionFrame.RemoveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveOutputVariable) - * [`RAMotionFrame.RemoveProcess()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveProcess) - * [`RAMotionFrame.SetCurrentTimeStep()`](RAMotionFrame.md#generated.RAMotionFrame.SetCurrentTimeStep) - * [`RAMotionFrame.SetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmAngularLimits) - * [`RAMotionFrame.SetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmLinearLimits) - * [`RAMotionFrame.SetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnablePeriodicMotion) - * [`RAMotionFrame.SetFbmMaxAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxAngularLimits) - * [`RAMotionFrame.SetFbmMaxLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxLinearLimits) - * [`RAMotionFrame.SetFbmMinAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinAngularLimits) - * [`RAMotionFrame.SetFbmMinLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinLinearLimits) - * [`RAMotionFrame.SetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.SetKeepInPlace) - * [`RAMotionFrame.SetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientation) - * [`RAMotionFrame.SetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngleAndVector) - * [`RAMotionFrame.SetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngles) - * [`RAMotionFrame.SetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromBasisVector) - * [`RAMotionFrame.SetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionPeriod) - * [`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) - * [`RAMotionFrameSource.GetParentMotionFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.GetParentMotionFrame) - * [`RAMotionFrameSource.IterMotionFrames()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.IterMotionFrames) - * [`RAMotionFrameSource.NewConeCrusherFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewConeCrusherFrame) - * [`RAMotionFrameSource.NewFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewFrame) - * [`RAMotionFrameSource.RemoveFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.RemoveFrame) -* [RAMotionList](RAMotionList.md) - * [`RAMotionList`](RAMotionList.md#generated.RAMotionList) - * [`RAMotionList.Clear()`](RAMotionList.md#generated.RAMotionList.Clear) - * [`RAMotionList.New()`](RAMotionList.md#generated.RAMotionList.New) - * [`RAMotionList.Remove()`](RAMotionList.md#generated.RAMotionList.Remove) -* [RAOneRollBeltProfile](RAOneRollBeltProfile.md) - * [`RAOneRollBeltProfile`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile) - * [`RAOneRollBeltProfile.GetAvailableMaterials()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetAvailableMaterials) - * [`RAOneRollBeltProfile.GetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetMaterial) - * [`RAOneRollBeltProfile.SetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.SetMaterial) -* [RAOutlet](RAOutlet.md) - * [`RAOutlet`](RAOutlet.md#generated.RAOutlet) - * [`RAOutlet.DisablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.DisablePrescribedPressure) - * [`RAOutlet.EnablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.EnablePrescribedPressure) - * [`RAOutlet.GetAvailableExitPoints()`](RAOutlet.md#generated.RAOutlet.GetAvailableExitPoints) - * [`RAOutlet.GetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.GetEnabledForParticles) - * [`RAOutlet.GetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.GetEnabledForSph) - * [`RAOutlet.GetExitPoint()`](RAOutlet.md#generated.RAOutlet.GetExitPoint) - * [`RAOutlet.GetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.GetPrescribedPressureEnabled) - * [`RAOutlet.GetPressure()`](RAOutlet.md#generated.RAOutlet.GetPressure) - * [`RAOutlet.IsPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.IsPrescribedPressureEnabled) - * [`RAOutlet.SetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.SetEnabledForParticles) - * [`RAOutlet.SetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.SetEnabledForSph) - * [`RAOutlet.SetExitPoint()`](RAOutlet.md#generated.RAOutlet.SetExitPoint) - * [`RAOutlet.SetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.SetPrescribedPressureEnabled) - * [`RAOutlet.SetPressure()`](RAOutlet.md#generated.RAOutlet.SetPressure) -* [RAParametricVar](RAParametricVar.md) - * [`RAParametricVar`](RAParametricVar.md#generated.RAParametricVar) - * [`RAParametricVar.GetValue()`](RAParametricVar.md#generated.RAParametricVar.GetValue) - * [`RAParametricVar.SetValue()`](RAParametricVar.md#generated.RAParametricVar.SetValue) -* [RAParametricVariables](RAParametricVariables.md) - * [`RAParametricVariables`](RAParametricVariables.md#generated.RAParametricVariables) - * [`RAParametricVariables.GetInputVariables()`](RAParametricVariables.md#generated.RAParametricVariables.GetInputVariables) -* [RAParticle](RAParticle.md) - * [`RAParticle`](RAParticle.md#generated.RAParticle) - * [`RAParticle.AddCurve()`](RAParticle.md#generated.RAParticle.AddCurve) - * [`RAParticle.AddCustomCurve()`](RAParticle.md#generated.RAParticle.AddCustomCurve) - * [`RAParticle.AddCustomProperty()`](RAParticle.md#generated.RAParticle.AddCustomProperty) - * [`RAParticle.AddGridFunction()`](RAParticle.md#generated.RAParticle.AddGridFunction) - * [`RAParticle.CreateCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateCurveOutputVariable) - * [`RAParticle.CreateGridFunction()`](RAParticle.md#generated.RAParticle.CreateGridFunction) - * [`RAParticle.CreateGridFunctionArrayOnCells()`](RAParticle.md#generated.RAParticle.CreateGridFunctionArrayOnCells) - * [`RAParticle.CreateGridFunctionStatisticOutputVariable()`](RAParticle.md#generated.RAParticle.CreateGridFunctionStatisticOutputVariable) - * [`RAParticle.CreateTransientCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateTransientCurveOutputVariable) - * [`RAParticle.DisableBreakage()`](RAParticle.md#generated.RAParticle.DisableBreakage) - * [`RAParticle.DisableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.DisableIncludeRotationalDeformations) - * [`RAParticle.DisableRandomOrientation()`](RAParticle.md#generated.RAParticle.DisableRandomOrientation) - * [`RAParticle.EditCustomCurve()`](RAParticle.md#generated.RAParticle.EditCustomCurve) - * [`RAParticle.EditCustomProperty()`](RAParticle.md#generated.RAParticle.EditCustomProperty) - * [`RAParticle.EnableBreakage()`](RAParticle.md#generated.RAParticle.EnableBreakage) - * [`RAParticle.EnableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.EnableIncludeRotationalDeformations) - * [`RAParticle.EnableRandomOrientation()`](RAParticle.md#generated.RAParticle.EnableRandomOrientation) - * [`RAParticle.GetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.GetAbt10MaximumT10Value) - * [`RAParticle.GetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10MinimumSpecificEnergy) - * [`RAParticle.GetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) - * [`RAParticle.GetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceSize) - * [`RAParticle.GetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.GetAbt10SelectFunctionCoefficient) - * [`RAParticle.GetActivesArray()`](RAParticle.md#generated.RAParticle.GetActivesArray) - * [`RAParticle.GetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) - * [`RAParticle.GetAnisotropic()`](RAParticle.md#generated.RAParticle.GetAnisotropic) - * [`RAParticle.GetAvailableMaterials()`](RAParticle.md#generated.RAParticle.GetAvailableMaterials) - * [`RAParticle.GetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetBendingAngleLimit) - * [`RAParticle.GetBoundingBox()`](RAParticle.md#generated.RAParticle.GetBoundingBox) - * [`RAParticle.GetBreakageModel()`](RAParticle.md#generated.RAParticle.GetBreakageModel) - * [`RAParticle.GetCellAreaAsArray()`](RAParticle.md#generated.RAParticle.GetCellAreaAsArray) - * [`RAParticle.GetCellCenterAsArray()`](RAParticle.md#generated.RAParticle.GetCellCenterAsArray) - * [`RAParticle.GetCellDzAsArray()`](RAParticle.md#generated.RAParticle.GetCellDzAsArray) - * [`RAParticle.GetCellFromIJK()`](RAParticle.md#generated.RAParticle.GetCellFromIJK) - * [`RAParticle.GetCellIJK()`](RAParticle.md#generated.RAParticle.GetCellIJK) - * [`RAParticle.GetCellNumberOfVertices()`](RAParticle.md#generated.RAParticle.GetCellNumberOfVertices) - * [`RAParticle.GetCellPointsAsFunction()`](RAParticle.md#generated.RAParticle.GetCellPointsAsFunction) - * [`RAParticle.GetCellVolumeAsArray()`](RAParticle.md#generated.RAParticle.GetCellVolumeAsArray) - * [`RAParticle.GetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.GetCenterOfMassOffset) - * [`RAParticle.GetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.GetCgmScaleFactor) - * [`RAParticle.GetChangeMassProperties()`](RAParticle.md#generated.RAParticle.GetChangeMassProperties) - * [`RAParticle.GetCurve()`](RAParticle.md#generated.RAParticle.GetCurve) - * [`RAParticle.GetCurveNames()`](RAParticle.md#generated.RAParticle.GetCurveNames) - * [`RAParticle.GetCurveNamesAssociation()`](RAParticle.md#generated.RAParticle.GetCurveNamesAssociation) - * [`RAParticle.GetDeformationModel()`](RAParticle.md#generated.RAParticle.GetDeformationModel) - * [`RAParticle.GetDistributionModel()`](RAParticle.md#generated.RAParticle.GetDistributionModel) - * [`RAParticle.GetEdgeAngle()`](RAParticle.md#generated.RAParticle.GetEdgeAngle) - * [`RAParticle.GetElasticRatioBending()`](RAParticle.md#generated.RAParticle.GetElasticRatioBending) - * [`RAParticle.GetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.GetElasticRatioNormal) - * [`RAParticle.GetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.GetElasticRatioTangential) - * [`RAParticle.GetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.GetElasticRatioTorsion) - * [`RAParticle.GetElasticity()`](RAParticle.md#generated.RAParticle.GetElasticity) - * [`RAParticle.GetElementCurve()`](RAParticle.md#generated.RAParticle.GetElementCurve) - * [`RAParticle.GetElementDampingRatio()`](RAParticle.md#generated.RAParticle.GetElementDampingRatio) - * [`RAParticle.GetEnableBreakage()`](RAParticle.md#generated.RAParticle.GetEnableBreakage) - * [`RAParticle.GetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.GetEnableRandomAngle) - * [`RAParticle.GetEnableRotations()`](RAParticle.md#generated.RAParticle.GetEnableRotations) - * [`RAParticle.GetFailureRatio()`](RAParticle.md#generated.RAParticle.GetFailureRatio) - * [`RAParticle.GetFlexible()`](RAParticle.md#generated.RAParticle.GetFlexible) - * [`RAParticle.GetGeometryQuantity()`](RAParticle.md#generated.RAParticle.GetGeometryQuantity) - * [`RAParticle.GetGeometryUnit()`](RAParticle.md#generated.RAParticle.GetGeometryUnit) - * [`RAParticle.GetGridFunction()`](RAParticle.md#generated.RAParticle.GetGridFunction) - * [`RAParticle.GetGridFunctionNames()`](RAParticle.md#generated.RAParticle.GetGridFunctionNames) - * [`RAParticle.GetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.GetHorizontalAspectRatio) - * [`RAParticle.GetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.GetIncludeRotationalDeformations) - * [`RAParticle.GetInternalFriction()`](RAParticle.md#generated.RAParticle.GetInternalFriction) - * [`RAParticle.GetJointDampingRatio()`](RAParticle.md#generated.RAParticle.GetJointDampingRatio) - * [`RAParticle.GetJointElasticRatio()`](RAParticle.md#generated.RAParticle.GetJointElasticRatio) - * [`RAParticle.GetJointThermalRatio()`](RAParticle.md#generated.RAParticle.GetJointThermalRatio) - * [`RAParticle.GetMaterial()`](RAParticle.md#generated.RAParticle.GetMaterial) - * [`RAParticle.GetMeshColoring()`](RAParticle.md#generated.RAParticle.GetMeshColoring) - * [`RAParticle.GetMinimumSize()`](RAParticle.md#generated.RAParticle.GetMinimumSize) - * [`RAParticle.GetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.GetMinimumSizeRatio) - * [`RAParticle.GetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.GetMinimumVolumeFractionForFragmentDisabling) - * [`RAParticle.GetModuleProperties()`](RAParticle.md#generated.RAParticle.GetModuleProperties) - * [`RAParticle.GetModuleProperty()`](RAParticle.md#generated.RAParticle.GetModuleProperty) - * [`RAParticle.GetNumberOfCells()`](RAParticle.md#generated.RAParticle.GetNumberOfCells) - * [`RAParticle.GetNumberOfCorners()`](RAParticle.md#generated.RAParticle.GetNumberOfCorners) - * [`RAParticle.GetNumberOfNodes()`](RAParticle.md#generated.RAParticle.GetNumberOfNodes) - * [`RAParticle.GetNumpyCurve()`](RAParticle.md#generated.RAParticle.GetNumpyCurve) - * [`RAParticle.GetOrientation()`](RAParticle.md#generated.RAParticle.GetOrientation) - * [`RAParticle.GetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngleAndVector) - * [`RAParticle.GetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngles) - * [`RAParticle.GetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromBasisVector) - * [`RAParticle.GetOutputVariableValue()`](RAParticle.md#generated.RAParticle.GetOutputVariableValue) - * [`RAParticle.GetPlasticLimit()`](RAParticle.md#generated.RAParticle.GetPlasticLimit) - * [`RAParticle.GetPlasticRatio()`](RAParticle.md#generated.RAParticle.GetPlasticRatio) - * [`RAParticle.GetPlasticityModel()`](RAParticle.md#generated.RAParticle.GetPlasticityModel) - * [`RAParticle.GetPorosity()`](RAParticle.md#generated.RAParticle.GetPorosity) - * [`RAParticle.GetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.GetPrincipalMomentOfInertia) - * [`RAParticle.GetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.GetRandomAnglesHalfRange) - * [`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) - * [`RAParticle.GetSideAngle()`](RAParticle.md#generated.RAParticle.GetSideAngle) - * [`RAParticle.GetSizeDistributionList()`](RAParticle.md#generated.RAParticle.GetSizeDistributionList) - * [`RAParticle.GetSizeType()`](RAParticle.md#generated.RAParticle.GetSizeType) - * [`RAParticle.GetSmoothness()`](RAParticle.md#generated.RAParticle.GetSmoothness) - * [`RAParticle.GetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.GetSuperquadricDegree) - * [`RAParticle.GetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.GetSurfaceEnergy) - * [`RAParticle.GetT10Formula()`](RAParticle.md#generated.RAParticle.GetT10Formula) - * [`RAParticle.GetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.GetTargetNumberOfElements) - * [`RAParticle.GetTavaresA()`](RAParticle.md#generated.RAParticle.GetTavaresA) - * [`RAParticle.GetTavaresB()`](RAParticle.md#generated.RAParticle.GetTavaresB) - * [`RAParticle.GetTavaresD0()`](RAParticle.md#generated.RAParticle.GetTavaresD0) - * [`RAParticle.GetTavaresEInf()`](RAParticle.md#generated.RAParticle.GetTavaresEInf) - * [`RAParticle.GetTavaresGamma()`](RAParticle.md#generated.RAParticle.GetTavaresGamma) - * [`RAParticle.GetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.GetTavaresMinimumEnergy) - * [`RAParticle.GetTavaresPhi()`](RAParticle.md#generated.RAParticle.GetTavaresPhi) - * [`RAParticle.GetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.GetTavaresRatioEmax) - * [`RAParticle.GetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.GetTavaresSigmaSquared) - * [`RAParticle.GetTensileStressLimit()`](RAParticle.md#generated.RAParticle.GetTensileStressLimit) - * [`RAParticle.GetThickness()`](RAParticle.md#generated.RAParticle.GetThickness) - * [`RAParticle.GetTimeSet()`](RAParticle.md#generated.RAParticle.GetTimeSet) - * [`RAParticle.GetTimeStatistics()`](RAParticle.md#generated.RAParticle.GetTimeStatistics) - * [`RAParticle.GetTimeStep()`](RAParticle.md#generated.RAParticle.GetTimeStep) - * [`RAParticle.GetTopologyShape()`](RAParticle.md#generated.RAParticle.GetTopologyShape) - * [`RAParticle.GetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.GetTorsionAngleLimit) - * [`RAParticle.GetUseMultipleElements()`](RAParticle.md#generated.RAParticle.GetUseMultipleElements) - * [`RAParticle.GetValidBreakageModelValues()`](RAParticle.md#generated.RAParticle.GetValidBreakageModelValues) - * [`RAParticle.GetValidDeformationModelValues()`](RAParticle.md#generated.RAParticle.GetValidDeformationModelValues) - * [`RAParticle.GetValidDistributionModelValues()`](RAParticle.md#generated.RAParticle.GetValidDistributionModelValues) - * [`RAParticle.GetValidElasticityValues()`](RAParticle.md#generated.RAParticle.GetValidElasticityValues) - * [`RAParticle.GetValidOptionsForModuleProperty()`](RAParticle.md#generated.RAParticle.GetValidOptionsForModuleProperty) - * [`RAParticle.GetValidPlasticityModelValues()`](RAParticle.md#generated.RAParticle.GetValidPlasticityModelValues) - * [`RAParticle.GetValidShapeValues()`](RAParticle.md#generated.RAParticle.GetValidShapeValues) - * [`RAParticle.GetValidSizeTypeValues()`](RAParticle.md#generated.RAParticle.GetValidSizeTypeValues) - * [`RAParticle.GetValidT10FormulaValues()`](RAParticle.md#generated.RAParticle.GetValidT10FormulaValues) - * [`RAParticle.GetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.GetVerticalAspectRatio) - * [`RAParticle.GetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.GetVonMisesStressLimit) - * [`RAParticle.GetWithFailure()`](RAParticle.md#generated.RAParticle.GetWithFailure) - * [`RAParticle.GetXDirection()`](RAParticle.md#generated.RAParticle.GetXDirection) - * [`RAParticle.GetYDirection()`](RAParticle.md#generated.RAParticle.GetYDirection) - * [`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) - * [`RAParticle.IsConcave()`](RAParticle.md#generated.RAParticle.IsConcave) - * [`RAParticle.IsIncludeRotationalDeformationsEnabled()`](RAParticle.md#generated.RAParticle.IsIncludeRotationalDeformationsEnabled) - * [`RAParticle.IsRandomOrientationEnabled()`](RAParticle.md#generated.RAParticle.IsRandomOrientationEnabled) - * [`RAParticle.IterCellVertices()`](RAParticle.md#generated.RAParticle.IterCellVertices) - * [`RAParticle.IterCells()`](RAParticle.md#generated.RAParticle.IterCells) - * [`RAParticle.Modified()`](RAParticle.md#generated.RAParticle.Modified) - * [`RAParticle.RemoveCustomCurve()`](RAParticle.md#generated.RAParticle.RemoveCustomCurve) - * [`RAParticle.RemoveCustomProperty()`](RAParticle.md#generated.RAParticle.RemoveCustomProperty) - * [`RAParticle.RemoveOutputVariable()`](RAParticle.md#generated.RAParticle.RemoveOutputVariable) - * [`RAParticle.RemoveProcess()`](RAParticle.md#generated.RAParticle.RemoveProcess) - * [`RAParticle.SetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.SetAbt10MaximumT10Value) - * [`RAParticle.SetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10MinimumSpecificEnergy) - * [`RAParticle.SetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) - * [`RAParticle.SetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceSize) - * [`RAParticle.SetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.SetAbt10SelectFunctionCoefficient) - * [`RAParticle.SetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.SetAllowSelfContacts) - * [`RAParticle.SetAnisotropic()`](RAParticle.md#generated.RAParticle.SetAnisotropic) - * [`RAParticle.SetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.SetBendingAngleLimit) - * [`RAParticle.SetBreakageModel()`](RAParticle.md#generated.RAParticle.SetBreakageModel) - * [`RAParticle.SetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.SetCenterOfMassOffset) - * [`RAParticle.SetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.SetCgmScaleFactor) - * [`RAParticle.SetChangeMassProperties()`](RAParticle.md#generated.RAParticle.SetChangeMassProperties) - * [`RAParticle.SetCurrentTimeStep()`](RAParticle.md#generated.RAParticle.SetCurrentTimeStep) - * [`RAParticle.SetDeformationModel()`](RAParticle.md#generated.RAParticle.SetDeformationModel) - * [`RAParticle.SetDistributionModel()`](RAParticle.md#generated.RAParticle.SetDistributionModel) - * [`RAParticle.SetEdgeAngle()`](RAParticle.md#generated.RAParticle.SetEdgeAngle) - * [`RAParticle.SetElasticRatioBending()`](RAParticle.md#generated.RAParticle.SetElasticRatioBending) - * [`RAParticle.SetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.SetElasticRatioNormal) - * [`RAParticle.SetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.SetElasticRatioTangential) - * [`RAParticle.SetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.SetElasticRatioTorsion) - * [`RAParticle.SetElasticity()`](RAParticle.md#generated.RAParticle.SetElasticity) - * [`RAParticle.SetElementDampingRatio()`](RAParticle.md#generated.RAParticle.SetElementDampingRatio) - * [`RAParticle.SetEnableBreakage()`](RAParticle.md#generated.RAParticle.SetEnableBreakage) - * [`RAParticle.SetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.SetEnableRandomAngle) - * [`RAParticle.SetEnableRotations()`](RAParticle.md#generated.RAParticle.SetEnableRotations) - * [`RAParticle.SetFailureRatio()`](RAParticle.md#generated.RAParticle.SetFailureRatio) - * [`RAParticle.SetFlexible()`](RAParticle.md#generated.RAParticle.SetFlexible) - * [`RAParticle.SetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.SetHorizontalAspectRatio) - * [`RAParticle.SetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.SetIncludeRotationalDeformations) - * [`RAParticle.SetInternalFriction()`](RAParticle.md#generated.RAParticle.SetInternalFriction) - * [`RAParticle.SetJointDampingRatio()`](RAParticle.md#generated.RAParticle.SetJointDampingRatio) - * [`RAParticle.SetJointElasticRatio()`](RAParticle.md#generated.RAParticle.SetJointElasticRatio) - * [`RAParticle.SetJointThermalRatio()`](RAParticle.md#generated.RAParticle.SetJointThermalRatio) - * [`RAParticle.SetMaterial()`](RAParticle.md#generated.RAParticle.SetMaterial) - * [`RAParticle.SetMinimumSize()`](RAParticle.md#generated.RAParticle.SetMinimumSize) - * [`RAParticle.SetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.SetMinimumSizeRatio) - * [`RAParticle.SetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.SetMinimumVolumeFractionForFragmentDisabling) - * [`RAParticle.SetModuleProperty()`](RAParticle.md#generated.RAParticle.SetModuleProperty) - * [`RAParticle.SetNumberOfCorners()`](RAParticle.md#generated.RAParticle.SetNumberOfCorners) - * [`RAParticle.SetOrientation()`](RAParticle.md#generated.RAParticle.SetOrientation) - * [`RAParticle.SetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngleAndVector) - * [`RAParticle.SetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngles) - * [`RAParticle.SetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromBasisVector) - * [`RAParticle.SetPlasticLimit()`](RAParticle.md#generated.RAParticle.SetPlasticLimit) - * [`RAParticle.SetPlasticRatio()`](RAParticle.md#generated.RAParticle.SetPlasticRatio) - * [`RAParticle.SetPlasticityModel()`](RAParticle.md#generated.RAParticle.SetPlasticityModel) - * [`RAParticle.SetPorosity()`](RAParticle.md#generated.RAParticle.SetPorosity) - * [`RAParticle.SetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.SetPrincipalMomentOfInertia) - * [`RAParticle.SetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.SetRandomAnglesHalfRange) - * [`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) - * [`RAParticle.SetSideAngle()`](RAParticle.md#generated.RAParticle.SetSideAngle) - * [`RAParticle.SetSizeType()`](RAParticle.md#generated.RAParticle.SetSizeType) - * [`RAParticle.SetSmoothness()`](RAParticle.md#generated.RAParticle.SetSmoothness) - * [`RAParticle.SetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.SetSuperquadricDegree) - * [`RAParticle.SetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.SetSurfaceEnergy) - * [`RAParticle.SetT10Formula()`](RAParticle.md#generated.RAParticle.SetT10Formula) - * [`RAParticle.SetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.SetTargetNumberOfElements) - * [`RAParticle.SetTavaresA()`](RAParticle.md#generated.RAParticle.SetTavaresA) - * [`RAParticle.SetTavaresB()`](RAParticle.md#generated.RAParticle.SetTavaresB) - * [`RAParticle.SetTavaresD0()`](RAParticle.md#generated.RAParticle.SetTavaresD0) - * [`RAParticle.SetTavaresEInf()`](RAParticle.md#generated.RAParticle.SetTavaresEInf) - * [`RAParticle.SetTavaresGamma()`](RAParticle.md#generated.RAParticle.SetTavaresGamma) - * [`RAParticle.SetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.SetTavaresMinimumEnergy) - * [`RAParticle.SetTavaresPhi()`](RAParticle.md#generated.RAParticle.SetTavaresPhi) - * [`RAParticle.SetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.SetTavaresRatioEmax) - * [`RAParticle.SetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.SetTavaresSigmaSquared) - * [`RAParticle.SetTensileStressLimit()`](RAParticle.md#generated.RAParticle.SetTensileStressLimit) - * [`RAParticle.SetThickness()`](RAParticle.md#generated.RAParticle.SetThickness) - * [`RAParticle.SetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.SetTorsionAngleLimit) - * [`RAParticle.SetUseMultipleElements()`](RAParticle.md#generated.RAParticle.SetUseMultipleElements) - * [`RAParticle.SetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.SetVerticalAspectRatio) - * [`RAParticle.SetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.SetVonMisesStressLimit) - * [`RAParticle.SetWithFailure()`](RAParticle.md#generated.RAParticle.SetWithFailure) - * [`RAParticle.SetXDirection()`](RAParticle.md#generated.RAParticle.SetXDirection) - * [`RAParticle.SetYDirection()`](RAParticle.md#generated.RAParticle.SetYDirection) - * [`RAParticle.SetZDirection()`](RAParticle.md#generated.RAParticle.SetZDirection) -* [RAParticleAssemblyPart](RAParticleAssemblyPart.md) - * [`RAParticleAssemblyPart`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart) - * [`RAParticleAssemblyPart.GetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAngle) - * [`RAParticleAssemblyPart.GetAvailableParticles()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAvailableParticles) - * [`RAParticleAssemblyPart.GetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetParticle) - * [`RAParticleAssemblyPart.GetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionX) - * [`RAParticleAssemblyPart.GetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionY) - * [`RAParticleAssemblyPart.GetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionZ) - * [`RAParticleAssemblyPart.GetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationX) - * [`RAParticleAssemblyPart.GetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationY) - * [`RAParticleAssemblyPart.GetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationZ) - * [`RAParticleAssemblyPart.GetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetScale) - * [`RAParticleAssemblyPart.SetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetAngle) - * [`RAParticleAssemblyPart.SetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetParticle) - * [`RAParticleAssemblyPart.SetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionX) - * [`RAParticleAssemblyPart.SetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionY) - * [`RAParticleAssemblyPart.SetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionZ) - * [`RAParticleAssemblyPart.SetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationX) - * [`RAParticleAssemblyPart.SetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationY) - * [`RAParticleAssemblyPart.SetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationZ) - * [`RAParticleAssemblyPart.SetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetScale) -* [RAParticleAssemblyPartList](RAParticleAssemblyPartList.md) - * [`RAParticleAssemblyPartList`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList) - * [`RAParticleAssemblyPartList.Clear()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Clear) - * [`RAParticleAssemblyPartList.New()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.New) - * [`RAParticleAssemblyPartList.Remove()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Remove) -* [RAParticleCollection](RAParticleCollection.md) - * [`RAParticleCollection`](RAParticleCollection.md#generated.RAParticleCollection) - * [`RAParticleCollection.Clear()`](RAParticleCollection.md#generated.RAParticleCollection.Clear) - * [`RAParticleCollection.GetParticle()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticle) - * [`RAParticleCollection.GetParticleNames()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticleNames) - * [`RAParticleCollection.New()`](RAParticleCollection.md#generated.RAParticleCollection.New) - * [`RAParticleCollection.Remove()`](RAParticleCollection.md#generated.RAParticleCollection.Remove) -* [RAParticleInlet](RAParticleInlet.md) - * [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) - * [`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.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) - * [`RAParticleInlet.SetStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopAllAtStopTime) - * [`RAParticleInlet.SetStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopTime) - * [`RAParticleInlet.SetTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetTargetNormalVelocity) - * [`RAParticleInlet.SetUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetUseTargetNormalVelocity) - * [`RAParticleInlet.SetUxLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUxLocal) - * [`RAParticleInlet.SetUzLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUzLocal) -* [RAParticleInletProperties](RAParticleInletProperties.md) - * [`RAParticleInletProperties`](RAParticleInletProperties.md#generated.RAParticleInletProperties) - * [`RAParticleInletProperties.GetAvailableParticles()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetAvailableParticles) - * [`RAParticleInletProperties.GetMassFlowRate()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetMassFlowRate) - * [`RAParticleInletProperties.GetModuleProperties()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetModuleProperties) - * [`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) - * [`RAParticleInletPropertiesList.New()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.New) - * [`RAParticleInletPropertiesList.Remove()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.Remove) -* [RAParticleJointsData](RAParticleJointsData.md) - * [`RAParticleJointsData`](RAParticleJointsData.md#generated.RAParticleJointsData) - * [`RAParticleJointsData.AddCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCurve) - * [`RAParticleJointsData.AddCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomCurve) - * [`RAParticleJointsData.AddCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomProperty) - * [`RAParticleJointsData.AddGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddGridFunction) - * [`RAParticleJointsData.CreateCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateCurveOutputVariable) - * [`RAParticleJointsData.CreateGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunction) - * [`RAParticleJointsData.CreateGridFunctionArrayOnCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionArrayOnCells) - * [`RAParticleJointsData.CreateGridFunctionStatisticOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionStatisticOutputVariable) - * [`RAParticleJointsData.CreateTransientCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateTransientCurveOutputVariable) - * [`RAParticleJointsData.DisableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.DisableCollectJointData) - * [`RAParticleJointsData.EditCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomCurve) - * [`RAParticleJointsData.EditCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomProperty) - * [`RAParticleJointsData.EnableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.EnableCollectJointData) - * [`RAParticleJointsData.GetActivesArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetActivesArray) - * [`RAParticleJointsData.GetBoundingBox()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetBoundingBox) - * [`RAParticleJointsData.GetCellAreaAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellAreaAsArray) - * [`RAParticleJointsData.GetCellCenterAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellCenterAsArray) - * [`RAParticleJointsData.GetCellDzAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellDzAsArray) - * [`RAParticleJointsData.GetCellFromIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellFromIJK) - * [`RAParticleJointsData.GetCellIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellIJK) - * [`RAParticleJointsData.GetCellNumberOfVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellNumberOfVertices) - * [`RAParticleJointsData.GetCellPointsAsFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellPointsAsFunction) - * [`RAParticleJointsData.GetCellVolumeAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellVolumeAsArray) - * [`RAParticleJointsData.GetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCollectJointData) - * [`RAParticleJointsData.GetCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurve) - * [`RAParticleJointsData.GetCurveNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNames) - * [`RAParticleJointsData.GetCurveNamesAssociation()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNamesAssociation) - * [`RAParticleJointsData.GetElementCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetElementCurve) - * [`RAParticleJointsData.GetGeometryQuantity()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryQuantity) - * [`RAParticleJointsData.GetGeometryUnit()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryUnit) - * [`RAParticleJointsData.GetGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunction) - * [`RAParticleJointsData.GetGridFunctionNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunctionNames) - * [`RAParticleJointsData.GetMeshColoring()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetMeshColoring) - * [`RAParticleJointsData.GetNumberOfCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfCells) - * [`RAParticleJointsData.GetNumberOfNodes()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfNodes) - * [`RAParticleJointsData.GetNumpyCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumpyCurve) - * [`RAParticleJointsData.GetOutputVariableValue()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetOutputVariableValue) - * [`RAParticleJointsData.GetTimeSet()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeSet) - * [`RAParticleJointsData.GetTimeStatistics()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStatistics) - * [`RAParticleJointsData.GetTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStep) - * [`RAParticleJointsData.GetTopologyShape()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTopologyShape) - * [`RAParticleJointsData.HasGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.HasGridFunction) - * [`RAParticleJointsData.IsCellActive()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCellActive) - * [`RAParticleJointsData.IsCollectJointDataEnabled()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCollectJointDataEnabled) - * [`RAParticleJointsData.IterCellVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCellVertices) - * [`RAParticleJointsData.IterCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCells) - * [`RAParticleJointsData.Modified()`](RAParticleJointsData.md#generated.RAParticleJointsData.Modified) - * [`RAParticleJointsData.RemoveCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomCurve) - * [`RAParticleJointsData.RemoveCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomProperty) - * [`RAParticleJointsData.RemoveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveOutputVariable) - * [`RAParticleJointsData.RemoveProcess()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveProcess) - * [`RAParticleJointsData.SetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCollectJointData) - * [`RAParticleJointsData.SetCurrentTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCurrentTimeStep) -* [RAParticleTimeSelectionProcess](RAParticleTimeSelectionProcess.md) - * [`RAParticleTimeSelectionProcess`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess) - * [`RAParticleTimeSelectionProcess.AddCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCurve) - * [`RAParticleTimeSelectionProcess.AddCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomCurve) - * [`RAParticleTimeSelectionProcess.AddCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomProperty) - * [`RAParticleTimeSelectionProcess.AddGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddGridFunction) - * [`RAParticleTimeSelectionProcess.CreateCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateCurveOutputVariable) - * [`RAParticleTimeSelectionProcess.CreateGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunction) - * [`RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells) - * [`RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable) - * [`RAParticleTimeSelectionProcess.EditCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomCurve) - * [`RAParticleTimeSelectionProcess.EditCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomProperty) - * [`RAParticleTimeSelectionProcess.GetActivesArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetActivesArray) - * [`RAParticleTimeSelectionProcess.GetBoundingBox()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetBoundingBox) - * [`RAParticleTimeSelectionProcess.GetCellAreaAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellAreaAsArray) - * [`RAParticleTimeSelectionProcess.GetCellCenterAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellCenterAsArray) - * [`RAParticleTimeSelectionProcess.GetCellDzAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellDzAsArray) - * [`RAParticleTimeSelectionProcess.GetCellFromIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellFromIJK) - * [`RAParticleTimeSelectionProcess.GetCellIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellIJK) - * [`RAParticleTimeSelectionProcess.GetCellNumberOfVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellNumberOfVertices) - * [`RAParticleTimeSelectionProcess.GetCellPointsAsFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellPointsAsFunction) - * [`RAParticleTimeSelectionProcess.GetCellVolumeAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellVolumeAsArray) - * [`RAParticleTimeSelectionProcess.GetCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurve) - * [`RAParticleTimeSelectionProcess.GetCurveNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNames) - * [`RAParticleTimeSelectionProcess.GetCurveNamesAssociation()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation) - * [`RAParticleTimeSelectionProcess.GetElementCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetElementCurve) - * [`RAParticleTimeSelectionProcess.GetGeometryQuantity()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity) - * [`RAParticleTimeSelectionProcess.GetGeometryUnit()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryUnit) - * [`RAParticleTimeSelectionProcess.GetGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunction) - * [`RAParticleTimeSelectionProcess.GetGridFunctionNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames) - * [`RAParticleTimeSelectionProcess.GetMeshColoring()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetMeshColoring) - * [`RAParticleTimeSelectionProcess.GetNumberOfCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfCells) - * [`RAParticleTimeSelectionProcess.GetNumberOfNodes()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfNodes) - * [`RAParticleTimeSelectionProcess.GetNumberOfParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfParticles) - * [`RAParticleTimeSelectionProcess.GetNumpyCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumpyCurve) - * [`RAParticleTimeSelectionProcess.GetOutputVariableValue()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetOutputVariableValue) - * [`RAParticleTimeSelectionProcess.GetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeRange) - * [`RAParticleTimeSelectionProcess.GetTimeSet()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeSet) - * [`RAParticleTimeSelectionProcess.GetTimeStatistics()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStatistics) - * [`RAParticleTimeSelectionProcess.GetTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStep) - * [`RAParticleTimeSelectionProcess.GetTopologyShape()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTopologyShape) - * [`RAParticleTimeSelectionProcess.HasGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.HasGridFunction) - * [`RAParticleTimeSelectionProcess.IsCellActive()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IsCellActive) - * [`RAParticleTimeSelectionProcess.IterCellVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCellVertices) - * [`RAParticleTimeSelectionProcess.IterCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCells) - * [`RAParticleTimeSelectionProcess.IterParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterParticles) - * [`RAParticleTimeSelectionProcess.Modified()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.Modified) - * [`RAParticleTimeSelectionProcess.RemoveCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomCurve) - * [`RAParticleTimeSelectionProcess.RemoveCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomProperty) - * [`RAParticleTimeSelectionProcess.RemoveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveOutputVariable) - * [`RAParticleTimeSelectionProcess.RemoveProcess()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveProcess) - * [`RAParticleTimeSelectionProcess.SetAbsoluteTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetAbsoluteTimeRange) - * [`RAParticleTimeSelectionProcess.SetCurrentTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetCurrentTimeStep) - * [`RAParticleTimeSelectionProcess.SetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetTimeRange) -* [RAParticleToContactProcess](RAParticleToContactProcess.md) - * [`RAParticleToContactProcess`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess) - * [`RAParticleToContactProcess.AddCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCurve) - * [`RAParticleToContactProcess.AddCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomCurve) - * [`RAParticleToContactProcess.AddCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomProperty) - * [`RAParticleToContactProcess.AddGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddGridFunction) - * [`RAParticleToContactProcess.CreateCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateCurveOutputVariable) - * [`RAParticleToContactProcess.CreateGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunction) - * [`RAParticleToContactProcess.CreateGridFunctionArrayOnCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionArrayOnCells) - * [`RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAParticleToContactProcess.CreateTransientCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateTransientCurveOutputVariable) - * [`RAParticleToContactProcess.EditCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomCurve) - * [`RAParticleToContactProcess.EditCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomProperty) - * [`RAParticleToContactProcess.GetActivesArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetActivesArray) - * [`RAParticleToContactProcess.GetBoundingBox()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetBoundingBox) - * [`RAParticleToContactProcess.GetCellAreaAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellAreaAsArray) - * [`RAParticleToContactProcess.GetCellCenterAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellCenterAsArray) - * [`RAParticleToContactProcess.GetCellDzAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellDzAsArray) - * [`RAParticleToContactProcess.GetCellFromIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellFromIJK) - * [`RAParticleToContactProcess.GetCellIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellIJK) - * [`RAParticleToContactProcess.GetCellNumberOfVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellNumberOfVertices) - * [`RAParticleToContactProcess.GetCellPointsAsFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellPointsAsFunction) - * [`RAParticleToContactProcess.GetCellVolumeAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellVolumeAsArray) - * [`RAParticleToContactProcess.GetCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurve) - * [`RAParticleToContactProcess.GetCurveNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNames) - * [`RAParticleToContactProcess.GetCurveNamesAssociation()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNamesAssociation) - * [`RAParticleToContactProcess.GetElementCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetElementCurve) - * [`RAParticleToContactProcess.GetGeometryQuantity()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryQuantity) - * [`RAParticleToContactProcess.GetGeometryUnit()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryUnit) - * [`RAParticleToContactProcess.GetGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunction) - * [`RAParticleToContactProcess.GetGridFunctionNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunctionNames) - * [`RAParticleToContactProcess.GetMeshColoring()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetMeshColoring) - * [`RAParticleToContactProcess.GetNumberOfCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfCells) - * [`RAParticleToContactProcess.GetNumberOfNodes()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfNodes) - * [`RAParticleToContactProcess.GetNumberOfParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfParticles) - * [`RAParticleToContactProcess.GetNumpyCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumpyCurve) - * [`RAParticleToContactProcess.GetOutputVariableValue()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetOutputVariableValue) - * [`RAParticleToContactProcess.GetTimeSet()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeSet) - * [`RAParticleToContactProcess.GetTimeStatistics()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStatistics) - * [`RAParticleToContactProcess.GetTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStep) - * [`RAParticleToContactProcess.GetTopologyShape()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTopologyShape) - * [`RAParticleToContactProcess.HasGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.HasGridFunction) - * [`RAParticleToContactProcess.IsCellActive()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IsCellActive) - * [`RAParticleToContactProcess.IterCellVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCellVertices) - * [`RAParticleToContactProcess.IterCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCells) - * [`RAParticleToContactProcess.IterParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterParticles) - * [`RAParticleToContactProcess.Modified()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.Modified) - * [`RAParticleToContactProcess.RemoveCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomCurve) - * [`RAParticleToContactProcess.RemoveCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomProperty) - * [`RAParticleToContactProcess.RemoveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveOutputVariable) - * [`RAParticleToContactProcess.RemoveProcess()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveProcess) - * [`RAParticleToContactProcess.SetCurrentTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.SetCurrentTimeStep) -* [RAParticles](RAParticles.md) - * [`RAParticles`](RAParticles.md#generated.RAParticles) - * [`RAParticles.AddCurve()`](RAParticles.md#generated.RAParticles.AddCurve) - * [`RAParticles.AddCustomCurve()`](RAParticles.md#generated.RAParticles.AddCustomCurve) - * [`RAParticles.AddCustomProperty()`](RAParticles.md#generated.RAParticles.AddCustomProperty) - * [`RAParticles.AddGridFunction()`](RAParticles.md#generated.RAParticles.AddGridFunction) - * [`RAParticles.CreateCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateCurveOutputVariable) - * [`RAParticles.CreateGridFunction()`](RAParticles.md#generated.RAParticles.CreateGridFunction) - * [`RAParticles.CreateGridFunctionArrayOnCells()`](RAParticles.md#generated.RAParticles.CreateGridFunctionArrayOnCells) - * [`RAParticles.CreateGridFunctionStatisticOutputVariable()`](RAParticles.md#generated.RAParticles.CreateGridFunctionStatisticOutputVariable) - * [`RAParticles.CreateTransientCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateTransientCurveOutputVariable) - * [`RAParticles.EditCustomCurve()`](RAParticles.md#generated.RAParticles.EditCustomCurve) - * [`RAParticles.EditCustomProperty()`](RAParticles.md#generated.RAParticles.EditCustomProperty) - * [`RAParticles.GetActivesArray()`](RAParticles.md#generated.RAParticles.GetActivesArray) - * [`RAParticles.GetBoundingBox()`](RAParticles.md#generated.RAParticles.GetBoundingBox) - * [`RAParticles.GetCellAreaAsArray()`](RAParticles.md#generated.RAParticles.GetCellAreaAsArray) - * [`RAParticles.GetCellCenterAsArray()`](RAParticles.md#generated.RAParticles.GetCellCenterAsArray) - * [`RAParticles.GetCellDzAsArray()`](RAParticles.md#generated.RAParticles.GetCellDzAsArray) - * [`RAParticles.GetCellFromIJK()`](RAParticles.md#generated.RAParticles.GetCellFromIJK) - * [`RAParticles.GetCellIJK()`](RAParticles.md#generated.RAParticles.GetCellIJK) - * [`RAParticles.GetCellNumberOfVertices()`](RAParticles.md#generated.RAParticles.GetCellNumberOfVertices) - * [`RAParticles.GetCellPointsAsFunction()`](RAParticles.md#generated.RAParticles.GetCellPointsAsFunction) - * [`RAParticles.GetCellVolumeAsArray()`](RAParticles.md#generated.RAParticles.GetCellVolumeAsArray) - * [`RAParticles.GetCurve()`](RAParticles.md#generated.RAParticles.GetCurve) - * [`RAParticles.GetCurveNames()`](RAParticles.md#generated.RAParticles.GetCurveNames) - * [`RAParticles.GetCurveNamesAssociation()`](RAParticles.md#generated.RAParticles.GetCurveNamesAssociation) - * [`RAParticles.GetElementCurve()`](RAParticles.md#generated.RAParticles.GetElementCurve) - * [`RAParticles.GetGeometryQuantity()`](RAParticles.md#generated.RAParticles.GetGeometryQuantity) - * [`RAParticles.GetGeometryUnit()`](RAParticles.md#generated.RAParticles.GetGeometryUnit) - * [`RAParticles.GetGridFunction()`](RAParticles.md#generated.RAParticles.GetGridFunction) - * [`RAParticles.GetGridFunctionNames()`](RAParticles.md#generated.RAParticles.GetGridFunctionNames) - * [`RAParticles.GetMeshColoring()`](RAParticles.md#generated.RAParticles.GetMeshColoring) - * [`RAParticles.GetNumberOfCells()`](RAParticles.md#generated.RAParticles.GetNumberOfCells) - * [`RAParticles.GetNumberOfNodes()`](RAParticles.md#generated.RAParticles.GetNumberOfNodes) - * [`RAParticles.GetNumberOfParticles()`](RAParticles.md#generated.RAParticles.GetNumberOfParticles) - * [`RAParticles.GetNumpyCurve()`](RAParticles.md#generated.RAParticles.GetNumpyCurve) - * [`RAParticles.GetOutputVariableValue()`](RAParticles.md#generated.RAParticles.GetOutputVariableValue) - * [`RAParticles.GetTimeSet()`](RAParticles.md#generated.RAParticles.GetTimeSet) - * [`RAParticles.GetTimeStatistics()`](RAParticles.md#generated.RAParticles.GetTimeStatistics) - * [`RAParticles.GetTimeStep()`](RAParticles.md#generated.RAParticles.GetTimeStep) - * [`RAParticles.GetTopologyShape()`](RAParticles.md#generated.RAParticles.GetTopologyShape) - * [`RAParticles.HasGridFunction()`](RAParticles.md#generated.RAParticles.HasGridFunction) - * [`RAParticles.IsCellActive()`](RAParticles.md#generated.RAParticles.IsCellActive) - * [`RAParticles.IterCellVertices()`](RAParticles.md#generated.RAParticles.IterCellVertices) - * [`RAParticles.IterCells()`](RAParticles.md#generated.RAParticles.IterCells) - * [`RAParticles.IterParticles()`](RAParticles.md#generated.RAParticles.IterParticles) - * [`RAParticles.Modified()`](RAParticles.md#generated.RAParticles.Modified) - * [`RAParticles.RemoveCustomCurve()`](RAParticles.md#generated.RAParticles.RemoveCustomCurve) - * [`RAParticles.RemoveCustomProperty()`](RAParticles.md#generated.RAParticles.RemoveCustomProperty) - * [`RAParticles.RemoveOutputVariable()`](RAParticles.md#generated.RAParticles.RemoveOutputVariable) - * [`RAParticles.RemoveProcess()`](RAParticles.md#generated.RAParticles.RemoveProcess) - * [`RAParticles.SetCurrentTimeStep()`](RAParticles.md#generated.RAParticles.SetCurrentTimeStep) -* [RAPendulum](RAPendulum.md) - * [`RAPendulum`](RAPendulum.md#generated.RAPendulum) - * [`RAPendulum.GetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.GetAmplitudeVariation) - * [`RAPendulum.GetDirection()`](RAPendulum.md#generated.RAPendulum.GetDirection) - * [`RAPendulum.GetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.GetFrequencyVariation) - * [`RAPendulum.GetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.GetInitialAmplitude) - * [`RAPendulum.GetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.GetInitialFrequency) - * [`RAPendulum.GetInitialPhase()`](RAPendulum.md#generated.RAPendulum.GetInitialPhase) - * [`RAPendulum.SetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.SetAmplitudeVariation) - * [`RAPendulum.SetDirection()`](RAPendulum.md#generated.RAPendulum.SetDirection) - * [`RAPendulum.SetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.SetFrequencyVariation) - * [`RAPendulum.SetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.SetInitialAmplitude) - * [`RAPendulum.SetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.SetInitialFrequency) - * [`RAPendulum.SetInitialPhase()`](RAPendulum.md#generated.RAPendulum.SetInitialPhase) -* [RAPhysics](RAPhysics.md) - * [`RAPhysics`](RAPhysics.md#generated.RAPhysics) - * [`RAPhysics.GetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.GetAdhesionModel) - * [`RAPhysics.GetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.GetClosePackingVolumeFraction) - * [`RAPhysics.GetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.GetEnableCoarseGrainModeling) - * [`RAPhysics.GetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.GetEnableThermalModel) - * [`RAPhysics.GetExponentLimit()`](RAPhysics.md#generated.RAPhysics.GetExponentLimit) - * [`RAPhysics.GetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStartTime) - * [`RAPhysics.GetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStopTime) - * [`RAPhysics.GetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityXDirection) - * [`RAPhysics.GetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityYDirection) - * [`RAPhysics.GetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityZDirection) - * [`RAPhysics.GetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.GetImpactEnergyModel) - * [`RAPhysics.GetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.GetNormalForceModel) - * [`RAPhysics.GetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.GetNumericalSofteningFactor) - * [`RAPhysics.GetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.GetRestitutionModel) - * [`RAPhysics.GetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.GetRollingResistanceModel) - * [`RAPhysics.GetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetSearchDistanceMultiplier) - * [`RAPhysics.GetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.GetSphThermalTransferModel) - * [`RAPhysics.GetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.GetTangentialForceModel) - * [`RAPhysics.GetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.GetThermalCorrectionModel) - * [`RAPhysics.GetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetUpdateDistanceMultiplier) - * [`RAPhysics.GetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.GetUseRadlEtAl) - * [`RAPhysics.GetValidAdhesionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidAdhesionModelValues) - * [`RAPhysics.GetValidImpactEnergyModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidImpactEnergyModelValues) - * [`RAPhysics.GetValidNormalForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidNormalForceModelValues) - * [`RAPhysics.GetValidRestitutionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRestitutionModelValues) - * [`RAPhysics.GetValidRollingResistanceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRollingResistanceModelValues) - * [`RAPhysics.GetValidSphThermalTransferModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidSphThermalTransferModelValues) - * [`RAPhysics.GetValidTangentialForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidTangentialForceModelValues) - * [`RAPhysics.GetValidThermalCorrectionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidThermalCorrectionModelValues) - * [`RAPhysics.GetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.GetVolumeFractionLimit) - * [`RAPhysics.SetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.SetAdhesionModel) - * [`RAPhysics.SetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.SetClosePackingVolumeFraction) - * [`RAPhysics.SetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.SetEnableCoarseGrainModeling) - * [`RAPhysics.SetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.SetEnableThermalModel) - * [`RAPhysics.SetExponentLimit()`](RAPhysics.md#generated.RAPhysics.SetExponentLimit) - * [`RAPhysics.SetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStartTime) - * [`RAPhysics.SetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStopTime) - * [`RAPhysics.SetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityXDirection) - * [`RAPhysics.SetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityYDirection) - * [`RAPhysics.SetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityZDirection) - * [`RAPhysics.SetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.SetImpactEnergyModel) - * [`RAPhysics.SetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.SetNormalForceModel) - * [`RAPhysics.SetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.SetNumericalSofteningFactor) - * [`RAPhysics.SetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.SetRestitutionModel) - * [`RAPhysics.SetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.SetRollingResistanceModel) - * [`RAPhysics.SetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetSearchDistanceMultiplier) - * [`RAPhysics.SetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.SetSphThermalTransferModel) - * [`RAPhysics.SetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.SetTangentialForceModel) - * [`RAPhysics.SetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.SetThermalCorrectionModel) - * [`RAPhysics.SetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetUpdateDistanceMultiplier) - * [`RAPhysics.SetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.SetUseRadlEtAl) - * [`RAPhysics.SetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.SetVolumeFractionLimit) -* [RAPlaneProcess](RAPlaneProcess.md) - * [`RAPlaneProcess`](RAPlaneProcess.md#generated.RAPlaneProcess) - * [`RAPlaneProcess.AddCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCurve) - * [`RAPlaneProcess.AddCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomCurve) - * [`RAPlaneProcess.AddCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomProperty) - * [`RAPlaneProcess.AddGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddGridFunction) - * [`RAPlaneProcess.CreateCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateCurveOutputVariable) - * [`RAPlaneProcess.CreateGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunction) - * [`RAPlaneProcess.CreateGridFunctionArrayOnCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionArrayOnCells) - * [`RAPlaneProcess.CreateGridFunctionStatisticOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAPlaneProcess.CreateTransientCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateTransientCurveOutputVariable) - * [`RAPlaneProcess.EditCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomCurve) - * [`RAPlaneProcess.EditCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomProperty) - * [`RAPlaneProcess.GetActivesArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetActivesArray) - * [`RAPlaneProcess.GetBoundingBox()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetBoundingBox) - * [`RAPlaneProcess.GetCellAreaAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellAreaAsArray) - * [`RAPlaneProcess.GetCellCenterAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellCenterAsArray) - * [`RAPlaneProcess.GetCellDzAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellDzAsArray) - * [`RAPlaneProcess.GetCellFromIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellFromIJK) - * [`RAPlaneProcess.GetCellIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellIJK) - * [`RAPlaneProcess.GetCellNumberOfVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellNumberOfVertices) - * [`RAPlaneProcess.GetCellPointsAsFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellPointsAsFunction) - * [`RAPlaneProcess.GetCellVolumeAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellVolumeAsArray) - * [`RAPlaneProcess.GetCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurve) - * [`RAPlaneProcess.GetCurveNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNames) - * [`RAPlaneProcess.GetCurveNamesAssociation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNamesAssociation) - * [`RAPlaneProcess.GetElementCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetElementCurve) - * [`RAPlaneProcess.GetGeometryQuantity()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryQuantity) - * [`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) - * [`RAPlaneProcess.GetNumpyCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumpyCurve) - * [`RAPlaneProcess.GetOrientation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientation) - * [`RAPlaneProcess.GetOrientationFromAngleAndVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngleAndVector) - * [`RAPlaneProcess.GetOrientationFromAngles()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngles) - * [`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.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.HasGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.HasGridFunction) - * [`RAPlaneProcess.IsCellActive()`](RAPlaneProcess.md#generated.RAPlaneProcess.IsCellActive) - * [`RAPlaneProcess.IterCellVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCellVertices) - * [`RAPlaneProcess.IterCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCells) - * [`RAPlaneProcess.IterParticles()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterParticles) - * [`RAPlaneProcess.Modified()`](RAPlaneProcess.md#generated.RAPlaneProcess.Modified) - * [`RAPlaneProcess.RemoveCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomCurve) - * [`RAPlaneProcess.RemoveCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomProperty) - * [`RAPlaneProcess.RemoveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveOutputVariable) - * [`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.SetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetType) -* [RAPointCloud](RAPointCloud.md) - * [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud) - * [`RAPointCloud.AddCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCurve) - * [`RAPointCloud.AddCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCustomCurve) - * [`RAPointCloud.AddCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.AddCustomProperty) - * [`RAPointCloud.AddGridFunction()`](RAPointCloud.md#generated.RAPointCloud.AddGridFunction) - * [`RAPointCloud.CreateCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateCurveOutputVariable) - * [`RAPointCloud.CreateGridFunction()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunction) - * [`RAPointCloud.CreateGridFunctionArrayOnCells()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionArrayOnCells) - * [`RAPointCloud.CreateGridFunctionStatisticOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionStatisticOutputVariable) - * [`RAPointCloud.CreateTransientCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateTransientCurveOutputVariable) - * [`RAPointCloud.DisablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.DisablePeriodic) - * [`RAPointCloud.EditCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.EditCustomCurve) - * [`RAPointCloud.EditCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.EditCustomProperty) - * [`RAPointCloud.EnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.EnablePeriodic) - * [`RAPointCloud.GetActivesArray()`](RAPointCloud.md#generated.RAPointCloud.GetActivesArray) - * [`RAPointCloud.GetBoundingBox()`](RAPointCloud.md#generated.RAPointCloud.GetBoundingBox) - * [`RAPointCloud.GetCellAreaAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellAreaAsArray) - * [`RAPointCloud.GetCellCenterAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellCenterAsArray) - * [`RAPointCloud.GetCellDzAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellDzAsArray) - * [`RAPointCloud.GetCellFromIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellFromIJK) - * [`RAPointCloud.GetCellIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellIJK) - * [`RAPointCloud.GetCellNumberOfVertices()`](RAPointCloud.md#generated.RAPointCloud.GetCellNumberOfVertices) - * [`RAPointCloud.GetCellPointsAsFunction()`](RAPointCloud.md#generated.RAPointCloud.GetCellPointsAsFunction) - * [`RAPointCloud.GetCellVolumeAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellVolumeAsArray) - * [`RAPointCloud.GetCurve()`](RAPointCloud.md#generated.RAPointCloud.GetCurve) - * [`RAPointCloud.GetCurveNames()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNames) - * [`RAPointCloud.GetCurveNamesAssociation()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNamesAssociation) - * [`RAPointCloud.GetElementCurve()`](RAPointCloud.md#generated.RAPointCloud.GetElementCurve) - * [`RAPointCloud.GetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.GetEnablePeriodic) - * [`RAPointCloud.GetFilePath()`](RAPointCloud.md#generated.RAPointCloud.GetFilePath) - * [`RAPointCloud.GetGeometryQuantity()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryQuantity) - * [`RAPointCloud.GetGeometryUnit()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryUnit) - * [`RAPointCloud.GetGridFunction()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunction) - * [`RAPointCloud.GetGridFunctionNames()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunctionNames) - * [`RAPointCloud.GetMeshColoring()`](RAPointCloud.md#generated.RAPointCloud.GetMeshColoring) - * [`RAPointCloud.GetModuleProperties()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperties) - * [`RAPointCloud.GetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperty) - * [`RAPointCloud.GetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.GetMotionFrame) - * [`RAPointCloud.GetNumberOfCells()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfCells) - * [`RAPointCloud.GetNumberOfNodes()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfNodes) - * [`RAPointCloud.GetNumpyCurve()`](RAPointCloud.md#generated.RAPointCloud.GetNumpyCurve) - * [`RAPointCloud.GetOutputVariableValue()`](RAPointCloud.md#generated.RAPointCloud.GetOutputVariableValue) - * [`RAPointCloud.GetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStartTime) - * [`RAPointCloud.GetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStopTime) - * [`RAPointCloud.GetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOff) - * [`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.HasGridFunction()`](RAPointCloud.md#generated.RAPointCloud.HasGridFunction) - * [`RAPointCloud.IsCellActive()`](RAPointCloud.md#generated.RAPointCloud.IsCellActive) - * [`RAPointCloud.IsPeriodicEnabled()`](RAPointCloud.md#generated.RAPointCloud.IsPeriodicEnabled) - * [`RAPointCloud.IsTransient()`](RAPointCloud.md#generated.RAPointCloud.IsTransient) - * [`RAPointCloud.IterCellVertices()`](RAPointCloud.md#generated.RAPointCloud.IterCellVertices) - * [`RAPointCloud.IterCells()`](RAPointCloud.md#generated.RAPointCloud.IterCells) - * [`RAPointCloud.Modified()`](RAPointCloud.md#generated.RAPointCloud.Modified) - * [`RAPointCloud.RemoveCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomCurve) - * [`RAPointCloud.RemoveCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomProperty) - * [`RAPointCloud.RemoveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.RemoveOutputVariable) - * [`RAPointCloud.RemoveProcess()`](RAPointCloud.md#generated.RAPointCloud.RemoveProcess) - * [`RAPointCloud.SetCurrentTimeStep()`](RAPointCloud.md#generated.RAPointCloud.SetCurrentTimeStep) - * [`RAPointCloud.SetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.SetEnablePeriodic) - * [`RAPointCloud.SetFilePath()`](RAPointCloud.md#generated.RAPointCloud.SetFilePath) - * [`RAPointCloud.SetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.SetModuleProperty) - * [`RAPointCloud.SetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.SetMotionFrame) - * [`RAPointCloud.SetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStartTime) - * [`RAPointCloud.SetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStopTime) - * [`RAPointCloud.SetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOff) -* [RAPointCloudCollection](RAPointCloudCollection.md) - * [`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) - * [`RAPointCloudCollection.Clear()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Clear) - * [`RAPointCloudCollection.New()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.New) - * [`RAPointCloudCollection.Remove()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Remove) -* [RAPolyhedronProcess](RAPolyhedronProcess.md) - * [`RAPolyhedronProcess`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess) - * [`RAPolyhedronProcess.AddCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCurve) - * [`RAPolyhedronProcess.AddCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomCurve) - * [`RAPolyhedronProcess.AddCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomProperty) - * [`RAPolyhedronProcess.AddGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddGridFunction) - * [`RAPolyhedronProcess.CreateCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateCurveOutputVariable) - * [`RAPolyhedronProcess.CreateGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunction) - * [`RAPolyhedronProcess.CreateGridFunctionArrayOnCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionArrayOnCells) - * [`RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAPolyhedronProcess.CreateTransientCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateTransientCurveOutputVariable) - * [`RAPolyhedronProcess.EditCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomCurve) - * [`RAPolyhedronProcess.EditCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomProperty) - * [`RAPolyhedronProcess.GetActivesArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetActivesArray) - * [`RAPolyhedronProcess.GetBoundingBox()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetBoundingBox) - * [`RAPolyhedronProcess.GetCellAreaAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellAreaAsArray) - * [`RAPolyhedronProcess.GetCellCenterAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellCenterAsArray) - * [`RAPolyhedronProcess.GetCellDzAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellDzAsArray) - * [`RAPolyhedronProcess.GetCellFromIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellFromIJK) - * [`RAPolyhedronProcess.GetCellIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellIJK) - * [`RAPolyhedronProcess.GetCellNumberOfVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellNumberOfVertices) - * [`RAPolyhedronProcess.GetCellPointsAsFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellPointsAsFunction) - * [`RAPolyhedronProcess.GetCellVolumeAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellVolumeAsArray) - * [`RAPolyhedronProcess.GetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenter) - * [`RAPolyhedronProcess.GetCenterAfterMovement()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenterAfterMovement) - * [`RAPolyhedronProcess.GetCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurve) - * [`RAPolyhedronProcess.GetCurveNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNames) - * [`RAPolyhedronProcess.GetCurveNamesAssociation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNamesAssociation) - * [`RAPolyhedronProcess.GetElementCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetElementCurve) - * [`RAPolyhedronProcess.GetGeometryQuantity()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryQuantity) - * [`RAPolyhedronProcess.GetGeometryUnit()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryUnit) - * [`RAPolyhedronProcess.GetGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunction) - * [`RAPolyhedronProcess.GetGridFunctionNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunctionNames) - * [`RAPolyhedronProcess.GetMeshColoring()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMeshColoring) - * [`RAPolyhedronProcess.GetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMotionFrame) - * [`RAPolyhedronProcess.GetNumberOfCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfCells) - * [`RAPolyhedronProcess.GetNumberOfNodes()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfNodes) - * [`RAPolyhedronProcess.GetNumberOfParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfParticles) - * [`RAPolyhedronProcess.GetNumpyCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumpyCurve) - * [`RAPolyhedronProcess.GetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientation) - * [`RAPolyhedronProcess.GetOrientationFromAngleAndVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromAngleAndVector) - * [`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.HasGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.HasGridFunction) - * [`RAPolyhedronProcess.IsCellActive()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IsCellActive) - * [`RAPolyhedronProcess.IterCellVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCellVertices) - * [`RAPolyhedronProcess.IterCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCells) - * [`RAPolyhedronProcess.IterParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterParticles) - * [`RAPolyhedronProcess.Modified()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.Modified) - * [`RAPolyhedronProcess.RemoveCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomCurve) - * [`RAPolyhedronProcess.RemoveCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomProperty) - * [`RAPolyhedronProcess.RemoveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveOutputVariable) - * [`RAPolyhedronProcess.RemoveProcess()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveProcess) - * [`RAPolyhedronProcess.SetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCenter) - * [`RAPolyhedronProcess.SetCurrentTimeStep()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCurrentTimeStep) - * [`RAPolyhedronProcess.SetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetMotionFrame) - * [`RAPolyhedronProcess.SetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientation) - * [`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) - * [`RAPrescribedForce.SetForceValue()`](RAPrescribedForce.md#generated.RAPrescribedForce.SetForceValue) -* [RAPrescribedMoment](RAPrescribedMoment.md) - * [`RAPrescribedMoment`](RAPrescribedMoment.md#generated.RAPrescribedMoment) - * [`RAPrescribedMoment.GetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.GetMomentValue) - * [`RAPrescribedMoment.SetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.SetMomentValue) -* [RAProject](RAProject.md) - * [`RAProject`](RAProject.md#generated.RAProject) - * [`RAProject.CloseProject()`](RAProject.md#generated.RAProject.CloseProject) - * [`RAProject.CreateStudy()`](RAProject.md#generated.RAProject.CreateStudy) - * [`RAProject.GetInputVariables()`](RAProject.md#generated.RAProject.GetInputVariables) - * [`RAProject.GetModelElement()`](RAProject.md#generated.RAProject.GetModelElement) - * [`RAProject.GetModelStudy()`](RAProject.md#generated.RAProject.GetModelStudy) - * [`RAProject.GetParametricVariables()`](RAProject.md#generated.RAProject.GetParametricVariables) - * [`RAProject.GetProjectFilename()`](RAProject.md#generated.RAProject.GetProjectFilename) - * [`RAProject.GetStudy()`](RAProject.md#generated.RAProject.GetStudy) - * [`RAProject.GetTimeFilter()`](RAProject.md#generated.RAProject.GetTimeFilter) - * [`RAProject.GetUserProcessCollection()`](RAProject.md#generated.RAProject.GetUserProcessCollection) - * [`RAProject.RemoveProcess()`](RAProject.md#generated.RAProject.RemoveProcess) - * [`RAProject.SaveProject()`](RAProject.md#generated.RAProject.SaveProject) - * [`RAProject.SaveProjectForRestart()`](RAProject.md#generated.RAProject.SaveProjectForRestart) -* [RAReceivingConveyor](RAReceivingConveyor.md) - * [`RAReceivingConveyor`](RAReceivingConveyor.md#generated.RAReceivingConveyor) - * [`RAReceivingConveyor.AddCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCurve) - * [`RAReceivingConveyor.AddCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomCurve) - * [`RAReceivingConveyor.AddCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomProperty) - * [`RAReceivingConveyor.AddGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddGridFunction) - * [`RAReceivingConveyor.CreateCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateCurveOutputVariable) - * [`RAReceivingConveyor.CreateGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunction) - * [`RAReceivingConveyor.CreateGridFunctionArrayOnCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionArrayOnCells) - * [`RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable) - * [`RAReceivingConveyor.CreateTransientCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateTransientCurveOutputVariable) - * [`RAReceivingConveyor.EditCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomCurve) - * [`RAReceivingConveyor.EditCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomProperty) - * [`RAReceivingConveyor.GetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAccelerationPeriod) - * [`RAReceivingConveyor.GetActivesArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetActivesArray) - * [`RAReceivingConveyor.GetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAlignmentAngle) - * [`RAReceivingConveyor.GetAvailableMaterials()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAvailableMaterials) - * [`RAReceivingConveyor.GetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStartTime) - * [`RAReceivingConveyor.GetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStopTime) - * [`RAReceivingConveyor.GetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltInclineAngle) - * [`RAReceivingConveyor.GetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfile) - * [`RAReceivingConveyor.GetBeltProfileName()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfileName) - * [`RAReceivingConveyor.GetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltSpeed) - * [`RAReceivingConveyor.GetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltThickness) - * [`RAReceivingConveyor.GetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltWidth) - * [`RAReceivingConveyor.GetBoundingBox()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBoundingBox) - * [`RAReceivingConveyor.GetCellAreaAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellAreaAsArray) - * [`RAReceivingConveyor.GetCellCenterAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellCenterAsArray) - * [`RAReceivingConveyor.GetCellDzAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellDzAsArray) - * [`RAReceivingConveyor.GetCellFromIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellFromIJK) - * [`RAReceivingConveyor.GetCellIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellIJK) - * [`RAReceivingConveyor.GetCellNumberOfVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellNumberOfVertices) - * [`RAReceivingConveyor.GetCellPointsAsFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellPointsAsFunction) - * [`RAReceivingConveyor.GetCellVolumeAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellVolumeAsArray) - * [`RAReceivingConveyor.GetCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurve) - * [`RAReceivingConveyor.GetCurveNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNames) - * [`RAReceivingConveyor.GetCurveNamesAssociation()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNamesAssociation) - * [`RAReceivingConveyor.GetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetDecelerationPeriod) - * [`RAReceivingConveyor.GetElementCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetElementCurve) - * [`RAReceivingConveyor.GetGeometryQuantity()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryQuantity) - * [`RAReceivingConveyor.GetGeometryUnit()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryUnit) - * [`RAReceivingConveyor.GetGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunction) - * [`RAReceivingConveyor.GetGridFunctionNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunctionNames) - * [`RAReceivingConveyor.GetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHeightOffset) - * [`RAReceivingConveyor.GetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHorizontalOffset) - * [`RAReceivingConveyor.GetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLength) - * [`RAReceivingConveyor.GetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLengthOffset) - * [`RAReceivingConveyor.GetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMaterial) - * [`RAReceivingConveyor.GetMeshColoring()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMeshColoring) - * [`RAReceivingConveyor.GetModuleProperties()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperties) - * [`RAReceivingConveyor.GetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperty) - * [`RAReceivingConveyor.GetNumberOfCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfCells) - * [`RAReceivingConveyor.GetNumberOfNodes()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfNodes) - * [`RAReceivingConveyor.GetNumpyCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumpyCurve) - * [`RAReceivingConveyor.GetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutOfPlaneOffset) - * [`RAReceivingConveyor.GetOutputVariableValue()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutputVariableValue) - * [`RAReceivingConveyor.GetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetReturnBeltAngle) - * [`RAReceivingConveyor.GetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardHeight) - * [`RAReceivingConveyor.GetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardLength) - * [`RAReceivingConveyor.GetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSphBoundaryType) - * [`RAReceivingConveyor.GetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSurfaceTensionContactAngle) - * [`RAReceivingConveyor.GetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTemperature) - * [`RAReceivingConveyor.GetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetThermalBoundaryConditionType) - * [`RAReceivingConveyor.GetTimeSet()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeSet) - * [`RAReceivingConveyor.GetTimeStatistics()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStatistics) - * [`RAReceivingConveyor.GetTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStep) - * [`RAReceivingConveyor.GetTopologyShape()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTopologyShape) - * [`RAReceivingConveyor.GetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTriangleSize) - * [`RAReceivingConveyor.GetValidBeltProfileNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidBeltProfileNames) - * [`RAReceivingConveyor.GetValidOptionsForModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidOptionsForModuleProperty) - * [`RAReceivingConveyor.GetValidSphBoundaryTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues) - * [`RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues) - * [`RAReceivingConveyor.GetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVerticalOffset) - * [`RAReceivingConveyor.GetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetWidth) - * [`RAReceivingConveyor.HasGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.HasGridFunction) - * [`RAReceivingConveyor.IsCellActive()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IsCellActive) - * [`RAReceivingConveyor.IterCellVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCellVertices) - * [`RAReceivingConveyor.IterCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCells) - * [`RAReceivingConveyor.Modified()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.Modified) - * [`RAReceivingConveyor.RemoveCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomCurve) - * [`RAReceivingConveyor.RemoveCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomProperty) - * [`RAReceivingConveyor.RemoveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveOutputVariable) - * [`RAReceivingConveyor.RemoveProcess()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveProcess) - * [`RAReceivingConveyor.SetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAccelerationPeriod) - * [`RAReceivingConveyor.SetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAlignmentAngle) - * [`RAReceivingConveyor.SetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStartTime) - * [`RAReceivingConveyor.SetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStopTime) - * [`RAReceivingConveyor.SetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltInclineAngle) - * [`RAReceivingConveyor.SetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltProfile) - * [`RAReceivingConveyor.SetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltSpeed) - * [`RAReceivingConveyor.SetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltThickness) - * [`RAReceivingConveyor.SetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltWidth) - * [`RAReceivingConveyor.SetCurrentTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCurrentTimeStep) - * [`RAReceivingConveyor.SetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetDecelerationPeriod) - * [`RAReceivingConveyor.SetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHeightOffset) - * [`RAReceivingConveyor.SetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHorizontalOffset) - * [`RAReceivingConveyor.SetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLength) - * [`RAReceivingConveyor.SetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLengthOffset) - * [`RAReceivingConveyor.SetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetMaterial) - * [`RAReceivingConveyor.SetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetModuleProperty) - * [`RAReceivingConveyor.SetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetOutOfPlaneOffset) - * [`RAReceivingConveyor.SetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetReturnBeltAngle) - * [`RAReceivingConveyor.SetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardHeight) - * [`RAReceivingConveyor.SetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardLength) - * [`RAReceivingConveyor.SetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSphBoundaryType) - * [`RAReceivingConveyor.SetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSurfaceTensionContactAngle) - * [`RAReceivingConveyor.SetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTemperature) - * [`RAReceivingConveyor.SetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetThermalBoundaryConditionType) - * [`RAReceivingConveyor.SetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTriangleSize) - * [`RAReceivingConveyor.SetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetVerticalOffset) - * [`RAReceivingConveyor.SetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetWidth) -* [RARectangularSurface](RARectangularSurface.md) - * [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface) - * [`RARectangularSurface.AddCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCurve) - * [`RARectangularSurface.AddCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomCurve) - * [`RARectangularSurface.AddCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomProperty) - * [`RARectangularSurface.AddGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.AddGridFunction) - * [`RARectangularSurface.CreateCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateCurveOutputVariable) - * [`RARectangularSurface.CreateGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunction) - * [`RARectangularSurface.CreateGridFunctionArrayOnCells()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionArrayOnCells) - * [`RARectangularSurface.CreateGridFunctionStatisticOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionStatisticOutputVariable) - * [`RARectangularSurface.CreateTransientCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateTransientCurveOutputVariable) - * [`RARectangularSurface.EditCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomCurve) - * [`RARectangularSurface.EditCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomProperty) - * [`RARectangularSurface.GetActivesArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetActivesArray) - * [`RARectangularSurface.GetBoundingBox()`](RARectangularSurface.md#generated.RARectangularSurface.GetBoundingBox) - * [`RARectangularSurface.GetCellAreaAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellAreaAsArray) - * [`RARectangularSurface.GetCellCenterAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellCenterAsArray) - * [`RARectangularSurface.GetCellDzAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellDzAsArray) - * [`RARectangularSurface.GetCellFromIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellFromIJK) - * [`RARectangularSurface.GetCellIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellIJK) - * [`RARectangularSurface.GetCellNumberOfVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellNumberOfVertices) - * [`RARectangularSurface.GetCellPointsAsFunction()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellPointsAsFunction) - * [`RARectangularSurface.GetCellVolumeAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellVolumeAsArray) - * [`RARectangularSurface.GetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.GetCenter) - * [`RARectangularSurface.GetCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurve) - * [`RARectangularSurface.GetCurveNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNames) - * [`RARectangularSurface.GetCurveNamesAssociation()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNamesAssociation) - * [`RARectangularSurface.GetElementCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetElementCurve) - * [`RARectangularSurface.GetGeometryQuantity()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryQuantity) - * [`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.GetNumberOfCells()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfCells) - * [`RARectangularSurface.GetNumberOfNodes()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfNodes) - * [`RARectangularSurface.GetNumpyCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumpyCurve) - * [`RARectangularSurface.GetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientation) - * [`RARectangularSurface.GetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngleAndVector) - * [`RARectangularSurface.GetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngles) - * [`RARectangularSurface.GetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromBasisVector) - * [`RARectangularSurface.GetOutputVariableValue()`](RARectangularSurface.md#generated.RARectangularSurface.GetOutputVariableValue) - * [`RARectangularSurface.GetTimeSet()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeSet) - * [`RARectangularSurface.GetTimeStatistics()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStatistics) - * [`RARectangularSurface.GetTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStep) - * [`RARectangularSurface.GetTopologyShape()`](RARectangularSurface.md#generated.RARectangularSurface.GetTopologyShape) - * [`RARectangularSurface.GetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.GetWidth) - * [`RARectangularSurface.HasGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.HasGridFunction) - * [`RARectangularSurface.HasMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.HasMotionFrame) - * [`RARectangularSurface.IsCellActive()`](RARectangularSurface.md#generated.RARectangularSurface.IsCellActive) - * [`RARectangularSurface.IterCellVertices()`](RARectangularSurface.md#generated.RARectangularSurface.IterCellVertices) - * [`RARectangularSurface.IterCells()`](RARectangularSurface.md#generated.RARectangularSurface.IterCells) - * [`RARectangularSurface.Modified()`](RARectangularSurface.md#generated.RARectangularSurface.Modified) - * [`RARectangularSurface.RemoveCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomCurve) - * [`RARectangularSurface.RemoveCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomProperty) - * [`RARectangularSurface.RemoveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveOutputVariable) - * [`RARectangularSurface.RemoveProcess()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveProcess) - * [`RARectangularSurface.SetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.SetCenter) - * [`RARectangularSurface.SetCurrentTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.SetCurrentTimeStep) - * [`RARectangularSurface.SetLength()`](RARectangularSurface.md#generated.RARectangularSurface.SetLength) - * [`RARectangularSurface.SetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientation) - * [`RARectangularSurface.SetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngleAndVector) - * [`RARectangularSurface.SetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngles) - * [`RARectangularSurface.SetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromBasisVector) - * [`RARectangularSurface.SetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.SetWidth) -* [RARegionOfInterestCube](RARegionOfInterestCube.md) - * [`RARegionOfInterestCube`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube) - * [`RARegionOfInterestCube.AddCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCurve) - * [`RARegionOfInterestCube.AddCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomCurve) - * [`RARegionOfInterestCube.AddCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomProperty) - * [`RARegionOfInterestCube.AddGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddGridFunction) - * [`RARegionOfInterestCube.CreateCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateCurveOutputVariable) - * [`RARegionOfInterestCube.CreateGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunction) - * [`RARegionOfInterestCube.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionArrayOnCells) - * [`RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable) - * [`RARegionOfInterestCube.CreateTransientCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateTransientCurveOutputVariable) - * [`RARegionOfInterestCube.EditCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomCurve) - * [`RARegionOfInterestCube.EditCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomProperty) - * [`RARegionOfInterestCube.GetActivesArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetActivesArray) - * [`RARegionOfInterestCube.GetBoundingBox()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetBoundingBox) - * [`RARegionOfInterestCube.GetCellAreaAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellAreaAsArray) - * [`RARegionOfInterestCube.GetCellCenterAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellCenterAsArray) - * [`RARegionOfInterestCube.GetCellDzAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellDzAsArray) - * [`RARegionOfInterestCube.GetCellFromIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellFromIJK) - * [`RARegionOfInterestCube.GetCellIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellIJK) - * [`RARegionOfInterestCube.GetCellNumberOfVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellNumberOfVertices) - * [`RARegionOfInterestCube.GetCellPointsAsFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellPointsAsFunction) - * [`RARegionOfInterestCube.GetCellVolumeAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellVolumeAsArray) - * [`RARegionOfInterestCube.GetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenter) - * [`RARegionOfInterestCube.GetCenterAfterMovement()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenterAfterMovement) - * [`RARegionOfInterestCube.GetCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurve) - * [`RARegionOfInterestCube.GetCurveNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNames) - * [`RARegionOfInterestCube.GetCurveNamesAssociation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNamesAssociation) - * [`RARegionOfInterestCube.GetElementCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetElementCurve) - * [`RARegionOfInterestCube.GetGeometryQuantity()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryQuantity) - * [`RARegionOfInterestCube.GetGeometryUnit()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryUnit) - * [`RARegionOfInterestCube.GetGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunction) - * [`RARegionOfInterestCube.GetGridFunctionNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunctionNames) - * [`RARegionOfInterestCube.GetMeshColoring()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMeshColoring) - * [`RARegionOfInterestCube.GetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMotionFrame) - * [`RARegionOfInterestCube.GetNumberOfCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfCells) - * [`RARegionOfInterestCube.GetNumberOfNodes()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfNodes) - * [`RARegionOfInterestCube.GetNumpyCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumpyCurve) - * [`RARegionOfInterestCube.GetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientation) - * [`RARegionOfInterestCube.GetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngleAndVector) - * [`RARegionOfInterestCube.GetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngles) - * [`RARegionOfInterestCube.GetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromBasisVector) - * [`RARegionOfInterestCube.GetOutputVariableValue()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOutputVariableValue) - * [`RARegionOfInterestCube.GetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetSize) - * [`RARegionOfInterestCube.GetTimeSet()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeSet) - * [`RARegionOfInterestCube.GetTimeStatistics()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStatistics) - * [`RARegionOfInterestCube.GetTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStep) - * [`RARegionOfInterestCube.GetTopologyShape()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTopologyShape) - * [`RARegionOfInterestCube.HasGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.HasGridFunction) - * [`RARegionOfInterestCube.IsCellActive()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IsCellActive) - * [`RARegionOfInterestCube.IterCellVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCellVertices) - * [`RARegionOfInterestCube.IterCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCells) - * [`RARegionOfInterestCube.Modified()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.Modified) - * [`RARegionOfInterestCube.RemoveCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomCurve) - * [`RARegionOfInterestCube.RemoveCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomProperty) - * [`RARegionOfInterestCube.RemoveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveOutputVariable) - * [`RARegionOfInterestCube.RemoveProcess()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveProcess) - * [`RARegionOfInterestCube.SetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCenter) - * [`RARegionOfInterestCube.SetCurrentTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCurrentTimeStep) - * [`RARegionOfInterestCube.SetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetMotionFrame) - * [`RARegionOfInterestCube.SetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientation) - * [`RARegionOfInterestCube.SetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngleAndVector) - * [`RARegionOfInterestCube.SetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngles) - * [`RARegionOfInterestCube.SetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromBasisVector) - * [`RARegionOfInterestCube.SetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetSize) -* [RARegionOfInterestCylinder](RARegionOfInterestCylinder.md) - * [`RARegionOfInterestCylinder`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder) - * [`RARegionOfInterestCylinder.AddCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCurve) - * [`RARegionOfInterestCylinder.AddCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomCurve) - * [`RARegionOfInterestCylinder.AddCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomProperty) - * [`RARegionOfInterestCylinder.AddGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddGridFunction) - * [`RARegionOfInterestCylinder.CreateCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateCurveOutputVariable) - * [`RARegionOfInterestCylinder.CreateGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunction) - * [`RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells) - * [`RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable) - * [`RARegionOfInterestCylinder.CreateTransientCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateTransientCurveOutputVariable) - * [`RARegionOfInterestCylinder.EditCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomCurve) - * [`RARegionOfInterestCylinder.EditCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomProperty) - * [`RARegionOfInterestCylinder.GetActivesArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetActivesArray) - * [`RARegionOfInterestCylinder.GetBoundingBox()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetBoundingBox) - * [`RARegionOfInterestCylinder.GetCellAreaAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellAreaAsArray) - * [`RARegionOfInterestCylinder.GetCellCenterAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellCenterAsArray) - * [`RARegionOfInterestCylinder.GetCellDzAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellDzAsArray) - * [`RARegionOfInterestCylinder.GetCellFromIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellFromIJK) - * [`RARegionOfInterestCylinder.GetCellIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellIJK) - * [`RARegionOfInterestCylinder.GetCellNumberOfVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellNumberOfVertices) - * [`RARegionOfInterestCylinder.GetCellPointsAsFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellPointsAsFunction) - * [`RARegionOfInterestCylinder.GetCellVolumeAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellVolumeAsArray) - * [`RARegionOfInterestCylinder.GetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenter) - * [`RARegionOfInterestCylinder.GetCenterAfterMovement()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenterAfterMovement) - * [`RARegionOfInterestCylinder.GetCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurve) - * [`RARegionOfInterestCylinder.GetCurveNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNames) - * [`RARegionOfInterestCylinder.GetCurveNamesAssociation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation) - * [`RARegionOfInterestCylinder.GetElementCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetElementCurve) - * [`RARegionOfInterestCylinder.GetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFinalAngle) - * [`RARegionOfInterestCylinder.GetGeometryQuantity()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryQuantity) - * [`RARegionOfInterestCylinder.GetGeometryUnit()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryUnit) - * [`RARegionOfInterestCylinder.GetGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunction) - * [`RARegionOfInterestCylinder.GetGridFunctionNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunctionNames) - * [`RARegionOfInterestCylinder.GetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetHeight) - * [`RARegionOfInterestCylinder.GetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInitialAngle) - * [`RARegionOfInterestCylinder.GetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInternalFactor) - * [`RARegionOfInterestCylinder.GetMeshColoring()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMeshColoring) - * [`RARegionOfInterestCylinder.GetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMotionFrame) - * [`RARegionOfInterestCylinder.GetNumberOfCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfCells) - * [`RARegionOfInterestCylinder.GetNumberOfNodes()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfNodes) - * [`RARegionOfInterestCylinder.GetNumpyCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumpyCurve) - * [`RARegionOfInterestCylinder.GetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientation) - * [`RARegionOfInterestCylinder.GetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngleAndVector) - * [`RARegionOfInterestCylinder.GetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngles) - * [`RARegionOfInterestCylinder.GetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromBasisVector) - * [`RARegionOfInterestCylinder.GetOutputVariableValue()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOutputVariableValue) - * [`RARegionOfInterestCylinder.GetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetRadius) - * [`RARegionOfInterestCylinder.GetTimeSet()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeSet) - * [`RARegionOfInterestCylinder.GetTimeStatistics()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStatistics) - * [`RARegionOfInterestCylinder.GetTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStep) - * [`RARegionOfInterestCylinder.GetTopologyShape()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTopologyShape) - * [`RARegionOfInterestCylinder.HasGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.HasGridFunction) - * [`RARegionOfInterestCylinder.IsCellActive()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IsCellActive) - * [`RARegionOfInterestCylinder.IterCellVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCellVertices) - * [`RARegionOfInterestCylinder.IterCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCells) - * [`RARegionOfInterestCylinder.Modified()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.Modified) - * [`RARegionOfInterestCylinder.RemoveCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomCurve) - * [`RARegionOfInterestCylinder.RemoveCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomProperty) - * [`RARegionOfInterestCylinder.RemoveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveOutputVariable) - * [`RARegionOfInterestCylinder.RemoveProcess()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveProcess) - * [`RARegionOfInterestCylinder.SetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCenter) - * [`RARegionOfInterestCylinder.SetCurrentTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCurrentTimeStep) - * [`RARegionOfInterestCylinder.SetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetFinalAngle) - * [`RARegionOfInterestCylinder.SetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetHeight) - * [`RARegionOfInterestCylinder.SetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInitialAngle) - * [`RARegionOfInterestCylinder.SetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInternalFactor) - * [`RARegionOfInterestCylinder.SetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetMotionFrame) - * [`RARegionOfInterestCylinder.SetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientation) - * [`RARegionOfInterestCylinder.SetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngleAndVector) - * [`RARegionOfInterestCylinder.SetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngles) - * [`RARegionOfInterestCylinder.SetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromBasisVector) - * [`RARegionOfInterestCylinder.SetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetRadius) -* [RARegionsOfInterestCollection](RARegionsOfInterestCollection.md) - * [`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) - * [`RARegionsOfInterestCollection.AddCube()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCube) - * [`RARegionsOfInterestCollection.AddCylinder()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCylinder) - * [`RARegionsOfInterestCollection.Clear()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Clear) - * [`RARegionsOfInterestCollection.New()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.New) - * [`RARegionsOfInterestCollection.Remove()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Remove) -* [RARotation](RARotation.md) - * [`RARotation`](RARotation.md#generated.RARotation) - * [`RARotation.GetAngularAcceleration()`](RARotation.md#generated.RARotation.GetAngularAcceleration) - * [`RARotation.GetInitialAngularVelocity()`](RARotation.md#generated.RARotation.GetInitialAngularVelocity) - * [`RARotation.SetAngularAcceleration()`](RARotation.md#generated.RARotation.SetAngularAcceleration) - * [`RARotation.SetInitialAngularVelocity()`](RARotation.md#generated.RARotation.SetInitialAngularVelocity) -* [RASPHEulerianSolution](RASPHEulerianSolution.md) - * [`RASPHEulerianSolution`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution) - * [`RASPHEulerianSolution.DisableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.DisableEulerianSolution) - * [`RASPHEulerianSolution.EnableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.EnableEulerianSolution) - * [`RASPHEulerianSolution.GetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetEulerianSolutionEnabled) - * [`RASPHEulerianSolution.GetMeshColoring()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetMeshColoring) - * [`RASPHEulerianSolution.IsEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.IsEulerianSolutionEnabled) - * [`RASPHEulerianSolution.SetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.SetEulerianSolutionEnabled) -* [RASPHSettings](RASPHSettings.md) - * [`RASPHSettings`](RASPHSettings.md#generated.RASPHSettings) - * [`RASPHSettings.AddCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCurve) - * [`RASPHSettings.AddCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCustomCurve) - * [`RASPHSettings.AddCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.AddCustomProperty) - * [`RASPHSettings.AddGridFunction()`](RASPHSettings.md#generated.RASPHSettings.AddGridFunction) - * [`RASPHSettings.CreateCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateCurveOutputVariable) - * [`RASPHSettings.CreateGridFunction()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunction) - * [`RASPHSettings.CreateGridFunctionArrayOnCells()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionArrayOnCells) - * [`RASPHSettings.CreateGridFunctionStatisticOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable) - * [`RASPHSettings.CreateTransientCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateTransientCurveOutputVariable) - * [`RASPHSettings.DisableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.DisableEulerianSolution) - * [`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.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) - * [`RASPHSettings.GetCellCenterAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellCenterAsArray) - * [`RASPHSettings.GetCellDzAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellDzAsArray) - * [`RASPHSettings.GetCellFromIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellFromIJK) - * [`RASPHSettings.GetCellIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellIJK) - * [`RASPHSettings.GetCellNumberOfVertices()`](RASPHSettings.md#generated.RASPHSettings.GetCellNumberOfVertices) - * [`RASPHSettings.GetCellPointsAsFunction()`](RASPHSettings.md#generated.RASPHSettings.GetCellPointsAsFunction) - * [`RASPHSettings.GetCellVolumeAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellVolumeAsArray) - * [`RASPHSettings.GetClearyFactor()`](RASPHSettings.md#generated.RASPHSettings.GetClearyFactor) - * [`RASPHSettings.GetCurve()`](RASPHSettings.md#generated.RASPHSettings.GetCurve) - * [`RASPHSettings.GetCurveNames()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNames) - * [`RASPHSettings.GetCurveNamesAssociation()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNamesAssociation) - * [`RASPHSettings.GetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevMinus) - * [`RASPHSettings.GetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevPlus) - * [`RASPHSettings.GetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.GetDensityRelativeErrorTolerance) - * [`RASPHSettings.GetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.GetDissFactor) - * [`RASPHSettings.GetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorNorm) - * [`RASPHSettings.GetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorTang) - * [`RASPHSettings.GetElementCurve()`](RASPHSettings.md#generated.RASPHSettings.GetElementCurve) - * [`RASPHSettings.GetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEulerianSolutionEnabled) - * [`RASPHSettings.GetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.GetFluidMaterial) - * [`RASPHSettings.GetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit) - * [`RASPHSettings.GetGeometryQuantity()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryQuantity) - * [`RASPHSettings.GetGeometryUnit()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryUnit) - * [`RASPHSettings.GetGridFunction()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunction) - * [`RASPHSettings.GetGridFunctionNames()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunctionNames) - * [`RASPHSettings.GetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetKernelDistFactor) - * [`RASPHSettings.GetKernelType()`](RASPHSettings.md#generated.RASPHSettings.GetKernelType) - * [`RASPHSettings.GetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.GetLimitTurbulentViscosity) - * [`RASPHSettings.GetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumExpectedVelocity) - * [`RASPHSettings.GetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumNumberOfIterations) - * [`RASPHSettings.GetMeshColoring()`](RASPHSettings.md#generated.RASPHSettings.GetMeshColoring) - * [`RASPHSettings.GetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetMinDistFactor) - * [`RASPHSettings.GetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.GetNegativePressureFactor) - * [`RASPHSettings.GetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumCellSteps) - * [`RASPHSettings.GetNumberOfCells()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfCells) - * [`RASPHSettings.GetNumberOfNodes()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfNodes) - * [`RASPHSettings.GetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfSteps) - * [`RASPHSettings.GetNumpyCurve()`](RASPHSettings.md#generated.RASPHSettings.GetNumpyCurve) - * [`RASPHSettings.GetOutputVariableValue()`](RASPHSettings.md#generated.RASPHSettings.GetOutputVariableValue) - * [`RASPHSettings.GetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.GetPosCorrectionType) - * [`RASPHSettings.GetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.GetPressureDeg) - * [`RASPHSettings.GetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetPressureUnderRelaxationFactor) - * [`RASPHSettings.GetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) - * [`RASPHSettings.GetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) - * [`RASPHSettings.GetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.GetShiftingFactor) - * [`RASPHSettings.GetSize()`](RASPHSettings.md#generated.RASPHSettings.GetSize) - * [`RASPHSettings.GetSolver()`](RASPHSettings.md#generated.RASPHSettings.GetSolver) - * [`RASPHSettings.GetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.GetSolverModel) - * [`RASPHSettings.GetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.GetSoundSpeed) - * [`RASPHSettings.GetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityDegree) - * [`RASPHSettings.GetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityNegFactor) - * [`RASPHSettings.GetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityPosFactor) - * [`RASPHSettings.GetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStiffFactor) - * [`RASPHSettings.GetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryAngle) - * [`RASPHSettings.GetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryFraction) - * [`RASPHSettings.GetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionCoefficient) - * [`RASPHSettings.GetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionType) - * [`RASPHSettings.GetTimeSet()`](RASPHSettings.md#generated.RASPHSettings.GetTimeSet) - * [`RASPHSettings.GetTimeStatistics()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStatistics) - * [`RASPHSettings.GetTimeStep()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStep) - * [`RASPHSettings.GetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.GetTimestepFactor) - * [`RASPHSettings.GetTopologyShape()`](RASPHSettings.md#generated.RASPHSettings.GetTopologyShape) - * [`RASPHSettings.GetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.GetTurbDistanceFraction) - * [`RASPHSettings.GetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulenceType) - * [`RASPHSettings.GetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentPrandtl) - * [`RASPHSettings.GetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentViscosityMaximumRatio) - * [`RASPHSettings.GetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.GetUpdateCoupledDensity) - * [`RASPHSettings.GetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.GetUseParticlesNeighborsList) - * [`RASPHSettings.GetValidKernelTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidKernelTypeValues) - * [`RASPHSettings.GetValidPosCorrectionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidPosCorrectionTypeValues) - * [`RASPHSettings.GetValidSolverModelValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSolverModelValues) - * [`RASPHSettings.GetValidSurfaceTensionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSurfaceTensionTypeValues) - * [`RASPHSettings.GetValidTurbulenceTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidTurbulenceTypeValues) - * [`RASPHSettings.GetValidViscosityTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscosityTypeValues) - * [`RASPHSettings.GetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.GetViscosityType) - * [`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.IsShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) - * [`RASPHSettings.IsShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) - * [`RASPHSettings.IterCellVertices()`](RASPHSettings.md#generated.RASPHSettings.IterCellVertices) - * [`RASPHSettings.IterCells()`](RASPHSettings.md#generated.RASPHSettings.IterCells) - * [`RASPHSettings.Modified()`](RASPHSettings.md#generated.RASPHSettings.Modified) - * [`RASPHSettings.RemoveCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.RemoveCustomCurve) - * [`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) - * [`RASPHSettings.SetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevMinus) - * [`RASPHSettings.SetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevPlus) - * [`RASPHSettings.SetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.SetDensityRelativeErrorTolerance) - * [`RASPHSettings.SetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.SetDissFactor) - * [`RASPHSettings.SetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorNorm) - * [`RASPHSettings.SetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorTang) - * [`RASPHSettings.SetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEulerianSolutionEnabled) - * [`RASPHSettings.SetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.SetFluidMaterial) - * [`RASPHSettings.SetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit) - * [`RASPHSettings.SetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetKernelDistFactor) - * [`RASPHSettings.SetKernelType()`](RASPHSettings.md#generated.RASPHSettings.SetKernelType) - * [`RASPHSettings.SetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.SetLimitTurbulentViscosity) - * [`RASPHSettings.SetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumExpectedVelocity) - * [`RASPHSettings.SetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumNumberOfIterations) - * [`RASPHSettings.SetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetMinDistFactor) - * [`RASPHSettings.SetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.SetNegativePressureFactor) - * [`RASPHSettings.SetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumCellSteps) - * [`RASPHSettings.SetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumberOfSteps) - * [`RASPHSettings.SetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.SetPosCorrectionType) - * [`RASPHSettings.SetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.SetPressureDeg) - * [`RASPHSettings.SetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetPressureUnderRelaxationFactor) - * [`RASPHSettings.SetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) - * [`RASPHSettings.SetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) - * [`RASPHSettings.SetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.SetShiftingFactor) - * [`RASPHSettings.SetSize()`](RASPHSettings.md#generated.RASPHSettings.SetSize) - * [`RASPHSettings.SetSolver()`](RASPHSettings.md#generated.RASPHSettings.SetSolver) - * [`RASPHSettings.SetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.SetSolverModel) - * [`RASPHSettings.SetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.SetSoundSpeed) - * [`RASPHSettings.SetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityDegree) - * [`RASPHSettings.SetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityNegFactor) - * [`RASPHSettings.SetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityPosFactor) - * [`RASPHSettings.SetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStiffFactor) - * [`RASPHSettings.SetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryAngle) - * [`RASPHSettings.SetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryFraction) - * [`RASPHSettings.SetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionCoefficient) - * [`RASPHSettings.SetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionType) - * [`RASPHSettings.SetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.SetTimestepFactor) - * [`RASPHSettings.SetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.SetTurbDistanceFraction) - * [`RASPHSettings.SetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulenceType) - * [`RASPHSettings.SetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentPrandtl) - * [`RASPHSettings.SetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentViscosityMaximumRatio) - * [`RASPHSettings.SetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.SetUpdateCoupledDensity) - * [`RASPHSettings.SetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.SetUseParticlesNeighborsList) - * [`RASPHSettings.SetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.SetViscosityType) - * [`RASPHSettings.SetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.SetXsphFactor) -* [RASimulatorRun](RASimulatorRun.md) - * [`RASimulatorRun`](RASimulatorRun.md#generated.RASimulatorRun) - * [`RASimulatorRun.AddCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCurve) - * [`RASimulatorRun.AddCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomCurve) - * [`RASimulatorRun.AddCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomProperty) - * [`RASimulatorRun.AddGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.AddGridFunction) - * [`RASimulatorRun.CreateCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateCurveOutputVariable) - * [`RASimulatorRun.CreateGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunction) - * [`RASimulatorRun.CreateGridFunctionArrayOnCells()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionArrayOnCells) - * [`RASimulatorRun.CreateGridFunctionStatisticOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionStatisticOutputVariable) - * [`RASimulatorRun.CreateTransientCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateTransientCurveOutputVariable) - * [`RASimulatorRun.DisableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.DisableCompressedFile) - * [`RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.DisableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.DisableFEMForces) - * [`RASimulatorRun.DisableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.DisableHtcCalculator) - * [`RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.DisableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.DisableNegateInitialOverlaps) - * [`RASimulatorRun.DisableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.DisableSortingDistanceFactor) - * [`RASimulatorRun.DisableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.DisableUse3RdPowerForCfdCgm) - * [`RASimulatorRun.EditCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomCurve) - * [`RASimulatorRun.EditCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomProperty) - * [`RASimulatorRun.EnableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.EnableCompressedFile) - * [`RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.EnableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.EnableFEMForces) - * [`RASimulatorRun.EnableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.EnableHtcCalculator) - * [`RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.EnableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.EnableNegateInitialOverlaps) - * [`RASimulatorRun.EnableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.EnableSortingDistanceFactor) - * [`RASimulatorRun.EnableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.EnableUse3RdPowerForCfdCgm) - * [`RASimulatorRun.GetActivesArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetActivesArray) - * [`RASimulatorRun.GetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetArraysGrowthRate) - * [`RASimulatorRun.GetAvailableModulesOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableModulesOutputProperties) - * [`RASimulatorRun.GetAvailableOutputRootProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRootProperties) - * [`RASimulatorRun.GetAvailableOutputRoots()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRoots) - * [`RASimulatorRun.GetAvailableStandardOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableStandardOutputProperties) - * [`RASimulatorRun.GetBoundingBox()`](RASimulatorRun.md#generated.RASimulatorRun.GetBoundingBox) - * [`RASimulatorRun.GetBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageDelayAfterRelease) - * [`RASimulatorRun.GetBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageOverlapFactor) - * [`RASimulatorRun.GetBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageStart) - * [`RASimulatorRun.GetCellAreaAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellAreaAsArray) - * [`RASimulatorRun.GetCellCenterAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellCenterAsArray) - * [`RASimulatorRun.GetCellDzAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellDzAsArray) - * [`RASimulatorRun.GetCellFromIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellFromIJK) - * [`RASimulatorRun.GetCellIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellIJK) - * [`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) - * [`RASimulatorRun.GetCurveNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNames) - * [`RASimulatorRun.GetCurveNamesAssociation()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNamesAssociation) - * [`RASimulatorRun.GetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.GetDeformableMassMatrixType) - * [`RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries) - * [`RASimulatorRun.GetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetDragLimiterFactor) - * [`RASimulatorRun.GetElementCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetElementCurve) - * [`RASimulatorRun.GetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetFixedTimestep) - * [`RASimulatorRun.GetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.GetFluentOutputsMultiplier) - * [`RASimulatorRun.GetGeometryQuantity()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryQuantity) - * [`RASimulatorRun.GetGeometryUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryUnit) - * [`RASimulatorRun.GetGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunction) - * [`RASimulatorRun.GetGridFunctionNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunctionNames) - * [`RASimulatorRun.GetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.GetJointElasticRatio) - * [`RASimulatorRun.GetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.GetLinearHystDamp) - * [`RASimulatorRun.GetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.GetLoadingNSteps) - * [`RASimulatorRun.GetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.GetMaximumNumberOfIterations) - * [`RASimulatorRun.GetMeshColoring()`](RASimulatorRun.md#generated.RASimulatorRun.GetMeshColoring) - * [`RASimulatorRun.GetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumLengthDeformationTolerance) - * [`RASimulatorRun.GetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumVolumeTolerance) - * [`RASimulatorRun.GetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertiesData) - * [`RASimulatorRun.GetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertyEnabled) - * [`RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.GetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.GetMultiGpuSlicingDirection) - * [`RASimulatorRun.GetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.GetNegateInitialOverlaps) - * [`RASimulatorRun.GetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetNeighborSearchModel) - * [`RASimulatorRun.GetNumberOfCells()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfCells) - * [`RASimulatorRun.GetNumberOfNodes()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfNodes) - * [`RASimulatorRun.GetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfProcessors) - * [`RASimulatorRun.GetNumpyCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumpyCurve) - * [`RASimulatorRun.GetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputPropertyEnabled) - * [`RASimulatorRun.GetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputRootEnabled) - * [`RASimulatorRun.GetOutputVariableValue()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputVariableValue) - * [`RASimulatorRun.GetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverRelaxationCoefficient) - * [`RASimulatorRun.GetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverlapParticlesDelay) - * [`RASimulatorRun.GetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.GetParticleSizeLimitForReordering) - * [`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) - * [`RASimulatorRun.GetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetStandardOutputPropertyEnabled) - * [`RASimulatorRun.GetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetSuccessiveOverRelaxationTolerance) - * [`RASimulatorRun.GetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpu) - * [`RASimulatorRun.GetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpus) - * [`RASimulatorRun.GetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeInterval) - * [`RASimulatorRun.GetTimeSet()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeSet) - * [`RASimulatorRun.GetTimeStatistics()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStatistics) - * [`RASimulatorRun.GetTimeStep()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStep) - * [`RASimulatorRun.GetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimestepModel) - * [`RASimulatorRun.GetTopologyShape()`](RASimulatorRun.md#generated.RASimulatorRun.GetTopologyShape) - * [`RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach) - * [`RASimulatorRun.GetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2SourceTermsApproach) - * [`RASimulatorRun.GetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse3RdPowerForCfdCgm) - * [`RASimulatorRun.GetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseArraysGrowthRate) - * [`RASimulatorRun.GetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseBreakageOverlapFactor) - * [`RASimulatorRun.GetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseCompressedFiles) - * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles) - * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles) - * [`RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.GetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDragLimiterFactor) - * [`RASimulatorRun.GetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseFixedTimestep) - * [`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.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.GetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateInterval) - * [`RASimulatorRun.GetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearStart) - * [`RASimulatorRun.HasFEMForcesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.HasFEMForcesEnabled) - * [`RASimulatorRun.HasGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.HasGridFunction) - * [`RASimulatorRun.HasHtcCalculatedData()`](RASimulatorRun.md#generated.RASimulatorRun.HasHtcCalculatedData) - * [`RASimulatorRun.IsCellActive()`](RASimulatorRun.md#generated.RASimulatorRun.IsCellActive) - * [`RASimulatorRun.IsCompressedFileEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsCompressedFileEnabled) - * [`RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled) - * [`RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled) - * [`RASimulatorRun.IsNegateInitialOverlapsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsNegateInitialOverlapsEnabled) - * [`RASimulatorRun.IsSortingDistanceFactorEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsSortingDistanceFactorEnabled) - * [`RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled) - * [`RASimulatorRun.IterCellVertices()`](RASimulatorRun.md#generated.RASimulatorRun.IterCellVertices) - * [`RASimulatorRun.IterCells()`](RASimulatorRun.md#generated.RASimulatorRun.IterCells) - * [`RASimulatorRun.Modified()`](RASimulatorRun.md#generated.RASimulatorRun.Modified) - * [`RASimulatorRun.RemoveCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomCurve) - * [`RASimulatorRun.RemoveCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomProperty) - * [`RASimulatorRun.RemoveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveOutputVariable) - * [`RASimulatorRun.RemoveProcess()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveProcess) - * [`RASimulatorRun.RestoreOutputPropertiesDefaults()`](RASimulatorRun.md#generated.RASimulatorRun.RestoreOutputPropertiesDefaults) - * [`RASimulatorRun.SetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetArraysGrowthRate) - * [`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) - * [`RASimulatorRun.SetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.SetDeformableMassMatrixType) - * [`RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries) - * [`RASimulatorRun.SetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetDragLimiterFactor) - * [`RASimulatorRun.SetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetFixedTimestep) - * [`RASimulatorRun.SetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.SetFluentOutputsMultiplier) - * [`RASimulatorRun.SetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.SetJointElasticRatio) - * [`RASimulatorRun.SetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.SetLinearHystDamp) - * [`RASimulatorRun.SetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.SetLoadingNSteps) - * [`RASimulatorRun.SetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.SetMaximumNumberOfIterations) - * [`RASimulatorRun.SetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumLengthDeformationTolerance) - * [`RASimulatorRun.SetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumVolumeTolerance) - * [`RASimulatorRun.SetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertiesData) - * [`RASimulatorRun.SetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertyEnabled) - * [`RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries) - * [`RASimulatorRun.SetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.SetMultiGpuSlicingDirection) - * [`RASimulatorRun.SetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.SetNegateInitialOverlaps) - * [`RASimulatorRun.SetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetNeighborSearchModel) - * [`RASimulatorRun.SetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.SetNumberOfProcessors) - * [`RASimulatorRun.SetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputPropertyEnabled) - * [`RASimulatorRun.SetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputRootEnabled) - * [`RASimulatorRun.SetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverRelaxationCoefficient) - * [`RASimulatorRun.SetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverlapParticlesDelay) - * [`RASimulatorRun.SetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.SetParticleSizeLimitForReordering) - * [`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) - * [`RASimulatorRun.SetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetStandardOutputPropertyEnabled) - * [`RASimulatorRun.SetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetSuccessiveOverRelaxationTolerance) - * [`RASimulatorRun.SetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpu) - * [`RASimulatorRun.SetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpus) - * [`RASimulatorRun.SetTimeConfiguration()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeConfiguration) - * [`RASimulatorRun.SetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeInterval) - * [`RASimulatorRun.SetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimestepModel) - * [`RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach) - * [`RASimulatorRun.SetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2SourceTermsApproach) - * [`RASimulatorRun.SetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse3RdPowerForCfdCgm) - * [`RASimulatorRun.SetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseArraysGrowthRate) - * [`RASimulatorRun.SetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseBreakageOverlapFactor) - * [`RASimulatorRun.SetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseCompressedFiles) - * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles) - * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles) - * [`RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) - * [`RASimulatorRun.SetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDragLimiterFactor) - * [`RASimulatorRun.SetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseFixedTimestep) - * [`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) - * [`RASizeDistribution`](RASizeDistribution.md#generated.RASizeDistribution) - * [`RASizeDistribution.GetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.GetCumulativePercentage) - * [`RASizeDistribution.GetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.GetScaleFactor) - * [`RASizeDistribution.GetSize()`](RASizeDistribution.md#generated.RASizeDistribution.GetSize) - * [`RASizeDistribution.SetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.SetCumulativePercentage) - * [`RASizeDistribution.SetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.SetScaleFactor) - * [`RASizeDistribution.SetSize()`](RASizeDistribution.md#generated.RASizeDistribution.SetSize) -* [RASizeDistributionList](RASizeDistributionList.md) - * [`RASizeDistributionList`](RASizeDistributionList.md#generated.RASizeDistributionList) - * [`RASizeDistributionList.Clear()`](RASizeDistributionList.md#generated.RASizeDistributionList.Clear) - * [`RASizeDistributionList.GetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetCgmScaleFactor) - * [`RASizeDistributionList.GetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetSizeType) - * [`RASizeDistributionList.GetValidSizeTypeValues()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetValidSizeTypeValues) - * [`RASizeDistributionList.New()`](RASizeDistributionList.md#generated.RASizeDistributionList.New) - * [`RASizeDistributionList.Remove()`](RASizeDistributionList.md#generated.RASizeDistributionList.Remove) - * [`RASizeDistributionList.SetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetCgmScaleFactor) - * [`RASizeDistributionList.SetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetSizeType) -* [RASolidMaterial](RASolidMaterial.md) - * [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) - * [`RASolidMaterial.GetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkDensity) - * [`RASolidMaterial.GetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkSolidFraction) - * [`RASolidMaterial.GetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetCurrentDensity) - * [`RASolidMaterial.GetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetDensity) - * [`RASolidMaterial.GetModuleProperties()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperties) - * [`RASolidMaterial.GetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperty) - * [`RASolidMaterial.GetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.GetPoissonRatio) - * [`RASolidMaterial.GetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.GetSpecificHeat) - * [`RASolidMaterial.GetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.GetThermalConductivity) - * [`RASolidMaterial.GetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetUseBulkDensity) - * [`RASolidMaterial.GetValidOptionsForModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetValidOptionsForModuleProperty) - * [`RASolidMaterial.GetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.GetYoungsModulus) - * [`RASolidMaterial.SetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkDensity) - * [`RASolidMaterial.SetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkSolidFraction) - * [`RASolidMaterial.SetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetCurrentDensity) - * [`RASolidMaterial.SetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetDensity) - * [`RASolidMaterial.SetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.SetModuleProperty) - * [`RASolidMaterial.SetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.SetPoissonRatio) - * [`RASolidMaterial.SetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.SetSpecificHeat) - * [`RASolidMaterial.SetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.SetThermalConductivity) - * [`RASolidMaterial.SetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetUseBulkDensity) - * [`RASolidMaterial.SetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.SetYoungsModulus) -* [RASpringDashpotForce](RASpringDashpotForce.md) - * [`RASpringDashpotForce`](RASpringDashpotForce.md#generated.RASpringDashpotForce) - * [`RASpringDashpotForce.GetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDashpotCoefficient) - * [`RASpringDashpotForce.GetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDirection) - * [`RASpringDashpotForce.GetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetSpringCoefficient) - * [`RASpringDashpotForce.GetValidDirectionValues()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetValidDirectionValues) - * [`RASpringDashpotForce.SetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDashpotCoefficient) - * [`RASpringDashpotForce.SetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDirection) - * [`RASpringDashpotForce.SetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetSpringCoefficient) -* [RASpringDashpotMoment](RASpringDashpotMoment.md) - * [`RASpringDashpotMoment`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment) - * [`RASpringDashpotMoment.GetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDashpotCoefficient) - * [`RASpringDashpotMoment.GetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDirection) - * [`RASpringDashpotMoment.GetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetSpringCoefficient) - * [`RASpringDashpotMoment.GetValidDirectionValues()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetValidDirectionValues) - * [`RASpringDashpotMoment.SetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDashpotCoefficient) - * [`RASpringDashpotMoment.SetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDirection) - * [`RASpringDashpotMoment.SetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetSpringCoefficient) -* [RAStreamlinesUserProcess](RAStreamlinesUserProcess.md) - * [`RAStreamlinesUserProcess`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess) - * [`RAStreamlinesUserProcess.AddCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCurve) - * [`RAStreamlinesUserProcess.AddCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomCurve) - * [`RAStreamlinesUserProcess.AddCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomProperty) - * [`RAStreamlinesUserProcess.AddGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddGridFunction) - * [`RAStreamlinesUserProcess.CreateCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateCurveOutputVariable) - * [`RAStreamlinesUserProcess.CreateGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunction) - * [`RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells) - * [`RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable) - * [`RAStreamlinesUserProcess.CreateTransientCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateTransientCurveOutputVariable) - * [`RAStreamlinesUserProcess.EditCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomCurve) - * [`RAStreamlinesUserProcess.EditCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomProperty) - * [`RAStreamlinesUserProcess.GetActivesArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetActivesArray) - * [`RAStreamlinesUserProcess.GetAvailableSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetAvailableSources) - * [`RAStreamlinesUserProcess.GetBoundingBox()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetBoundingBox) - * [`RAStreamlinesUserProcess.GetCellAreaAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellAreaAsArray) - * [`RAStreamlinesUserProcess.GetCellCenterAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellCenterAsArray) - * [`RAStreamlinesUserProcess.GetCellDzAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellDzAsArray) - * [`RAStreamlinesUserProcess.GetCellFromIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellFromIJK) - * [`RAStreamlinesUserProcess.GetCellIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellIJK) - * [`RAStreamlinesUserProcess.GetCellNumberOfVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellNumberOfVertices) - * [`RAStreamlinesUserProcess.GetCellPointsAsFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellPointsAsFunction) - * [`RAStreamlinesUserProcess.GetCellVolumeAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellVolumeAsArray) - * [`RAStreamlinesUserProcess.GetCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurve) - * [`RAStreamlinesUserProcess.GetCurveNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNames) - * [`RAStreamlinesUserProcess.GetCurveNamesAssociation()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation) - * [`RAStreamlinesUserProcess.GetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetDirection) - * [`RAStreamlinesUserProcess.GetElementCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetElementCurve) - * [`RAStreamlinesUserProcess.GetGeometryQuantity()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryQuantity) - * [`RAStreamlinesUserProcess.GetGeometryUnit()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryUnit) - * [`RAStreamlinesUserProcess.GetGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunction) - * [`RAStreamlinesUserProcess.GetGridFunctionNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunctionNames) - * [`RAStreamlinesUserProcess.GetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMaximumLength) - * [`RAStreamlinesUserProcess.GetMeshColoring()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMeshColoring) - * [`RAStreamlinesUserProcess.GetNumberOfCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfCells) - * [`RAStreamlinesUserProcess.GetNumberOfNodes()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfNodes) - * [`RAStreamlinesUserProcess.GetNumberOfParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfParticles) - * [`RAStreamlinesUserProcess.GetNumpyCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumpyCurve) - * [`RAStreamlinesUserProcess.GetOutputVariableValue()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetOutputVariableValue) - * [`RAStreamlinesUserProcess.GetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSources) - * [`RAStreamlinesUserProcess.GetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSpacing) - * [`RAStreamlinesUserProcess.GetTimeSet()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeSet) - * [`RAStreamlinesUserProcess.GetTimeStatistics()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStatistics) - * [`RAStreamlinesUserProcess.GetTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStep) - * [`RAStreamlinesUserProcess.GetTopologyShape()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTopologyShape) - * [`RAStreamlinesUserProcess.GetValidDirectionValues()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetValidDirectionValues) - * [`RAStreamlinesUserProcess.HasGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.HasGridFunction) - * [`RAStreamlinesUserProcess.IsCellActive()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IsCellActive) - * [`RAStreamlinesUserProcess.IterCellVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCellVertices) - * [`RAStreamlinesUserProcess.IterCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCells) - * [`RAStreamlinesUserProcess.IterParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterParticles) - * [`RAStreamlinesUserProcess.Modified()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.Modified) - * [`RAStreamlinesUserProcess.RemoveCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomCurve) - * [`RAStreamlinesUserProcess.RemoveCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomProperty) - * [`RAStreamlinesUserProcess.RemoveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveOutputVariable) - * [`RAStreamlinesUserProcess.RemoveProcess()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveProcess) - * [`RAStreamlinesUserProcess.SetCurrentTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetCurrentTimeStep) - * [`RAStreamlinesUserProcess.SetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetDirection) - * [`RAStreamlinesUserProcess.SetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetMaximumLength) - * [`RAStreamlinesUserProcess.SetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSources) - * [`RAStreamlinesUserProcess.SetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSpacing) - * [`RAStreamlinesUserProcess.UpdateStreamlines()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.UpdateStreamlines) -* [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) - * [`RAStudy.GetAirFlow()`](RAStudy.md#generated.RAStudy.GetAirFlow) - * [`RAStudy.GetCFDCoupling()`](RAStudy.md#generated.RAStudy.GetCFDCoupling) - * [`RAStudy.GetCalculations()`](RAStudy.md#generated.RAStudy.GetCalculations) - * [`RAStudy.GetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.GetCollectForcesForFemAnalysis) - * [`RAStudy.GetContactData()`](RAStudy.md#generated.RAStudy.GetContactData) - * [`RAStudy.GetCustomerName()`](RAStudy.md#generated.RAStudy.GetCustomerName) - * [`RAStudy.GetDescription()`](RAStudy.md#generated.RAStudy.GetDescription) - * [`RAStudy.GetDomainSettings()`](RAStudy.md#generated.RAStudy.GetDomainSettings) - * [`RAStudy.GetElementCurve()`](RAStudy.md#generated.RAStudy.GetElementCurve) - * [`RAStudy.GetExportToolkit()`](RAStudy.md#generated.RAStudy.GetExportToolkit) - * [`RAStudy.GetFEMForcesAnalysisModules()`](RAStudy.md#generated.RAStudy.GetFEMForcesAnalysisModules) - * [`RAStudy.GetGeometry()`](RAStudy.md#generated.RAStudy.GetGeometry) - * [`RAStudy.GetGeometryCollection()`](RAStudy.md#generated.RAStudy.GetGeometryCollection) - * [`RAStudy.GetInletsOutletsCollection()`](RAStudy.md#generated.RAStudy.GetInletsOutletsCollection) - * [`RAStudy.GetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.GetIntraParticleCollisionStatistics) - * [`RAStudy.GetJointsData()`](RAStudy.md#generated.RAStudy.GetJointsData) - * [`RAStudy.GetMaterialCollection()`](RAStudy.md#generated.RAStudy.GetMaterialCollection) - * [`RAStudy.GetMaterialsInteractionCollection()`](RAStudy.md#generated.RAStudy.GetMaterialsInteractionCollection) - * [`RAStudy.GetMeshedParticlesUpscalingEnabled()`](RAStudy.md#generated.RAStudy.GetMeshedParticlesUpscalingEnabled) - * [`RAStudy.GetModuleCollection()`](RAStudy.md#generated.RAStudy.GetModuleCollection) - * [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource) - * [`RAStudy.GetParticleCollection()`](RAStudy.md#generated.RAStudy.GetParticleCollection) - * [`RAStudy.GetParticleInput()`](RAStudy.md#generated.RAStudy.GetParticleInput) - * [`RAStudy.GetParticles()`](RAStudy.md#generated.RAStudy.GetParticles) - * [`RAStudy.GetPhysics()`](RAStudy.md#generated.RAStudy.GetPhysics) - * [`RAStudy.GetPointCloudCollection()`](RAStudy.md#generated.RAStudy.GetPointCloudCollection) - * [`RAStudy.GetProgress()`](RAStudy.md#generated.RAStudy.GetProgress) - * [`RAStudy.GetSimulatorRun()`](RAStudy.md#generated.RAStudy.GetSimulatorRun) - * [`RAStudy.GetSolver()`](RAStudy.md#generated.RAStudy.GetSolver) - * [`RAStudy.GetStatus()`](RAStudy.md#generated.RAStudy.GetStatus) - * [`RAStudy.GetSurfaceFromFilename()`](RAStudy.md#generated.RAStudy.GetSurfaceFromFilename) - * [`RAStudy.GetTimeSet()`](RAStudy.md#generated.RAStudy.GetTimeSet) - * [`RAStudy.GetWallFromFilename()`](RAStudy.md#generated.RAStudy.GetWallFromFilename) - * [`RAStudy.HasCalculatedHTC()`](RAStudy.md#generated.RAStudy.HasCalculatedHTC) - * [`RAStudy.HasResults()`](RAStudy.md#generated.RAStudy.HasResults) - * [`RAStudy.ImportSurface()`](RAStudy.md#generated.RAStudy.ImportSurface) - * [`RAStudy.ImportSystemCouplingWall()`](RAStudy.md#generated.RAStudy.ImportSystemCouplingWall) - * [`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) - * [`RAStudy.SetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.SetCollectForcesForFemAnalysis) - * [`RAStudy.SetCustomerName()`](RAStudy.md#generated.RAStudy.SetCustomerName) - * [`RAStudy.SetDescription()`](RAStudy.md#generated.RAStudy.SetDescription) - * [`RAStudy.SetHTCCalculatorEnabled()`](RAStudy.md#generated.RAStudy.SetHTCCalculatorEnabled) - * [`RAStudy.SetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.SetIntraParticleCollisionStatistics) - * [`RAStudy.SetVariable()`](RAStudy.md#generated.RAStudy.SetVariable) - * [`RAStudy.StartSimulation()`](RAStudy.md#generated.RAStudy.StartSimulation) - * [`RAStudy.StopSimulation()`](RAStudy.md#generated.RAStudy.StopSimulation) - * [`RAStudy.customer_name`](RAStudy.md#generated.RAStudy.customer_name) - * [`RAStudy.description`](RAStudy.md#generated.RAStudy.description) -* [RASurface](RASurface.md) - * [`RASurface`](RASurface.md#generated.RASurface) - * [`RASurface.AddCurve()`](RASurface.md#generated.RASurface.AddCurve) - * [`RASurface.AddCustomCurve()`](RASurface.md#generated.RASurface.AddCustomCurve) - * [`RASurface.AddCustomProperty()`](RASurface.md#generated.RASurface.AddCustomProperty) - * [`RASurface.AddGridFunction()`](RASurface.md#generated.RASurface.AddGridFunction) - * [`RASurface.CreateCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateCurveOutputVariable) - * [`RASurface.CreateGridFunction()`](RASurface.md#generated.RASurface.CreateGridFunction) - * [`RASurface.CreateGridFunctionArrayOnCells()`](RASurface.md#generated.RASurface.CreateGridFunctionArrayOnCells) - * [`RASurface.CreateGridFunctionStatisticOutputVariable()`](RASurface.md#generated.RASurface.CreateGridFunctionStatisticOutputVariable) - * [`RASurface.CreateTransientCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateTransientCurveOutputVariable) - * [`RASurface.EditCustomCurve()`](RASurface.md#generated.RASurface.EditCustomCurve) - * [`RASurface.EditCustomProperty()`](RASurface.md#generated.RASurface.EditCustomProperty) - * [`RASurface.GetActivesArray()`](RASurface.md#generated.RASurface.GetActivesArray) - * [`RASurface.GetBoundingBox()`](RASurface.md#generated.RASurface.GetBoundingBox) - * [`RASurface.GetCellAreaAsArray()`](RASurface.md#generated.RASurface.GetCellAreaAsArray) - * [`RASurface.GetCellCenterAsArray()`](RASurface.md#generated.RASurface.GetCellCenterAsArray) - * [`RASurface.GetCellDzAsArray()`](RASurface.md#generated.RASurface.GetCellDzAsArray) - * [`RASurface.GetCellFromIJK()`](RASurface.md#generated.RASurface.GetCellFromIJK) - * [`RASurface.GetCellIJK()`](RASurface.md#generated.RASurface.GetCellIJK) - * [`RASurface.GetCellNumberOfVertices()`](RASurface.md#generated.RASurface.GetCellNumberOfVertices) - * [`RASurface.GetCellPointsAsFunction()`](RASurface.md#generated.RASurface.GetCellPointsAsFunction) - * [`RASurface.GetCellVolumeAsArray()`](RASurface.md#generated.RASurface.GetCellVolumeAsArray) - * [`RASurface.GetCurve()`](RASurface.md#generated.RASurface.GetCurve) - * [`RASurface.GetCurveNames()`](RASurface.md#generated.RASurface.GetCurveNames) - * [`RASurface.GetCurveNamesAssociation()`](RASurface.md#generated.RASurface.GetCurveNamesAssociation) - * [`RASurface.GetElementCurve()`](RASurface.md#generated.RASurface.GetElementCurve) - * [`RASurface.GetGeometryQuantity()`](RASurface.md#generated.RASurface.GetGeometryQuantity) - * [`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.GetNumberOfCells()`](RASurface.md#generated.RASurface.GetNumberOfCells) - * [`RASurface.GetNumberOfNodes()`](RASurface.md#generated.RASurface.GetNumberOfNodes) - * [`RASurface.GetNumpyCurve()`](RASurface.md#generated.RASurface.GetNumpyCurve) - * [`RASurface.GetOrientation()`](RASurface.md#generated.RASurface.GetOrientation) - * [`RASurface.GetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.GetOrientationFromAngleAndVector) - * [`RASurface.GetOrientationFromAngles()`](RASurface.md#generated.RASurface.GetOrientationFromAngles) - * [`RASurface.GetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.GetOrientationFromBasisVector) - * [`RASurface.GetOutputVariableValue()`](RASurface.md#generated.RASurface.GetOutputVariableValue) - * [`RASurface.GetPivotPoint()`](RASurface.md#generated.RASurface.GetPivotPoint) - * [`RASurface.GetTimeSet()`](RASurface.md#generated.RASurface.GetTimeSet) - * [`RASurface.GetTimeStatistics()`](RASurface.md#generated.RASurface.GetTimeStatistics) - * [`RASurface.GetTimeStep()`](RASurface.md#generated.RASurface.GetTimeStep) - * [`RASurface.GetTopologyShape()`](RASurface.md#generated.RASurface.GetTopologyShape) - * [`RASurface.GetTranslation()`](RASurface.md#generated.RASurface.GetTranslation) - * [`RASurface.HasGridFunction()`](RASurface.md#generated.RASurface.HasGridFunction) - * [`RASurface.HasMotionFrame()`](RASurface.md#generated.RASurface.HasMotionFrame) - * [`RASurface.IsCellActive()`](RASurface.md#generated.RASurface.IsCellActive) - * [`RASurface.IterCellVertices()`](RASurface.md#generated.RASurface.IterCellVertices) - * [`RASurface.IterCells()`](RASurface.md#generated.RASurface.IterCells) - * [`RASurface.Modified()`](RASurface.md#generated.RASurface.Modified) - * [`RASurface.RemoveCustomCurve()`](RASurface.md#generated.RASurface.RemoveCustomCurve) - * [`RASurface.RemoveCustomProperty()`](RASurface.md#generated.RASurface.RemoveCustomProperty) - * [`RASurface.RemoveOutputVariable()`](RASurface.md#generated.RASurface.RemoveOutputVariable) - * [`RASurface.RemoveProcess()`](RASurface.md#generated.RASurface.RemoveProcess) - * [`RASurface.SetCurrentTimeStep()`](RASurface.md#generated.RASurface.SetCurrentTimeStep) - * [`RASurface.SetInvertNormal()`](RASurface.md#generated.RASurface.SetInvertNormal) - * [`RASurface.SetOrientation()`](RASurface.md#generated.RASurface.SetOrientation) - * [`RASurface.SetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.SetOrientationFromAngleAndVector) - * [`RASurface.SetOrientationFromAngles()`](RASurface.md#generated.RASurface.SetOrientationFromAngles) - * [`RASurface.SetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.SetOrientationFromBasisVector) - * [`RASurface.SetPivotPoint()`](RASurface.md#generated.RASurface.SetPivotPoint) - * [`RASurface.SetTranslation()`](RASurface.md#generated.RASurface.SetTranslation) -* [RASurfaceUserProcess](RASurfaceUserProcess.md) - * [`RASurfaceUserProcess`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess) - * [`RASurfaceUserProcess.AddCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCurve) - * [`RASurfaceUserProcess.AddCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomCurve) - * [`RASurfaceUserProcess.AddCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomProperty) - * [`RASurfaceUserProcess.AddGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddGridFunction) - * [`RASurfaceUserProcess.CreateCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateCurveOutputVariable) - * [`RASurfaceUserProcess.CreateGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunction) - * [`RASurfaceUserProcess.CreateGridFunctionArrayOnCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionArrayOnCells) - * [`RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable) - * [`RASurfaceUserProcess.CreateTransientCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateTransientCurveOutputVariable) - * [`RASurfaceUserProcess.EditCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomCurve) - * [`RASurfaceUserProcess.EditCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomProperty) - * [`RASurfaceUserProcess.GetActivesArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetActivesArray) - * [`RASurfaceUserProcess.GetBoundingBox()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetBoundingBox) - * [`RASurfaceUserProcess.GetCellAreaAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellAreaAsArray) - * [`RASurfaceUserProcess.GetCellCenterAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellCenterAsArray) - * [`RASurfaceUserProcess.GetCellDzAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellDzAsArray) - * [`RASurfaceUserProcess.GetCellFromIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellFromIJK) - * [`RASurfaceUserProcess.GetCellIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellIJK) - * [`RASurfaceUserProcess.GetCellNumberOfVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellNumberOfVertices) - * [`RASurfaceUserProcess.GetCellPointsAsFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellPointsAsFunction) - * [`RASurfaceUserProcess.GetCellVolumeAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellVolumeAsArray) - * [`RASurfaceUserProcess.GetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCenter) - * [`RASurfaceUserProcess.GetCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurve) - * [`RASurfaceUserProcess.GetCurveNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNames) - * [`RASurfaceUserProcess.GetCurveNamesAssociation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNamesAssociation) - * [`RASurfaceUserProcess.GetElementCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetElementCurve) - * [`RASurfaceUserProcess.GetGeometryQuantity()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryQuantity) - * [`RASurfaceUserProcess.GetGeometryUnit()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryUnit) - * [`RASurfaceUserProcess.GetGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunction) - * [`RASurfaceUserProcess.GetGridFunctionNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunctionNames) - * [`RASurfaceUserProcess.GetMeshColoring()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMeshColoring) - * [`RASurfaceUserProcess.GetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMotionFrame) - * [`RASurfaceUserProcess.GetNumberOfCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfCells) - * [`RASurfaceUserProcess.GetNumberOfNodes()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfNodes) - * [`RASurfaceUserProcess.GetNumberOfParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfParticles) - * [`RASurfaceUserProcess.GetNumpyCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumpyCurve) - * [`RASurfaceUserProcess.GetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientation) - * [`RASurfaceUserProcess.GetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngleAndVector) - * [`RASurfaceUserProcess.GetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngles) - * [`RASurfaceUserProcess.GetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromBasisVector) - * [`RASurfaceUserProcess.GetOutputVariableValue()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOutputVariableValue) - * [`RASurfaceUserProcess.GetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetScale) - * [`RASurfaceUserProcess.GetTimeSet()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeSet) - * [`RASurfaceUserProcess.GetTimeStatistics()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStatistics) - * [`RASurfaceUserProcess.GetTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStep) - * [`RASurfaceUserProcess.GetTopologyShape()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTopologyShape) - * [`RASurfaceUserProcess.HasGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.HasGridFunction) - * [`RASurfaceUserProcess.IsCellActive()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IsCellActive) - * [`RASurfaceUserProcess.IterCellVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCellVertices) - * [`RASurfaceUserProcess.IterCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCells) - * [`RASurfaceUserProcess.IterParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterParticles) - * [`RASurfaceUserProcess.Modified()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.Modified) - * [`RASurfaceUserProcess.RemoveCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomCurve) - * [`RASurfaceUserProcess.RemoveCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomProperty) - * [`RASurfaceUserProcess.RemoveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveOutputVariable) - * [`RASurfaceUserProcess.RemoveProcess()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveProcess) - * [`RASurfaceUserProcess.SetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCenter) - * [`RASurfaceUserProcess.SetCurrentTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCurrentTimeStep) - * [`RASurfaceUserProcess.SetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetMotionFrame) - * [`RASurfaceUserProcess.SetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientation) - * [`RASurfaceUserProcess.SetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngleAndVector) - * [`RASurfaceUserProcess.SetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngles) - * [`RASurfaceUserProcess.SetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromBasisVector) - * [`RASurfaceUserProcess.SetSTL()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetSTL) - * [`RASurfaceUserProcess.SetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetScale) -* [RASystemCouplingWall](RASystemCouplingWall.md) - * [`RASystemCouplingWall`](RASystemCouplingWall.md#generated.RASystemCouplingWall) - * [`RASystemCouplingWall.AddCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCurve) - * [`RASystemCouplingWall.AddCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomCurve) - * [`RASystemCouplingWall.AddCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomProperty) - * [`RASystemCouplingWall.AddGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddGridFunction) - * [`RASystemCouplingWall.CreateCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateCurveOutputVariable) - * [`RASystemCouplingWall.CreateGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunction) - * [`RASystemCouplingWall.CreateGridFunctionArrayOnCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionArrayOnCells) - * [`RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable) - * [`RASystemCouplingWall.CreateTransientCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateTransientCurveOutputVariable) - * [`RASystemCouplingWall.DisableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableStructuralCouplingType) - * [`RASystemCouplingWall.DisableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableThermalCouplingType) - * [`RASystemCouplingWall.EditCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomCurve) - * [`RASystemCouplingWall.EditCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomProperty) - * [`RASystemCouplingWall.EnableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableStructuralCouplingType) - * [`RASystemCouplingWall.EnableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableThermalCouplingType) - * [`RASystemCouplingWall.GetActivesArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetActivesArray) - * [`RASystemCouplingWall.GetAvailableMaterials()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetAvailableMaterials) - * [`RASystemCouplingWall.GetBoundingBox()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetBoundingBox) - * [`RASystemCouplingWall.GetCellAreaAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellAreaAsArray) - * [`RASystemCouplingWall.GetCellCenterAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellCenterAsArray) - * [`RASystemCouplingWall.GetCellDzAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellDzAsArray) - * [`RASystemCouplingWall.GetCellFromIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellFromIJK) - * [`RASystemCouplingWall.GetCellIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellIJK) - * [`RASystemCouplingWall.GetCellNumberOfVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellNumberOfVertices) - * [`RASystemCouplingWall.GetCellPointsAsFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellPointsAsFunction) - * [`RASystemCouplingWall.GetCellVolumeAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellVolumeAsArray) - * [`RASystemCouplingWall.GetCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurve) - * [`RASystemCouplingWall.GetCurveNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNames) - * [`RASystemCouplingWall.GetCurveNamesAssociation()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNamesAssociation) - * [`RASystemCouplingWall.GetElementCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetElementCurve) - * [`RASystemCouplingWall.GetGeometryQuantity()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryQuantity) - * [`RASystemCouplingWall.GetGeometryUnit()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryUnit) - * [`RASystemCouplingWall.GetGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunction) - * [`RASystemCouplingWall.GetGridFunctionNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunctionNames) - * [`RASystemCouplingWall.GetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMaterial) - * [`RASystemCouplingWall.GetMeshColoring()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMeshColoring) - * [`RASystemCouplingWall.GetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMotionFrame) - * [`RASystemCouplingWall.GetNumberOfCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfCells) - * [`RASystemCouplingWall.GetNumberOfNodes()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfNodes) - * [`RASystemCouplingWall.GetNumpyCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumpyCurve) - * [`RASystemCouplingWall.GetOutputVariableValue()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetOutputVariableValue) - * [`RASystemCouplingWall.GetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSphBoundaryType) - * [`RASystemCouplingWall.GetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetStructuralCouplingTypeEnabled) - * [`RASystemCouplingWall.GetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSurfaceTensionContactAngle) - * [`RASystemCouplingWall.GetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetThermalCouplingTypeEnabled) - * [`RASystemCouplingWall.GetTimeSet()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeSet) - * [`RASystemCouplingWall.GetTimeStatistics()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStatistics) - * [`RASystemCouplingWall.GetTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStep) - * [`RASystemCouplingWall.GetTopologyShape()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTopologyShape) - * [`RASystemCouplingWall.GetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTriangleSize) - * [`RASystemCouplingWall.GetValidSphBoundaryTypeValues()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues) - * [`RASystemCouplingWall.HasGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasGridFunction) - * [`RASystemCouplingWall.HasMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasMotionFrame) - * [`RASystemCouplingWall.IsCellActive()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsCellActive) - * [`RASystemCouplingWall.IsStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsStructuralCouplingTypeEnabled) - * [`RASystemCouplingWall.IsThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsThermalCouplingTypeEnabled) - * [`RASystemCouplingWall.IterCellVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCellVertices) - * [`RASystemCouplingWall.IterCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCells) - * [`RASystemCouplingWall.Modified()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.Modified) - * [`RASystemCouplingWall.RemoveCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomCurve) - * [`RASystemCouplingWall.RemoveCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomProperty) - * [`RASystemCouplingWall.RemoveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveOutputVariable) - * [`RASystemCouplingWall.RemoveProcess()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveProcess) - * [`RASystemCouplingWall.SetCurrentTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCurrentTimeStep) - * [`RASystemCouplingWall.SetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMaterial) - * [`RASystemCouplingWall.SetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMotionFrame) - * [`RASystemCouplingWall.SetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSphBoundaryType) - * [`RASystemCouplingWall.SetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetStructuralCouplingTypeEnabled) - * [`RASystemCouplingWall.SetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSurfaceTensionContactAngle) - * [`RASystemCouplingWall.SetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetThermalCouplingTypeEnabled) - * [`RASystemCouplingWall.SetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetTriangleSize) -* [RATagging](RATagging.md) - * [`RATagging`](RATagging.md#generated.RATagging) - * [`RATagging.GetGridFunctionName()`](RATagging.md#generated.RATagging.GetGridFunctionName) - * [`RATagging.GetNameMask()`](RATagging.md#generated.RATagging.GetNameMask) - * [`RATagging.GetTagValue()`](RATagging.md#generated.RATagging.GetTagValue) - * [`RATagging.GetTimeRangeFilter()`](RATagging.md#generated.RATagging.GetTimeRangeFilter) - * [`RATagging.SetNameMask()`](RATagging.md#generated.RATagging.SetNameMask) - * [`RATagging.SetTagValue()`](RATagging.md#generated.RATagging.SetTagValue) -* [RAThreeRollsBeltProfile](RAThreeRollsBeltProfile.md) - * [`RAThreeRollsBeltProfile`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile) - * [`RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths) - * [`RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths) - * [`RAThreeRollsBeltProfile.GetAvailableMaterials()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetAvailableMaterials) - * [`RAThreeRollsBeltProfile.GetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetCenterRollLength) - * [`RAThreeRollsBeltProfile.GetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetLowerCornerRadius) - * [`RAThreeRollsBeltProfile.GetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetMaterial) - * [`RAThreeRollsBeltProfile.GetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetTroughingAngle) - * [`RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths) - * [`RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled) - * [`RAThreeRollsBeltProfile.SetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetCenterRollLength) - * [`RAThreeRollsBeltProfile.SetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetLowerCornerRadius) - * [`RAThreeRollsBeltProfile.SetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetMaterial) - * [`RAThreeRollsBeltProfile.SetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetTroughingAngle) - * [`RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths) -* [RATimeRangeFilter](RATimeRangeFilter.md) - * [`RATimeRangeFilter`](RATimeRangeFilter.md#generated.RATimeRangeFilter) - * [`RATimeRangeFilter.GetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetDomainRange) - * [`RATimeRangeFilter.GetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetFinal) - * [`RATimeRangeFilter.GetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetInitial) - * [`RATimeRangeFilter.GetValidDomainRangeValues()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetValidDomainRangeValues) - * [`RATimeRangeFilter.SetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetDomainRange) - * [`RATimeRangeFilter.SetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetFinal) - * [`RATimeRangeFilter.SetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetInitial) -* [RATimeSeriesRotation](RATimeSeriesRotation.md) - * [`RATimeSeriesRotation`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation) - * [`RATimeSeriesRotation.ImportTimeSeriesMotion()`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation.ImportTimeSeriesMotion) -* [RATimeSeriesTranslation](RATimeSeriesTranslation.md) - * [`RATimeSeriesTranslation`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation) - * [`RATimeSeriesTranslation.ImportTimeSeriesMotion()`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation.ImportTimeSeriesMotion) -* [RATrajectoryProcess](RATrajectoryProcess.md) - * [`RATrajectoryProcess`](RATrajectoryProcess.md#generated.RATrajectoryProcess) - * [`RATrajectoryProcess.AddCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCurve) - * [`RATrajectoryProcess.AddCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomCurve) - * [`RATrajectoryProcess.AddCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomProperty) - * [`RATrajectoryProcess.AddGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddGridFunction) - * [`RATrajectoryProcess.CreateCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateCurveOutputVariable) - * [`RATrajectoryProcess.CreateGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunction) - * [`RATrajectoryProcess.CreateGridFunctionArrayOnCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionArrayOnCells) - * [`RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable) - * [`RATrajectoryProcess.CreateTransientCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateTransientCurveOutputVariable) - * [`RATrajectoryProcess.EditCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomCurve) - * [`RATrajectoryProcess.EditCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomProperty) - * [`RATrajectoryProcess.GetActivesArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetActivesArray) - * [`RATrajectoryProcess.GetBoundingBox()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetBoundingBox) - * [`RATrajectoryProcess.GetCellAreaAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellAreaAsArray) - * [`RATrajectoryProcess.GetCellCenterAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellCenterAsArray) - * [`RATrajectoryProcess.GetCellDzAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellDzAsArray) - * [`RATrajectoryProcess.GetCellFromIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellFromIJK) - * [`RATrajectoryProcess.GetCellIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellIJK) - * [`RATrajectoryProcess.GetCellNumberOfVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellNumberOfVertices) - * [`RATrajectoryProcess.GetCellPointsAsFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellPointsAsFunction) - * [`RATrajectoryProcess.GetCellVolumeAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellVolumeAsArray) - * [`RATrajectoryProcess.GetCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurve) - * [`RATrajectoryProcess.GetCurveNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNames) - * [`RATrajectoryProcess.GetCurveNamesAssociation()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNamesAssociation) - * [`RATrajectoryProcess.GetElementCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetElementCurve) - * [`RATrajectoryProcess.GetGeometryQuantity()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryQuantity) - * [`RATrajectoryProcess.GetGeometryUnit()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryUnit) - * [`RATrajectoryProcess.GetGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunction) - * [`RATrajectoryProcess.GetGridFunctionNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunctionNames) - * [`RATrajectoryProcess.GetMeshColoring()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetMeshColoring) - * [`RATrajectoryProcess.GetNumberOfCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfCells) - * [`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.HasGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.HasGridFunction) - * [`RATrajectoryProcess.IsCellActive()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IsCellActive) - * [`RATrajectoryProcess.IterCellVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCellVertices) - * [`RATrajectoryProcess.IterCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCells) - * [`RATrajectoryProcess.IterParticles()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterParticles) - * [`RATrajectoryProcess.Modified()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.Modified) - * [`RATrajectoryProcess.RemoveCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomCurve) - * [`RATrajectoryProcess.RemoveCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomProperty) - * [`RATrajectoryProcess.RemoveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveOutputVariable) - * [`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) - * [`RATranslation.GetAcceleration()`](RATranslation.md#generated.RATranslation.GetAcceleration) - * [`RATranslation.GetFinalVelocity()`](RATranslation.md#generated.RATranslation.GetFinalVelocity) - * [`RATranslation.GetInput()`](RATranslation.md#generated.RATranslation.GetInput) - * [`RATranslation.GetValidInputValues()`](RATranslation.md#generated.RATranslation.GetValidInputValues) - * [`RATranslation.GetVelocity()`](RATranslation.md#generated.RATranslation.GetVelocity) - * [`RATranslation.SetAcceleration()`](RATranslation.md#generated.RATranslation.SetAcceleration) - * [`RATranslation.SetFinalVelocity()`](RATranslation.md#generated.RATranslation.SetFinalVelocity) - * [`RATranslation.SetInput()`](RATranslation.md#generated.RATranslation.SetInput) - * [`RATranslation.SetVelocity()`](RATranslation.md#generated.RATranslation.SetVelocity) -* [RATwoRollsBeltProfile](RATwoRollsBeltProfile.md) - * [`RATwoRollsBeltProfile`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile) - * [`RATwoRollsBeltProfile.GetAvailableMaterials()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetAvailableMaterials) - * [`RATwoRollsBeltProfile.GetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetLowerCornerRadius) - * [`RATwoRollsBeltProfile.GetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetMaterial) - * [`RATwoRollsBeltProfile.GetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetTroughingAngle) - * [`RATwoRollsBeltProfile.SetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetLowerCornerRadius) - * [`RATwoRollsBeltProfile.SetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetMaterial) - * [`RATwoRollsBeltProfile.SetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetTroughingAngle) -* [RAUserProcessCollection](RAUserProcessCollection.md) - * [`RAUserProcessCollection`](RAUserProcessCollection.md#generated.RAUserProcessCollection) - * [`RAUserProcessCollection.CreateContactToParticleProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateContactToParticleProcess) - * [`RAUserProcessCollection.CreateCubeProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCubeProcess) - * [`RAUserProcessCollection.CreateCylinderProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCylinderProcess) - * [`RAUserProcessCollection.CreateEulerianStatistics()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateEulerianStatistics) - * [`RAUserProcessCollection.CreateFilterProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateFilterProcess) - * [`RAUserProcessCollection.CreateInspectorProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateInspectorProcess) - * [`RAUserProcessCollection.CreateParticleTimeSelectionProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleTimeSelectionProcess) - * [`RAUserProcessCollection.CreateParticleToContactProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleToContactProcess) - * [`RAUserProcessCollection.CreatePlaneProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePlaneProcess) - * [`RAUserProcessCollection.CreatePolyhedronProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePolyhedronProcess) - * [`RAUserProcessCollection.CreatePropertyProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePropertyProcess) - * [`RAUserProcessCollection.CreateStreamlinesUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateStreamlinesUserProcess) - * [`RAUserProcessCollection.CreateSurfaceUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateSurfaceUserProcess) - * [`RAUserProcessCollection.CreateTrajectoryProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateTrajectoryProcess) - * [`RAUserProcessCollection.GetContactToParticleProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetContactToParticleProcessNames) - * [`RAUserProcessCollection.GetCubeProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCubeProcessNames) - * [`RAUserProcessCollection.GetCylinderProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCylinderProcessNames) - * [`RAUserProcessCollection.GetEulerianStatisticsNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetEulerianStatisticsNames) - * [`RAUserProcessCollection.GetFilterProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetFilterProcessNames) - * [`RAUserProcessCollection.GetInspectorProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetInspectorProcessNames) - * [`RAUserProcessCollection.GetParticleTimeSelectionProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleTimeSelectionProcessNames) - * [`RAUserProcessCollection.GetParticleToContactProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleToContactProcessNames) - * [`RAUserProcessCollection.GetPlaneProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPlaneProcessNames) - * [`RAUserProcessCollection.GetPolyhedronProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPolyhedronProcessNames) - * [`RAUserProcessCollection.GetProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcess) - * [`RAUserProcessCollection.GetProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcessNames) - * [`RAUserProcessCollection.GetPropertyProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPropertyProcessNames) - * [`RAUserProcessCollection.GetStreamlinesUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetStreamlinesUserProcessNames) - * [`RAUserProcessCollection.GetSurfaceUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetSurfaceUserProcessNames) - * [`RAUserProcessCollection.GetTrajectoryProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetTrajectoryProcessNames) -* [RAVibration](RAVibration.md) - * [`RAVibration`](RAVibration.md#generated.RAVibration) - * [`RAVibration.GetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.GetAmplitudeVariation) - * [`RAVibration.GetDirection()`](RAVibration.md#generated.RAVibration.GetDirection) - * [`RAVibration.GetFrequencyVariation()`](RAVibration.md#generated.RAVibration.GetFrequencyVariation) - * [`RAVibration.GetInitialAmplitude()`](RAVibration.md#generated.RAVibration.GetInitialAmplitude) - * [`RAVibration.GetInitialFrequency()`](RAVibration.md#generated.RAVibration.GetInitialFrequency) - * [`RAVibration.GetInitialPhase()`](RAVibration.md#generated.RAVibration.GetInitialPhase) - * [`RAVibration.SetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.SetAmplitudeVariation) - * [`RAVibration.SetDirection()`](RAVibration.md#generated.RAVibration.SetDirection) - * [`RAVibration.SetFrequencyVariation()`](RAVibration.md#generated.RAVibration.SetFrequencyVariation) - * [`RAVibration.SetInitialAmplitude()`](RAVibration.md#generated.RAVibration.SetInitialAmplitude) - * [`RAVibration.SetInitialFrequency()`](RAVibration.md#generated.RAVibration.SetInitialFrequency) - * [`RAVibration.SetInitialPhase()`](RAVibration.md#generated.RAVibration.SetInitialPhase) -* [RAVolumetricInlet](RAVolumetricInlet.md) - * [`RAVolumetricInlet`](RAVolumetricInlet.md#generated.RAVolumetricInlet) - * [`RAVolumetricInlet.DisablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisablePeriodic) - * [`RAVolumetricInlet.EnablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnablePeriodic) - * [`RAVolumetricInlet.GetAvailableGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetAvailableGeometries) - * [`RAVolumetricInlet.GetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxCenter) - * [`RAVolumetricInlet.GetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxDimensions) - * [`RAVolumetricInlet.GetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGapScaleFactor) - * [`RAVolumetricInlet.GetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGeometries) - * [`RAVolumetricInlet.GetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInitialVelocity) - * [`RAVolumetricInlet.GetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInjectionTime) - * [`RAVolumetricInlet.GetInputPropertiesList()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInputPropertiesList) - * [`RAVolumetricInlet.GetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientation) - * [`RAVolumetricInlet.GetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngleAndVector) - * [`RAVolumetricInlet.GetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngles) - * [`RAVolumetricInlet.GetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromBasisVector) - * [`RAVolumetricInlet.GetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriod) - * [`RAVolumetricInlet.GetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriodic) - * [`RAVolumetricInlet.GetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSeedCoordinates) - * [`RAVolumetricInlet.GetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphMass) - * [`RAVolumetricInlet.GetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphTemperature) - * [`RAVolumetricInlet.GetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetStopTime) - * [`RAVolumetricInlet.GetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseGeometriesToCompute) - * [`RAVolumetricInlet.IsPeriodicEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled) - * [`RAVolumetricInlet.SetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxCenter) - * [`RAVolumetricInlet.SetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxDimensions) - * [`RAVolumetricInlet.SetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGapScaleFactor) - * [`RAVolumetricInlet.SetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGeometries) - * [`RAVolumetricInlet.SetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInitialVelocity) - * [`RAVolumetricInlet.SetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInjectionTime) - * [`RAVolumetricInlet.SetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientation) - * [`RAVolumetricInlet.SetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngleAndVector) - * [`RAVolumetricInlet.SetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngles) - * [`RAVolumetricInlet.SetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromBasisVector) - * [`RAVolumetricInlet.SetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriod) - * [`RAVolumetricInlet.SetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriodic) - * [`RAVolumetricInlet.SetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSeedCoordinates) - * [`RAVolumetricInlet.SetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphMass) - * [`RAVolumetricInlet.SetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphTemperature) - * [`RAVolumetricInlet.SetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetStopTime) - * [`RAVolumetricInlet.SetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseGeometriesToCompute) -* [RAVolumetricInletProperties](RAVolumetricInletProperties.md) - * [`RAVolumetricInletProperties`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties) - * [`RAVolumetricInletProperties.GetAvailableParticles()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetAvailableParticles) - * [`RAVolumetricInletProperties.GetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetMass) - * [`RAVolumetricInletProperties.GetModuleProperties()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperties) - * [`RAVolumetricInletProperties.GetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperty) - * [`RAVolumetricInletProperties.GetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetParticle) - * [`RAVolumetricInletProperties.GetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetTemperature) - * [`RAVolumetricInletProperties.GetValidOptionsForModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetValidOptionsForModuleProperty) - * [`RAVolumetricInletProperties.SetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetMass) - * [`RAVolumetricInletProperties.SetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetModuleProperty) - * [`RAVolumetricInletProperties.SetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetParticle) - * [`RAVolumetricInletProperties.SetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetTemperature) -* [RAVolumetricInletPropertiesList](RAVolumetricInletPropertiesList.md) - * [`RAVolumetricInletPropertiesList`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList) - * [`RAVolumetricInletPropertiesList.Clear()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Clear) - * [`RAVolumetricInletPropertiesList.New()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.New) - * [`RAVolumetricInletPropertiesList.Remove()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Remove) -* [RAWall](RAWall.md) - * [`RAWall`](RAWall.md#generated.RAWall) - * [`RAWall.AddCurve()`](RAWall.md#generated.RAWall.AddCurve) - * [`RAWall.AddCustomCurve()`](RAWall.md#generated.RAWall.AddCustomCurve) - * [`RAWall.AddCustomProperty()`](RAWall.md#generated.RAWall.AddCustomProperty) - * [`RAWall.AddGridFunction()`](RAWall.md#generated.RAWall.AddGridFunction) - * [`RAWall.CreateCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateCurveOutputVariable) - * [`RAWall.CreateGridFunction()`](RAWall.md#generated.RAWall.CreateGridFunction) - * [`RAWall.CreateGridFunctionArrayOnCells()`](RAWall.md#generated.RAWall.CreateGridFunctionArrayOnCells) - * [`RAWall.CreateGridFunctionStatisticOutputVariable()`](RAWall.md#generated.RAWall.CreateGridFunctionStatisticOutputVariable) - * [`RAWall.CreateTransientCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateTransientCurveOutputVariable) - * [`RAWall.EditCustomCurve()`](RAWall.md#generated.RAWall.EditCustomCurve) - * [`RAWall.EditCustomProperty()`](RAWall.md#generated.RAWall.EditCustomProperty) - * [`RAWall.GetActivesArray()`](RAWall.md#generated.RAWall.GetActivesArray) - * [`RAWall.GetAvailableMaterials()`](RAWall.md#generated.RAWall.GetAvailableMaterials) - * [`RAWall.GetBoundaryMass()`](RAWall.md#generated.RAWall.GetBoundaryMass) - * [`RAWall.GetBoundingBox()`](RAWall.md#generated.RAWall.GetBoundingBox) - * [`RAWall.GetCellAreaAsArray()`](RAWall.md#generated.RAWall.GetCellAreaAsArray) - * [`RAWall.GetCellCenterAsArray()`](RAWall.md#generated.RAWall.GetCellCenterAsArray) - * [`RAWall.GetCellDzAsArray()`](RAWall.md#generated.RAWall.GetCellDzAsArray) - * [`RAWall.GetCellFromIJK()`](RAWall.md#generated.RAWall.GetCellFromIJK) - * [`RAWall.GetCellIJK()`](RAWall.md#generated.RAWall.GetCellIJK) - * [`RAWall.GetCellNumberOfVertices()`](RAWall.md#generated.RAWall.GetCellNumberOfVertices) - * [`RAWall.GetCellPointsAsFunction()`](RAWall.md#generated.RAWall.GetCellPointsAsFunction) - * [`RAWall.GetCellVolumeAsArray()`](RAWall.md#generated.RAWall.GetCellVolumeAsArray) - * [`RAWall.GetCurve()`](RAWall.md#generated.RAWall.GetCurve) - * [`RAWall.GetCurveNames()`](RAWall.md#generated.RAWall.GetCurveNames) - * [`RAWall.GetCurveNamesAssociation()`](RAWall.md#generated.RAWall.GetCurveNamesAssociation) - * [`RAWall.GetDisableTime()`](RAWall.md#generated.RAWall.GetDisableTime) - * [`RAWall.GetElementCurve()`](RAWall.md#generated.RAWall.GetElementCurve) - * [`RAWall.GetEnableTime()`](RAWall.md#generated.RAWall.GetEnableTime) - * [`RAWall.GetGeometryQuantity()`](RAWall.md#generated.RAWall.GetGeometryQuantity) - * [`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) - * [`RAWall.GetModuleProperty()`](RAWall.md#generated.RAWall.GetModuleProperty) - * [`RAWall.GetMomentXDirection()`](RAWall.md#generated.RAWall.GetMomentXDirection) - * [`RAWall.GetMomentYDirection()`](RAWall.md#generated.RAWall.GetMomentYDirection) - * [`RAWall.GetMomentZDirection()`](RAWall.md#generated.RAWall.GetMomentZDirection) - * [`RAWall.GetNumberOfCells()`](RAWall.md#generated.RAWall.GetNumberOfCells) - * [`RAWall.GetNumberOfNodes()`](RAWall.md#generated.RAWall.GetNumberOfNodes) - * [`RAWall.GetNumberOfReplications()`](RAWall.md#generated.RAWall.GetNumberOfReplications) - * [`RAWall.GetNumpyCurve()`](RAWall.md#generated.RAWall.GetNumpyCurve) - * [`RAWall.GetOrientation()`](RAWall.md#generated.RAWall.GetOrientation) - * [`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) - * [`RAWall.GetPrincipalMomentOfInertia()`](RAWall.md#generated.RAWall.GetPrincipalMomentOfInertia) - * [`RAWall.GetReplicateGeometry()`](RAWall.md#generated.RAWall.GetReplicateGeometry) - * [`RAWall.GetReplicateTime()`](RAWall.md#generated.RAWall.GetReplicateTime) - * [`RAWall.GetSphBoundaryType()`](RAWall.md#generated.RAWall.GetSphBoundaryType) - * [`RAWall.GetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.GetSurfaceTensionContactAngle) - * [`RAWall.GetTemperature()`](RAWall.md#generated.RAWall.GetTemperature) - * [`RAWall.GetThermalBoundaryConditionType()`](RAWall.md#generated.RAWall.GetThermalBoundaryConditionType) - * [`RAWall.GetTimeSet()`](RAWall.md#generated.RAWall.GetTimeSet) - * [`RAWall.GetTimeStatistics()`](RAWall.md#generated.RAWall.GetTimeStatistics) - * [`RAWall.GetTimeStep()`](RAWall.md#generated.RAWall.GetTimeStep) - * [`RAWall.GetTopologyShape()`](RAWall.md#generated.RAWall.GetTopologyShape) - * [`RAWall.GetTranslation()`](RAWall.md#generated.RAWall.GetTranslation) - * [`RAWall.GetTriangleSize()`](RAWall.md#generated.RAWall.GetTriangleSize) - * [`RAWall.GetValidOptionsForModuleProperty()`](RAWall.md#generated.RAWall.GetValidOptionsForModuleProperty) - * [`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.GetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.GetVolumeShearWorkRatio) - * [`RAWall.GetWearModel()`](RAWall.md#generated.RAWall.GetWearModel) - * [`RAWall.HasGridFunction()`](RAWall.md#generated.RAWall.HasGridFunction) - * [`RAWall.HasMotionFrame()`](RAWall.md#generated.RAWall.HasMotionFrame) - * [`RAWall.IsCellActive()`](RAWall.md#generated.RAWall.IsCellActive) - * [`RAWall.IterCellVertices()`](RAWall.md#generated.RAWall.IterCellVertices) - * [`RAWall.IterCells()`](RAWall.md#generated.RAWall.IterCells) - * [`RAWall.LoadFile()`](RAWall.md#generated.RAWall.LoadFile) - * [`RAWall.Modified()`](RAWall.md#generated.RAWall.Modified) - * [`RAWall.OrientationAnglesOrder`](RAWall.md#generated.RAWall.OrientationAnglesOrder) - * [`RAWall.RemoveCustomCurve()`](RAWall.md#generated.RAWall.RemoveCustomCurve) - * [`RAWall.RemoveCustomProperty()`](RAWall.md#generated.RAWall.RemoveCustomProperty) - * [`RAWall.RemoveOutputVariable()`](RAWall.md#generated.RAWall.RemoveOutputVariable) - * [`RAWall.RemoveProcess()`](RAWall.md#generated.RAWall.RemoveProcess) - * [`RAWall.SetBoundaryMass()`](RAWall.md#generated.RAWall.SetBoundaryMass) - * [`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.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) - * [`RAWall.SetReplicateGeometry()`](RAWall.md#generated.RAWall.SetReplicateGeometry) - * [`RAWall.SetReplicateTime()`](RAWall.md#generated.RAWall.SetReplicateTime) - * [`RAWall.SetSphBoundaryType()`](RAWall.md#generated.RAWall.SetSphBoundaryType) - * [`RAWall.SetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.SetSurfaceTensionContactAngle) - * [`RAWall.SetTemperature()`](RAWall.md#generated.RAWall.SetTemperature) - * [`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) + + +# Class Reference + +These are the classes and methods available to the user when executing scripts: + +* [RAAirFlow](RAAirFlow.md) + * [`RAAirFlow`](RAAirFlow.md#generated.RAAirFlow) + * [`RAAirFlow.AddCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCurve) + * [`RAAirFlow.AddCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCustomCurve) + * [`RAAirFlow.AddCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.AddCustomProperty) + * [`RAAirFlow.AddGridFunction()`](RAAirFlow.md#generated.RAAirFlow.AddGridFunction) + * [`RAAirFlow.CreateCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateCurveOutputVariable) + * [`RAAirFlow.CreateGridFunction()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunction) + * [`RAAirFlow.CreateGridFunctionArrayOnCells()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionArrayOnCells) + * [`RAAirFlow.CreateGridFunctionStatisticOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateGridFunctionStatisticOutputVariable) + * [`RAAirFlow.CreateTransientCurveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.CreateTransientCurveOutputVariable) + * [`RAAirFlow.EditCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.EditCustomCurve) + * [`RAAirFlow.EditCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.EditCustomProperty) + * [`RAAirFlow.GetActivesArray()`](RAAirFlow.md#generated.RAAirFlow.GetActivesArray) + * [`RAAirFlow.GetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.GetAirDensity) + * [`RAAirFlow.GetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.GetAirKinematicViscosity) + * [`RAAirFlow.GetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.GetBoundaryConditionType) + * [`RAAirFlow.GetBoundingBox()`](RAAirFlow.md#generated.RAAirFlow.GetBoundingBox) + * [`RAAirFlow.GetCellAreaAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellAreaAsArray) + * [`RAAirFlow.GetCellCenterAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellCenterAsArray) + * [`RAAirFlow.GetCellDzAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellDzAsArray) + * [`RAAirFlow.GetCellFromIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellFromIJK) + * [`RAAirFlow.GetCellIJK()`](RAAirFlow.md#generated.RAAirFlow.GetCellIJK) + * [`RAAirFlow.GetCellNumberOfVertices()`](RAAirFlow.md#generated.RAAirFlow.GetCellNumberOfVertices) + * [`RAAirFlow.GetCellPointsAsFunction()`](RAAirFlow.md#generated.RAAirFlow.GetCellPointsAsFunction) + * [`RAAirFlow.GetCellSize()`](RAAirFlow.md#generated.RAAirFlow.GetCellSize) + * [`RAAirFlow.GetCellVolumeAsArray()`](RAAirFlow.md#generated.RAAirFlow.GetCellVolumeAsArray) + * [`RAAirFlow.GetCurve()`](RAAirFlow.md#generated.RAAirFlow.GetCurve) + * [`RAAirFlow.GetCurveNames()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNames) + * [`RAAirFlow.GetCurveNamesAssociation()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNamesAssociation) + * [`RAAirFlow.GetElementCurve()`](RAAirFlow.md#generated.RAAirFlow.GetElementCurve) + * [`RAAirFlow.GetGeometryQuantity()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryQuantity) + * [`RAAirFlow.GetGeometryUnit()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryUnit) + * [`RAAirFlow.GetGridFunction()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunction) + * [`RAAirFlow.GetGridFunctionNames()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunctionNames) + * [`RAAirFlow.GetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.GetInteractionScale) + * [`RAAirFlow.GetMaxX()`](RAAirFlow.md#generated.RAAirFlow.GetMaxX) + * [`RAAirFlow.GetMaxY()`](RAAirFlow.md#generated.RAAirFlow.GetMaxY) + * [`RAAirFlow.GetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.GetMaxZ) + * [`RAAirFlow.GetMeshColoring()`](RAAirFlow.md#generated.RAAirFlow.GetMeshColoring) + * [`RAAirFlow.GetMinX()`](RAAirFlow.md#generated.RAAirFlow.GetMinX) + * [`RAAirFlow.GetMinY()`](RAAirFlow.md#generated.RAAirFlow.GetMinY) + * [`RAAirFlow.GetMinZ()`](RAAirFlow.md#generated.RAAirFlow.GetMinZ) + * [`RAAirFlow.GetNumberOfCells()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfCells) + * [`RAAirFlow.GetNumberOfNodes()`](RAAirFlow.md#generated.RAAirFlow.GetNumberOfNodes) + * [`RAAirFlow.GetNumpyCurve()`](RAAirFlow.md#generated.RAAirFlow.GetNumpyCurve) + * [`RAAirFlow.GetOutputVariableValue()`](RAAirFlow.md#generated.RAAirFlow.GetOutputVariableValue) + * [`RAAirFlow.GetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.GetSpeedOfSound) + * [`RAAirFlow.GetStartTime()`](RAAirFlow.md#generated.RAAirFlow.GetStartTime) + * [`RAAirFlow.GetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.GetStartWhenParticlesEnter) + * [`RAAirFlow.GetTimeSet()`](RAAirFlow.md#generated.RAAirFlow.GetTimeSet) + * [`RAAirFlow.GetTimeStatistics()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStatistics) + * [`RAAirFlow.GetTimeStep()`](RAAirFlow.md#generated.RAAirFlow.GetTimeStep) + * [`RAAirFlow.GetTopologyShape()`](RAAirFlow.md#generated.RAAirFlow.GetTopologyShape) + * [`RAAirFlow.GetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.GetUseAirflow) + * [`RAAirFlow.GetValidBoundaryConditionTypeValues()`](RAAirFlow.md#generated.RAAirFlow.GetValidBoundaryConditionTypeValues) + * [`RAAirFlow.HasGridFunction()`](RAAirFlow.md#generated.RAAirFlow.HasGridFunction) + * [`RAAirFlow.IsCellActive()`](RAAirFlow.md#generated.RAAirFlow.IsCellActive) + * [`RAAirFlow.IterCellVertices()`](RAAirFlow.md#generated.RAAirFlow.IterCellVertices) + * [`RAAirFlow.IterCells()`](RAAirFlow.md#generated.RAAirFlow.IterCells) + * [`RAAirFlow.Modified()`](RAAirFlow.md#generated.RAAirFlow.Modified) + * [`RAAirFlow.RemoveCustomCurve()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomCurve) + * [`RAAirFlow.RemoveCustomProperty()`](RAAirFlow.md#generated.RAAirFlow.RemoveCustomProperty) + * [`RAAirFlow.RemoveOutputVariable()`](RAAirFlow.md#generated.RAAirFlow.RemoveOutputVariable) + * [`RAAirFlow.RemoveProcess()`](RAAirFlow.md#generated.RAAirFlow.RemoveProcess) + * [`RAAirFlow.SetAirDensity()`](RAAirFlow.md#generated.RAAirFlow.SetAirDensity) + * [`RAAirFlow.SetAirKinematicViscosity()`](RAAirFlow.md#generated.RAAirFlow.SetAirKinematicViscosity) + * [`RAAirFlow.SetBoundaryConditionType()`](RAAirFlow.md#generated.RAAirFlow.SetBoundaryConditionType) + * [`RAAirFlow.SetCellSize()`](RAAirFlow.md#generated.RAAirFlow.SetCellSize) + * [`RAAirFlow.SetCurrentTimeStep()`](RAAirFlow.md#generated.RAAirFlow.SetCurrentTimeStep) + * [`RAAirFlow.SetInteractionScale()`](RAAirFlow.md#generated.RAAirFlow.SetInteractionScale) + * [`RAAirFlow.SetMaxX()`](RAAirFlow.md#generated.RAAirFlow.SetMaxX) + * [`RAAirFlow.SetMaxY()`](RAAirFlow.md#generated.RAAirFlow.SetMaxY) + * [`RAAirFlow.SetMaxZ()`](RAAirFlow.md#generated.RAAirFlow.SetMaxZ) + * [`RAAirFlow.SetMinX()`](RAAirFlow.md#generated.RAAirFlow.SetMinX) + * [`RAAirFlow.SetMinY()`](RAAirFlow.md#generated.RAAirFlow.SetMinY) + * [`RAAirFlow.SetMinZ()`](RAAirFlow.md#generated.RAAirFlow.SetMinZ) + * [`RAAirFlow.SetPartIdIfValid()`](RAAirFlow.md#generated.RAAirFlow.SetPartIdIfValid) + * [`RAAirFlow.SetSpeedOfSound()`](RAAirFlow.md#generated.RAAirFlow.SetSpeedOfSound) + * [`RAAirFlow.SetStartTime()`](RAAirFlow.md#generated.RAAirFlow.SetStartTime) + * [`RAAirFlow.SetStartWhenParticlesEnter()`](RAAirFlow.md#generated.RAAirFlow.SetStartWhenParticlesEnter) + * [`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) + * [`RACFDParametersList`](RACFDParametersList.md#generated.RACFDParametersList) + * [`RACFDParametersList.Clear()`](RACFDParametersList.md#generated.RACFDParametersList.Clear) + * [`RACFDParametersList.GetParametersFor()`](RACFDParametersList.md#generated.RACFDParametersList.GetParametersFor) + * [`RACFDParametersList.New()`](RACFDParametersList.md#generated.RACFDParametersList.New) + * [`RACFDParametersList.Remove()`](RACFDParametersList.md#generated.RACFDParametersList.Remove) +* [RACFDPerParticleParameters](RACFDPerParticleParameters.md) + * [`RACFDPerParticleParameters`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters) + * [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetConvectiveHeatTransferLaw) + * [`RACFDPerParticleParameters.GetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetDragLaw) + * [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetLiftLaw) + * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK1) + * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK2) + * [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetMorsiAndAlexanderK3) + * [`RACFDPerParticleParameters.GetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienC1) + * [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetSyamlalObrienD1) + * [`RACFDPerParticleParameters.GetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetTorqueLaw) + * [`RACFDPerParticleParameters.GetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetUseUserDefinedConstants) + * [`RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues) + * [`RACFDPerParticleParameters.GetValidDragLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidDragLawValues) + * [`RACFDPerParticleParameters.GetValidLiftLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidLiftLawValues) + * [`RACFDPerParticleParameters.GetValidTorqueLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidTorqueLawValues) + * [`RACFDPerParticleParameters.GetValidVirtualMassLawValues()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetValidVirtualMassLawValues) + * [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.GetVirtualMassLaw) + * [`RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetConvectiveHeatTransferLaw) + * [`RACFDPerParticleParameters.SetDragLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetDragLaw) + * [`RACFDPerParticleParameters.SetLiftLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetLiftLaw) + * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK1) + * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK2()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK2) + * [`RACFDPerParticleParameters.SetMorsiAndAlexanderK3()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetMorsiAndAlexanderK3) + * [`RACFDPerParticleParameters.SetSyamlalObrienC1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienC1) + * [`RACFDPerParticleParameters.SetSyamlalObrienD1()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetSyamlalObrienD1) + * [`RACFDPerParticleParameters.SetTorqueLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetTorqueLaw) + * [`RACFDPerParticleParameters.SetUseUserDefinedConstants()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetUseUserDefinedConstants) + * [`RACFDPerParticleParameters.SetVirtualMassLaw()`](RACFDPerParticleParameters.md#generated.RACFDPerParticleParameters.SetVirtualMassLaw) +* [RACalculations](RACalculations.md) + * [`RACalculations`](RACalculations.md#generated.RACalculations) + * [`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) + * [`RACalculations.GetTagging()`](RACalculations.md#generated.RACalculations.GetTagging) + * [`RACalculations.GetTaggingNames()`](RACalculations.md#generated.RACalculations.GetTaggingNames) +* [RACircularSurface](RACircularSurface.md) + * [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface) + * [`RACircularSurface.AddCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCurve) + * [`RACircularSurface.AddCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.AddCustomCurve) + * [`RACircularSurface.AddCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.AddCustomProperty) + * [`RACircularSurface.AddGridFunction()`](RACircularSurface.md#generated.RACircularSurface.AddGridFunction) + * [`RACircularSurface.CreateCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateCurveOutputVariable) + * [`RACircularSurface.CreateGridFunction()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunction) + * [`RACircularSurface.CreateGridFunctionArrayOnCells()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionArrayOnCells) + * [`RACircularSurface.CreateGridFunctionStatisticOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateGridFunctionStatisticOutputVariable) + * [`RACircularSurface.CreateTransientCurveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.CreateTransientCurveOutputVariable) + * [`RACircularSurface.EditCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.EditCustomCurve) + * [`RACircularSurface.EditCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.EditCustomProperty) + * [`RACircularSurface.GetActivesArray()`](RACircularSurface.md#generated.RACircularSurface.GetActivesArray) + * [`RACircularSurface.GetBoundingBox()`](RACircularSurface.md#generated.RACircularSurface.GetBoundingBox) + * [`RACircularSurface.GetCellAreaAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellAreaAsArray) + * [`RACircularSurface.GetCellCenterAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellCenterAsArray) + * [`RACircularSurface.GetCellDzAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellDzAsArray) + * [`RACircularSurface.GetCellFromIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellFromIJK) + * [`RACircularSurface.GetCellIJK()`](RACircularSurface.md#generated.RACircularSurface.GetCellIJK) + * [`RACircularSurface.GetCellNumberOfVertices()`](RACircularSurface.md#generated.RACircularSurface.GetCellNumberOfVertices) + * [`RACircularSurface.GetCellPointsAsFunction()`](RACircularSurface.md#generated.RACircularSurface.GetCellPointsAsFunction) + * [`RACircularSurface.GetCellVolumeAsArray()`](RACircularSurface.md#generated.RACircularSurface.GetCellVolumeAsArray) + * [`RACircularSurface.GetCenter()`](RACircularSurface.md#generated.RACircularSurface.GetCenter) + * [`RACircularSurface.GetCurve()`](RACircularSurface.md#generated.RACircularSurface.GetCurve) + * [`RACircularSurface.GetCurveNames()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNames) + * [`RACircularSurface.GetCurveNamesAssociation()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNamesAssociation) + * [`RACircularSurface.GetElementCurve()`](RACircularSurface.md#generated.RACircularSurface.GetElementCurve) + * [`RACircularSurface.GetGeometryQuantity()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryQuantity) + * [`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.GetNumberOfCells()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfCells) + * [`RACircularSurface.GetNumberOfNodes()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfNodes) + * [`RACircularSurface.GetNumpyCurve()`](RACircularSurface.md#generated.RACircularSurface.GetNumpyCurve) + * [`RACircularSurface.GetOrientation()`](RACircularSurface.md#generated.RACircularSurface.GetOrientation) + * [`RACircularSurface.GetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngleAndVector) + * [`RACircularSurface.GetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromAngles) + * [`RACircularSurface.GetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.GetOrientationFromBasisVector) + * [`RACircularSurface.GetOutputVariableValue()`](RACircularSurface.md#generated.RACircularSurface.GetOutputVariableValue) + * [`RACircularSurface.GetTimeSet()`](RACircularSurface.md#generated.RACircularSurface.GetTimeSet) + * [`RACircularSurface.GetTimeStatistics()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStatistics) + * [`RACircularSurface.GetTimeStep()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStep) + * [`RACircularSurface.GetTopologyShape()`](RACircularSurface.md#generated.RACircularSurface.GetTopologyShape) + * [`RACircularSurface.HasGridFunction()`](RACircularSurface.md#generated.RACircularSurface.HasGridFunction) + * [`RACircularSurface.HasMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.HasMotionFrame) + * [`RACircularSurface.IsCellActive()`](RACircularSurface.md#generated.RACircularSurface.IsCellActive) + * [`RACircularSurface.IterCellVertices()`](RACircularSurface.md#generated.RACircularSurface.IterCellVertices) + * [`RACircularSurface.IterCells()`](RACircularSurface.md#generated.RACircularSurface.IterCells) + * [`RACircularSurface.Modified()`](RACircularSurface.md#generated.RACircularSurface.Modified) + * [`RACircularSurface.RemoveCustomCurve()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomCurve) + * [`RACircularSurface.RemoveCustomProperty()`](RACircularSurface.md#generated.RACircularSurface.RemoveCustomProperty) + * [`RACircularSurface.RemoveOutputVariable()`](RACircularSurface.md#generated.RACircularSurface.RemoveOutputVariable) + * [`RACircularSurface.RemoveProcess()`](RACircularSurface.md#generated.RACircularSurface.RemoveProcess) + * [`RACircularSurface.SetCenter()`](RACircularSurface.md#generated.RACircularSurface.SetCenter) + * [`RACircularSurface.SetCurrentTimeStep()`](RACircularSurface.md#generated.RACircularSurface.SetCurrentTimeStep) + * [`RACircularSurface.SetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMaxRadius) + * [`RACircularSurface.SetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMinRadius) + * [`RACircularSurface.SetOrientation()`](RACircularSurface.md#generated.RACircularSurface.SetOrientation) + * [`RACircularSurface.SetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngleAndVector) + * [`RACircularSurface.SetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngles) + * [`RACircularSurface.SetOrientationFromBasisVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromBasisVector) +* [RAConeCrusherFrame](RAConeCrusherFrame.md) + * [`RAConeCrusherFrame`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame) + * [`RAConeCrusherFrame.GetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetInitialOrientation) + * [`RAConeCrusherFrame.GetMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetMotionFrame) + * [`RAConeCrusherFrame.GetParentMotionFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetParentMotionFrame) + * [`RAConeCrusherFrame.GetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetPivotPoint) + * [`RAConeCrusherFrame.GetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationAxis) + * [`RAConeCrusherFrame.GetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetRotationalVelocity) + * [`RAConeCrusherFrame.GetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStartTime) + * [`RAConeCrusherFrame.GetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.GetStopTime) + * [`RAConeCrusherFrame.IterMotionFrames()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.IterMotionFrames) + * [`RAConeCrusherFrame.NewConeCrusherFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewConeCrusherFrame) + * [`RAConeCrusherFrame.NewFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.NewFrame) + * [`RAConeCrusherFrame.RemoveFrame()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.RemoveFrame) + * [`RAConeCrusherFrame.SetInitialOrientation()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetInitialOrientation) + * [`RAConeCrusherFrame.SetPivotPoint()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetPivotPoint) + * [`RAConeCrusherFrame.SetRotationAxis()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationAxis) + * [`RAConeCrusherFrame.SetRotationalVelocity()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetRotationalVelocity) + * [`RAConeCrusherFrame.SetStartTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStartTime) + * [`RAConeCrusherFrame.SetStopTime()`](RAConeCrusherFrame.md#generated.RAConeCrusherFrame.SetStopTime) +* [RAConstantOneWayCoupling](RAConstantOneWayCoupling.md) + * [`RAConstantOneWayCoupling`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling) + * [`RAConstantOneWayCoupling.AddCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCurve) + * [`RAConstantOneWayCoupling.AddCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomCurve) + * [`RAConstantOneWayCoupling.AddCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddCustomProperty) + * [`RAConstantOneWayCoupling.AddGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.AddGridFunction) + * [`RAConstantOneWayCoupling.CreateCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateCurveOutputVariable) + * [`RAConstantOneWayCoupling.CreateGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunction) + * [`RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionArrayOnCells) + * [`RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateGridFunctionStatisticOutputVariable) + * [`RAConstantOneWayCoupling.CreateTransientCurveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.CreateTransientCurveOutputVariable) + * [`RAConstantOneWayCoupling.DisableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.DisableTurbulentDispersion) + * [`RAConstantOneWayCoupling.EditCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomCurve) + * [`RAConstantOneWayCoupling.EditCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EditCustomProperty) + * [`RAConstantOneWayCoupling.EnableTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.EnableTurbulentDispersion) + * [`RAConstantOneWayCoupling.GetActivesArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetActivesArray) + * [`RAConstantOneWayCoupling.GetBoundingBox()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetBoundingBox) + * [`RAConstantOneWayCoupling.GetCFDParametersList()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCFDParametersList) + * [`RAConstantOneWayCoupling.GetCellAreaAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellAreaAsArray) + * [`RAConstantOneWayCoupling.GetCellCenterAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellCenterAsArray) + * [`RAConstantOneWayCoupling.GetCellDzAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellDzAsArray) + * [`RAConstantOneWayCoupling.GetCellFromIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellFromIJK) + * [`RAConstantOneWayCoupling.GetCellIJK()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellIJK) + * [`RAConstantOneWayCoupling.GetCellNumberOfVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellNumberOfVertices) + * [`RAConstantOneWayCoupling.GetCellPointsAsFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellPointsAsFunction) + * [`RAConstantOneWayCoupling.GetCellVolumeAsArray()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCellVolumeAsArray) + * [`RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetConvectiveHeatTransferLaw) + * [`RAConstantOneWayCoupling.GetCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurve) + * [`RAConstantOneWayCoupling.GetCurveNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNames) + * [`RAConstantOneWayCoupling.GetCurveNamesAssociation()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetCurveNamesAssociation) + * [`RAConstantOneWayCoupling.GetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDensity) + * [`RAConstantOneWayCoupling.GetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDragLaw) + * [`RAConstantOneWayCoupling.GetElementCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetElementCurve) + * [`RAConstantOneWayCoupling.GetGeometryQuantity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryQuantity) + * [`RAConstantOneWayCoupling.GetGeometryUnit()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryUnit) + * [`RAConstantOneWayCoupling.GetGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunction) + * [`RAConstantOneWayCoupling.GetGridFunctionNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunctionNames) + * [`RAConstantOneWayCoupling.GetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetLiftLaw) + * [`RAConstantOneWayCoupling.GetMeshColoring()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMeshColoring) + * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK1) + * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK2) + * [`RAConstantOneWayCoupling.GetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK3) + * [`RAConstantOneWayCoupling.GetNumberOfCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfCells) + * [`RAConstantOneWayCoupling.GetNumberOfNodes()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumberOfNodes) + * [`RAConstantOneWayCoupling.GetNumpyCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetNumpyCurve) + * [`RAConstantOneWayCoupling.GetOutputVariableValue()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetOutputVariableValue) + * [`RAConstantOneWayCoupling.GetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSpecificHeat) + * [`RAConstantOneWayCoupling.GetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetStartTime) + * [`RAConstantOneWayCoupling.GetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienC1) + * [`RAConstantOneWayCoupling.GetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetSyamlalObrienD1) + * [`RAConstantOneWayCoupling.GetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTemperature) + * [`RAConstantOneWayCoupling.GetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetThermalConductivity) + * [`RAConstantOneWayCoupling.GetTimeSet()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeSet) + * [`RAConstantOneWayCoupling.GetTimeStatistics()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStatistics) + * [`RAConstantOneWayCoupling.GetTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTimeStep) + * [`RAConstantOneWayCoupling.GetTopologyShape()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTopologyShape) + * [`RAConstantOneWayCoupling.GetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTorqueLaw) + * [`RAConstantOneWayCoupling.GetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentDissipationRate) + * [`RAConstantOneWayCoupling.GetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetTurbulentKineticEnergy) + * [`RAConstantOneWayCoupling.GetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion) + * [`RAConstantOneWayCoupling.GetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants) + * [`RAConstantOneWayCoupling.GetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVelocity) + * [`RAConstantOneWayCoupling.GetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVirtualMassLaw) + * [`RAConstantOneWayCoupling.GetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetViscosity) + * [`RAConstantOneWayCoupling.HasGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.HasGridFunction) + * [`RAConstantOneWayCoupling.IsCellActive()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsCellActive) + * [`RAConstantOneWayCoupling.IsTurbulentDispersionEnabled()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IsTurbulentDispersionEnabled) + * [`RAConstantOneWayCoupling.IterCellVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCellVertices) + * [`RAConstantOneWayCoupling.IterCells()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.IterCells) + * [`RAConstantOneWayCoupling.Modified()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.Modified) + * [`RAConstantOneWayCoupling.RemoveCustomCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomCurve) + * [`RAConstantOneWayCoupling.RemoveCustomProperty()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveCustomProperty) + * [`RAConstantOneWayCoupling.RemoveOutputVariable()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveOutputVariable) + * [`RAConstantOneWayCoupling.RemoveProcess()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.RemoveProcess) + * [`RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetConvectiveHeatTransferLaw) + * [`RAConstantOneWayCoupling.SetCurrentTimeStep()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetCurrentTimeStep) + * [`RAConstantOneWayCoupling.SetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDensity) + * [`RAConstantOneWayCoupling.SetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetDragLaw) + * [`RAConstantOneWayCoupling.SetLiftLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetLiftLaw) + * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK1) + * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK2()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK2) + * [`RAConstantOneWayCoupling.SetMorsiAndAlexanderK3()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetMorsiAndAlexanderK3) + * [`RAConstantOneWayCoupling.SetPartIdIfValid()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetPartIdIfValid) + * [`RAConstantOneWayCoupling.SetSpecificHeat()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSpecificHeat) + * [`RAConstantOneWayCoupling.SetStartTime()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetStartTime) + * [`RAConstantOneWayCoupling.SetSyamlalObrienC1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienC1) + * [`RAConstantOneWayCoupling.SetSyamlalObrienD1()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetSyamlalObrienD1) + * [`RAConstantOneWayCoupling.SetTemperature()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTemperature) + * [`RAConstantOneWayCoupling.SetThermalConductivity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetThermalConductivity) + * [`RAConstantOneWayCoupling.SetTorqueLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTorqueLaw) + * [`RAConstantOneWayCoupling.SetTurbulentDissipationRate()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentDissipationRate) + * [`RAConstantOneWayCoupling.SetTurbulentKineticEnergy()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetTurbulentKineticEnergy) + * [`RAConstantOneWayCoupling.SetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseTurbulentDispersion) + * [`RAConstantOneWayCoupling.SetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetUseUserDefinedConstants) + * [`RAConstantOneWayCoupling.SetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVelocity) + * [`RAConstantOneWayCoupling.SetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetVirtualMassLaw) + * [`RAConstantOneWayCoupling.SetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.SetViscosity) +* [RAContactData](RAContactData.md) + * [`RAContactData`](RAContactData.md#generated.RAContactData) + * [`RAContactData.AddCurve()`](RAContactData.md#generated.RAContactData.AddCurve) + * [`RAContactData.AddCustomCurve()`](RAContactData.md#generated.RAContactData.AddCustomCurve) + * [`RAContactData.AddCustomProperty()`](RAContactData.md#generated.RAContactData.AddCustomProperty) + * [`RAContactData.AddGridFunction()`](RAContactData.md#generated.RAContactData.AddGridFunction) + * [`RAContactData.CreateCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateCurveOutputVariable) + * [`RAContactData.CreateGridFunction()`](RAContactData.md#generated.RAContactData.CreateGridFunction) + * [`RAContactData.CreateGridFunctionArrayOnCells()`](RAContactData.md#generated.RAContactData.CreateGridFunctionArrayOnCells) + * [`RAContactData.CreateGridFunctionStatisticOutputVariable()`](RAContactData.md#generated.RAContactData.CreateGridFunctionStatisticOutputVariable) + * [`RAContactData.CreateTransientCurveOutputVariable()`](RAContactData.md#generated.RAContactData.CreateTransientCurveOutputVariable) + * [`RAContactData.DisableCollectContactsData()`](RAContactData.md#generated.RAContactData.DisableCollectContactsData) + * [`RAContactData.DisableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.DisableIncludeAdhesiveContacts) + * [`RAContactData.EditCustomCurve()`](RAContactData.md#generated.RAContactData.EditCustomCurve) + * [`RAContactData.EditCustomProperty()`](RAContactData.md#generated.RAContactData.EditCustomProperty) + * [`RAContactData.EnableCollectContactsData()`](RAContactData.md#generated.RAContactData.EnableCollectContactsData) + * [`RAContactData.EnableIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.EnableIncludeAdhesiveContacts) + * [`RAContactData.GetActivesArray()`](RAContactData.md#generated.RAContactData.GetActivesArray) + * [`RAContactData.GetBoundingBox()`](RAContactData.md#generated.RAContactData.GetBoundingBox) + * [`RAContactData.GetCellAreaAsArray()`](RAContactData.md#generated.RAContactData.GetCellAreaAsArray) + * [`RAContactData.GetCellCenterAsArray()`](RAContactData.md#generated.RAContactData.GetCellCenterAsArray) + * [`RAContactData.GetCellDzAsArray()`](RAContactData.md#generated.RAContactData.GetCellDzAsArray) + * [`RAContactData.GetCellFromIJK()`](RAContactData.md#generated.RAContactData.GetCellFromIJK) + * [`RAContactData.GetCellIJK()`](RAContactData.md#generated.RAContactData.GetCellIJK) + * [`RAContactData.GetCellNumberOfVertices()`](RAContactData.md#generated.RAContactData.GetCellNumberOfVertices) + * [`RAContactData.GetCellPointsAsFunction()`](RAContactData.md#generated.RAContactData.GetCellPointsAsFunction) + * [`RAContactData.GetCellVolumeAsArray()`](RAContactData.md#generated.RAContactData.GetCellVolumeAsArray) + * [`RAContactData.GetCollectContactsData()`](RAContactData.md#generated.RAContactData.GetCollectContactsData) + * [`RAContactData.GetCurve()`](RAContactData.md#generated.RAContactData.GetCurve) + * [`RAContactData.GetCurveNames()`](RAContactData.md#generated.RAContactData.GetCurveNames) + * [`RAContactData.GetCurveNamesAssociation()`](RAContactData.md#generated.RAContactData.GetCurveNamesAssociation) + * [`RAContactData.GetElementCurve()`](RAContactData.md#generated.RAContactData.GetElementCurve) + * [`RAContactData.GetGeometryQuantity()`](RAContactData.md#generated.RAContactData.GetGeometryQuantity) + * [`RAContactData.GetGeometryUnit()`](RAContactData.md#generated.RAContactData.GetGeometryUnit) + * [`RAContactData.GetGridFunction()`](RAContactData.md#generated.RAContactData.GetGridFunction) + * [`RAContactData.GetGridFunctionNames()`](RAContactData.md#generated.RAContactData.GetGridFunctionNames) + * [`RAContactData.GetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.GetIncludeAdhesiveContacts) + * [`RAContactData.GetMeshColoring()`](RAContactData.md#generated.RAContactData.GetMeshColoring) + * [`RAContactData.GetNumberOfCells()`](RAContactData.md#generated.RAContactData.GetNumberOfCells) + * [`RAContactData.GetNumberOfNodes()`](RAContactData.md#generated.RAContactData.GetNumberOfNodes) + * [`RAContactData.GetNumpyCurve()`](RAContactData.md#generated.RAContactData.GetNumpyCurve) + * [`RAContactData.GetOutputVariableValue()`](RAContactData.md#generated.RAContactData.GetOutputVariableValue) + * [`RAContactData.GetTimeSet()`](RAContactData.md#generated.RAContactData.GetTimeSet) + * [`RAContactData.GetTimeStatistics()`](RAContactData.md#generated.RAContactData.GetTimeStatistics) + * [`RAContactData.GetTimeStep()`](RAContactData.md#generated.RAContactData.GetTimeStep) + * [`RAContactData.GetTopologyShape()`](RAContactData.md#generated.RAContactData.GetTopologyShape) + * [`RAContactData.HasGridFunction()`](RAContactData.md#generated.RAContactData.HasGridFunction) + * [`RAContactData.IsCellActive()`](RAContactData.md#generated.RAContactData.IsCellActive) + * [`RAContactData.IsCollectContactsDataEnabled()`](RAContactData.md#generated.RAContactData.IsCollectContactsDataEnabled) + * [`RAContactData.IsIncludeAdhesiveContactsEnabled()`](RAContactData.md#generated.RAContactData.IsIncludeAdhesiveContactsEnabled) + * [`RAContactData.IterCellVertices()`](RAContactData.md#generated.RAContactData.IterCellVertices) + * [`RAContactData.IterCells()`](RAContactData.md#generated.RAContactData.IterCells) + * [`RAContactData.Modified()`](RAContactData.md#generated.RAContactData.Modified) + * [`RAContactData.RemoveCustomCurve()`](RAContactData.md#generated.RAContactData.RemoveCustomCurve) + * [`RAContactData.RemoveCustomProperty()`](RAContactData.md#generated.RAContactData.RemoveCustomProperty) + * [`RAContactData.RemoveOutputVariable()`](RAContactData.md#generated.RAContactData.RemoveOutputVariable) + * [`RAContactData.RemoveProcess()`](RAContactData.md#generated.RAContactData.RemoveProcess) + * [`RAContactData.SetCollectContactsData()`](RAContactData.md#generated.RAContactData.SetCollectContactsData) + * [`RAContactData.SetCurrentTimeStep()`](RAContactData.md#generated.RAContactData.SetCurrentTimeStep) + * [`RAContactData.SetIncludeAdhesiveContacts()`](RAContactData.md#generated.RAContactData.SetIncludeAdhesiveContacts) +* [RAContactToParticleProcess](RAContactToParticleProcess.md) + * [`RAContactToParticleProcess`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess) + * [`RAContactToParticleProcess.AddCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCurve) + * [`RAContactToParticleProcess.AddCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomCurve) + * [`RAContactToParticleProcess.AddCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddCustomProperty) + * [`RAContactToParticleProcess.AddGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.AddGridFunction) + * [`RAContactToParticleProcess.CreateCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateCurveOutputVariable) + * [`RAContactToParticleProcess.CreateGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunction) + * [`RAContactToParticleProcess.CreateGridFunctionArrayOnCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionArrayOnCells) + * [`RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAContactToParticleProcess.CreateTransientCurveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.CreateTransientCurveOutputVariable) + * [`RAContactToParticleProcess.EditCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomCurve) + * [`RAContactToParticleProcess.EditCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.EditCustomProperty) + * [`RAContactToParticleProcess.GetActivesArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetActivesArray) + * [`RAContactToParticleProcess.GetBoundingBox()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetBoundingBox) + * [`RAContactToParticleProcess.GetCellAreaAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellAreaAsArray) + * [`RAContactToParticleProcess.GetCellCenterAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellCenterAsArray) + * [`RAContactToParticleProcess.GetCellDzAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellDzAsArray) + * [`RAContactToParticleProcess.GetCellFromIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellFromIJK) + * [`RAContactToParticleProcess.GetCellIJK()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellIJK) + * [`RAContactToParticleProcess.GetCellNumberOfVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellNumberOfVertices) + * [`RAContactToParticleProcess.GetCellPointsAsFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellPointsAsFunction) + * [`RAContactToParticleProcess.GetCellVolumeAsArray()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCellVolumeAsArray) + * [`RAContactToParticleProcess.GetCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurve) + * [`RAContactToParticleProcess.GetCurveNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNames) + * [`RAContactToParticleProcess.GetCurveNamesAssociation()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNamesAssociation) + * [`RAContactToParticleProcess.GetElementCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetElementCurve) + * [`RAContactToParticleProcess.GetGeometryQuantity()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryQuantity) + * [`RAContactToParticleProcess.GetGeometryUnit()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryUnit) + * [`RAContactToParticleProcess.GetGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunction) + * [`RAContactToParticleProcess.GetGridFunctionNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunctionNames) + * [`RAContactToParticleProcess.GetMeshColoring()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetMeshColoring) + * [`RAContactToParticleProcess.GetNumberOfCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfCells) + * [`RAContactToParticleProcess.GetNumberOfNodes()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfNodes) + * [`RAContactToParticleProcess.GetNumberOfParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumberOfParticles) + * [`RAContactToParticleProcess.GetNumpyCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetNumpyCurve) + * [`RAContactToParticleProcess.GetOutputVariableValue()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetOutputVariableValue) + * [`RAContactToParticleProcess.GetTimeSet()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeSet) + * [`RAContactToParticleProcess.GetTimeStatistics()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStatistics) + * [`RAContactToParticleProcess.GetTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStep) + * [`RAContactToParticleProcess.GetTopologyShape()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTopologyShape) + * [`RAContactToParticleProcess.HasGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.HasGridFunction) + * [`RAContactToParticleProcess.IsCellActive()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IsCellActive) + * [`RAContactToParticleProcess.IterCellVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCellVertices) + * [`RAContactToParticleProcess.IterCells()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCells) + * [`RAContactToParticleProcess.IterParticles()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterParticles) + * [`RAContactToParticleProcess.Modified()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.Modified) + * [`RAContactToParticleProcess.RemoveCustomCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomCurve) + * [`RAContactToParticleProcess.RemoveCustomProperty()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveCustomProperty) + * [`RAContactToParticleProcess.RemoveOutputVariable()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveOutputVariable) + * [`RAContactToParticleProcess.RemoveProcess()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.RemoveProcess) + * [`RAContactToParticleProcess.SetCurrentTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.SetCurrentTimeStep) +* [RAContactsDataMeshColoring](RAContactsDataMeshColoring.md) + * [`RAContactsDataMeshColoring`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring) + * [`RAContactsDataMeshColoring.GetAvailableGridFunctions()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctions) + * [`RAContactsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetAvailableGridFunctionsNames) + * [`RAContactsDataMeshColoring.GetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsColor) + * [`RAContactsDataMeshColoring.GetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkColor) + * [`RAContactsDataMeshColoring.GetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkLineWidth) + * [`RAContactsDataMeshColoring.GetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkProperty) + * [`RAContactsDataMeshColoring.GetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsNetworkVisible) + * [`RAContactsDataMeshColoring.GetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsPointSize) + * [`RAContactsDataMeshColoring.GetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsProperty) + * [`RAContactsDataMeshColoring.GetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetContactsVisible) + * [`RAContactsDataMeshColoring.GetValidColoringModes()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.GetValidColoringModes) + * [`RAContactsDataMeshColoring.SetContactsColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsColor) + * [`RAContactsDataMeshColoring.SetContactsNetworkColor()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkColor) + * [`RAContactsDataMeshColoring.SetContactsNetworkLineWidth()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkLineWidth) + * [`RAContactsDataMeshColoring.SetContactsNetworkProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkProperty) + * [`RAContactsDataMeshColoring.SetContactsNetworkVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsNetworkVisible) + * [`RAContactsDataMeshColoring.SetContactsPointSize()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsPointSize) + * [`RAContactsDataMeshColoring.SetContactsProperty()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsProperty) + * [`RAContactsDataMeshColoring.SetContactsVisible()`](RAContactsDataMeshColoring.md#generated.RAContactsDataMeshColoring.SetContactsVisible) +* [RACoupledWall](RACoupledWall.md) + * [`RACoupledWall`](RACoupledWall.md#generated.RACoupledWall) + * [`RACoupledWall.AddCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCurve) + * [`RACoupledWall.AddCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.AddCustomCurve) + * [`RACoupledWall.AddCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.AddCustomProperty) + * [`RACoupledWall.AddGridFunction()`](RACoupledWall.md#generated.RACoupledWall.AddGridFunction) + * [`RACoupledWall.CreateCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateCurveOutputVariable) + * [`RACoupledWall.CreateGridFunction()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunction) + * [`RACoupledWall.CreateGridFunctionArrayOnCells()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionArrayOnCells) + * [`RACoupledWall.CreateGridFunctionStatisticOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateGridFunctionStatisticOutputVariable) + * [`RACoupledWall.CreateTransientCurveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.CreateTransientCurveOutputVariable) + * [`RACoupledWall.EditCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.EditCustomCurve) + * [`RACoupledWall.EditCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.EditCustomProperty) + * [`RACoupledWall.GetActivesArray()`](RACoupledWall.md#generated.RACoupledWall.GetActivesArray) + * [`RACoupledWall.GetAvailableMaterials()`](RACoupledWall.md#generated.RACoupledWall.GetAvailableMaterials) + * [`RACoupledWall.GetBoundingBox()`](RACoupledWall.md#generated.RACoupledWall.GetBoundingBox) + * [`RACoupledWall.GetCellAreaAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellAreaAsArray) + * [`RACoupledWall.GetCellCenterAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellCenterAsArray) + * [`RACoupledWall.GetCellDzAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellDzAsArray) + * [`RACoupledWall.GetCellFromIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellFromIJK) + * [`RACoupledWall.GetCellIJK()`](RACoupledWall.md#generated.RACoupledWall.GetCellIJK) + * [`RACoupledWall.GetCellNumberOfVertices()`](RACoupledWall.md#generated.RACoupledWall.GetCellNumberOfVertices) + * [`RACoupledWall.GetCellPointsAsFunction()`](RACoupledWall.md#generated.RACoupledWall.GetCellPointsAsFunction) + * [`RACoupledWall.GetCellVolumeAsArray()`](RACoupledWall.md#generated.RACoupledWall.GetCellVolumeAsArray) + * [`RACoupledWall.GetCurve()`](RACoupledWall.md#generated.RACoupledWall.GetCurve) + * [`RACoupledWall.GetCurveNames()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNames) + * [`RACoupledWall.GetCurveNamesAssociation()`](RACoupledWall.md#generated.RACoupledWall.GetCurveNamesAssociation) + * [`RACoupledWall.GetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.GetDisableTime) + * [`RACoupledWall.GetElementCurve()`](RACoupledWall.md#generated.RACoupledWall.GetElementCurve) + * [`RACoupledWall.GetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.GetEnableTime) + * [`RACoupledWall.GetGeometryQuantity()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryQuantity) + * [`RACoupledWall.GetGeometryUnit()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryUnit) + * [`RACoupledWall.GetGridFunction()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunction) + * [`RACoupledWall.GetGridFunctionNames()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunctionNames) + * [`RACoupledWall.GetMaterial()`](RACoupledWall.md#generated.RACoupledWall.GetMaterial) + * [`RACoupledWall.GetMeshColoring()`](RACoupledWall.md#generated.RACoupledWall.GetMeshColoring) + * [`RACoupledWall.GetModuleProperties()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperties) + * [`RACoupledWall.GetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperty) + * [`RACoupledWall.GetNumberOfCells()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfCells) + * [`RACoupledWall.GetNumberOfNodes()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfNodes) + * [`RACoupledWall.GetNumpyCurve()`](RACoupledWall.md#generated.RACoupledWall.GetNumpyCurve) + * [`RACoupledWall.GetOutputVariableValue()`](RACoupledWall.md#generated.RACoupledWall.GetOutputVariableValue) + * [`RACoupledWall.GetTimeSet()`](RACoupledWall.md#generated.RACoupledWall.GetTimeSet) + * [`RACoupledWall.GetTimeStatistics()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStatistics) + * [`RACoupledWall.GetTimeStep()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStep) + * [`RACoupledWall.GetTopologyShape()`](RACoupledWall.md#generated.RACoupledWall.GetTopologyShape) + * [`RACoupledWall.GetValidOptionsForModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetValidOptionsForModuleProperty) + * [`RACoupledWall.HasGridFunction()`](RACoupledWall.md#generated.RACoupledWall.HasGridFunction) + * [`RACoupledWall.HasMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.HasMotionFrame) + * [`RACoupledWall.IsCellActive()`](RACoupledWall.md#generated.RACoupledWall.IsCellActive) + * [`RACoupledWall.IterCellVertices()`](RACoupledWall.md#generated.RACoupledWall.IterCellVertices) + * [`RACoupledWall.IterCells()`](RACoupledWall.md#generated.RACoupledWall.IterCells) + * [`RACoupledWall.Modified()`](RACoupledWall.md#generated.RACoupledWall.Modified) + * [`RACoupledWall.RemoveCustomCurve()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomCurve) + * [`RACoupledWall.RemoveCustomProperty()`](RACoupledWall.md#generated.RACoupledWall.RemoveCustomProperty) + * [`RACoupledWall.RemoveOutputVariable()`](RACoupledWall.md#generated.RACoupledWall.RemoveOutputVariable) + * [`RACoupledWall.RemoveProcess()`](RACoupledWall.md#generated.RACoupledWall.RemoveProcess) + * [`RACoupledWall.SetCurrentTimeStep()`](RACoupledWall.md#generated.RACoupledWall.SetCurrentTimeStep) + * [`RACoupledWall.SetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.SetDisableTime) + * [`RACoupledWall.SetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.SetEnableTime) + * [`RACoupledWall.SetMaterial()`](RACoupledWall.md#generated.RACoupledWall.SetMaterial) + * [`RACoupledWall.SetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.SetModuleProperty) +* [RACubeGroup](RACubeGroup.md) + * [`RACubeGroup`](RACubeGroup.md#generated.RACubeGroup) + * [`RACubeGroup.AddCurve()`](RACubeGroup.md#generated.RACubeGroup.AddCurve) + * [`RACubeGroup.GetCenter()`](RACubeGroup.md#generated.RACubeGroup.GetCenter) + * [`RACubeGroup.GetCenterAfterMovement()`](RACubeGroup.md#generated.RACubeGroup.GetCenterAfterMovement) + * [`RACubeGroup.GetCurve()`](RACubeGroup.md#generated.RACubeGroup.GetCurve) + * [`RACubeGroup.GetCurveNames()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNames) + * [`RACubeGroup.GetCurveNamesAssociation()`](RACubeGroup.md#generated.RACubeGroup.GetCurveNamesAssociation) + * [`RACubeGroup.GetElementCurve()`](RACubeGroup.md#generated.RACubeGroup.GetElementCurve) + * [`RACubeGroup.GetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.GetMotionFrame) + * [`RACubeGroup.GetNumpyCurve()`](RACubeGroup.md#generated.RACubeGroup.GetNumpyCurve) + * [`RACubeGroup.GetOrientation()`](RACubeGroup.md#generated.RACubeGroup.GetOrientation) + * [`RACubeGroup.GetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngleAndVector) + * [`RACubeGroup.GetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromAngles) + * [`RACubeGroup.GetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.GetOrientationFromBasisVector) + * [`RACubeGroup.GetRotation()`](RACubeGroup.md#generated.RACubeGroup.GetRotation) + * [`RACubeGroup.GetSize()`](RACubeGroup.md#generated.RACubeGroup.GetSize) + * [`RACubeGroup.SetCenter()`](RACubeGroup.md#generated.RACubeGroup.SetCenter) + * [`RACubeGroup.SetMotionFrame()`](RACubeGroup.md#generated.RACubeGroup.SetMotionFrame) + * [`RACubeGroup.SetOrientation()`](RACubeGroup.md#generated.RACubeGroup.SetOrientation) + * [`RACubeGroup.SetOrientationFromAngleAndVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngleAndVector) + * [`RACubeGroup.SetOrientationFromAngles()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromAngles) + * [`RACubeGroup.SetOrientationFromBasisVector()`](RACubeGroup.md#generated.RACubeGroup.SetOrientationFromBasisVector) + * [`RACubeGroup.SetRotation()`](RACubeGroup.md#generated.RACubeGroup.SetRotation) + * [`RACubeGroup.SetSize()`](RACubeGroup.md#generated.RACubeGroup.SetSize) +* [RACubeProcess](RACubeProcess.md) + * [`RACubeProcess`](RACubeProcess.md#generated.RACubeProcess) + * [`RACubeProcess.AddCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCurve) + * [`RACubeProcess.AddCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.AddCustomCurve) + * [`RACubeProcess.AddCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.AddCustomProperty) + * [`RACubeProcess.AddGridFunction()`](RACubeProcess.md#generated.RACubeProcess.AddGridFunction) + * [`RACubeProcess.CreateCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateCurveOutputVariable) + * [`RACubeProcess.CreateGridFunction()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunction) + * [`RACubeProcess.CreateGridFunctionArrayOnCells()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionArrayOnCells) + * [`RACubeProcess.CreateGridFunctionStatisticOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateGridFunctionStatisticOutputVariable) + * [`RACubeProcess.CreateTransientCurveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.CreateTransientCurveOutputVariable) + * [`RACubeProcess.EditCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.EditCustomCurve) + * [`RACubeProcess.EditCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.EditCustomProperty) + * [`RACubeProcess.GetActivesArray()`](RACubeProcess.md#generated.RACubeProcess.GetActivesArray) + * [`RACubeProcess.GetBoundingBox()`](RACubeProcess.md#generated.RACubeProcess.GetBoundingBox) + * [`RACubeProcess.GetCellAreaAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellAreaAsArray) + * [`RACubeProcess.GetCellCenterAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellCenterAsArray) + * [`RACubeProcess.GetCellDzAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellDzAsArray) + * [`RACubeProcess.GetCellFromIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellFromIJK) + * [`RACubeProcess.GetCellIJK()`](RACubeProcess.md#generated.RACubeProcess.GetCellIJK) + * [`RACubeProcess.GetCellNumberOfVertices()`](RACubeProcess.md#generated.RACubeProcess.GetCellNumberOfVertices) + * [`RACubeProcess.GetCellPointsAsFunction()`](RACubeProcess.md#generated.RACubeProcess.GetCellPointsAsFunction) + * [`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.GetGeometryQuantity()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryQuantity) + * [`RACubeProcess.GetGeometryUnit()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryUnit) + * [`RACubeProcess.GetGridFunction()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunction) + * [`RACubeProcess.GetGridFunctionNames()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunctionNames) + * [`RACubeProcess.GetMeshColoring()`](RACubeProcess.md#generated.RACubeProcess.GetMeshColoring) + * [`RACubeProcess.GetMotionFrame()`](RACubeProcess.md#generated.RACubeProcess.GetMotionFrame) + * [`RACubeProcess.GetNumberOfCells()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfCells) + * [`RACubeProcess.GetNumberOfNodes()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfNodes) + * [`RACubeProcess.GetNumberOfParticles()`](RACubeProcess.md#generated.RACubeProcess.GetNumberOfParticles) + * [`RACubeProcess.GetNumpyCurve()`](RACubeProcess.md#generated.RACubeProcess.GetNumpyCurve) + * [`RACubeProcess.GetOrientation()`](RACubeProcess.md#generated.RACubeProcess.GetOrientation) + * [`RACubeProcess.GetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngleAndVector) + * [`RACubeProcess.GetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromAngles) + * [`RACubeProcess.GetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.GetOrientationFromBasisVector) + * [`RACubeProcess.GetOutputVariableValue()`](RACubeProcess.md#generated.RACubeProcess.GetOutputVariableValue) + * [`RACubeProcess.GetRotation()`](RACubeProcess.md#generated.RACubeProcess.GetRotation) + * [`RACubeProcess.GetSize()`](RACubeProcess.md#generated.RACubeProcess.GetSize) + * [`RACubeProcess.GetTimeSet()`](RACubeProcess.md#generated.RACubeProcess.GetTimeSet) + * [`RACubeProcess.GetTimeStatistics()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStatistics) + * [`RACubeProcess.GetTimeStep()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStep) + * [`RACubeProcess.GetTopologyShape()`](RACubeProcess.md#generated.RACubeProcess.GetTopologyShape) + * [`RACubeProcess.HasGridFunction()`](RACubeProcess.md#generated.RACubeProcess.HasGridFunction) + * [`RACubeProcess.IsCellActive()`](RACubeProcess.md#generated.RACubeProcess.IsCellActive) + * [`RACubeProcess.IterCellVertices()`](RACubeProcess.md#generated.RACubeProcess.IterCellVertices) + * [`RACubeProcess.IterCells()`](RACubeProcess.md#generated.RACubeProcess.IterCells) + * [`RACubeProcess.IterParticles()`](RACubeProcess.md#generated.RACubeProcess.IterParticles) + * [`RACubeProcess.Modified()`](RACubeProcess.md#generated.RACubeProcess.Modified) + * [`RACubeProcess.RemoveCustomCurve()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomCurve) + * [`RACubeProcess.RemoveCustomProperty()`](RACubeProcess.md#generated.RACubeProcess.RemoveCustomProperty) + * [`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) + * [`RACubeProcess.SetOrientationFromAngleAndVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngleAndVector) + * [`RACubeProcess.SetOrientationFromAngles()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromAngles) + * [`RACubeProcess.SetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromBasisVector) + * [`RACubeProcess.SetRotation()`](RACubeProcess.md#generated.RACubeProcess.SetRotation) + * [`RACubeProcess.SetSize()`](RACubeProcess.md#generated.RACubeProcess.SetSize) +* [RACustomInput](RACustomInput.md) + * [`RACustomInput`](RACustomInput.md#generated.RACustomInput) + * [`RACustomInput.GetAvailableMotionFrames()`](RACustomInput.md#generated.RACustomInput.GetAvailableMotionFrames) + * [`RACustomInput.GetAvailableParticles()`](RACustomInput.md#generated.RACustomInput.GetAvailableParticles) + * [`RACustomInput.GetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.GetDefaultTemperature) + * [`RACustomInput.GetFilePath()`](RACustomInput.md#generated.RACustomInput.GetFilePath) + * [`RACustomInput.GetModuleProperties()`](RACustomInput.md#generated.RACustomInput.GetModuleProperties) + * [`RACustomInput.GetModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetModuleProperty) + * [`RACustomInput.GetMotionFrame()`](RACustomInput.md#generated.RACustomInput.GetMotionFrame) + * [`RACustomInput.GetParticle()`](RACustomInput.md#generated.RACustomInput.GetParticle) + * [`RACustomInput.GetValidOptionsForModuleProperty()`](RACustomInput.md#generated.RACustomInput.GetValidOptionsForModuleProperty) + * [`RACustomInput.SetDefaultTemperature()`](RACustomInput.md#generated.RACustomInput.SetDefaultTemperature) + * [`RACustomInput.SetFilePath()`](RACustomInput.md#generated.RACustomInput.SetFilePath) + * [`RACustomInput.SetModuleProperty()`](RACustomInput.md#generated.RACustomInput.SetModuleProperty) + * [`RACustomInput.SetMotionFrame()`](RACustomInput.md#generated.RACustomInput.SetMotionFrame) + * [`RACustomInput.SetParticle()`](RACustomInput.md#generated.RACustomInput.SetParticle) +* [RACylinderGroup](RACylinderGroup.md) + * [`RACylinderGroup`](RACylinderGroup.md#generated.RACylinderGroup) + * [`RACylinderGroup.AddCurve()`](RACylinderGroup.md#generated.RACylinderGroup.AddCurve) + * [`RACylinderGroup.GetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenter) + * [`RACylinderGroup.GetCenterAfterMovement()`](RACylinderGroup.md#generated.RACylinderGroup.GetCenterAfterMovement) + * [`RACylinderGroup.GetCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurve) + * [`RACylinderGroup.GetCurveNames()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNames) + * [`RACylinderGroup.GetCurveNamesAssociation()`](RACylinderGroup.md#generated.RACylinderGroup.GetCurveNamesAssociation) + * [`RACylinderGroup.GetElementCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetElementCurve) + * [`RACylinderGroup.GetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetFinalAngle) + * [`RACylinderGroup.GetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.GetInitialAngle) + * [`RACylinderGroup.GetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.GetInternalFactor) + * [`RACylinderGroup.GetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.GetMotionFrame) + * [`RACylinderGroup.GetNumpyCurve()`](RACylinderGroup.md#generated.RACylinderGroup.GetNumpyCurve) + * [`RACylinderGroup.GetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientation) + * [`RACylinderGroup.GetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngleAndVector) + * [`RACylinderGroup.GetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromAngles) + * [`RACylinderGroup.GetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.GetOrientationFromBasisVector) + * [`RACylinderGroup.GetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.GetRotation) + * [`RACylinderGroup.GetSize()`](RACylinderGroup.md#generated.RACylinderGroup.GetSize) + * [`RACylinderGroup.SetCenter()`](RACylinderGroup.md#generated.RACylinderGroup.SetCenter) + * [`RACylinderGroup.SetFinalAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetFinalAngle) + * [`RACylinderGroup.SetInitialAngle()`](RACylinderGroup.md#generated.RACylinderGroup.SetInitialAngle) + * [`RACylinderGroup.SetInternalFactor()`](RACylinderGroup.md#generated.RACylinderGroup.SetInternalFactor) + * [`RACylinderGroup.SetMotionFrame()`](RACylinderGroup.md#generated.RACylinderGroup.SetMotionFrame) + * [`RACylinderGroup.SetOrientation()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientation) + * [`RACylinderGroup.SetOrientationFromAngleAndVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngleAndVector) + * [`RACylinderGroup.SetOrientationFromAngles()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromAngles) + * [`RACylinderGroup.SetOrientationFromBasisVector()`](RACylinderGroup.md#generated.RACylinderGroup.SetOrientationFromBasisVector) + * [`RACylinderGroup.SetRotation()`](RACylinderGroup.md#generated.RACylinderGroup.SetRotation) + * [`RACylinderGroup.SetSize()`](RACylinderGroup.md#generated.RACylinderGroup.SetSize) +* [RACylinderProcess](RACylinderProcess.md) + * [`RACylinderProcess`](RACylinderProcess.md#generated.RACylinderProcess) + * [`RACylinderProcess.AddCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCurve) + * [`RACylinderProcess.AddCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomCurve) + * [`RACylinderProcess.AddCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.AddCustomProperty) + * [`RACylinderProcess.AddGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.AddGridFunction) + * [`RACylinderProcess.CreateCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateCurveOutputVariable) + * [`RACylinderProcess.CreateGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunction) + * [`RACylinderProcess.CreateGridFunctionArrayOnCells()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionArrayOnCells) + * [`RACylinderProcess.CreateGridFunctionStatisticOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateGridFunctionStatisticOutputVariable) + * [`RACylinderProcess.CreateTransientCurveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.CreateTransientCurveOutputVariable) + * [`RACylinderProcess.EditCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomCurve) + * [`RACylinderProcess.EditCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.EditCustomProperty) + * [`RACylinderProcess.GetActivesArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetActivesArray) + * [`RACylinderProcess.GetBoundingBox()`](RACylinderProcess.md#generated.RACylinderProcess.GetBoundingBox) + * [`RACylinderProcess.GetCellAreaAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellAreaAsArray) + * [`RACylinderProcess.GetCellCenterAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellCenterAsArray) + * [`RACylinderProcess.GetCellDzAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellDzAsArray) + * [`RACylinderProcess.GetCellFromIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellFromIJK) + * [`RACylinderProcess.GetCellIJK()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellIJK) + * [`RACylinderProcess.GetCellNumberOfVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellNumberOfVertices) + * [`RACylinderProcess.GetCellPointsAsFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellPointsAsFunction) + * [`RACylinderProcess.GetCellVolumeAsArray()`](RACylinderProcess.md#generated.RACylinderProcess.GetCellVolumeAsArray) + * [`RACylinderProcess.GetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenter) + * [`RACylinderProcess.GetCenterAfterMovement()`](RACylinderProcess.md#generated.RACylinderProcess.GetCenterAfterMovement) + * [`RACylinderProcess.GetCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurve) + * [`RACylinderProcess.GetCurveNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNames) + * [`RACylinderProcess.GetCurveNamesAssociation()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNamesAssociation) + * [`RACylinderProcess.GetElementCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetElementCurve) + * [`RACylinderProcess.GetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetFinalAngle) + * [`RACylinderProcess.GetGeometryQuantity()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryQuantity) + * [`RACylinderProcess.GetGeometryUnit()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryUnit) + * [`RACylinderProcess.GetGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunction) + * [`RACylinderProcess.GetGridFunctionNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunctionNames) + * [`RACylinderProcess.GetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetInitialAngle) + * [`RACylinderProcess.GetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.GetInternalFactor) + * [`RACylinderProcess.GetMeshColoring()`](RACylinderProcess.md#generated.RACylinderProcess.GetMeshColoring) + * [`RACylinderProcess.GetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.GetMotionFrame) + * [`RACylinderProcess.GetNumberOfCells()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfCells) + * [`RACylinderProcess.GetNumberOfNodes()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfNodes) + * [`RACylinderProcess.GetNumberOfParticles()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumberOfParticles) + * [`RACylinderProcess.GetNumpyCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetNumpyCurve) + * [`RACylinderProcess.GetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientation) + * [`RACylinderProcess.GetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngleAndVector) + * [`RACylinderProcess.GetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromAngles) + * [`RACylinderProcess.GetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.GetOrientationFromBasisVector) + * [`RACylinderProcess.GetOutputVariableValue()`](RACylinderProcess.md#generated.RACylinderProcess.GetOutputVariableValue) + * [`RACylinderProcess.GetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.GetRotation) + * [`RACylinderProcess.GetSize()`](RACylinderProcess.md#generated.RACylinderProcess.GetSize) + * [`RACylinderProcess.GetTimeSet()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeSet) + * [`RACylinderProcess.GetTimeStatistics()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStatistics) + * [`RACylinderProcess.GetTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStep) + * [`RACylinderProcess.GetTopologyShape()`](RACylinderProcess.md#generated.RACylinderProcess.GetTopologyShape) + * [`RACylinderProcess.HasGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.HasGridFunction) + * [`RACylinderProcess.IsCellActive()`](RACylinderProcess.md#generated.RACylinderProcess.IsCellActive) + * [`RACylinderProcess.IterCellVertices()`](RACylinderProcess.md#generated.RACylinderProcess.IterCellVertices) + * [`RACylinderProcess.IterCells()`](RACylinderProcess.md#generated.RACylinderProcess.IterCells) + * [`RACylinderProcess.IterParticles()`](RACylinderProcess.md#generated.RACylinderProcess.IterParticles) + * [`RACylinderProcess.Modified()`](RACylinderProcess.md#generated.RACylinderProcess.Modified) + * [`RACylinderProcess.RemoveCustomCurve()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomCurve) + * [`RACylinderProcess.RemoveCustomProperty()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveCustomProperty) + * [`RACylinderProcess.RemoveOutputVariable()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveOutputVariable) + * [`RACylinderProcess.RemoveProcess()`](RACylinderProcess.md#generated.RACylinderProcess.RemoveProcess) + * [`RACylinderProcess.SetCenter()`](RACylinderProcess.md#generated.RACylinderProcess.SetCenter) + * [`RACylinderProcess.SetCurrentTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.SetCurrentTimeStep) + * [`RACylinderProcess.SetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetFinalAngle) + * [`RACylinderProcess.SetInitialAngle()`](RACylinderProcess.md#generated.RACylinderProcess.SetInitialAngle) + * [`RACylinderProcess.SetInternalFactor()`](RACylinderProcess.md#generated.RACylinderProcess.SetInternalFactor) + * [`RACylinderProcess.SetMotionFrame()`](RACylinderProcess.md#generated.RACylinderProcess.SetMotionFrame) + * [`RACylinderProcess.SetOrientation()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientation) + * [`RACylinderProcess.SetOrientationFromAngleAndVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngleAndVector) + * [`RACylinderProcess.SetOrientationFromAngles()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromAngles) + * [`RACylinderProcess.SetOrientationFromBasisVector()`](RACylinderProcess.md#generated.RACylinderProcess.SetOrientationFromBasisVector) + * [`RACylinderProcess.SetRotation()`](RACylinderProcess.md#generated.RACylinderProcess.SetRotation) + * [`RACylinderProcess.SetSize()`](RACylinderProcess.md#generated.RACylinderProcess.SetSize) +* [RADivisionsTagging](RADivisionsTagging.md) + * [`RADivisionsTagging`](RADivisionsTagging.md#generated.RADivisionsTagging) + * [`RADivisionsTagging.GetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsI) + * [`RADivisionsTagging.GetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsJ) + * [`RADivisionsTagging.GetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetDivisionsK) + * [`RADivisionsTagging.GetGridFunctionName()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetGridFunctionName) + * [`RADivisionsTagging.GetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetNameMask) + * [`RADivisionsTagging.GetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagStride) + * [`RADivisionsTagging.GetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTagValue) + * [`RADivisionsTagging.GetTimeRangeFilter()`](RADivisionsTagging.md#generated.RADivisionsTagging.GetTimeRangeFilter) + * [`RADivisionsTagging.SetDivisionsI()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsI) + * [`RADivisionsTagging.SetDivisionsJ()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsJ) + * [`RADivisionsTagging.SetDivisionsK()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetDivisionsK) + * [`RADivisionsTagging.SetNameMask()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetNameMask) + * [`RADivisionsTagging.SetTagStride()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagStride) + * [`RADivisionsTagging.SetTagValue()`](RADivisionsTagging.md#generated.RADivisionsTagging.SetTagValue) +* [RADomainSettings](RADomainSettings.md) + * [`RADomainSettings`](RADomainSettings.md#generated.RADomainSettings) + * [`RADomainSettings.DisablePeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.DisablePeriodicAtGeometryLimits) + * [`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) + * [`RADomainSettings.GetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.GetCylindricalPeriodicDirections) + * [`RADomainSettings.GetDomainType()`](RADomainSettings.md#generated.RADomainSettings.GetDomainType) + * [`RADomainSettings.GetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.GetInitialAngle) + * [`RADomainSettings.GetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.GetNumberOfDivisions) + * [`RADomainSettings.GetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicAtGeometryLimits) + * [`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.SetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCartesianPeriodicDirections) + * [`RADomainSettings.SetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMaxValues) + * [`RADomainSettings.SetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMinValues) + * [`RADomainSettings.SetCylindricalPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCylindricalPeriodicDirections) + * [`RADomainSettings.SetDomainType()`](RADomainSettings.md#generated.RADomainSettings.SetDomainType) + * [`RADomainSettings.SetInitialAngle()`](RADomainSettings.md#generated.RADomainSettings.SetInitialAngle) + * [`RADomainSettings.SetNumberOfDivisions()`](RADomainSettings.md#generated.RADomainSettings.SetNumberOfDivisions) + * [`RADomainSettings.SetPeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicAtGeometryLimits) + * [`RADomainSettings.SetPeriodicLimitsMaxCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMaxCoordinates) + * [`RADomainSettings.SetPeriodicLimitsMinCoordinates()`](RADomainSettings.md#generated.RADomainSettings.SetPeriodicLimitsMinCoordinates) + * [`RADomainSettings.SetUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.SetUseBoundaryLimits) +* [RAEulerianStatistics](RAEulerianStatistics.md) + * [`RAEulerianStatistics`](RAEulerianStatistics.md#generated.RAEulerianStatistics) + * [`RAEulerianStatistics.AddCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCurve) + * [`RAEulerianStatistics.AddCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomCurve) + * [`RAEulerianStatistics.AddCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddCustomProperty) + * [`RAEulerianStatistics.AddGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.AddGridFunction) + * [`RAEulerianStatistics.CreateCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateCurveOutputVariable) + * [`RAEulerianStatistics.CreateEulerianGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateEulerianGridFunction) + * [`RAEulerianStatistics.CreateGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunction) + * [`RAEulerianStatistics.CreateGridFunctionArrayOnCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionArrayOnCells) + * [`RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateGridFunctionStatisticOutputVariable) + * [`RAEulerianStatistics.CreateTransientCurveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.CreateTransientCurveOutputVariable) + * [`RAEulerianStatistics.EditCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomCurve) + * [`RAEulerianStatistics.EditCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.EditCustomProperty) + * [`RAEulerianStatistics.GetActivesArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetActivesArray) + * [`RAEulerianStatistics.GetAvailableOperations()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetAvailableOperations) + * [`RAEulerianStatistics.GetBoundingBox()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetBoundingBox) + * [`RAEulerianStatistics.GetCellAreaAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellAreaAsArray) + * [`RAEulerianStatistics.GetCellCenterAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellCenterAsArray) + * [`RAEulerianStatistics.GetCellDzAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellDzAsArray) + * [`RAEulerianStatistics.GetCellFromIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellFromIJK) + * [`RAEulerianStatistics.GetCellIJK()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellIJK) + * [`RAEulerianStatistics.GetCellNumberOfVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellNumberOfVertices) + * [`RAEulerianStatistics.GetCellPointsAsFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellPointsAsFunction) + * [`RAEulerianStatistics.GetCellVolumeAsArray()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCellVolumeAsArray) + * [`RAEulerianStatistics.GetCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurve) + * [`RAEulerianStatistics.GetCurveNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNames) + * [`RAEulerianStatistics.GetCurveNamesAssociation()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNamesAssociation) + * [`RAEulerianStatistics.GetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetDivisions) + * [`RAEulerianStatistics.GetElementCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetElementCurve) + * [`RAEulerianStatistics.GetGeometryQuantity()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryQuantity) + * [`RAEulerianStatistics.GetGeometryUnit()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryUnit) + * [`RAEulerianStatistics.GetGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunction) + * [`RAEulerianStatistics.GetGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunctionNames) + * [`RAEulerianStatistics.GetMeshColoring()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetMeshColoring) + * [`RAEulerianStatistics.GetNumberOfCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfCells) + * [`RAEulerianStatistics.GetNumberOfNodes()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfNodes) + * [`RAEulerianStatistics.GetNumberOfParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumberOfParticles) + * [`RAEulerianStatistics.GetNumpyCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetNumpyCurve) + * [`RAEulerianStatistics.GetOutputVariableValue()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetOutputVariableValue) + * [`RAEulerianStatistics.GetParticleGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetParticleGridFunctionNames) + * [`RAEulerianStatistics.GetTimeSet()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeSet) + * [`RAEulerianStatistics.GetTimeStatistics()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStatistics) + * [`RAEulerianStatistics.GetTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStep) + * [`RAEulerianStatistics.GetTopologyShape()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTopologyShape) + * [`RAEulerianStatistics.HasGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.HasGridFunction) + * [`RAEulerianStatistics.IsCellActive()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IsCellActive) + * [`RAEulerianStatistics.IterCellVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCellVertices) + * [`RAEulerianStatistics.IterCells()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCells) + * [`RAEulerianStatistics.IterParticles()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterParticles) + * [`RAEulerianStatistics.Modified()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.Modified) + * [`RAEulerianStatistics.RemoveCustomCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomCurve) + * [`RAEulerianStatistics.RemoveCustomProperty()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveCustomProperty) + * [`RAEulerianStatistics.RemoveOutputVariable()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveOutputVariable) + * [`RAEulerianStatistics.RemoveProcess()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.RemoveProcess) + * [`RAEulerianStatistics.SetCurrentTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetCurrentTimeStep) + * [`RAEulerianStatistics.SetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.SetDivisions) +* [RAExportToolkit](RAExportToolkit.md) + * [`RAExportToolkit`](RAExportToolkit.md#generated.RAExportToolkit) + * [`RAExportToolkit.ExportFEMForces()`](RAExportToolkit.md#generated.RAExportToolkit.ExportFEMForces) + * [`RAExportToolkit.ExportGeometryLoads()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoads) + * [`RAExportToolkit.ExportGeometryLoadsMultiTime()`](RAExportToolkit.md#generated.RAExportToolkit.ExportGeometryLoadsMultiTime) + * [`RAExportToolkit.ExportHTC()`](RAExportToolkit.md#generated.RAExportToolkit.ExportHTC) + * [`RAExportToolkit.ExportParticleToStl()`](RAExportToolkit.md#generated.RAExportToolkit.ExportParticleToStl) + * [`RAExportToolkit.ExportToSTL()`](RAExportToolkit.md#generated.RAExportToolkit.ExportToSTL) +* [RAFeedConveyor](RAFeedConveyor.md) + * [`RAFeedConveyor`](RAFeedConveyor.md#generated.RAFeedConveyor) + * [`RAFeedConveyor.AddCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCurve) + * [`RAFeedConveyor.AddCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomCurve) + * [`RAFeedConveyor.AddCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddCustomProperty) + * [`RAFeedConveyor.AddGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.AddGridFunction) + * [`RAFeedConveyor.CreateCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateCurveOutputVariable) + * [`RAFeedConveyor.CreateGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunction) + * [`RAFeedConveyor.CreateGridFunctionArrayOnCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionArrayOnCells) + * [`RAFeedConveyor.CreateGridFunctionStatisticOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateGridFunctionStatisticOutputVariable) + * [`RAFeedConveyor.CreateTransientCurveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.CreateTransientCurveOutputVariable) + * [`RAFeedConveyor.EditCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomCurve) + * [`RAFeedConveyor.EditCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.EditCustomProperty) + * [`RAFeedConveyor.GetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAccelerationPeriod) + * [`RAFeedConveyor.GetActivesArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetActivesArray) + * [`RAFeedConveyor.GetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAlignmentAngle) + * [`RAFeedConveyor.GetAvailableMaterials()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetAvailableMaterials) + * [`RAFeedConveyor.GetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStartTime) + * [`RAFeedConveyor.GetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeginningStopTime) + * [`RAFeedConveyor.GetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltInclineAngle) + * [`RAFeedConveyor.GetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfile) + * [`RAFeedConveyor.GetBeltProfileName()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltProfileName) + * [`RAFeedConveyor.GetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltSpeed) + * [`RAFeedConveyor.GetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltThickness) + * [`RAFeedConveyor.GetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltWidth) + * [`RAFeedConveyor.GetBoundingBox()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBoundingBox) + * [`RAFeedConveyor.GetCellAreaAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellAreaAsArray) + * [`RAFeedConveyor.GetCellCenterAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellCenterAsArray) + * [`RAFeedConveyor.GetCellDzAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellDzAsArray) + * [`RAFeedConveyor.GetCellFromIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellFromIJK) + * [`RAFeedConveyor.GetCellIJK()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellIJK) + * [`RAFeedConveyor.GetCellNumberOfVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellNumberOfVertices) + * [`RAFeedConveyor.GetCellPointsAsFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellPointsAsFunction) + * [`RAFeedConveyor.GetCellVolumeAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellVolumeAsArray) + * [`RAFeedConveyor.GetCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurve) + * [`RAFeedConveyor.GetCurveNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNames) + * [`RAFeedConveyor.GetCurveNamesAssociation()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCurveNamesAssociation) + * [`RAFeedConveyor.GetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDecelerationPeriod) + * [`RAFeedConveyor.GetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDiameter) + * [`RAFeedConveyor.GetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxHeight) + * [`RAFeedConveyor.GetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxLength) + * [`RAFeedConveyor.GetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxWidth) + * [`RAFeedConveyor.GetElementCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetElementCurve) + * [`RAFeedConveyor.GetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceWidth) + * [`RAFeedConveyor.GetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFrontPlateOffset) + * [`RAFeedConveyor.GetGeometryQuantity()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryQuantity) + * [`RAFeedConveyor.GetGeometryUnit()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryUnit) + * [`RAFeedConveyor.GetGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunction) + * [`RAFeedConveyor.GetGridFunctionNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunctionNames) + * [`RAFeedConveyor.GetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHeightOffset) + * [`RAFeedConveyor.GetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetHorizontalOffset) + * [`RAFeedConveyor.GetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLengthOffset) + * [`RAFeedConveyor.GetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetLoadingLength) + * [`RAFeedConveyor.GetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMaterial) + * [`RAFeedConveyor.GetMeshColoring()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetMeshColoring) + * [`RAFeedConveyor.GetModuleProperties()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperties) + * [`RAFeedConveyor.GetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetModuleProperty) + * [`RAFeedConveyor.GetNumberOfCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfCells) + * [`RAFeedConveyor.GetNumberOfNodes()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumberOfNodes) + * [`RAFeedConveyor.GetNumpyCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetNumpyCurve) + * [`RAFeedConveyor.GetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOffsetToIdlers) + * [`RAFeedConveyor.GetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutOfPlaneOffset) + * [`RAFeedConveyor.GetOutputVariableValue()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetOutputVariableValue) + * [`RAFeedConveyor.GetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetReturnBeltAngle) + * [`RAFeedConveyor.GetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardHeight) + * [`RAFeedConveyor.GetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSkirtboardLength) + * [`RAFeedConveyor.GetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSphBoundaryType) + * [`RAFeedConveyor.GetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetSurfaceTensionContactAngle) + * [`RAFeedConveyor.GetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTemperature) + * [`RAFeedConveyor.GetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetThermalBoundaryConditionType) + * [`RAFeedConveyor.GetTimeSet()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeSet) + * [`RAFeedConveyor.GetTimeStatistics()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStatistics) + * [`RAFeedConveyor.GetTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTimeStep) + * [`RAFeedConveyor.GetTopologyShape()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTopologyShape) + * [`RAFeedConveyor.GetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTransitionLength) + * [`RAFeedConveyor.GetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetTriangleSize) + * [`RAFeedConveyor.GetValidBeltProfileNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidBeltProfileNames) + * [`RAFeedConveyor.GetValidOptionsForModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidOptionsForModuleProperty) + * [`RAFeedConveyor.GetValidSphBoundaryTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues) + * [`RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues) + * [`RAFeedConveyor.GetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVerticalOffset) + * [`RAFeedConveyor.GetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWallThickness) + * [`RAFeedConveyor.GetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWidth) + * [`RAFeedConveyor.HasGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.HasGridFunction) + * [`RAFeedConveyor.IsCellActive()`](RAFeedConveyor.md#generated.RAFeedConveyor.IsCellActive) + * [`RAFeedConveyor.IterCellVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCellVertices) + * [`RAFeedConveyor.IterCells()`](RAFeedConveyor.md#generated.RAFeedConveyor.IterCells) + * [`RAFeedConveyor.Modified()`](RAFeedConveyor.md#generated.RAFeedConveyor.Modified) + * [`RAFeedConveyor.RemoveCustomCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomCurve) + * [`RAFeedConveyor.RemoveCustomProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveCustomProperty) + * [`RAFeedConveyor.RemoveOutputVariable()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveOutputVariable) + * [`RAFeedConveyor.RemoveProcess()`](RAFeedConveyor.md#generated.RAFeedConveyor.RemoveProcess) + * [`RAFeedConveyor.SetAccelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAccelerationPeriod) + * [`RAFeedConveyor.SetAlignmentAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetAlignmentAngle) + * [`RAFeedConveyor.SetBeginningStartTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStartTime) + * [`RAFeedConveyor.SetBeginningStopTime()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeginningStopTime) + * [`RAFeedConveyor.SetBeltInclineAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltInclineAngle) + * [`RAFeedConveyor.SetBeltProfile()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltProfile) + * [`RAFeedConveyor.SetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltSpeed) + * [`RAFeedConveyor.SetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltThickness) + * [`RAFeedConveyor.SetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltWidth) + * [`RAFeedConveyor.SetCurrentTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCurrentTimeStep) + * [`RAFeedConveyor.SetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDecelerationPeriod) + * [`RAFeedConveyor.SetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDiameter) + * [`RAFeedConveyor.SetDropBoxHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxHeight) + * [`RAFeedConveyor.SetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxLength) + * [`RAFeedConveyor.SetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDropBoxWidth) + * [`RAFeedConveyor.SetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFaceWidth) + * [`RAFeedConveyor.SetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetFrontPlateOffset) + * [`RAFeedConveyor.SetHeightOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHeightOffset) + * [`RAFeedConveyor.SetHorizontalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetHorizontalOffset) + * [`RAFeedConveyor.SetLengthOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLengthOffset) + * [`RAFeedConveyor.SetLoadingLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetLoadingLength) + * [`RAFeedConveyor.SetMaterial()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetMaterial) + * [`RAFeedConveyor.SetModuleProperty()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetModuleProperty) + * [`RAFeedConveyor.SetOffsetToIdlers()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOffsetToIdlers) + * [`RAFeedConveyor.SetOutOfPlaneOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetOutOfPlaneOffset) + * [`RAFeedConveyor.SetReturnBeltAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetReturnBeltAngle) + * [`RAFeedConveyor.SetSkirtboardHeight()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardHeight) + * [`RAFeedConveyor.SetSkirtboardLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSkirtboardLength) + * [`RAFeedConveyor.SetSphBoundaryType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSphBoundaryType) + * [`RAFeedConveyor.SetSurfaceTensionContactAngle()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetSurfaceTensionContactAngle) + * [`RAFeedConveyor.SetTemperature()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTemperature) + * [`RAFeedConveyor.SetThermalBoundaryConditionType()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetThermalBoundaryConditionType) + * [`RAFeedConveyor.SetTransitionLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTransitionLength) + * [`RAFeedConveyor.SetTriangleSize()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetTriangleSize) + * [`RAFeedConveyor.SetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetVerticalOffset) + * [`RAFeedConveyor.SetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWallThickness) + * [`RAFeedConveyor.SetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetWidth) +* [RAFilterProcess](RAFilterProcess.md) + * [`RAFilterProcess`](RAFilterProcess.md#generated.RAFilterProcess) + * [`RAFilterProcess.AddCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCurve) + * [`RAFilterProcess.AddCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomCurve) + * [`RAFilterProcess.AddCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.AddCustomProperty) + * [`RAFilterProcess.AddGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.AddGridFunction) + * [`RAFilterProcess.CreateCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateCurveOutputVariable) + * [`RAFilterProcess.CreateGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunction) + * [`RAFilterProcess.CreateGridFunctionArrayOnCells()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionArrayOnCells) + * [`RAFilterProcess.CreateGridFunctionStatisticOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAFilterProcess.CreateTransientCurveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.CreateTransientCurveOutputVariable) + * [`RAFilterProcess.EditCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomCurve) + * [`RAFilterProcess.EditCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.EditCustomProperty) + * [`RAFilterProcess.GetActivesArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetActivesArray) + * [`RAFilterProcess.GetBoundingBox()`](RAFilterProcess.md#generated.RAFilterProcess.GetBoundingBox) + * [`RAFilterProcess.GetCellAreaAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellAreaAsArray) + * [`RAFilterProcess.GetCellCenterAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellCenterAsArray) + * [`RAFilterProcess.GetCellDzAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellDzAsArray) + * [`RAFilterProcess.GetCellFromIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellFromIJK) + * [`RAFilterProcess.GetCellIJK()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellIJK) + * [`RAFilterProcess.GetCellNumberOfVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellNumberOfVertices) + * [`RAFilterProcess.GetCellPointsAsFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellPointsAsFunction) + * [`RAFilterProcess.GetCellVolumeAsArray()`](RAFilterProcess.md#generated.RAFilterProcess.GetCellVolumeAsArray) + * [`RAFilterProcess.GetCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurve) + * [`RAFilterProcess.GetCurveNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNames) + * [`RAFilterProcess.GetCurveNamesAssociation()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNamesAssociation) + * [`RAFilterProcess.GetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetCutValue) + * [`RAFilterProcess.GetElementCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetElementCurve) + * [`RAFilterProcess.GetGeometryQuantity()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryQuantity) + * [`RAFilterProcess.GetGeometryUnit()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryUnit) + * [`RAFilterProcess.GetGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunction) + * [`RAFilterProcess.GetGridFunctionNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunctionNames) + * [`RAFilterProcess.GetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMaxValue) + * [`RAFilterProcess.GetMeshColoring()`](RAFilterProcess.md#generated.RAFilterProcess.GetMeshColoring) + * [`RAFilterProcess.GetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetMinValue) + * [`RAFilterProcess.GetMode()`](RAFilterProcess.md#generated.RAFilterProcess.GetMode) + * [`RAFilterProcess.GetNumberOfCells()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfCells) + * [`RAFilterProcess.GetNumberOfNodes()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfNodes) + * [`RAFilterProcess.GetNumberOfParticles()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumberOfParticles) + * [`RAFilterProcess.GetNumpyCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetNumpyCurve) + * [`RAFilterProcess.GetOutputVariableValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetOutputVariableValue) + * [`RAFilterProcess.GetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetPropertyGridFunction) + * [`RAFilterProcess.GetTimeSet()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeSet) + * [`RAFilterProcess.GetTimeStatistics()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStatistics) + * [`RAFilterProcess.GetTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStep) + * [`RAFilterProcess.GetTopologyShape()`](RAFilterProcess.md#generated.RAFilterProcess.GetTopologyShape) + * [`RAFilterProcess.GetType()`](RAFilterProcess.md#generated.RAFilterProcess.GetType) + * [`RAFilterProcess.HasGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.HasGridFunction) + * [`RAFilterProcess.IsCellActive()`](RAFilterProcess.md#generated.RAFilterProcess.IsCellActive) + * [`RAFilterProcess.IterCellVertices()`](RAFilterProcess.md#generated.RAFilterProcess.IterCellVertices) + * [`RAFilterProcess.IterCells()`](RAFilterProcess.md#generated.RAFilterProcess.IterCells) + * [`RAFilterProcess.IterParticles()`](RAFilterProcess.md#generated.RAFilterProcess.IterParticles) + * [`RAFilterProcess.Modified()`](RAFilterProcess.md#generated.RAFilterProcess.Modified) + * [`RAFilterProcess.RemoveCustomCurve()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomCurve) + * [`RAFilterProcess.RemoveCustomProperty()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveCustomProperty) + * [`RAFilterProcess.RemoveOutputVariable()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveOutputVariable) + * [`RAFilterProcess.RemoveProcess()`](RAFilterProcess.md#generated.RAFilterProcess.RemoveProcess) + * [`RAFilterProcess.SetCurrentTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.SetCurrentTimeStep) + * [`RAFilterProcess.SetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetCutValue) + * [`RAFilterProcess.SetMaxValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMaxValue) + * [`RAFilterProcess.SetMinValue()`](RAFilterProcess.md#generated.RAFilterProcess.SetMinValue) + * [`RAFilterProcess.SetMode()`](RAFilterProcess.md#generated.RAFilterProcess.SetMode) + * [`RAFilterProcess.SetPropertyGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.SetPropertyGridFunction) + * [`RAFilterProcess.SetType()`](RAFilterProcess.md#generated.RAFilterProcess.SetType) +* [RAFiveRollsBeltProfile](RAFiveRollsBeltProfile.md) + * [`RAFiveRollsBeltProfile`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile) + * [`RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.DisableUse0223RatioForRollLengths) + * [`RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.EnableUse0223RatioForRollLengths) + * [`RAFiveRollsBeltProfile.GetAvailableMaterials()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetAvailableMaterials) + * [`RAFiveRollsBeltProfile.GetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetCenterRollLength) + * [`RAFiveRollsBeltProfile.GetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLastRollAngle) + * [`RAFiveRollsBeltProfile.GetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetLowerCornerRadius) + * [`RAFiveRollsBeltProfile.GetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetMaterial) + * [`RAFiveRollsBeltProfile.GetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetSideRollLength) + * [`RAFiveRollsBeltProfile.GetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetTroughingAngle) + * [`RAFiveRollsBeltProfile.GetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUpperCornerRadius) + * [`RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.GetUse0223RatioForRollLengths) + * [`RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.IsUse0223RatioForRollLengthsEnabled) + * [`RAFiveRollsBeltProfile.SetCenterRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetCenterRollLength) + * [`RAFiveRollsBeltProfile.SetLastRollAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLastRollAngle) + * [`RAFiveRollsBeltProfile.SetLowerCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetLowerCornerRadius) + * [`RAFiveRollsBeltProfile.SetMaterial()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetMaterial) + * [`RAFiveRollsBeltProfile.SetSideRollLength()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetSideRollLength) + * [`RAFiveRollsBeltProfile.SetTroughingAngle()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetTroughingAngle) + * [`RAFiveRollsBeltProfile.SetUpperCornerRadius()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUpperCornerRadius) + * [`RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths()`](RAFiveRollsBeltProfile.md#generated.RAFiveRollsBeltProfile.SetUse0223RatioForRollLengths) +* [RAFluentOneWayCoupling](RAFluentOneWayCoupling.md) + * [`RAFluentOneWayCoupling`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling) + * [`RAFluentOneWayCoupling.AddCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCurve) + * [`RAFluentOneWayCoupling.AddCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomCurve) + * [`RAFluentOneWayCoupling.AddCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddCustomProperty) + * [`RAFluentOneWayCoupling.AddGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.AddGridFunction) + * [`RAFluentOneWayCoupling.CreateCoupledBoundaries()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCoupledBoundaries) + * [`RAFluentOneWayCoupling.CreateCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateCurveOutputVariable) + * [`RAFluentOneWayCoupling.CreateGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunction) + * [`RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionArrayOnCells) + * [`RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateGridFunctionStatisticOutputVariable) + * [`RAFluentOneWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.CreateTransientCurveOutputVariable) + * [`RAFluentOneWayCoupling.EditCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomCurve) + * [`RAFluentOneWayCoupling.EditCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.EditCustomProperty) + * [`RAFluentOneWayCoupling.GetActivesArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetActivesArray) + * [`RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames) + * [`RAFluentOneWayCoupling.GetBoundingBox()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetBoundingBox) + * [`RAFluentOneWayCoupling.GetCFDParametersList()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCFDParametersList) + * [`RAFluentOneWayCoupling.GetCellAreaAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellAreaAsArray) + * [`RAFluentOneWayCoupling.GetCellCenterAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellCenterAsArray) + * [`RAFluentOneWayCoupling.GetCellDzAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellDzAsArray) + * [`RAFluentOneWayCoupling.GetCellFromIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellFromIJK) + * [`RAFluentOneWayCoupling.GetCellIJK()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellIJK) + * [`RAFluentOneWayCoupling.GetCellNumberOfVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellNumberOfVertices) + * [`RAFluentOneWayCoupling.GetCellPointsAsFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellPointsAsFunction) + * [`RAFluentOneWayCoupling.GetCellVolumeAsArray()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCellVolumeAsArray) + * [`RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetConvectiveHeatTransferLaw) + * [`RAFluentOneWayCoupling.GetCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurve) + * [`RAFluentOneWayCoupling.GetCurveNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNames) + * [`RAFluentOneWayCoupling.GetCurveNamesAssociation()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation) + * [`RAFluentOneWayCoupling.GetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetDragLaw) + * [`RAFluentOneWayCoupling.GetElementCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetElementCurve) + * [`RAFluentOneWayCoupling.GetGeometryQuantity()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryQuantity) + * [`RAFluentOneWayCoupling.GetGeometryUnit()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryUnit) + * [`RAFluentOneWayCoupling.GetGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunction) + * [`RAFluentOneWayCoupling.GetGridFunctionNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunctionNames) + * [`RAFluentOneWayCoupling.GetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetIsOneWayPeriodic) + * [`RAFluentOneWayCoupling.GetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetLiftLaw) + * [`RAFluentOneWayCoupling.GetMeshColoring()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMeshColoring) + * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK1) + * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK2) + * [`RAFluentOneWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetMorsiAndAlexanderK3) + * [`RAFluentOneWayCoupling.GetNumberOfCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfCells) + * [`RAFluentOneWayCoupling.GetNumberOfNodes()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumberOfNodes) + * [`RAFluentOneWayCoupling.GetNumpyCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetNumpyCurve) + * [`RAFluentOneWayCoupling.GetOutputVariableValue()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOutputVariableValue) + * [`RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance) + * [`RAFluentOneWayCoupling.GetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetStartTime) + * [`RAFluentOneWayCoupling.GetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienC1) + * [`RAFluentOneWayCoupling.GetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetSyamlalObrienD1) + * [`RAFluentOneWayCoupling.GetTimeSet()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeSet) + * [`RAFluentOneWayCoupling.GetTimeStatistics()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStatistics) + * [`RAFluentOneWayCoupling.GetTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTimeStep) + * [`RAFluentOneWayCoupling.GetTopologyShape()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTopologyShape) + * [`RAFluentOneWayCoupling.GetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetTorqueLaw) + * [`RAFluentOneWayCoupling.GetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion) + * [`RAFluentOneWayCoupling.GetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants) + * [`RAFluentOneWayCoupling.GetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance) + * [`RAFluentOneWayCoupling.GetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVirtualMassLaw) + * [`RAFluentOneWayCoupling.HasGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.HasGridFunction) + * [`RAFluentOneWayCoupling.IsCellActive()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IsCellActive) + * [`RAFluentOneWayCoupling.IterCellVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCellVertices) + * [`RAFluentOneWayCoupling.IterCells()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IterCells) + * [`RAFluentOneWayCoupling.Modified()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.Modified) + * [`RAFluentOneWayCoupling.RemoveCustomCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomCurve) + * [`RAFluentOneWayCoupling.RemoveCustomProperty()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveCustomProperty) + * [`RAFluentOneWayCoupling.RemoveOutputVariable()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveOutputVariable) + * [`RAFluentOneWayCoupling.RemoveProcess()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.RemoveProcess) + * [`RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetConvectiveHeatTransferLaw) + * [`RAFluentOneWayCoupling.SetCurrentTimeStep()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetCurrentTimeStep) + * [`RAFluentOneWayCoupling.SetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetDragLaw) + * [`RAFluentOneWayCoupling.SetIsOneWayPeriodic()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetIsOneWayPeriodic) + * [`RAFluentOneWayCoupling.SetLiftLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetLiftLaw) + * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK1) + * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK2) + * [`RAFluentOneWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetMorsiAndAlexanderK3) + * [`RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance) + * [`RAFluentOneWayCoupling.SetPartIdIfValid()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetPartIdIfValid) + * [`RAFluentOneWayCoupling.SetStartTime()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetStartTime) + * [`RAFluentOneWayCoupling.SetSyamlalObrienC1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienC1) + * [`RAFluentOneWayCoupling.SetSyamlalObrienD1()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetSyamlalObrienD1) + * [`RAFluentOneWayCoupling.SetTorqueLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetTorqueLaw) + * [`RAFluentOneWayCoupling.SetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseTurbulentDispersion) + * [`RAFluentOneWayCoupling.SetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUseUserDefinedConstants) + * [`RAFluentOneWayCoupling.SetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetUserCfdUpdateDistance) + * [`RAFluentOneWayCoupling.SetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetVirtualMassLaw) + * [`RAFluentOneWayCoupling.SetupStoreFiles()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.SetupStoreFiles) +* [RAFluentSemiResolvedCoupling](RAFluentSemiResolvedCoupling.md) + * [`RAFluentSemiResolvedCoupling`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling) + * [`RAFluentSemiResolvedCoupling.GetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetCouplingFilesKept) + * [`RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs) + * [`RAFluentSemiResolvedCoupling.GetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentExecutionMode) + * [`RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier) + * [`RAFluentSemiResolvedCoupling.GetFluentReleases()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentReleases) + * [`RAFluentSemiResolvedCoupling.GetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentSolverProcesses) + * [`RAFluentSemiResolvedCoupling.GetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetFluentVersion) + * [`RAFluentSemiResolvedCoupling.GetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetUseDatInitialization) + * [`RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues) + * [`RAFluentSemiResolvedCoupling.SetCouplingFilesKept()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetCouplingFilesKept) + * [`RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs) + * [`RAFluentSemiResolvedCoupling.SetFluentExecutionMode()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentExecutionMode) + * [`RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier) + * [`RAFluentSemiResolvedCoupling.SetFluentSolverProcesses()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentSolverProcesses) + * [`RAFluentSemiResolvedCoupling.SetFluentVersion()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetFluentVersion) + * [`RAFluentSemiResolvedCoupling.SetPartIdIfValid()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetPartIdIfValid) + * [`RAFluentSemiResolvedCoupling.SetUseDatInitialization()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetUseDatInitialization) + * [`RAFluentSemiResolvedCoupling.SetupStoreFiles()`](RAFluentSemiResolvedCoupling.md#generated.RAFluentSemiResolvedCoupling.SetupStoreFiles) +* [RAFluentTwoWayCoupling](RAFluentTwoWayCoupling.md) + * [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling) + * [`RAFluentTwoWayCoupling.AddCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCurve) + * [`RAFluentTwoWayCoupling.AddCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomCurve) + * [`RAFluentTwoWayCoupling.AddCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddCustomProperty) + * [`RAFluentTwoWayCoupling.AddGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.AddGridFunction) + * [`RAFluentTwoWayCoupling.CloseFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CloseFluent) + * [`RAFluentTwoWayCoupling.CreateCoupledBoundaries()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCoupledBoundaries) + * [`RAFluentTwoWayCoupling.CreateCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateCurveOutputVariable) + * [`RAFluentTwoWayCoupling.CreateGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunction) + * [`RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionArrayOnCells) + * [`RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateGridFunctionStatisticOutputVariable) + * [`RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.CreateTransientCurveOutputVariable) + * [`RAFluentTwoWayCoupling.DisableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableBackDiffusion) + * [`RAFluentTwoWayCoupling.DisableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.DisableSubstepping) + * [`RAFluentTwoWayCoupling.EditCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomCurve) + * [`RAFluentTwoWayCoupling.EditCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EditCustomProperty) + * [`RAFluentTwoWayCoupling.EnableBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableBackDiffusion) + * [`RAFluentTwoWayCoupling.EnableSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.EnableSubstepping) + * [`RAFluentTwoWayCoupling.GetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAbsoluteValue) + * [`RAFluentTwoWayCoupling.GetActivesArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetActivesArray) + * [`RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAvailableCoupledBoundaryNames) + * [`RAFluentTwoWayCoupling.GetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingMethod) + * [`RAFluentTwoWayCoupling.GetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetAveragingRadiusType) + * [`RAFluentTwoWayCoupling.GetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBackDiffusion) + * [`RAFluentTwoWayCoupling.GetBoundingBox()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetBoundingBox) + * [`RAFluentTwoWayCoupling.GetCFDParametersList()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCFDParametersList) + * [`RAFluentTwoWayCoupling.GetCellAreaAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellAreaAsArray) + * [`RAFluentTwoWayCoupling.GetCellCenterAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellCenterAsArray) + * [`RAFluentTwoWayCoupling.GetCellDzAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellDzAsArray) + * [`RAFluentTwoWayCoupling.GetCellFromIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellFromIJK) + * [`RAFluentTwoWayCoupling.GetCellIJK()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellIJK) + * [`RAFluentTwoWayCoupling.GetCellNumberOfVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellNumberOfVertices) + * [`RAFluentTwoWayCoupling.GetCellPointsAsFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellPointsAsFunction) + * [`RAFluentTwoWayCoupling.GetCellVolumeAsArray()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCellVolumeAsArray) + * [`RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetConvectiveHeatTransferLaw) + * [`RAFluentTwoWayCoupling.GetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCouplingFilesKept) + * [`RAFluentTwoWayCoupling.GetCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurve) + * [`RAFluentTwoWayCoupling.GetCurveNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNames) + * [`RAFluentTwoWayCoupling.GetCurveNamesAssociation()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetCurveNamesAssociation) + * [`RAFluentTwoWayCoupling.GetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDecompositionFactor) + * [`RAFluentTwoWayCoupling.GetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient) + * [`RAFluentTwoWayCoupling.GetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDragLaw) + * [`RAFluentTwoWayCoupling.GetElementCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetElementCurve) + * [`RAFluentTwoWayCoupling.GetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs) + * [`RAFluentTwoWayCoupling.GetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode) + * [`RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier) + * [`RAFluentTwoWayCoupling.GetFluentReleases()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentReleases) + * [`RAFluentTwoWayCoupling.GetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentSolverProcesses) + * [`RAFluentTwoWayCoupling.GetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentVersion) + * [`RAFluentTwoWayCoupling.GetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFractionParticleSize) + * [`RAFluentTwoWayCoupling.GetGeometryQuantity()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryQuantity) + * [`RAFluentTwoWayCoupling.GetGeometryUnit()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryUnit) + * [`RAFluentTwoWayCoupling.GetGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunction) + * [`RAFluentTwoWayCoupling.GetGridFunctionNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunctionNames) + * [`RAFluentTwoWayCoupling.GetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetLiftLaw) + * [`RAFluentTwoWayCoupling.GetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMappingMethod) + * [`RAFluentTwoWayCoupling.GetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumIterations) + * [`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) + * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK1) + * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK2) + * [`RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMorsiAndAlexanderK3) + * [`RAFluentTwoWayCoupling.GetNumberOfCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfCells) + * [`RAFluentTwoWayCoupling.GetNumberOfNodes()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfNodes) + * [`RAFluentTwoWayCoupling.GetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfSubsteps) + * [`RAFluentTwoWayCoupling.GetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumberOfThreads) + * [`RAFluentTwoWayCoupling.GetNumpyCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetNumpyCurve) + * [`RAFluentTwoWayCoupling.GetOutputVariableValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOutputVariableValue) + * [`RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetOverwriteCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.GetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSubstepping) + * [`RAFluentTwoWayCoupling.GetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienC1) + * [`RAFluentTwoWayCoupling.GetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetSyamlalObrienD1) + * [`RAFluentTwoWayCoupling.GetTimeSet()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeSet) + * [`RAFluentTwoWayCoupling.GetTimeStatistics()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStatistics) + * [`RAFluentTwoWayCoupling.GetTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTimeStep) + * [`RAFluentTwoWayCoupling.GetTopologyShape()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTopologyShape) + * [`RAFluentTwoWayCoupling.GetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetTorqueLaw) + * [`RAFluentTwoWayCoupling.GetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseDatInitialization) + * [`RAFluentTwoWayCoupling.GetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseTurbulentDispersion) + * [`RAFluentTwoWayCoupling.GetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUseUserDefinedConstants) + * [`RAFluentTwoWayCoupling.GetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetUserCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.GetValidAveragingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingMethodValues) + * [`RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues) + * [`RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues) + * [`RAFluentTwoWayCoupling.GetValidMappingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) + * [`RAFluentTwoWayCoupling.GetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw) + * [`RAFluentTwoWayCoupling.GetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.HasGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.HasGridFunction) + * [`RAFluentTwoWayCoupling.IsBackDiffusionEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsBackDiffusionEnabled) + * [`RAFluentTwoWayCoupling.IsCellActive()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsCellActive) + * [`RAFluentTwoWayCoupling.IsFluentRunning()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsFluentRunning) + * [`RAFluentTwoWayCoupling.IsSubsteppingEnabled()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IsSubsteppingEnabled) + * [`RAFluentTwoWayCoupling.IterCellVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCellVertices) + * [`RAFluentTwoWayCoupling.IterCells()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.IterCells) + * [`RAFluentTwoWayCoupling.Modified()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.Modified) + * [`RAFluentTwoWayCoupling.RemoveCustomCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomCurve) + * [`RAFluentTwoWayCoupling.RemoveCustomProperty()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveCustomProperty) + * [`RAFluentTwoWayCoupling.RemoveOutputVariable()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveOutputVariable) + * [`RAFluentTwoWayCoupling.RemoveProcess()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.RemoveProcess) + * [`RAFluentTwoWayCoupling.SetAbsoluteValue()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAbsoluteValue) + * [`RAFluentTwoWayCoupling.SetAveragingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingMethod) + * [`RAFluentTwoWayCoupling.SetAveragingRadiusType()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetAveragingRadiusType) + * [`RAFluentTwoWayCoupling.SetBackDiffusion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetBackDiffusion) + * [`RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetConvectiveHeatTransferLaw) + * [`RAFluentTwoWayCoupling.SetCouplingFilesKept()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCouplingFilesKept) + * [`RAFluentTwoWayCoupling.SetCurrentTimeStep()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetCurrentTimeStep) + * [`RAFluentTwoWayCoupling.SetDecompositionFactor()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDecompositionFactor) + * [`RAFluentTwoWayCoupling.SetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDiffusionCoefficient) + * [`RAFluentTwoWayCoupling.SetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetDragLaw) + * [`RAFluentTwoWayCoupling.SetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentAdditionalArgs) + * [`RAFluentTwoWayCoupling.SetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentExecutionMode) + * [`RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentOutputFrequencyMultiplier) + * [`RAFluentTwoWayCoupling.SetFluentSolverProcesses()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentSolverProcesses) + * [`RAFluentTwoWayCoupling.SetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFluentVersion) + * [`RAFluentTwoWayCoupling.SetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetFractionParticleSize) + * [`RAFluentTwoWayCoupling.SetLiftLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetLiftLaw) + * [`RAFluentTwoWayCoupling.SetMappingMethod()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMappingMethod) + * [`RAFluentTwoWayCoupling.SetMaximumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumIterations) + * [`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) + * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK2) + * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK3) + * [`RAFluentTwoWayCoupling.SetNumberOfSubsteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfSubsteps) + * [`RAFluentTwoWayCoupling.SetNumberOfThreads()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetNumberOfThreads) + * [`RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetOverwriteCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.SetPartIdIfValid()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetPartIdIfValid) + * [`RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSolidsMaximumVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.SetSubstepping()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSubstepping) + * [`RAFluentTwoWayCoupling.SetSyamlalObrienC1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienC1) + * [`RAFluentTwoWayCoupling.SetSyamlalObrienD1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetSyamlalObrienD1) + * [`RAFluentTwoWayCoupling.SetTorqueLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetTorqueLaw) + * [`RAFluentTwoWayCoupling.SetUseDatInitialization()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseDatInitialization) + * [`RAFluentTwoWayCoupling.SetUseTurbulentDispersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseTurbulentDispersion) + * [`RAFluentTwoWayCoupling.SetUseUserDefinedConstants()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUseUserDefinedConstants) + * [`RAFluentTwoWayCoupling.SetUserCfdUpdateDistance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetUserCfdUpdateDistance) + * [`RAFluentTwoWayCoupling.SetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVirtualMassLaw) + * [`RAFluentTwoWayCoupling.SetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetVolumeFractionTarget) + * [`RAFluentTwoWayCoupling.SetupStoreFiles()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetupStoreFiles) + * [`RAFluentTwoWayCoupling.StartFluent()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.StartFluent) + * [`RAFluentTwoWayCoupling.UpdateFluentInfo()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.UpdateFluentInfo) +* [RAFluidInlet](RAFluidInlet.md) + * [`RAFluidInlet`](RAFluidInlet.md#generated.RAFluidInlet) + * [`RAFluidInlet.GetAvailableEntryPoints()`](RAFluidInlet.md#generated.RAFluidInlet.GetAvailableEntryPoints) + * [`RAFluidInlet.GetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.GetBoundaryCondition) + * [`RAFluidInlet.GetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.GetEntryPoint) + * [`RAFluidInlet.GetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.GetMassFlowRate) + * [`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.SetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.SetBoundaryCondition) + * [`RAFluidInlet.SetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.SetEntryPoint) + * [`RAFluidInlet.SetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.SetMassFlowRate) + * [`RAFluidInlet.SetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStartTime) + * [`RAFluidInlet.SetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStopTime) + * [`RAFluidInlet.SetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.SetTemperature) + * [`RAFluidInlet.SetVelocity()`](RAFluidInlet.md#generated.RAFluidInlet.SetVelocity) +* [RAFluidMaterial](RAFluidMaterial.md) + * [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial) + * [`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) +* [RAFreeBodyRotation](RAFreeBodyRotation.md) + * [`RAFreeBodyRotation`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation) + * [`RAFreeBodyRotation.GetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetFreeMotionDirection) + * [`RAFreeBodyRotation.GetValidFreeMotionDirectionValues()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.GetValidFreeMotionDirectionValues) + * [`RAFreeBodyRotation.SetFreeMotionDirection()`](RAFreeBodyRotation.md#generated.RAFreeBodyRotation.SetFreeMotionDirection) +* [RAFreeBodyTranslation](RAFreeBodyTranslation.md) + * [`RAFreeBodyTranslation`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation) + * [`RAFreeBodyTranslation.GetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetFreeMotionDirection) + * [`RAFreeBodyTranslation.GetValidFreeMotionDirectionValues()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.GetValidFreeMotionDirectionValues) + * [`RAFreeBodyTranslation.SetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.SetFreeMotionDirection) +* [RAGeometryCollection](RAGeometryCollection.md) + * [`RAGeometryCollection`](RAGeometryCollection.md#generated.RAGeometryCollection) + * [`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.RemoveGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.RemoveGeometry) +* [RAInletGeometry](RAInletGeometry.md) + * [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry) + * [`RAInletGeometry.AddCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCurve) + * [`RAInletGeometry.AddCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomCurve) + * [`RAInletGeometry.AddCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.AddCustomProperty) + * [`RAInletGeometry.AddGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.AddGridFunction) + * [`RAInletGeometry.CreateCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateCurveOutputVariable) + * [`RAInletGeometry.CreateGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunction) + * [`RAInletGeometry.CreateGridFunctionArrayOnCells()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionArrayOnCells) + * [`RAInletGeometry.CreateGridFunctionStatisticOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateGridFunctionStatisticOutputVariable) + * [`RAInletGeometry.CreateTransientCurveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.CreateTransientCurveOutputVariable) + * [`RAInletGeometry.EditCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomCurve) + * [`RAInletGeometry.EditCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.EditCustomProperty) + * [`RAInletGeometry.GetActivesArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetActivesArray) + * [`RAInletGeometry.GetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetAlignmentAngle) + * [`RAInletGeometry.GetBoundingBox()`](RAInletGeometry.md#generated.RAInletGeometry.GetBoundingBox) + * [`RAInletGeometry.GetCellAreaAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellAreaAsArray) + * [`RAInletGeometry.GetCellCenterAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellCenterAsArray) + * [`RAInletGeometry.GetCellDzAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellDzAsArray) + * [`RAInletGeometry.GetCellFromIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellFromIJK) + * [`RAInletGeometry.GetCellIJK()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellIJK) + * [`RAInletGeometry.GetCellNumberOfVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellNumberOfVertices) + * [`RAInletGeometry.GetCellPointsAsFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellPointsAsFunction) + * [`RAInletGeometry.GetCellVolumeAsArray()`](RAInletGeometry.md#generated.RAInletGeometry.GetCellVolumeAsArray) + * [`RAInletGeometry.GetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.GetCenter) + * [`RAInletGeometry.GetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.GetCircularMinMaxRadius) + * [`RAInletGeometry.GetCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurve) + * [`RAInletGeometry.GetCurveNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNames) + * [`RAInletGeometry.GetCurveNamesAssociation()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNamesAssociation) + * [`RAInletGeometry.GetElementCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetElementCurve) + * [`RAInletGeometry.GetGeometryQuantity()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryQuantity) + * [`RAInletGeometry.GetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryType) + * [`RAInletGeometry.GetGeometryUnit()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryUnit) + * [`RAInletGeometry.GetGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunction) + * [`RAInletGeometry.GetGridFunctionNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunctionNames) + * [`RAInletGeometry.GetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.GetInclineAngle) + * [`RAInletGeometry.GetLength()`](RAInletGeometry.md#generated.RAInletGeometry.GetLength) + * [`RAInletGeometry.GetMeshColoring()`](RAInletGeometry.md#generated.RAInletGeometry.GetMeshColoring) + * [`RAInletGeometry.GetNumberOfCells()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfCells) + * [`RAInletGeometry.GetNumberOfNodes()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumberOfNodes) + * [`RAInletGeometry.GetNumpyCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetNumpyCurve) + * [`RAInletGeometry.GetOutputVariableValue()`](RAInletGeometry.md#generated.RAInletGeometry.GetOutputVariableValue) + * [`RAInletGeometry.GetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.GetRectangularSize) + * [`RAInletGeometry.GetTimeSet()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeSet) + * [`RAInletGeometry.GetTimeStatistics()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStatistics) + * [`RAInletGeometry.GetTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStep) + * [`RAInletGeometry.GetTopologyShape()`](RAInletGeometry.md#generated.RAInletGeometry.GetTopologyShape) + * [`RAInletGeometry.GetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.GetWidth) + * [`RAInletGeometry.HasGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.HasGridFunction) + * [`RAInletGeometry.IsCellActive()`](RAInletGeometry.md#generated.RAInletGeometry.IsCellActive) + * [`RAInletGeometry.IterCellVertices()`](RAInletGeometry.md#generated.RAInletGeometry.IterCellVertices) + * [`RAInletGeometry.IterCells()`](RAInletGeometry.md#generated.RAInletGeometry.IterCells) + * [`RAInletGeometry.Modified()`](RAInletGeometry.md#generated.RAInletGeometry.Modified) + * [`RAInletGeometry.RemoveCustomCurve()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomCurve) + * [`RAInletGeometry.RemoveCustomProperty()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveCustomProperty) + * [`RAInletGeometry.RemoveOutputVariable()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveOutputVariable) + * [`RAInletGeometry.RemoveProcess()`](RAInletGeometry.md#generated.RAInletGeometry.RemoveProcess) + * [`RAInletGeometry.SetAlignmentAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetAlignmentAngle) + * [`RAInletGeometry.SetCenter()`](RAInletGeometry.md#generated.RAInletGeometry.SetCenter) + * [`RAInletGeometry.SetCircularMinMaxRadius()`](RAInletGeometry.md#generated.RAInletGeometry.SetCircularMinMaxRadius) + * [`RAInletGeometry.SetCurrentTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.SetCurrentTimeStep) + * [`RAInletGeometry.SetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.SetGeometryType) + * [`RAInletGeometry.SetInclineAngle()`](RAInletGeometry.md#generated.RAInletGeometry.SetInclineAngle) + * [`RAInletGeometry.SetLength()`](RAInletGeometry.md#generated.RAInletGeometry.SetLength) + * [`RAInletGeometry.SetRectangularSize()`](RAInletGeometry.md#generated.RAInletGeometry.SetRectangularSize) + * [`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) + * [`RAInletsOutletsCollection.AddParticleInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddParticleInlet) + * [`RAInletsOutletsCollection.AddVolumetricInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddVolumetricInlet) + * [`RAInletsOutletsCollection.Clear()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Clear) + * [`RAInletsOutletsCollection.GetParticleInput()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInput) + * [`RAInletsOutletsCollection.GetParticleInputNames()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.GetParticleInputNames) + * [`RAInletsOutletsCollection.New()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.New) + * [`RAInletsOutletsCollection.Remove()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.Remove) +* [RAInputVariables](RAInputVariables.md) + * [`RAInputVariables`](RAInputVariables.md#generated.RAInputVariables) + * [`RAInputVariables.CreateVariable()`](RAInputVariables.md#generated.RAInputVariables.CreateVariable) + * [`RAInputVariables.GetVariableByName()`](RAInputVariables.md#generated.RAInputVariables.GetVariableByName) + * [`RAInputVariables.RemoveVariable()`](RAInputVariables.md#generated.RAInputVariables.RemoveVariable) +* [RAInspectorProcess](RAInspectorProcess.md) + * [`RAInspectorProcess`](RAInspectorProcess.md#generated.RAInspectorProcess) + * [`RAInspectorProcess.AddCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCurve) + * [`RAInspectorProcess.AddCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomCurve) + * [`RAInspectorProcess.AddCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddCustomProperty) + * [`RAInspectorProcess.AddGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.AddGridFunction) + * [`RAInspectorProcess.CreateCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateCurveOutputVariable) + * [`RAInspectorProcess.CreateGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunction) + * [`RAInspectorProcess.CreateGridFunctionArrayOnCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionArrayOnCells) + * [`RAInspectorProcess.CreateGridFunctionStatisticOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAInspectorProcess.CreateTransientCurveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.CreateTransientCurveOutputVariable) + * [`RAInspectorProcess.EditCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomCurve) + * [`RAInspectorProcess.EditCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.EditCustomProperty) + * [`RAInspectorProcess.GetActivesArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetActivesArray) + * [`RAInspectorProcess.GetBoundingBox()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetBoundingBox) + * [`RAInspectorProcess.GetCellAreaAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellAreaAsArray) + * [`RAInspectorProcess.GetCellCenterAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellCenterAsArray) + * [`RAInspectorProcess.GetCellDzAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellDzAsArray) + * [`RAInspectorProcess.GetCellFromIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellFromIJK) + * [`RAInspectorProcess.GetCellIJK()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellIJK) + * [`RAInspectorProcess.GetCellNumberOfVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellNumberOfVertices) + * [`RAInspectorProcess.GetCellPointsAsFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellPointsAsFunction) + * [`RAInspectorProcess.GetCellVolumeAsArray()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCellVolumeAsArray) + * [`RAInspectorProcess.GetCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurve) + * [`RAInspectorProcess.GetCurveNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNames) + * [`RAInspectorProcess.GetCurveNamesAssociation()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNamesAssociation) + * [`RAInspectorProcess.GetElementCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetElementCurve) + * [`RAInspectorProcess.GetGeometryQuantity()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryQuantity) + * [`RAInspectorProcess.GetGeometryUnit()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryUnit) + * [`RAInspectorProcess.GetGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunction) + * [`RAInspectorProcess.GetGridFunctionNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunctionNames) + * [`RAInspectorProcess.GetMeshColoring()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetMeshColoring) + * [`RAInspectorProcess.GetNumberOfCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfCells) + * [`RAInspectorProcess.GetNumberOfNodes()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfNodes) + * [`RAInspectorProcess.GetNumberOfParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumberOfParticles) + * [`RAInspectorProcess.GetNumpyCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetNumpyCurve) + * [`RAInspectorProcess.GetOutputVariableValue()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetOutputVariableValue) + * [`RAInspectorProcess.GetTimeSet()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeSet) + * [`RAInspectorProcess.GetTimeStatistics()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStatistics) + * [`RAInspectorProcess.GetTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStep) + * [`RAInspectorProcess.GetTopologyShape()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTopologyShape) + * [`RAInspectorProcess.HasGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.HasGridFunction) + * [`RAInspectorProcess.IsCellActive()`](RAInspectorProcess.md#generated.RAInspectorProcess.IsCellActive) + * [`RAInspectorProcess.IterCellVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCellVertices) + * [`RAInspectorProcess.IterCells()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCells) + * [`RAInspectorProcess.IterParticles()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterParticles) + * [`RAInspectorProcess.Modified()`](RAInspectorProcess.md#generated.RAInspectorProcess.Modified) + * [`RAInspectorProcess.RemoveCustomCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomCurve) + * [`RAInspectorProcess.RemoveCustomProperty()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveCustomProperty) + * [`RAInspectorProcess.RemoveOutputVariable()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveOutputVariable) + * [`RAInspectorProcess.RemoveProcess()`](RAInspectorProcess.md#generated.RAInspectorProcess.RemoveProcess) + * [`RAInspectorProcess.SetCurrentTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.SetCurrentTimeStep) +* [RAJointsDataMeshColoring](RAJointsDataMeshColoring.md) + * [`RAJointsDataMeshColoring`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring) + * [`RAJointsDataMeshColoring.GetAvailableGridFunctions()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctions) + * [`RAJointsDataMeshColoring.GetAvailableGridFunctionsNames()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetAvailableGridFunctionsNames) + * [`RAJointsDataMeshColoring.GetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsColor) + * [`RAJointsDataMeshColoring.GetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityColor) + * [`RAJointsDataMeshColoring.GetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityLineWidth) + * [`RAJointsDataMeshColoring.GetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityProperty) + * [`RAJointsDataMeshColoring.GetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsConnectivityVisible) + * [`RAJointsDataMeshColoring.GetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsPointSize) + * [`RAJointsDataMeshColoring.GetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsProperty) + * [`RAJointsDataMeshColoring.GetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetJointsVisible) + * [`RAJointsDataMeshColoring.GetValidColoringModes()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.GetValidColoringModes) + * [`RAJointsDataMeshColoring.SetJointsColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsColor) + * [`RAJointsDataMeshColoring.SetJointsConnectivityColor()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityColor) + * [`RAJointsDataMeshColoring.SetJointsConnectivityLineWidth()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityLineWidth) + * [`RAJointsDataMeshColoring.SetJointsConnectivityProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityProperty) + * [`RAJointsDataMeshColoring.SetJointsConnectivityVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsConnectivityVisible) + * [`RAJointsDataMeshColoring.SetJointsPointSize()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsPointSize) + * [`RAJointsDataMeshColoring.SetJointsProperty()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsProperty) + * [`RAJointsDataMeshColoring.SetJointsVisible()`](RAJointsDataMeshColoring.md#generated.RAJointsDataMeshColoring.SetJointsVisible) +* [RALinearTimeVariableForce](RALinearTimeVariableForce.md) + * [`RALinearTimeVariableForce`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce) + * [`RALinearTimeVariableForce.GetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetInitialForceValue) + * [`RALinearTimeVariableForce.GetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.GetTimeCoefficients) + * [`RALinearTimeVariableForce.SetInitialForceValue()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetInitialForceValue) + * [`RALinearTimeVariableForce.SetTimeCoefficients()`](RALinearTimeVariableForce.md#generated.RALinearTimeVariableForce.SetTimeCoefficients) +* [RALinearTimeVariableMoment](RALinearTimeVariableMoment.md) + * [`RALinearTimeVariableMoment`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment) + * [`RALinearTimeVariableMoment.GetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetInitialMomentValue) + * [`RALinearTimeVariableMoment.GetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.GetTimeCoefficients) + * [`RALinearTimeVariableMoment.SetInitialMomentValue()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetInitialMomentValue) + * [`RALinearTimeVariableMoment.SetTimeCoefficients()`](RALinearTimeVariableMoment.md#generated.RALinearTimeVariableMoment.SetTimeCoefficients) +* [RAMaterialCollection](RAMaterialCollection.md) + * [`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) + * [`RAMaterialCollection.Remove()`](RAMaterialCollection.md#generated.RAMaterialCollection.Remove) + * [`RAMaterialCollection.SetBulkSolidFraction()`](RAMaterialCollection.md#generated.RAMaterialCollection.SetBulkSolidFraction) +* [RAMaterialsInteraction](RAMaterialsInteraction.md) + * [`RAMaterialsInteraction`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction) + * [`RAMaterialsInteraction.GetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveDistance) + * [`RAMaterialsInteraction.GetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetAdhesiveFraction) + * [`RAMaterialsInteraction.GetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetContactStiffnessMultiplier) + * [`RAMaterialsInteraction.GetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetDynamicFriction) + * [`RAMaterialsInteraction.GetFirstMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetFirstMaterial) + * [`RAMaterialsInteraction.GetModuleProperties()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperties) + * [`RAMaterialsInteraction.GetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetModuleProperty) + * [`RAMaterialsInteraction.GetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetRestitutionCoefficient) + * [`RAMaterialsInteraction.GetSecondMaterial()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSecondMaterial) + * [`RAMaterialsInteraction.GetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetStaticFriction) + * [`RAMaterialsInteraction.GetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetSurfaceEnergy) + * [`RAMaterialsInteraction.GetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetTangentialStiffnessRatio) + * [`RAMaterialsInteraction.GetValidOptionsForModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetValidOptionsForModuleProperty) + * [`RAMaterialsInteraction.GetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityExponent) + * [`RAMaterialsInteraction.GetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.GetVelocityLimit) + * [`RAMaterialsInteraction.SetAdhesiveDistance()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveDistance) + * [`RAMaterialsInteraction.SetAdhesiveFraction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetAdhesiveFraction) + * [`RAMaterialsInteraction.SetContactStiffnessMultiplier()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetContactStiffnessMultiplier) + * [`RAMaterialsInteraction.SetDynamicFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetDynamicFriction) + * [`RAMaterialsInteraction.SetModuleProperty()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetModuleProperty) + * [`RAMaterialsInteraction.SetRestitutionCoefficient()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetRestitutionCoefficient) + * [`RAMaterialsInteraction.SetStaticFriction()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetStaticFriction) + * [`RAMaterialsInteraction.SetSurfaceEnergy()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetSurfaceEnergy) + * [`RAMaterialsInteraction.SetTangentialStiffnessRatio()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetTangentialStiffnessRatio) + * [`RAMaterialsInteraction.SetVelocityExponent()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityExponent) + * [`RAMaterialsInteraction.SetVelocityLimit()`](RAMaterialsInteraction.md#generated.RAMaterialsInteraction.SetVelocityLimit) +* [RAMaterialsInteractionCollection](RAMaterialsInteractionCollection.md) + * [`RAMaterialsInteractionCollection`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection) + * [`RAMaterialsInteractionCollection.Clear()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Clear) + * [`RAMaterialsInteractionCollection.GetMaterialsInteraction()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.GetMaterialsInteraction) + * [`RAMaterialsInteractionCollection.New()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.New) + * [`RAMaterialsInteractionCollection.Remove()`](RAMaterialsInteractionCollection.md#generated.RAMaterialsInteractionCollection.Remove) +* [RAMeshColoring](RAMeshColoring.md) + * [`RAMeshColoring`](RAMeshColoring.md#generated.RAMeshColoring) + * [`RAMeshColoring.GetAvailableGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctions) + * [`RAMeshColoring.GetAvailableGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableGridFunctionsNames) + * [`RAMeshColoring.GetAvailableVectorGridFunctions()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctions) + * [`RAMeshColoring.GetAvailableVectorGridFunctionsNames()`](RAMeshColoring.md#generated.RAMeshColoring.GetAvailableVectorGridFunctionsNames) + * [`RAMeshColoring.GetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeColor) + * [`RAMeshColoring.GetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeGridFunction) + * [`RAMeshColoring.GetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeLineWidth) + * [`RAMeshColoring.GetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetEdgeVisible) + * [`RAMeshColoring.GetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceColor) + * [`RAMeshColoring.GetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceCustomStructuredPartitions) + * [`RAMeshColoring.GetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceGridFunction) + * [`RAMeshColoring.GetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceScope) + * [`RAMeshColoring.GetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceShowOnNode) + * [`RAMeshColoring.GetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceStructuredPartitions) + * [`RAMeshColoring.GetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetFaceVisible) + * [`RAMeshColoring.GetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.GetLevelOfDetail) + * [`RAMeshColoring.GetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeColor) + * [`RAMeshColoring.GetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeGridFunction) + * [`RAMeshColoring.GetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodePointSize) + * [`RAMeshColoring.GetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetNodeVisible) + * [`RAMeshColoring.GetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetNormalizedVectorsEnabled) + * [`RAMeshColoring.GetStride()`](RAMeshColoring.md#generated.RAMeshColoring.GetStride) + * [`RAMeshColoring.GetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparency) + * [`RAMeshColoring.GetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.GetTransparencyEnabled) + * [`RAMeshColoring.GetValidColoringModes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidColoringModes) + * [`RAMeshColoring.GetValidFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceCustomStructuredPartitions) + * [`RAMeshColoring.GetValidFaceScopes()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceScopes) + * [`RAMeshColoring.GetValidFaceStructuredPartitionsValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidFaceStructuredPartitionsValues) + * [`RAMeshColoring.GetValidLevelOfDetailValues()`](RAMeshColoring.md#generated.RAMeshColoring.GetValidLevelOfDetailValues) + * [`RAMeshColoring.GetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorGridFunction) + * [`RAMeshColoring.GetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorScale) + * [`RAMeshColoring.GetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVectorVisible) + * [`RAMeshColoring.GetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.GetVisible) + * [`RAMeshColoring.SetEdgeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeColor) + * [`RAMeshColoring.SetEdgeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeGridFunction) + * [`RAMeshColoring.SetEdgeLineWidth()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeLineWidth) + * [`RAMeshColoring.SetEdgeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetEdgeVisible) + * [`RAMeshColoring.SetFaceColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceColor) + * [`RAMeshColoring.SetFaceCustomStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceCustomStructuredPartitions) + * [`RAMeshColoring.SetFaceGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceGridFunction) + * [`RAMeshColoring.SetFaceScope()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceScope) + * [`RAMeshColoring.SetFaceShowOnNode()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceShowOnNode) + * [`RAMeshColoring.SetFaceStructuredPartitions()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceStructuredPartitions) + * [`RAMeshColoring.SetFaceVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetFaceVisible) + * [`RAMeshColoring.SetLevelOfDetail()`](RAMeshColoring.md#generated.RAMeshColoring.SetLevelOfDetail) + * [`RAMeshColoring.SetNodeColor()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeColor) + * [`RAMeshColoring.SetNodeGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeGridFunction) + * [`RAMeshColoring.SetNodePointSize()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodePointSize) + * [`RAMeshColoring.SetNodeVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetNodeVisible) + * [`RAMeshColoring.SetNormalizedVectorsEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetNormalizedVectorsEnabled) + * [`RAMeshColoring.SetStride()`](RAMeshColoring.md#generated.RAMeshColoring.SetStride) + * [`RAMeshColoring.SetTransparency()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparency) + * [`RAMeshColoring.SetTransparencyEnabled()`](RAMeshColoring.md#generated.RAMeshColoring.SetTransparencyEnabled) + * [`RAMeshColoring.SetVectorGridFunction()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorGridFunction) + * [`RAMeshColoring.SetVectorScale()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorScale) + * [`RAMeshColoring.SetVectorVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVectorVisible) + * [`RAMeshColoring.SetVisible()`](RAMeshColoring.md#generated.RAMeshColoring.SetVisible) +* [RAModule](RAModule.md) + * [`RAModule`](RAModule.md#generated.RAModule) + * [`RAModule.DisableModule()`](RAModule.md#generated.RAModule.DisableModule) + * [`RAModule.EnableModule()`](RAModule.md#generated.RAModule.EnableModule) + * [`RAModule.GetModuleProperties()`](RAModule.md#generated.RAModule.GetModuleProperties) + * [`RAModule.GetModuleProperty()`](RAModule.md#generated.RAModule.GetModuleProperty) + * [`RAModule.GetOutputObject()`](RAModule.md#generated.RAModule.GetOutputObject) + * [`RAModule.GetValidOptionsForModuleProperty()`](RAModule.md#generated.RAModule.GetValidOptionsForModuleProperty) + * [`RAModule.IsModuleEnabled()`](RAModule.md#generated.RAModule.IsModuleEnabled) + * [`RAModule.SetModuleEnabled()`](RAModule.md#generated.RAModule.SetModuleEnabled) + * [`RAModule.SetModuleProperty()`](RAModule.md#generated.RAModule.SetModuleProperty) +* [RAModuleCollection](RAModuleCollection.md) + * [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) + * [`RAModuleCollection.GetEnabledModules()`](RAModuleCollection.md#generated.RAModuleCollection.GetEnabledModules) + * [`RAModuleCollection.GetModule()`](RAModuleCollection.md#generated.RAModuleCollection.GetModule) + * [`RAModuleCollection.GetModuleNames()`](RAModuleCollection.md#generated.RAModuleCollection.GetModuleNames) +* [RAModuleOutput](RAModuleOutput.md) + * [`RAModuleOutput`](RAModuleOutput.md#generated.RAModuleOutput) + * [`RAModuleOutput.AddCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCurve) + * [`RAModuleOutput.AddCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomCurve) + * [`RAModuleOutput.AddCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.AddCustomProperty) + * [`RAModuleOutput.AddGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.AddGridFunction) + * [`RAModuleOutput.CreateCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateCurveOutputVariable) + * [`RAModuleOutput.CreateGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunction) + * [`RAModuleOutput.CreateGridFunctionArrayOnCells()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionArrayOnCells) + * [`RAModuleOutput.CreateGridFunctionStatisticOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateGridFunctionStatisticOutputVariable) + * [`RAModuleOutput.CreateTransientCurveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.CreateTransientCurveOutputVariable) + * [`RAModuleOutput.EditCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomCurve) + * [`RAModuleOutput.EditCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.EditCustomProperty) + * [`RAModuleOutput.GetActivesArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetActivesArray) + * [`RAModuleOutput.GetBoundingBox()`](RAModuleOutput.md#generated.RAModuleOutput.GetBoundingBox) + * [`RAModuleOutput.GetCellAreaAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellAreaAsArray) + * [`RAModuleOutput.GetCellCenterAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellCenterAsArray) + * [`RAModuleOutput.GetCellDzAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellDzAsArray) + * [`RAModuleOutput.GetCellFromIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellFromIJK) + * [`RAModuleOutput.GetCellIJK()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellIJK) + * [`RAModuleOutput.GetCellNumberOfVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellNumberOfVertices) + * [`RAModuleOutput.GetCellPointsAsFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellPointsAsFunction) + * [`RAModuleOutput.GetCellVolumeAsArray()`](RAModuleOutput.md#generated.RAModuleOutput.GetCellVolumeAsArray) + * [`RAModuleOutput.GetCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurve) + * [`RAModuleOutput.GetCurveNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNames) + * [`RAModuleOutput.GetCurveNamesAssociation()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNamesAssociation) + * [`RAModuleOutput.GetElementCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetElementCurve) + * [`RAModuleOutput.GetGeometryQuantity()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryQuantity) + * [`RAModuleOutput.GetGeometryUnit()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryUnit) + * [`RAModuleOutput.GetGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunction) + * [`RAModuleOutput.GetGridFunctionNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunctionNames) + * [`RAModuleOutput.GetMeshColoring()`](RAModuleOutput.md#generated.RAModuleOutput.GetMeshColoring) + * [`RAModuleOutput.GetNumberOfCells()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfCells) + * [`RAModuleOutput.GetNumberOfNodes()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumberOfNodes) + * [`RAModuleOutput.GetNumpyCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetNumpyCurve) + * [`RAModuleOutput.GetOutputVariableValue()`](RAModuleOutput.md#generated.RAModuleOutput.GetOutputVariableValue) + * [`RAModuleOutput.GetTimeSet()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeSet) + * [`RAModuleOutput.GetTimeStatistics()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStatistics) + * [`RAModuleOutput.GetTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStep) + * [`RAModuleOutput.GetTopologyShape()`](RAModuleOutput.md#generated.RAModuleOutput.GetTopologyShape) + * [`RAModuleOutput.HasGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.HasGridFunction) + * [`RAModuleOutput.IsCellActive()`](RAModuleOutput.md#generated.RAModuleOutput.IsCellActive) + * [`RAModuleOutput.IterCellVertices()`](RAModuleOutput.md#generated.RAModuleOutput.IterCellVertices) + * [`RAModuleOutput.IterCells()`](RAModuleOutput.md#generated.RAModuleOutput.IterCells) + * [`RAModuleOutput.Modified()`](RAModuleOutput.md#generated.RAModuleOutput.Modified) + * [`RAModuleOutput.RemoveCustomCurve()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomCurve) + * [`RAModuleOutput.RemoveCustomProperty()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveCustomProperty) + * [`RAModuleOutput.RemoveOutputVariable()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveOutputVariable) + * [`RAModuleOutput.RemoveProcess()`](RAModuleOutput.md#generated.RAModuleOutput.RemoveProcess) + * [`RAModuleOutput.SetCurrentTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.SetCurrentTimeStep) +* [RAModulePropertyList](RAModulePropertyList.md) + * [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList) + * [`RAModulePropertyList.Clear()`](RAModulePropertyList.md#generated.RAModulePropertyList.Clear) + * [`RAModulePropertyList.New()`](RAModulePropertyList.md#generated.RAModulePropertyList.New) + * [`RAModulePropertyList.Remove()`](RAModulePropertyList.md#generated.RAModulePropertyList.Remove) +* [RAModulePropertyListItem](RAModulePropertyListItem.md) + * [`RAModulePropertyListItem`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem) + * [`RAModulePropertyListItem.GetModuleProperties()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperties) + * [`RAModulePropertyListItem.GetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetModuleProperty) + * [`RAModulePropertyListItem.GetValidOptionsForModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.GetValidOptionsForModuleProperty) + * [`RAModulePropertyListItem.SetModuleProperty()`](RAModulePropertyListItem.md#generated.RAModulePropertyListItem.SetModuleProperty) +* [RAMotion](RAMotion.md) + * [`RAMotion`](RAMotion.md#generated.RAMotion) + * [`RAMotion.GetStartTime()`](RAMotion.md#generated.RAMotion.GetStartTime) + * [`RAMotion.GetStopTime()`](RAMotion.md#generated.RAMotion.GetStopTime) + * [`RAMotion.GetType()`](RAMotion.md#generated.RAMotion.GetType) + * [`RAMotion.GetTypeObject()`](RAMotion.md#generated.RAMotion.GetTypeObject) + * [`RAMotion.GetValidTypes()`](RAMotion.md#generated.RAMotion.GetValidTypes) + * [`RAMotion.SetStartTime()`](RAMotion.md#generated.RAMotion.SetStartTime) + * [`RAMotion.SetStopTime()`](RAMotion.md#generated.RAMotion.SetStopTime) + * [`RAMotion.SetType()`](RAMotion.md#generated.RAMotion.SetType) +* [RAMotionFrame](RAMotionFrame.md) + * [`RAMotionFrame`](RAMotionFrame.md#generated.RAMotionFrame) + * [`RAMotionFrame.AddCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCurve) + * [`RAMotionFrame.AddCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomCurve) + * [`RAMotionFrame.AddCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomProperty) + * [`RAMotionFrame.AddGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.AddGridFunction) + * [`RAMotionFrame.AddPendulumMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddPendulumMotion) + * [`RAMotionFrame.AddRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddRotationMotion) + * [`RAMotionFrame.AddTranslationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddTranslationMotion) + * [`RAMotionFrame.AddVibrationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddVibrationMotion) + * [`RAMotionFrame.ApplyTo()`](RAMotionFrame.md#generated.RAMotionFrame.ApplyTo) + * [`RAMotionFrame.CreateCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateCurveOutputVariable) + * [`RAMotionFrame.CreateGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunction) + * [`RAMotionFrame.CreateGridFunctionArrayOnCells()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionArrayOnCells) + * [`RAMotionFrame.CreateGridFunctionStatisticOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateGridFunctionStatisticOutputVariable) + * [`RAMotionFrame.CreateTransientCurveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.CreateTransientCurveOutputVariable) + * [`RAMotionFrame.EditCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomCurve) + * [`RAMotionFrame.EditCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.EditCustomProperty) + * [`RAMotionFrame.GetActivesArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetActivesArray) + * [`RAMotionFrame.GetBoundingBox()`](RAMotionFrame.md#generated.RAMotionFrame.GetBoundingBox) + * [`RAMotionFrame.GetCellAreaAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellAreaAsArray) + * [`RAMotionFrame.GetCellCenterAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellCenterAsArray) + * [`RAMotionFrame.GetCellDzAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellDzAsArray) + * [`RAMotionFrame.GetCellFromIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellFromIJK) + * [`RAMotionFrame.GetCellIJK()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellIJK) + * [`RAMotionFrame.GetCellNumberOfVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellNumberOfVertices) + * [`RAMotionFrame.GetCellPointsAsFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellPointsAsFunction) + * [`RAMotionFrame.GetCellVolumeAsArray()`](RAMotionFrame.md#generated.RAMotionFrame.GetCellVolumeAsArray) + * [`RAMotionFrame.GetCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurve) + * [`RAMotionFrame.GetCurveNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNames) + * [`RAMotionFrame.GetCurveNamesAssociation()`](RAMotionFrame.md#generated.RAMotionFrame.GetCurveNamesAssociation) + * [`RAMotionFrame.GetElementCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetElementCurve) + * [`RAMotionFrame.GetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmAngularLimits) + * [`RAMotionFrame.GetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmLinearLimits) + * [`RAMotionFrame.GetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnablePeriodicMotion) + * [`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.GetGeometryUnit()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryUnit) + * [`RAMotionFrame.GetGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunction) + * [`RAMotionFrame.GetGridFunctionNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunctionNames) + * [`RAMotionFrame.GetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.GetKeepInPlace) + * [`RAMotionFrame.GetMeshColoring()`](RAMotionFrame.md#generated.RAMotionFrame.GetMeshColoring) + * [`RAMotionFrame.GetMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotionFrame) + * [`RAMotionFrame.GetMotions()`](RAMotionFrame.md#generated.RAMotionFrame.GetMotions) + * [`RAMotionFrame.GetNumberOfCells()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfCells) + * [`RAMotionFrame.GetNumberOfNodes()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumberOfNodes) + * [`RAMotionFrame.GetNumpyCurve()`](RAMotionFrame.md#generated.RAMotionFrame.GetNumpyCurve) + * [`RAMotionFrame.GetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientation) + * [`RAMotionFrame.GetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngleAndVector) + * [`RAMotionFrame.GetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromAngles) + * [`RAMotionFrame.GetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetOrientationFromBasisVector) + * [`RAMotionFrame.GetOutputVariableValue()`](RAMotionFrame.md#generated.RAMotionFrame.GetOutputVariableValue) + * [`RAMotionFrame.GetParentMotionFrame()`](RAMotionFrame.md#generated.RAMotionFrame.GetParentMotionFrame) + * [`RAMotionFrame.GetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionPeriod) + * [`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.HasGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.HasGridFunction) + * [`RAMotionFrame.IsCellActive()`](RAMotionFrame.md#generated.RAMotionFrame.IsCellActive) + * [`RAMotionFrame.IterCellVertices()`](RAMotionFrame.md#generated.RAMotionFrame.IterCellVertices) + * [`RAMotionFrame.IterCells()`](RAMotionFrame.md#generated.RAMotionFrame.IterCells) + * [`RAMotionFrame.IterMotionFrames()`](RAMotionFrame.md#generated.RAMotionFrame.IterMotionFrames) + * [`RAMotionFrame.Modified()`](RAMotionFrame.md#generated.RAMotionFrame.Modified) + * [`RAMotionFrame.NewConeCrusherFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewConeCrusherFrame) + * [`RAMotionFrame.NewFrame()`](RAMotionFrame.md#generated.RAMotionFrame.NewFrame) + * [`RAMotionFrame.RemoveCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomCurve) + * [`RAMotionFrame.RemoveCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveCustomProperty) + * [`RAMotionFrame.RemoveFrame()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveFrame) + * [`RAMotionFrame.RemoveOutputVariable()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveOutputVariable) + * [`RAMotionFrame.RemoveProcess()`](RAMotionFrame.md#generated.RAMotionFrame.RemoveProcess) + * [`RAMotionFrame.SetCurrentTimeStep()`](RAMotionFrame.md#generated.RAMotionFrame.SetCurrentTimeStep) + * [`RAMotionFrame.SetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmAngularLimits) + * [`RAMotionFrame.SetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnableFbmLinearLimits) + * [`RAMotionFrame.SetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.SetEnablePeriodicMotion) + * [`RAMotionFrame.SetFbmMaxAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxAngularLimits) + * [`RAMotionFrame.SetFbmMaxLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMaxLinearLimits) + * [`RAMotionFrame.SetFbmMinAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinAngularLimits) + * [`RAMotionFrame.SetFbmMinLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.SetFbmMinLinearLimits) + * [`RAMotionFrame.SetKeepInPlace()`](RAMotionFrame.md#generated.RAMotionFrame.SetKeepInPlace) + * [`RAMotionFrame.SetOrientation()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientation) + * [`RAMotionFrame.SetOrientationFromAngleAndVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngleAndVector) + * [`RAMotionFrame.SetOrientationFromAngles()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromAngles) + * [`RAMotionFrame.SetOrientationFromBasisVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetOrientationFromBasisVector) + * [`RAMotionFrame.SetPeriodicMotionPeriod()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionPeriod) + * [`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) + * [`RAMotionFrameSource.GetParentMotionFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.GetParentMotionFrame) + * [`RAMotionFrameSource.IterMotionFrames()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.IterMotionFrames) + * [`RAMotionFrameSource.NewConeCrusherFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewConeCrusherFrame) + * [`RAMotionFrameSource.NewFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.NewFrame) + * [`RAMotionFrameSource.RemoveFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.RemoveFrame) +* [RAMotionList](RAMotionList.md) + * [`RAMotionList`](RAMotionList.md#generated.RAMotionList) + * [`RAMotionList.Clear()`](RAMotionList.md#generated.RAMotionList.Clear) + * [`RAMotionList.New()`](RAMotionList.md#generated.RAMotionList.New) + * [`RAMotionList.Remove()`](RAMotionList.md#generated.RAMotionList.Remove) +* [RAOneRollBeltProfile](RAOneRollBeltProfile.md) + * [`RAOneRollBeltProfile`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile) + * [`RAOneRollBeltProfile.GetAvailableMaterials()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetAvailableMaterials) + * [`RAOneRollBeltProfile.GetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.GetMaterial) + * [`RAOneRollBeltProfile.SetMaterial()`](RAOneRollBeltProfile.md#generated.RAOneRollBeltProfile.SetMaterial) +* [RAOutlet](RAOutlet.md) + * [`RAOutlet`](RAOutlet.md#generated.RAOutlet) + * [`RAOutlet.DisablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.DisablePrescribedPressure) + * [`RAOutlet.EnablePrescribedPressure()`](RAOutlet.md#generated.RAOutlet.EnablePrescribedPressure) + * [`RAOutlet.GetAvailableExitPoints()`](RAOutlet.md#generated.RAOutlet.GetAvailableExitPoints) + * [`RAOutlet.GetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.GetEnabledForParticles) + * [`RAOutlet.GetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.GetEnabledForSph) + * [`RAOutlet.GetExitPoint()`](RAOutlet.md#generated.RAOutlet.GetExitPoint) + * [`RAOutlet.GetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.GetPrescribedPressureEnabled) + * [`RAOutlet.GetPressure()`](RAOutlet.md#generated.RAOutlet.GetPressure) + * [`RAOutlet.IsPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.IsPrescribedPressureEnabled) + * [`RAOutlet.SetEnabledForParticles()`](RAOutlet.md#generated.RAOutlet.SetEnabledForParticles) + * [`RAOutlet.SetEnabledForSph()`](RAOutlet.md#generated.RAOutlet.SetEnabledForSph) + * [`RAOutlet.SetExitPoint()`](RAOutlet.md#generated.RAOutlet.SetExitPoint) + * [`RAOutlet.SetPrescribedPressureEnabled()`](RAOutlet.md#generated.RAOutlet.SetPrescribedPressureEnabled) + * [`RAOutlet.SetPressure()`](RAOutlet.md#generated.RAOutlet.SetPressure) +* [RAParametricVar](RAParametricVar.md) + * [`RAParametricVar`](RAParametricVar.md#generated.RAParametricVar) + * [`RAParametricVar.GetValue()`](RAParametricVar.md#generated.RAParametricVar.GetValue) + * [`RAParametricVar.SetValue()`](RAParametricVar.md#generated.RAParametricVar.SetValue) +* [RAParametricVariables](RAParametricVariables.md) + * [`RAParametricVariables`](RAParametricVariables.md#generated.RAParametricVariables) + * [`RAParametricVariables.GetInputVariables()`](RAParametricVariables.md#generated.RAParametricVariables.GetInputVariables) +* [RAParticle](RAParticle.md) + * [`RAParticle`](RAParticle.md#generated.RAParticle) + * [`RAParticle.AddCurve()`](RAParticle.md#generated.RAParticle.AddCurve) + * [`RAParticle.AddCustomCurve()`](RAParticle.md#generated.RAParticle.AddCustomCurve) + * [`RAParticle.AddCustomProperty()`](RAParticle.md#generated.RAParticle.AddCustomProperty) + * [`RAParticle.AddGridFunction()`](RAParticle.md#generated.RAParticle.AddGridFunction) + * [`RAParticle.CreateCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateCurveOutputVariable) + * [`RAParticle.CreateGridFunction()`](RAParticle.md#generated.RAParticle.CreateGridFunction) + * [`RAParticle.CreateGridFunctionArrayOnCells()`](RAParticle.md#generated.RAParticle.CreateGridFunctionArrayOnCells) + * [`RAParticle.CreateGridFunctionStatisticOutputVariable()`](RAParticle.md#generated.RAParticle.CreateGridFunctionStatisticOutputVariable) + * [`RAParticle.CreateTransientCurveOutputVariable()`](RAParticle.md#generated.RAParticle.CreateTransientCurveOutputVariable) + * [`RAParticle.DisableBreakage()`](RAParticle.md#generated.RAParticle.DisableBreakage) + * [`RAParticle.DisableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.DisableIncludeRotationalDeformations) + * [`RAParticle.DisableRandomOrientation()`](RAParticle.md#generated.RAParticle.DisableRandomOrientation) + * [`RAParticle.EditCustomCurve()`](RAParticle.md#generated.RAParticle.EditCustomCurve) + * [`RAParticle.EditCustomProperty()`](RAParticle.md#generated.RAParticle.EditCustomProperty) + * [`RAParticle.EnableBreakage()`](RAParticle.md#generated.RAParticle.EnableBreakage) + * [`RAParticle.EnableIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.EnableIncludeRotationalDeformations) + * [`RAParticle.EnableRandomOrientation()`](RAParticle.md#generated.RAParticle.EnableRandomOrientation) + * [`RAParticle.GetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.GetAbt10MaximumT10Value) + * [`RAParticle.GetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10MinimumSpecificEnergy) + * [`RAParticle.GetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceMinimumSpecificEnergy) + * [`RAParticle.GetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.GetAbt10ReferenceSize) + * [`RAParticle.GetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.GetAbt10SelectFunctionCoefficient) + * [`RAParticle.GetActivesArray()`](RAParticle.md#generated.RAParticle.GetActivesArray) + * [`RAParticle.GetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) + * [`RAParticle.GetAnisotropic()`](RAParticle.md#generated.RAParticle.GetAnisotropic) + * [`RAParticle.GetAvailableMaterials()`](RAParticle.md#generated.RAParticle.GetAvailableMaterials) + * [`RAParticle.GetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetBendingAngleLimit) + * [`RAParticle.GetBoundingBox()`](RAParticle.md#generated.RAParticle.GetBoundingBox) + * [`RAParticle.GetBreakageModel()`](RAParticle.md#generated.RAParticle.GetBreakageModel) + * [`RAParticle.GetCellAreaAsArray()`](RAParticle.md#generated.RAParticle.GetCellAreaAsArray) + * [`RAParticle.GetCellCenterAsArray()`](RAParticle.md#generated.RAParticle.GetCellCenterAsArray) + * [`RAParticle.GetCellDzAsArray()`](RAParticle.md#generated.RAParticle.GetCellDzAsArray) + * [`RAParticle.GetCellFromIJK()`](RAParticle.md#generated.RAParticle.GetCellFromIJK) + * [`RAParticle.GetCellIJK()`](RAParticle.md#generated.RAParticle.GetCellIJK) + * [`RAParticle.GetCellNumberOfVertices()`](RAParticle.md#generated.RAParticle.GetCellNumberOfVertices) + * [`RAParticle.GetCellPointsAsFunction()`](RAParticle.md#generated.RAParticle.GetCellPointsAsFunction) + * [`RAParticle.GetCellVolumeAsArray()`](RAParticle.md#generated.RAParticle.GetCellVolumeAsArray) + * [`RAParticle.GetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.GetCenterOfMassOffset) + * [`RAParticle.GetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.GetCgmScaleFactor) + * [`RAParticle.GetChangeMassProperties()`](RAParticle.md#generated.RAParticle.GetChangeMassProperties) + * [`RAParticle.GetCurve()`](RAParticle.md#generated.RAParticle.GetCurve) + * [`RAParticle.GetCurveNames()`](RAParticle.md#generated.RAParticle.GetCurveNames) + * [`RAParticle.GetCurveNamesAssociation()`](RAParticle.md#generated.RAParticle.GetCurveNamesAssociation) + * [`RAParticle.GetDeformationModel()`](RAParticle.md#generated.RAParticle.GetDeformationModel) + * [`RAParticle.GetDistributionModel()`](RAParticle.md#generated.RAParticle.GetDistributionModel) + * [`RAParticle.GetEdgeAngle()`](RAParticle.md#generated.RAParticle.GetEdgeAngle) + * [`RAParticle.GetElasticRatioBending()`](RAParticle.md#generated.RAParticle.GetElasticRatioBending) + * [`RAParticle.GetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.GetElasticRatioNormal) + * [`RAParticle.GetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.GetElasticRatioTangential) + * [`RAParticle.GetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.GetElasticRatioTorsion) + * [`RAParticle.GetElasticity()`](RAParticle.md#generated.RAParticle.GetElasticity) + * [`RAParticle.GetElementCurve()`](RAParticle.md#generated.RAParticle.GetElementCurve) + * [`RAParticle.GetElementDampingRatio()`](RAParticle.md#generated.RAParticle.GetElementDampingRatio) + * [`RAParticle.GetEnableBreakage()`](RAParticle.md#generated.RAParticle.GetEnableBreakage) + * [`RAParticle.GetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.GetEnableRandomAngle) + * [`RAParticle.GetEnableRotations()`](RAParticle.md#generated.RAParticle.GetEnableRotations) + * [`RAParticle.GetFailureRatio()`](RAParticle.md#generated.RAParticle.GetFailureRatio) + * [`RAParticle.GetFlexible()`](RAParticle.md#generated.RAParticle.GetFlexible) + * [`RAParticle.GetGeometryQuantity()`](RAParticle.md#generated.RAParticle.GetGeometryQuantity) + * [`RAParticle.GetGeometryUnit()`](RAParticle.md#generated.RAParticle.GetGeometryUnit) + * [`RAParticle.GetGridFunction()`](RAParticle.md#generated.RAParticle.GetGridFunction) + * [`RAParticle.GetGridFunctionNames()`](RAParticle.md#generated.RAParticle.GetGridFunctionNames) + * [`RAParticle.GetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.GetHorizontalAspectRatio) + * [`RAParticle.GetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.GetIncludeRotationalDeformations) + * [`RAParticle.GetInternalFriction()`](RAParticle.md#generated.RAParticle.GetInternalFriction) + * [`RAParticle.GetJointDampingRatio()`](RAParticle.md#generated.RAParticle.GetJointDampingRatio) + * [`RAParticle.GetJointElasticRatio()`](RAParticle.md#generated.RAParticle.GetJointElasticRatio) + * [`RAParticle.GetJointThermalRatio()`](RAParticle.md#generated.RAParticle.GetJointThermalRatio) + * [`RAParticle.GetMaterial()`](RAParticle.md#generated.RAParticle.GetMaterial) + * [`RAParticle.GetMeshColoring()`](RAParticle.md#generated.RAParticle.GetMeshColoring) + * [`RAParticle.GetMinimumSize()`](RAParticle.md#generated.RAParticle.GetMinimumSize) + * [`RAParticle.GetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.GetMinimumSizeRatio) + * [`RAParticle.GetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.GetMinimumVolumeFractionForFragmentDisabling) + * [`RAParticle.GetModuleProperties()`](RAParticle.md#generated.RAParticle.GetModuleProperties) + * [`RAParticle.GetModuleProperty()`](RAParticle.md#generated.RAParticle.GetModuleProperty) + * [`RAParticle.GetNumberOfCells()`](RAParticle.md#generated.RAParticle.GetNumberOfCells) + * [`RAParticle.GetNumberOfCorners()`](RAParticle.md#generated.RAParticle.GetNumberOfCorners) + * [`RAParticle.GetNumberOfNodes()`](RAParticle.md#generated.RAParticle.GetNumberOfNodes) + * [`RAParticle.GetNumpyCurve()`](RAParticle.md#generated.RAParticle.GetNumpyCurve) + * [`RAParticle.GetOrientation()`](RAParticle.md#generated.RAParticle.GetOrientation) + * [`RAParticle.GetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngleAndVector) + * [`RAParticle.GetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.GetOrientationFromAngles) + * [`RAParticle.GetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.GetOrientationFromBasisVector) + * [`RAParticle.GetOutputVariableValue()`](RAParticle.md#generated.RAParticle.GetOutputVariableValue) + * [`RAParticle.GetPlasticLimit()`](RAParticle.md#generated.RAParticle.GetPlasticLimit) + * [`RAParticle.GetPlasticRatio()`](RAParticle.md#generated.RAParticle.GetPlasticRatio) + * [`RAParticle.GetPlasticityModel()`](RAParticle.md#generated.RAParticle.GetPlasticityModel) + * [`RAParticle.GetPorosity()`](RAParticle.md#generated.RAParticle.GetPorosity) + * [`RAParticle.GetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.GetPrincipalMomentOfInertia) + * [`RAParticle.GetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.GetRandomAnglesHalfRange) + * [`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) + * [`RAParticle.GetSideAngle()`](RAParticle.md#generated.RAParticle.GetSideAngle) + * [`RAParticle.GetSizeDistributionList()`](RAParticle.md#generated.RAParticle.GetSizeDistributionList) + * [`RAParticle.GetSizeType()`](RAParticle.md#generated.RAParticle.GetSizeType) + * [`RAParticle.GetSmoothness()`](RAParticle.md#generated.RAParticle.GetSmoothness) + * [`RAParticle.GetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.GetSuperquadricDegree) + * [`RAParticle.GetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.GetSurfaceEnergy) + * [`RAParticle.GetT10Formula()`](RAParticle.md#generated.RAParticle.GetT10Formula) + * [`RAParticle.GetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.GetTargetNumberOfElements) + * [`RAParticle.GetTavaresA()`](RAParticle.md#generated.RAParticle.GetTavaresA) + * [`RAParticle.GetTavaresB()`](RAParticle.md#generated.RAParticle.GetTavaresB) + * [`RAParticle.GetTavaresD0()`](RAParticle.md#generated.RAParticle.GetTavaresD0) + * [`RAParticle.GetTavaresEInf()`](RAParticle.md#generated.RAParticle.GetTavaresEInf) + * [`RAParticle.GetTavaresGamma()`](RAParticle.md#generated.RAParticle.GetTavaresGamma) + * [`RAParticle.GetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.GetTavaresMinimumEnergy) + * [`RAParticle.GetTavaresPhi()`](RAParticle.md#generated.RAParticle.GetTavaresPhi) + * [`RAParticle.GetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.GetTavaresRatioEmax) + * [`RAParticle.GetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.GetTavaresSigmaSquared) + * [`RAParticle.GetTensileStressLimit()`](RAParticle.md#generated.RAParticle.GetTensileStressLimit) + * [`RAParticle.GetThickness()`](RAParticle.md#generated.RAParticle.GetThickness) + * [`RAParticle.GetTimeSet()`](RAParticle.md#generated.RAParticle.GetTimeSet) + * [`RAParticle.GetTimeStatistics()`](RAParticle.md#generated.RAParticle.GetTimeStatistics) + * [`RAParticle.GetTimeStep()`](RAParticle.md#generated.RAParticle.GetTimeStep) + * [`RAParticle.GetTopologyShape()`](RAParticle.md#generated.RAParticle.GetTopologyShape) + * [`RAParticle.GetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.GetTorsionAngleLimit) + * [`RAParticle.GetUseMultipleElements()`](RAParticle.md#generated.RAParticle.GetUseMultipleElements) + * [`RAParticle.GetValidBreakageModelValues()`](RAParticle.md#generated.RAParticle.GetValidBreakageModelValues) + * [`RAParticle.GetValidDeformationModelValues()`](RAParticle.md#generated.RAParticle.GetValidDeformationModelValues) + * [`RAParticle.GetValidDistributionModelValues()`](RAParticle.md#generated.RAParticle.GetValidDistributionModelValues) + * [`RAParticle.GetValidElasticityValues()`](RAParticle.md#generated.RAParticle.GetValidElasticityValues) + * [`RAParticle.GetValidOptionsForModuleProperty()`](RAParticle.md#generated.RAParticle.GetValidOptionsForModuleProperty) + * [`RAParticle.GetValidPlasticityModelValues()`](RAParticle.md#generated.RAParticle.GetValidPlasticityModelValues) + * [`RAParticle.GetValidShapeValues()`](RAParticle.md#generated.RAParticle.GetValidShapeValues) + * [`RAParticle.GetValidSizeTypeValues()`](RAParticle.md#generated.RAParticle.GetValidSizeTypeValues) + * [`RAParticle.GetValidT10FormulaValues()`](RAParticle.md#generated.RAParticle.GetValidT10FormulaValues) + * [`RAParticle.GetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.GetVerticalAspectRatio) + * [`RAParticle.GetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.GetVonMisesStressLimit) + * [`RAParticle.GetWithFailure()`](RAParticle.md#generated.RAParticle.GetWithFailure) + * [`RAParticle.GetXDirection()`](RAParticle.md#generated.RAParticle.GetXDirection) + * [`RAParticle.GetYDirection()`](RAParticle.md#generated.RAParticle.GetYDirection) + * [`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) + * [`RAParticle.IsConcave()`](RAParticle.md#generated.RAParticle.IsConcave) + * [`RAParticle.IsIncludeRotationalDeformationsEnabled()`](RAParticle.md#generated.RAParticle.IsIncludeRotationalDeformationsEnabled) + * [`RAParticle.IsRandomOrientationEnabled()`](RAParticle.md#generated.RAParticle.IsRandomOrientationEnabled) + * [`RAParticle.IterCellVertices()`](RAParticle.md#generated.RAParticle.IterCellVertices) + * [`RAParticle.IterCells()`](RAParticle.md#generated.RAParticle.IterCells) + * [`RAParticle.Modified()`](RAParticle.md#generated.RAParticle.Modified) + * [`RAParticle.RemoveCustomCurve()`](RAParticle.md#generated.RAParticle.RemoveCustomCurve) + * [`RAParticle.RemoveCustomProperty()`](RAParticle.md#generated.RAParticle.RemoveCustomProperty) + * [`RAParticle.RemoveOutputVariable()`](RAParticle.md#generated.RAParticle.RemoveOutputVariable) + * [`RAParticle.RemoveProcess()`](RAParticle.md#generated.RAParticle.RemoveProcess) + * [`RAParticle.SetAbt10MaximumT10Value()`](RAParticle.md#generated.RAParticle.SetAbt10MaximumT10Value) + * [`RAParticle.SetAbt10MinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10MinimumSpecificEnergy) + * [`RAParticle.SetAbt10ReferenceMinimumSpecificEnergy()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceMinimumSpecificEnergy) + * [`RAParticle.SetAbt10ReferenceSize()`](RAParticle.md#generated.RAParticle.SetAbt10ReferenceSize) + * [`RAParticle.SetAbt10SelectFunctionCoefficient()`](RAParticle.md#generated.RAParticle.SetAbt10SelectFunctionCoefficient) + * [`RAParticle.SetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.SetAllowSelfContacts) + * [`RAParticle.SetAnisotropic()`](RAParticle.md#generated.RAParticle.SetAnisotropic) + * [`RAParticle.SetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.SetBendingAngleLimit) + * [`RAParticle.SetBreakageModel()`](RAParticle.md#generated.RAParticle.SetBreakageModel) + * [`RAParticle.SetCenterOfMassOffset()`](RAParticle.md#generated.RAParticle.SetCenterOfMassOffset) + * [`RAParticle.SetCgmScaleFactor()`](RAParticle.md#generated.RAParticle.SetCgmScaleFactor) + * [`RAParticle.SetChangeMassProperties()`](RAParticle.md#generated.RAParticle.SetChangeMassProperties) + * [`RAParticle.SetCurrentTimeStep()`](RAParticle.md#generated.RAParticle.SetCurrentTimeStep) + * [`RAParticle.SetDeformationModel()`](RAParticle.md#generated.RAParticle.SetDeformationModel) + * [`RAParticle.SetDistributionModel()`](RAParticle.md#generated.RAParticle.SetDistributionModel) + * [`RAParticle.SetEdgeAngle()`](RAParticle.md#generated.RAParticle.SetEdgeAngle) + * [`RAParticle.SetElasticRatioBending()`](RAParticle.md#generated.RAParticle.SetElasticRatioBending) + * [`RAParticle.SetElasticRatioNormal()`](RAParticle.md#generated.RAParticle.SetElasticRatioNormal) + * [`RAParticle.SetElasticRatioTangential()`](RAParticle.md#generated.RAParticle.SetElasticRatioTangential) + * [`RAParticle.SetElasticRatioTorsion()`](RAParticle.md#generated.RAParticle.SetElasticRatioTorsion) + * [`RAParticle.SetElasticity()`](RAParticle.md#generated.RAParticle.SetElasticity) + * [`RAParticle.SetElementDampingRatio()`](RAParticle.md#generated.RAParticle.SetElementDampingRatio) + * [`RAParticle.SetEnableBreakage()`](RAParticle.md#generated.RAParticle.SetEnableBreakage) + * [`RAParticle.SetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.SetEnableRandomAngle) + * [`RAParticle.SetEnableRotations()`](RAParticle.md#generated.RAParticle.SetEnableRotations) + * [`RAParticle.SetFailureRatio()`](RAParticle.md#generated.RAParticle.SetFailureRatio) + * [`RAParticle.SetFlexible()`](RAParticle.md#generated.RAParticle.SetFlexible) + * [`RAParticle.SetHorizontalAspectRatio()`](RAParticle.md#generated.RAParticle.SetHorizontalAspectRatio) + * [`RAParticle.SetIncludeRotationalDeformations()`](RAParticle.md#generated.RAParticle.SetIncludeRotationalDeformations) + * [`RAParticle.SetInternalFriction()`](RAParticle.md#generated.RAParticle.SetInternalFriction) + * [`RAParticle.SetJointDampingRatio()`](RAParticle.md#generated.RAParticle.SetJointDampingRatio) + * [`RAParticle.SetJointElasticRatio()`](RAParticle.md#generated.RAParticle.SetJointElasticRatio) + * [`RAParticle.SetJointThermalRatio()`](RAParticle.md#generated.RAParticle.SetJointThermalRatio) + * [`RAParticle.SetMaterial()`](RAParticle.md#generated.RAParticle.SetMaterial) + * [`RAParticle.SetMinimumSize()`](RAParticle.md#generated.RAParticle.SetMinimumSize) + * [`RAParticle.SetMinimumSizeRatio()`](RAParticle.md#generated.RAParticle.SetMinimumSizeRatio) + * [`RAParticle.SetMinimumVolumeFractionForFragmentDisabling()`](RAParticle.md#generated.RAParticle.SetMinimumVolumeFractionForFragmentDisabling) + * [`RAParticle.SetModuleProperty()`](RAParticle.md#generated.RAParticle.SetModuleProperty) + * [`RAParticle.SetNumberOfCorners()`](RAParticle.md#generated.RAParticle.SetNumberOfCorners) + * [`RAParticle.SetOrientation()`](RAParticle.md#generated.RAParticle.SetOrientation) + * [`RAParticle.SetOrientationFromAngleAndVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngleAndVector) + * [`RAParticle.SetOrientationFromAngles()`](RAParticle.md#generated.RAParticle.SetOrientationFromAngles) + * [`RAParticle.SetOrientationFromBasisVector()`](RAParticle.md#generated.RAParticle.SetOrientationFromBasisVector) + * [`RAParticle.SetPlasticLimit()`](RAParticle.md#generated.RAParticle.SetPlasticLimit) + * [`RAParticle.SetPlasticRatio()`](RAParticle.md#generated.RAParticle.SetPlasticRatio) + * [`RAParticle.SetPlasticityModel()`](RAParticle.md#generated.RAParticle.SetPlasticityModel) + * [`RAParticle.SetPorosity()`](RAParticle.md#generated.RAParticle.SetPorosity) + * [`RAParticle.SetPrincipalMomentOfInertia()`](RAParticle.md#generated.RAParticle.SetPrincipalMomentOfInertia) + * [`RAParticle.SetRandomAnglesHalfRange()`](RAParticle.md#generated.RAParticle.SetRandomAnglesHalfRange) + * [`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) + * [`RAParticle.SetSideAngle()`](RAParticle.md#generated.RAParticle.SetSideAngle) + * [`RAParticle.SetSizeType()`](RAParticle.md#generated.RAParticle.SetSizeType) + * [`RAParticle.SetSmoothness()`](RAParticle.md#generated.RAParticle.SetSmoothness) + * [`RAParticle.SetSuperquadricDegree()`](RAParticle.md#generated.RAParticle.SetSuperquadricDegree) + * [`RAParticle.SetSurfaceEnergy()`](RAParticle.md#generated.RAParticle.SetSurfaceEnergy) + * [`RAParticle.SetT10Formula()`](RAParticle.md#generated.RAParticle.SetT10Formula) + * [`RAParticle.SetTargetNumberOfElements()`](RAParticle.md#generated.RAParticle.SetTargetNumberOfElements) + * [`RAParticle.SetTavaresA()`](RAParticle.md#generated.RAParticle.SetTavaresA) + * [`RAParticle.SetTavaresB()`](RAParticle.md#generated.RAParticle.SetTavaresB) + * [`RAParticle.SetTavaresD0()`](RAParticle.md#generated.RAParticle.SetTavaresD0) + * [`RAParticle.SetTavaresEInf()`](RAParticle.md#generated.RAParticle.SetTavaresEInf) + * [`RAParticle.SetTavaresGamma()`](RAParticle.md#generated.RAParticle.SetTavaresGamma) + * [`RAParticle.SetTavaresMinimumEnergy()`](RAParticle.md#generated.RAParticle.SetTavaresMinimumEnergy) + * [`RAParticle.SetTavaresPhi()`](RAParticle.md#generated.RAParticle.SetTavaresPhi) + * [`RAParticle.SetTavaresRatioEmax()`](RAParticle.md#generated.RAParticle.SetTavaresRatioEmax) + * [`RAParticle.SetTavaresSigmaSquared()`](RAParticle.md#generated.RAParticle.SetTavaresSigmaSquared) + * [`RAParticle.SetTensileStressLimit()`](RAParticle.md#generated.RAParticle.SetTensileStressLimit) + * [`RAParticle.SetThickness()`](RAParticle.md#generated.RAParticle.SetThickness) + * [`RAParticle.SetTorsionAngleLimit()`](RAParticle.md#generated.RAParticle.SetTorsionAngleLimit) + * [`RAParticle.SetUseMultipleElements()`](RAParticle.md#generated.RAParticle.SetUseMultipleElements) + * [`RAParticle.SetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.SetVerticalAspectRatio) + * [`RAParticle.SetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.SetVonMisesStressLimit) + * [`RAParticle.SetWithFailure()`](RAParticle.md#generated.RAParticle.SetWithFailure) + * [`RAParticle.SetXDirection()`](RAParticle.md#generated.RAParticle.SetXDirection) + * [`RAParticle.SetYDirection()`](RAParticle.md#generated.RAParticle.SetYDirection) + * [`RAParticle.SetZDirection()`](RAParticle.md#generated.RAParticle.SetZDirection) +* [RAParticleAssemblyPart](RAParticleAssemblyPart.md) + * [`RAParticleAssemblyPart`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart) + * [`RAParticleAssemblyPart.GetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAngle) + * [`RAParticleAssemblyPart.GetAvailableParticles()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetAvailableParticles) + * [`RAParticleAssemblyPart.GetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetParticle) + * [`RAParticleAssemblyPart.GetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionX) + * [`RAParticleAssemblyPart.GetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionY) + * [`RAParticleAssemblyPart.GetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetPositionZ) + * [`RAParticleAssemblyPart.GetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationX) + * [`RAParticleAssemblyPart.GetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationY) + * [`RAParticleAssemblyPart.GetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetRotationZ) + * [`RAParticleAssemblyPart.GetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.GetScale) + * [`RAParticleAssemblyPart.SetAngle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetAngle) + * [`RAParticleAssemblyPart.SetParticle()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetParticle) + * [`RAParticleAssemblyPart.SetPositionX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionX) + * [`RAParticleAssemblyPart.SetPositionY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionY) + * [`RAParticleAssemblyPart.SetPositionZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetPositionZ) + * [`RAParticleAssemblyPart.SetRotationX()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationX) + * [`RAParticleAssemblyPart.SetRotationY()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationY) + * [`RAParticleAssemblyPart.SetRotationZ()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetRotationZ) + * [`RAParticleAssemblyPart.SetScale()`](RAParticleAssemblyPart.md#generated.RAParticleAssemblyPart.SetScale) +* [RAParticleAssemblyPartList](RAParticleAssemblyPartList.md) + * [`RAParticleAssemblyPartList`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList) + * [`RAParticleAssemblyPartList.Clear()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Clear) + * [`RAParticleAssemblyPartList.New()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.New) + * [`RAParticleAssemblyPartList.Remove()`](RAParticleAssemblyPartList.md#generated.RAParticleAssemblyPartList.Remove) +* [RAParticleCollection](RAParticleCollection.md) + * [`RAParticleCollection`](RAParticleCollection.md#generated.RAParticleCollection) + * [`RAParticleCollection.Clear()`](RAParticleCollection.md#generated.RAParticleCollection.Clear) + * [`RAParticleCollection.GetParticle()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticle) + * [`RAParticleCollection.GetParticleNames()`](RAParticleCollection.md#generated.RAParticleCollection.GetParticleNames) + * [`RAParticleCollection.New()`](RAParticleCollection.md#generated.RAParticleCollection.New) + * [`RAParticleCollection.Remove()`](RAParticleCollection.md#generated.RAParticleCollection.Remove) +* [RAParticleInlet](RAParticleInlet.md) + * [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) + * [`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.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) + * [`RAParticleInlet.SetStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopAllAtStopTime) + * [`RAParticleInlet.SetStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStopTime) + * [`RAParticleInlet.SetTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetTargetNormalVelocity) + * [`RAParticleInlet.SetUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.SetUseTargetNormalVelocity) + * [`RAParticleInlet.SetUxLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUxLocal) + * [`RAParticleInlet.SetUzLocal()`](RAParticleInlet.md#generated.RAParticleInlet.SetUzLocal) +* [RAParticleInletProperties](RAParticleInletProperties.md) + * [`RAParticleInletProperties`](RAParticleInletProperties.md#generated.RAParticleInletProperties) + * [`RAParticleInletProperties.GetAvailableParticles()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetAvailableParticles) + * [`RAParticleInletProperties.GetMassFlowRate()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetMassFlowRate) + * [`RAParticleInletProperties.GetModuleProperties()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetModuleProperties) + * [`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) + * [`RAParticleInletPropertiesList.New()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.New) + * [`RAParticleInletPropertiesList.Remove()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.Remove) +* [RAParticleJointsData](RAParticleJointsData.md) + * [`RAParticleJointsData`](RAParticleJointsData.md#generated.RAParticleJointsData) + * [`RAParticleJointsData.AddCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCurve) + * [`RAParticleJointsData.AddCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomCurve) + * [`RAParticleJointsData.AddCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddCustomProperty) + * [`RAParticleJointsData.AddGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.AddGridFunction) + * [`RAParticleJointsData.CreateCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateCurveOutputVariable) + * [`RAParticleJointsData.CreateGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunction) + * [`RAParticleJointsData.CreateGridFunctionArrayOnCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionArrayOnCells) + * [`RAParticleJointsData.CreateGridFunctionStatisticOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateGridFunctionStatisticOutputVariable) + * [`RAParticleJointsData.CreateTransientCurveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.CreateTransientCurveOutputVariable) + * [`RAParticleJointsData.DisableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.DisableCollectJointData) + * [`RAParticleJointsData.EditCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomCurve) + * [`RAParticleJointsData.EditCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.EditCustomProperty) + * [`RAParticleJointsData.EnableCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.EnableCollectJointData) + * [`RAParticleJointsData.GetActivesArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetActivesArray) + * [`RAParticleJointsData.GetBoundingBox()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetBoundingBox) + * [`RAParticleJointsData.GetCellAreaAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellAreaAsArray) + * [`RAParticleJointsData.GetCellCenterAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellCenterAsArray) + * [`RAParticleJointsData.GetCellDzAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellDzAsArray) + * [`RAParticleJointsData.GetCellFromIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellFromIJK) + * [`RAParticleJointsData.GetCellIJK()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellIJK) + * [`RAParticleJointsData.GetCellNumberOfVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellNumberOfVertices) + * [`RAParticleJointsData.GetCellPointsAsFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellPointsAsFunction) + * [`RAParticleJointsData.GetCellVolumeAsArray()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCellVolumeAsArray) + * [`RAParticleJointsData.GetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCollectJointData) + * [`RAParticleJointsData.GetCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurve) + * [`RAParticleJointsData.GetCurveNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNames) + * [`RAParticleJointsData.GetCurveNamesAssociation()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNamesAssociation) + * [`RAParticleJointsData.GetElementCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetElementCurve) + * [`RAParticleJointsData.GetGeometryQuantity()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryQuantity) + * [`RAParticleJointsData.GetGeometryUnit()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryUnit) + * [`RAParticleJointsData.GetGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunction) + * [`RAParticleJointsData.GetGridFunctionNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunctionNames) + * [`RAParticleJointsData.GetMeshColoring()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetMeshColoring) + * [`RAParticleJointsData.GetNumberOfCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfCells) + * [`RAParticleJointsData.GetNumberOfNodes()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumberOfNodes) + * [`RAParticleJointsData.GetNumpyCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetNumpyCurve) + * [`RAParticleJointsData.GetOutputVariableValue()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetOutputVariableValue) + * [`RAParticleJointsData.GetTimeSet()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeSet) + * [`RAParticleJointsData.GetTimeStatistics()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStatistics) + * [`RAParticleJointsData.GetTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStep) + * [`RAParticleJointsData.GetTopologyShape()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTopologyShape) + * [`RAParticleJointsData.HasGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.HasGridFunction) + * [`RAParticleJointsData.IsCellActive()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCellActive) + * [`RAParticleJointsData.IsCollectJointDataEnabled()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCollectJointDataEnabled) + * [`RAParticleJointsData.IterCellVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCellVertices) + * [`RAParticleJointsData.IterCells()`](RAParticleJointsData.md#generated.RAParticleJointsData.IterCells) + * [`RAParticleJointsData.Modified()`](RAParticleJointsData.md#generated.RAParticleJointsData.Modified) + * [`RAParticleJointsData.RemoveCustomCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomCurve) + * [`RAParticleJointsData.RemoveCustomProperty()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveCustomProperty) + * [`RAParticleJointsData.RemoveOutputVariable()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveOutputVariable) + * [`RAParticleJointsData.RemoveProcess()`](RAParticleJointsData.md#generated.RAParticleJointsData.RemoveProcess) + * [`RAParticleJointsData.SetCollectJointData()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCollectJointData) + * [`RAParticleJointsData.SetCurrentTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.SetCurrentTimeStep) +* [RAParticleTimeSelectionProcess](RAParticleTimeSelectionProcess.md) + * [`RAParticleTimeSelectionProcess`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess) + * [`RAParticleTimeSelectionProcess.AddCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCurve) + * [`RAParticleTimeSelectionProcess.AddCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomCurve) + * [`RAParticleTimeSelectionProcess.AddCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddCustomProperty) + * [`RAParticleTimeSelectionProcess.AddGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.AddGridFunction) + * [`RAParticleTimeSelectionProcess.CreateCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateCurveOutputVariable) + * [`RAParticleTimeSelectionProcess.CreateGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunction) + * [`RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionArrayOnCells) + * [`RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.CreateTransientCurveOutputVariable) + * [`RAParticleTimeSelectionProcess.EditCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomCurve) + * [`RAParticleTimeSelectionProcess.EditCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.EditCustomProperty) + * [`RAParticleTimeSelectionProcess.GetActivesArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetActivesArray) + * [`RAParticleTimeSelectionProcess.GetBoundingBox()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetBoundingBox) + * [`RAParticleTimeSelectionProcess.GetCellAreaAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellAreaAsArray) + * [`RAParticleTimeSelectionProcess.GetCellCenterAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellCenterAsArray) + * [`RAParticleTimeSelectionProcess.GetCellDzAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellDzAsArray) + * [`RAParticleTimeSelectionProcess.GetCellFromIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellFromIJK) + * [`RAParticleTimeSelectionProcess.GetCellIJK()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellIJK) + * [`RAParticleTimeSelectionProcess.GetCellNumberOfVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellNumberOfVertices) + * [`RAParticleTimeSelectionProcess.GetCellPointsAsFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellPointsAsFunction) + * [`RAParticleTimeSelectionProcess.GetCellVolumeAsArray()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCellVolumeAsArray) + * [`RAParticleTimeSelectionProcess.GetCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurve) + * [`RAParticleTimeSelectionProcess.GetCurveNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNames) + * [`RAParticleTimeSelectionProcess.GetCurveNamesAssociation()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation) + * [`RAParticleTimeSelectionProcess.GetElementCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetElementCurve) + * [`RAParticleTimeSelectionProcess.GetGeometryQuantity()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity) + * [`RAParticleTimeSelectionProcess.GetGeometryUnit()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryUnit) + * [`RAParticleTimeSelectionProcess.GetGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunction) + * [`RAParticleTimeSelectionProcess.GetGridFunctionNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames) + * [`RAParticleTimeSelectionProcess.GetMeshColoring()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetMeshColoring) + * [`RAParticleTimeSelectionProcess.GetNumberOfCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfCells) + * [`RAParticleTimeSelectionProcess.GetNumberOfNodes()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfNodes) + * [`RAParticleTimeSelectionProcess.GetNumberOfParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumberOfParticles) + * [`RAParticleTimeSelectionProcess.GetNumpyCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetNumpyCurve) + * [`RAParticleTimeSelectionProcess.GetOutputVariableValue()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetOutputVariableValue) + * [`RAParticleTimeSelectionProcess.GetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeRange) + * [`RAParticleTimeSelectionProcess.GetTimeSet()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeSet) + * [`RAParticleTimeSelectionProcess.GetTimeStatistics()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStatistics) + * [`RAParticleTimeSelectionProcess.GetTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStep) + * [`RAParticleTimeSelectionProcess.GetTopologyShape()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTopologyShape) + * [`RAParticleTimeSelectionProcess.HasGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.HasGridFunction) + * [`RAParticleTimeSelectionProcess.IsCellActive()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IsCellActive) + * [`RAParticleTimeSelectionProcess.IterCellVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCellVertices) + * [`RAParticleTimeSelectionProcess.IterCells()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCells) + * [`RAParticleTimeSelectionProcess.IterParticles()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterParticles) + * [`RAParticleTimeSelectionProcess.Modified()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.Modified) + * [`RAParticleTimeSelectionProcess.RemoveCustomCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomCurve) + * [`RAParticleTimeSelectionProcess.RemoveCustomProperty()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveCustomProperty) + * [`RAParticleTimeSelectionProcess.RemoveOutputVariable()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveOutputVariable) + * [`RAParticleTimeSelectionProcess.RemoveProcess()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.RemoveProcess) + * [`RAParticleTimeSelectionProcess.SetAbsoluteTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetAbsoluteTimeRange) + * [`RAParticleTimeSelectionProcess.SetCurrentTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetCurrentTimeStep) + * [`RAParticleTimeSelectionProcess.SetTimeRange()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.SetTimeRange) +* [RAParticleToContactProcess](RAParticleToContactProcess.md) + * [`RAParticleToContactProcess`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess) + * [`RAParticleToContactProcess.AddCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCurve) + * [`RAParticleToContactProcess.AddCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomCurve) + * [`RAParticleToContactProcess.AddCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddCustomProperty) + * [`RAParticleToContactProcess.AddGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.AddGridFunction) + * [`RAParticleToContactProcess.CreateCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateCurveOutputVariable) + * [`RAParticleToContactProcess.CreateGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunction) + * [`RAParticleToContactProcess.CreateGridFunctionArrayOnCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionArrayOnCells) + * [`RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAParticleToContactProcess.CreateTransientCurveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.CreateTransientCurveOutputVariable) + * [`RAParticleToContactProcess.EditCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomCurve) + * [`RAParticleToContactProcess.EditCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.EditCustomProperty) + * [`RAParticleToContactProcess.GetActivesArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetActivesArray) + * [`RAParticleToContactProcess.GetBoundingBox()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetBoundingBox) + * [`RAParticleToContactProcess.GetCellAreaAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellAreaAsArray) + * [`RAParticleToContactProcess.GetCellCenterAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellCenterAsArray) + * [`RAParticleToContactProcess.GetCellDzAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellDzAsArray) + * [`RAParticleToContactProcess.GetCellFromIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellFromIJK) + * [`RAParticleToContactProcess.GetCellIJK()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellIJK) + * [`RAParticleToContactProcess.GetCellNumberOfVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellNumberOfVertices) + * [`RAParticleToContactProcess.GetCellPointsAsFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellPointsAsFunction) + * [`RAParticleToContactProcess.GetCellVolumeAsArray()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCellVolumeAsArray) + * [`RAParticleToContactProcess.GetCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurve) + * [`RAParticleToContactProcess.GetCurveNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNames) + * [`RAParticleToContactProcess.GetCurveNamesAssociation()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNamesAssociation) + * [`RAParticleToContactProcess.GetElementCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetElementCurve) + * [`RAParticleToContactProcess.GetGeometryQuantity()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryQuantity) + * [`RAParticleToContactProcess.GetGeometryUnit()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryUnit) + * [`RAParticleToContactProcess.GetGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunction) + * [`RAParticleToContactProcess.GetGridFunctionNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunctionNames) + * [`RAParticleToContactProcess.GetMeshColoring()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetMeshColoring) + * [`RAParticleToContactProcess.GetNumberOfCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfCells) + * [`RAParticleToContactProcess.GetNumberOfNodes()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfNodes) + * [`RAParticleToContactProcess.GetNumberOfParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumberOfParticles) + * [`RAParticleToContactProcess.GetNumpyCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetNumpyCurve) + * [`RAParticleToContactProcess.GetOutputVariableValue()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetOutputVariableValue) + * [`RAParticleToContactProcess.GetTimeSet()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeSet) + * [`RAParticleToContactProcess.GetTimeStatistics()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStatistics) + * [`RAParticleToContactProcess.GetTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStep) + * [`RAParticleToContactProcess.GetTopologyShape()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTopologyShape) + * [`RAParticleToContactProcess.HasGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.HasGridFunction) + * [`RAParticleToContactProcess.IsCellActive()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IsCellActive) + * [`RAParticleToContactProcess.IterCellVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCellVertices) + * [`RAParticleToContactProcess.IterCells()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCells) + * [`RAParticleToContactProcess.IterParticles()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterParticles) + * [`RAParticleToContactProcess.Modified()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.Modified) + * [`RAParticleToContactProcess.RemoveCustomCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomCurve) + * [`RAParticleToContactProcess.RemoveCustomProperty()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveCustomProperty) + * [`RAParticleToContactProcess.RemoveOutputVariable()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveOutputVariable) + * [`RAParticleToContactProcess.RemoveProcess()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.RemoveProcess) + * [`RAParticleToContactProcess.SetCurrentTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.SetCurrentTimeStep) +* [RAParticles](RAParticles.md) + * [`RAParticles`](RAParticles.md#generated.RAParticles) + * [`RAParticles.AddCurve()`](RAParticles.md#generated.RAParticles.AddCurve) + * [`RAParticles.AddCustomCurve()`](RAParticles.md#generated.RAParticles.AddCustomCurve) + * [`RAParticles.AddCustomProperty()`](RAParticles.md#generated.RAParticles.AddCustomProperty) + * [`RAParticles.AddGridFunction()`](RAParticles.md#generated.RAParticles.AddGridFunction) + * [`RAParticles.CreateCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateCurveOutputVariable) + * [`RAParticles.CreateGridFunction()`](RAParticles.md#generated.RAParticles.CreateGridFunction) + * [`RAParticles.CreateGridFunctionArrayOnCells()`](RAParticles.md#generated.RAParticles.CreateGridFunctionArrayOnCells) + * [`RAParticles.CreateGridFunctionStatisticOutputVariable()`](RAParticles.md#generated.RAParticles.CreateGridFunctionStatisticOutputVariable) + * [`RAParticles.CreateTransientCurveOutputVariable()`](RAParticles.md#generated.RAParticles.CreateTransientCurveOutputVariable) + * [`RAParticles.EditCustomCurve()`](RAParticles.md#generated.RAParticles.EditCustomCurve) + * [`RAParticles.EditCustomProperty()`](RAParticles.md#generated.RAParticles.EditCustomProperty) + * [`RAParticles.GetActivesArray()`](RAParticles.md#generated.RAParticles.GetActivesArray) + * [`RAParticles.GetBoundingBox()`](RAParticles.md#generated.RAParticles.GetBoundingBox) + * [`RAParticles.GetCellAreaAsArray()`](RAParticles.md#generated.RAParticles.GetCellAreaAsArray) + * [`RAParticles.GetCellCenterAsArray()`](RAParticles.md#generated.RAParticles.GetCellCenterAsArray) + * [`RAParticles.GetCellDzAsArray()`](RAParticles.md#generated.RAParticles.GetCellDzAsArray) + * [`RAParticles.GetCellFromIJK()`](RAParticles.md#generated.RAParticles.GetCellFromIJK) + * [`RAParticles.GetCellIJK()`](RAParticles.md#generated.RAParticles.GetCellIJK) + * [`RAParticles.GetCellNumberOfVertices()`](RAParticles.md#generated.RAParticles.GetCellNumberOfVertices) + * [`RAParticles.GetCellPointsAsFunction()`](RAParticles.md#generated.RAParticles.GetCellPointsAsFunction) + * [`RAParticles.GetCellVolumeAsArray()`](RAParticles.md#generated.RAParticles.GetCellVolumeAsArray) + * [`RAParticles.GetCurve()`](RAParticles.md#generated.RAParticles.GetCurve) + * [`RAParticles.GetCurveNames()`](RAParticles.md#generated.RAParticles.GetCurveNames) + * [`RAParticles.GetCurveNamesAssociation()`](RAParticles.md#generated.RAParticles.GetCurveNamesAssociation) + * [`RAParticles.GetElementCurve()`](RAParticles.md#generated.RAParticles.GetElementCurve) + * [`RAParticles.GetGeometryQuantity()`](RAParticles.md#generated.RAParticles.GetGeometryQuantity) + * [`RAParticles.GetGeometryUnit()`](RAParticles.md#generated.RAParticles.GetGeometryUnit) + * [`RAParticles.GetGridFunction()`](RAParticles.md#generated.RAParticles.GetGridFunction) + * [`RAParticles.GetGridFunctionNames()`](RAParticles.md#generated.RAParticles.GetGridFunctionNames) + * [`RAParticles.GetMeshColoring()`](RAParticles.md#generated.RAParticles.GetMeshColoring) + * [`RAParticles.GetNumberOfCells()`](RAParticles.md#generated.RAParticles.GetNumberOfCells) + * [`RAParticles.GetNumberOfNodes()`](RAParticles.md#generated.RAParticles.GetNumberOfNodes) + * [`RAParticles.GetNumberOfParticles()`](RAParticles.md#generated.RAParticles.GetNumberOfParticles) + * [`RAParticles.GetNumpyCurve()`](RAParticles.md#generated.RAParticles.GetNumpyCurve) + * [`RAParticles.GetOutputVariableValue()`](RAParticles.md#generated.RAParticles.GetOutputVariableValue) + * [`RAParticles.GetTimeSet()`](RAParticles.md#generated.RAParticles.GetTimeSet) + * [`RAParticles.GetTimeStatistics()`](RAParticles.md#generated.RAParticles.GetTimeStatistics) + * [`RAParticles.GetTimeStep()`](RAParticles.md#generated.RAParticles.GetTimeStep) + * [`RAParticles.GetTopologyShape()`](RAParticles.md#generated.RAParticles.GetTopologyShape) + * [`RAParticles.HasGridFunction()`](RAParticles.md#generated.RAParticles.HasGridFunction) + * [`RAParticles.IsCellActive()`](RAParticles.md#generated.RAParticles.IsCellActive) + * [`RAParticles.IterCellVertices()`](RAParticles.md#generated.RAParticles.IterCellVertices) + * [`RAParticles.IterCells()`](RAParticles.md#generated.RAParticles.IterCells) + * [`RAParticles.IterParticles()`](RAParticles.md#generated.RAParticles.IterParticles) + * [`RAParticles.Modified()`](RAParticles.md#generated.RAParticles.Modified) + * [`RAParticles.RemoveCustomCurve()`](RAParticles.md#generated.RAParticles.RemoveCustomCurve) + * [`RAParticles.RemoveCustomProperty()`](RAParticles.md#generated.RAParticles.RemoveCustomProperty) + * [`RAParticles.RemoveOutputVariable()`](RAParticles.md#generated.RAParticles.RemoveOutputVariable) + * [`RAParticles.RemoveProcess()`](RAParticles.md#generated.RAParticles.RemoveProcess) + * [`RAParticles.SetCurrentTimeStep()`](RAParticles.md#generated.RAParticles.SetCurrentTimeStep) +* [RAPendulum](RAPendulum.md) + * [`RAPendulum`](RAPendulum.md#generated.RAPendulum) + * [`RAPendulum.GetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.GetAmplitudeVariation) + * [`RAPendulum.GetDirection()`](RAPendulum.md#generated.RAPendulum.GetDirection) + * [`RAPendulum.GetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.GetFrequencyVariation) + * [`RAPendulum.GetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.GetInitialAmplitude) + * [`RAPendulum.GetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.GetInitialFrequency) + * [`RAPendulum.GetInitialPhase()`](RAPendulum.md#generated.RAPendulum.GetInitialPhase) + * [`RAPendulum.SetAmplitudeVariation()`](RAPendulum.md#generated.RAPendulum.SetAmplitudeVariation) + * [`RAPendulum.SetDirection()`](RAPendulum.md#generated.RAPendulum.SetDirection) + * [`RAPendulum.SetFrequencyVariation()`](RAPendulum.md#generated.RAPendulum.SetFrequencyVariation) + * [`RAPendulum.SetInitialAmplitude()`](RAPendulum.md#generated.RAPendulum.SetInitialAmplitude) + * [`RAPendulum.SetInitialFrequency()`](RAPendulum.md#generated.RAPendulum.SetInitialFrequency) + * [`RAPendulum.SetInitialPhase()`](RAPendulum.md#generated.RAPendulum.SetInitialPhase) +* [RAPhysics](RAPhysics.md) + * [`RAPhysics`](RAPhysics.md#generated.RAPhysics) + * [`RAPhysics.GetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.GetAdhesionModel) + * [`RAPhysics.GetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.GetClosePackingVolumeFraction) + * [`RAPhysics.GetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.GetEnableCoarseGrainModeling) + * [`RAPhysics.GetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.GetEnableThermalModel) + * [`RAPhysics.GetExponentLimit()`](RAPhysics.md#generated.RAPhysics.GetExponentLimit) + * [`RAPhysics.GetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStartTime) + * [`RAPhysics.GetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.GetGravityStopTime) + * [`RAPhysics.GetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityXDirection) + * [`RAPhysics.GetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityYDirection) + * [`RAPhysics.GetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.GetGravityZDirection) + * [`RAPhysics.GetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.GetImpactEnergyModel) + * [`RAPhysics.GetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.GetNormalForceModel) + * [`RAPhysics.GetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.GetNumericalSofteningFactor) + * [`RAPhysics.GetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.GetRestitutionModel) + * [`RAPhysics.GetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.GetRollingResistanceModel) + * [`RAPhysics.GetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetSearchDistanceMultiplier) + * [`RAPhysics.GetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.GetSphThermalTransferModel) + * [`RAPhysics.GetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.GetTangentialForceModel) + * [`RAPhysics.GetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.GetThermalCorrectionModel) + * [`RAPhysics.GetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.GetUpdateDistanceMultiplier) + * [`RAPhysics.GetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.GetUseRadlEtAl) + * [`RAPhysics.GetValidAdhesionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidAdhesionModelValues) + * [`RAPhysics.GetValidImpactEnergyModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidImpactEnergyModelValues) + * [`RAPhysics.GetValidNormalForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidNormalForceModelValues) + * [`RAPhysics.GetValidRestitutionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRestitutionModelValues) + * [`RAPhysics.GetValidRollingResistanceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidRollingResistanceModelValues) + * [`RAPhysics.GetValidSphThermalTransferModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidSphThermalTransferModelValues) + * [`RAPhysics.GetValidTangentialForceModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidTangentialForceModelValues) + * [`RAPhysics.GetValidThermalCorrectionModelValues()`](RAPhysics.md#generated.RAPhysics.GetValidThermalCorrectionModelValues) + * [`RAPhysics.GetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.GetVolumeFractionLimit) + * [`RAPhysics.SetAdhesionModel()`](RAPhysics.md#generated.RAPhysics.SetAdhesionModel) + * [`RAPhysics.SetClosePackingVolumeFraction()`](RAPhysics.md#generated.RAPhysics.SetClosePackingVolumeFraction) + * [`RAPhysics.SetEnableCoarseGrainModeling()`](RAPhysics.md#generated.RAPhysics.SetEnableCoarseGrainModeling) + * [`RAPhysics.SetEnableThermalModel()`](RAPhysics.md#generated.RAPhysics.SetEnableThermalModel) + * [`RAPhysics.SetExponentLimit()`](RAPhysics.md#generated.RAPhysics.SetExponentLimit) + * [`RAPhysics.SetGravityStartTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStartTime) + * [`RAPhysics.SetGravityStopTime()`](RAPhysics.md#generated.RAPhysics.SetGravityStopTime) + * [`RAPhysics.SetGravityXDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityXDirection) + * [`RAPhysics.SetGravityYDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityYDirection) + * [`RAPhysics.SetGravityZDirection()`](RAPhysics.md#generated.RAPhysics.SetGravityZDirection) + * [`RAPhysics.SetImpactEnergyModel()`](RAPhysics.md#generated.RAPhysics.SetImpactEnergyModel) + * [`RAPhysics.SetNormalForceModel()`](RAPhysics.md#generated.RAPhysics.SetNormalForceModel) + * [`RAPhysics.SetNumericalSofteningFactor()`](RAPhysics.md#generated.RAPhysics.SetNumericalSofteningFactor) + * [`RAPhysics.SetRestitutionModel()`](RAPhysics.md#generated.RAPhysics.SetRestitutionModel) + * [`RAPhysics.SetRollingResistanceModel()`](RAPhysics.md#generated.RAPhysics.SetRollingResistanceModel) + * [`RAPhysics.SetSearchDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetSearchDistanceMultiplier) + * [`RAPhysics.SetSphThermalTransferModel()`](RAPhysics.md#generated.RAPhysics.SetSphThermalTransferModel) + * [`RAPhysics.SetTangentialForceModel()`](RAPhysics.md#generated.RAPhysics.SetTangentialForceModel) + * [`RAPhysics.SetThermalCorrectionModel()`](RAPhysics.md#generated.RAPhysics.SetThermalCorrectionModel) + * [`RAPhysics.SetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetUpdateDistanceMultiplier) + * [`RAPhysics.SetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.SetUseRadlEtAl) + * [`RAPhysics.SetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.SetVolumeFractionLimit) +* [RAPlaneProcess](RAPlaneProcess.md) + * [`RAPlaneProcess`](RAPlaneProcess.md#generated.RAPlaneProcess) + * [`RAPlaneProcess.AddCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCurve) + * [`RAPlaneProcess.AddCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomCurve) + * [`RAPlaneProcess.AddCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCustomProperty) + * [`RAPlaneProcess.AddGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddGridFunction) + * [`RAPlaneProcess.CreateCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateCurveOutputVariable) + * [`RAPlaneProcess.CreateGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunction) + * [`RAPlaneProcess.CreateGridFunctionArrayOnCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionArrayOnCells) + * [`RAPlaneProcess.CreateGridFunctionStatisticOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAPlaneProcess.CreateTransientCurveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.CreateTransientCurveOutputVariable) + * [`RAPlaneProcess.EditCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomCurve) + * [`RAPlaneProcess.EditCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.EditCustomProperty) + * [`RAPlaneProcess.GetActivesArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetActivesArray) + * [`RAPlaneProcess.GetBoundingBox()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetBoundingBox) + * [`RAPlaneProcess.GetCellAreaAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellAreaAsArray) + * [`RAPlaneProcess.GetCellCenterAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellCenterAsArray) + * [`RAPlaneProcess.GetCellDzAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellDzAsArray) + * [`RAPlaneProcess.GetCellFromIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellFromIJK) + * [`RAPlaneProcess.GetCellIJK()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellIJK) + * [`RAPlaneProcess.GetCellNumberOfVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellNumberOfVertices) + * [`RAPlaneProcess.GetCellPointsAsFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellPointsAsFunction) + * [`RAPlaneProcess.GetCellVolumeAsArray()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCellVolumeAsArray) + * [`RAPlaneProcess.GetCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurve) + * [`RAPlaneProcess.GetCurveNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNames) + * [`RAPlaneProcess.GetCurveNamesAssociation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNamesAssociation) + * [`RAPlaneProcess.GetElementCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetElementCurve) + * [`RAPlaneProcess.GetGeometryQuantity()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryQuantity) + * [`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) + * [`RAPlaneProcess.GetNumpyCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumpyCurve) + * [`RAPlaneProcess.GetOrientation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientation) + * [`RAPlaneProcess.GetOrientationFromAngleAndVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngleAndVector) + * [`RAPlaneProcess.GetOrientationFromAngles()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromAngles) + * [`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.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.HasGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.HasGridFunction) + * [`RAPlaneProcess.IsCellActive()`](RAPlaneProcess.md#generated.RAPlaneProcess.IsCellActive) + * [`RAPlaneProcess.IterCellVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCellVertices) + * [`RAPlaneProcess.IterCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCells) + * [`RAPlaneProcess.IterParticles()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterParticles) + * [`RAPlaneProcess.Modified()`](RAPlaneProcess.md#generated.RAPlaneProcess.Modified) + * [`RAPlaneProcess.RemoveCustomCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomCurve) + * [`RAPlaneProcess.RemoveCustomProperty()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveCustomProperty) + * [`RAPlaneProcess.RemoveOutputVariable()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveOutputVariable) + * [`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.SetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetType) +* [RAPointCloud](RAPointCloud.md) + * [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud) + * [`RAPointCloud.AddCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCurve) + * [`RAPointCloud.AddCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.AddCustomCurve) + * [`RAPointCloud.AddCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.AddCustomProperty) + * [`RAPointCloud.AddGridFunction()`](RAPointCloud.md#generated.RAPointCloud.AddGridFunction) + * [`RAPointCloud.CreateCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateCurveOutputVariable) + * [`RAPointCloud.CreateGridFunction()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunction) + * [`RAPointCloud.CreateGridFunctionArrayOnCells()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionArrayOnCells) + * [`RAPointCloud.CreateGridFunctionStatisticOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateGridFunctionStatisticOutputVariable) + * [`RAPointCloud.CreateTransientCurveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.CreateTransientCurveOutputVariable) + * [`RAPointCloud.DisablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.DisablePeriodic) + * [`RAPointCloud.EditCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.EditCustomCurve) + * [`RAPointCloud.EditCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.EditCustomProperty) + * [`RAPointCloud.EnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.EnablePeriodic) + * [`RAPointCloud.GetActivesArray()`](RAPointCloud.md#generated.RAPointCloud.GetActivesArray) + * [`RAPointCloud.GetBoundingBox()`](RAPointCloud.md#generated.RAPointCloud.GetBoundingBox) + * [`RAPointCloud.GetCellAreaAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellAreaAsArray) + * [`RAPointCloud.GetCellCenterAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellCenterAsArray) + * [`RAPointCloud.GetCellDzAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellDzAsArray) + * [`RAPointCloud.GetCellFromIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellFromIJK) + * [`RAPointCloud.GetCellIJK()`](RAPointCloud.md#generated.RAPointCloud.GetCellIJK) + * [`RAPointCloud.GetCellNumberOfVertices()`](RAPointCloud.md#generated.RAPointCloud.GetCellNumberOfVertices) + * [`RAPointCloud.GetCellPointsAsFunction()`](RAPointCloud.md#generated.RAPointCloud.GetCellPointsAsFunction) + * [`RAPointCloud.GetCellVolumeAsArray()`](RAPointCloud.md#generated.RAPointCloud.GetCellVolumeAsArray) + * [`RAPointCloud.GetCurve()`](RAPointCloud.md#generated.RAPointCloud.GetCurve) + * [`RAPointCloud.GetCurveNames()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNames) + * [`RAPointCloud.GetCurveNamesAssociation()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNamesAssociation) + * [`RAPointCloud.GetElementCurve()`](RAPointCloud.md#generated.RAPointCloud.GetElementCurve) + * [`RAPointCloud.GetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.GetEnablePeriodic) + * [`RAPointCloud.GetFilePath()`](RAPointCloud.md#generated.RAPointCloud.GetFilePath) + * [`RAPointCloud.GetGeometryQuantity()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryQuantity) + * [`RAPointCloud.GetGeometryUnit()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryUnit) + * [`RAPointCloud.GetGridFunction()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunction) + * [`RAPointCloud.GetGridFunctionNames()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunctionNames) + * [`RAPointCloud.GetMeshColoring()`](RAPointCloud.md#generated.RAPointCloud.GetMeshColoring) + * [`RAPointCloud.GetModuleProperties()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperties) + * [`RAPointCloud.GetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.GetModuleProperty) + * [`RAPointCloud.GetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.GetMotionFrame) + * [`RAPointCloud.GetNumberOfCells()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfCells) + * [`RAPointCloud.GetNumberOfNodes()`](RAPointCloud.md#generated.RAPointCloud.GetNumberOfNodes) + * [`RAPointCloud.GetNumpyCurve()`](RAPointCloud.md#generated.RAPointCloud.GetNumpyCurve) + * [`RAPointCloud.GetOutputVariableValue()`](RAPointCloud.md#generated.RAPointCloud.GetOutputVariableValue) + * [`RAPointCloud.GetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStartTime) + * [`RAPointCloud.GetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStopTime) + * [`RAPointCloud.GetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOff) + * [`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.HasGridFunction()`](RAPointCloud.md#generated.RAPointCloud.HasGridFunction) + * [`RAPointCloud.IsCellActive()`](RAPointCloud.md#generated.RAPointCloud.IsCellActive) + * [`RAPointCloud.IsPeriodicEnabled()`](RAPointCloud.md#generated.RAPointCloud.IsPeriodicEnabled) + * [`RAPointCloud.IsTransient()`](RAPointCloud.md#generated.RAPointCloud.IsTransient) + * [`RAPointCloud.IterCellVertices()`](RAPointCloud.md#generated.RAPointCloud.IterCellVertices) + * [`RAPointCloud.IterCells()`](RAPointCloud.md#generated.RAPointCloud.IterCells) + * [`RAPointCloud.Modified()`](RAPointCloud.md#generated.RAPointCloud.Modified) + * [`RAPointCloud.RemoveCustomCurve()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomCurve) + * [`RAPointCloud.RemoveCustomProperty()`](RAPointCloud.md#generated.RAPointCloud.RemoveCustomProperty) + * [`RAPointCloud.RemoveOutputVariable()`](RAPointCloud.md#generated.RAPointCloud.RemoveOutputVariable) + * [`RAPointCloud.RemoveProcess()`](RAPointCloud.md#generated.RAPointCloud.RemoveProcess) + * [`RAPointCloud.SetCurrentTimeStep()`](RAPointCloud.md#generated.RAPointCloud.SetCurrentTimeStep) + * [`RAPointCloud.SetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.SetEnablePeriodic) + * [`RAPointCloud.SetFilePath()`](RAPointCloud.md#generated.RAPointCloud.SetFilePath) + * [`RAPointCloud.SetModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.SetModuleProperty) + * [`RAPointCloud.SetMotionFrame()`](RAPointCloud.md#generated.RAPointCloud.SetMotionFrame) + * [`RAPointCloud.SetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStartTime) + * [`RAPointCloud.SetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStopTime) + * [`RAPointCloud.SetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOff) +* [RAPointCloudCollection](RAPointCloudCollection.md) + * [`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) + * [`RAPointCloudCollection.Clear()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Clear) + * [`RAPointCloudCollection.New()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.New) + * [`RAPointCloudCollection.Remove()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Remove) +* [RAPolyhedronProcess](RAPolyhedronProcess.md) + * [`RAPolyhedronProcess`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess) + * [`RAPolyhedronProcess.AddCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCurve) + * [`RAPolyhedronProcess.AddCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomCurve) + * [`RAPolyhedronProcess.AddCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddCustomProperty) + * [`RAPolyhedronProcess.AddGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.AddGridFunction) + * [`RAPolyhedronProcess.CreateCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateCurveOutputVariable) + * [`RAPolyhedronProcess.CreateGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunction) + * [`RAPolyhedronProcess.CreateGridFunctionArrayOnCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionArrayOnCells) + * [`RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAPolyhedronProcess.CreateTransientCurveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.CreateTransientCurveOutputVariable) + * [`RAPolyhedronProcess.EditCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomCurve) + * [`RAPolyhedronProcess.EditCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.EditCustomProperty) + * [`RAPolyhedronProcess.GetActivesArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetActivesArray) + * [`RAPolyhedronProcess.GetBoundingBox()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetBoundingBox) + * [`RAPolyhedronProcess.GetCellAreaAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellAreaAsArray) + * [`RAPolyhedronProcess.GetCellCenterAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellCenterAsArray) + * [`RAPolyhedronProcess.GetCellDzAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellDzAsArray) + * [`RAPolyhedronProcess.GetCellFromIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellFromIJK) + * [`RAPolyhedronProcess.GetCellIJK()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellIJK) + * [`RAPolyhedronProcess.GetCellNumberOfVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellNumberOfVertices) + * [`RAPolyhedronProcess.GetCellPointsAsFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellPointsAsFunction) + * [`RAPolyhedronProcess.GetCellVolumeAsArray()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCellVolumeAsArray) + * [`RAPolyhedronProcess.GetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenter) + * [`RAPolyhedronProcess.GetCenterAfterMovement()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCenterAfterMovement) + * [`RAPolyhedronProcess.GetCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurve) + * [`RAPolyhedronProcess.GetCurveNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNames) + * [`RAPolyhedronProcess.GetCurveNamesAssociation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNamesAssociation) + * [`RAPolyhedronProcess.GetElementCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetElementCurve) + * [`RAPolyhedronProcess.GetGeometryQuantity()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryQuantity) + * [`RAPolyhedronProcess.GetGeometryUnit()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryUnit) + * [`RAPolyhedronProcess.GetGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunction) + * [`RAPolyhedronProcess.GetGridFunctionNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunctionNames) + * [`RAPolyhedronProcess.GetMeshColoring()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMeshColoring) + * [`RAPolyhedronProcess.GetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetMotionFrame) + * [`RAPolyhedronProcess.GetNumberOfCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfCells) + * [`RAPolyhedronProcess.GetNumberOfNodes()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfNodes) + * [`RAPolyhedronProcess.GetNumberOfParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumberOfParticles) + * [`RAPolyhedronProcess.GetNumpyCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetNumpyCurve) + * [`RAPolyhedronProcess.GetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientation) + * [`RAPolyhedronProcess.GetOrientationFromAngleAndVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromAngleAndVector) + * [`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.HasGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.HasGridFunction) + * [`RAPolyhedronProcess.IsCellActive()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IsCellActive) + * [`RAPolyhedronProcess.IterCellVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCellVertices) + * [`RAPolyhedronProcess.IterCells()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCells) + * [`RAPolyhedronProcess.IterParticles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterParticles) + * [`RAPolyhedronProcess.Modified()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.Modified) + * [`RAPolyhedronProcess.RemoveCustomCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomCurve) + * [`RAPolyhedronProcess.RemoveCustomProperty()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveCustomProperty) + * [`RAPolyhedronProcess.RemoveOutputVariable()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveOutputVariable) + * [`RAPolyhedronProcess.RemoveProcess()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.RemoveProcess) + * [`RAPolyhedronProcess.SetCenter()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCenter) + * [`RAPolyhedronProcess.SetCurrentTimeStep()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetCurrentTimeStep) + * [`RAPolyhedronProcess.SetMotionFrame()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetMotionFrame) + * [`RAPolyhedronProcess.SetOrientation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientation) + * [`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) + * [`RAPrescribedForce.SetForceValue()`](RAPrescribedForce.md#generated.RAPrescribedForce.SetForceValue) +* [RAPrescribedMoment](RAPrescribedMoment.md) + * [`RAPrescribedMoment`](RAPrescribedMoment.md#generated.RAPrescribedMoment) + * [`RAPrescribedMoment.GetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.GetMomentValue) + * [`RAPrescribedMoment.SetMomentValue()`](RAPrescribedMoment.md#generated.RAPrescribedMoment.SetMomentValue) +* [RAProject](RAProject.md) + * [`RAProject`](RAProject.md#generated.RAProject) + * [`RAProject.CloseProject()`](RAProject.md#generated.RAProject.CloseProject) + * [`RAProject.CreateStudy()`](RAProject.md#generated.RAProject.CreateStudy) + * [`RAProject.GetInputVariables()`](RAProject.md#generated.RAProject.GetInputVariables) + * [`RAProject.GetModelElement()`](RAProject.md#generated.RAProject.GetModelElement) + * [`RAProject.GetModelStudy()`](RAProject.md#generated.RAProject.GetModelStudy) + * [`RAProject.GetParametricVariables()`](RAProject.md#generated.RAProject.GetParametricVariables) + * [`RAProject.GetProjectFilename()`](RAProject.md#generated.RAProject.GetProjectFilename) + * [`RAProject.GetStudy()`](RAProject.md#generated.RAProject.GetStudy) + * [`RAProject.GetTimeFilter()`](RAProject.md#generated.RAProject.GetTimeFilter) + * [`RAProject.GetUserProcessCollection()`](RAProject.md#generated.RAProject.GetUserProcessCollection) + * [`RAProject.RemoveProcess()`](RAProject.md#generated.RAProject.RemoveProcess) + * [`RAProject.SaveProject()`](RAProject.md#generated.RAProject.SaveProject) + * [`RAProject.SaveProjectForRestart()`](RAProject.md#generated.RAProject.SaveProjectForRestart) +* [RAReceivingConveyor](RAReceivingConveyor.md) + * [`RAReceivingConveyor`](RAReceivingConveyor.md#generated.RAReceivingConveyor) + * [`RAReceivingConveyor.AddCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCurve) + * [`RAReceivingConveyor.AddCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomCurve) + * [`RAReceivingConveyor.AddCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddCustomProperty) + * [`RAReceivingConveyor.AddGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.AddGridFunction) + * [`RAReceivingConveyor.CreateCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateCurveOutputVariable) + * [`RAReceivingConveyor.CreateGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunction) + * [`RAReceivingConveyor.CreateGridFunctionArrayOnCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionArrayOnCells) + * [`RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateGridFunctionStatisticOutputVariable) + * [`RAReceivingConveyor.CreateTransientCurveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.CreateTransientCurveOutputVariable) + * [`RAReceivingConveyor.EditCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomCurve) + * [`RAReceivingConveyor.EditCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.EditCustomProperty) + * [`RAReceivingConveyor.GetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAccelerationPeriod) + * [`RAReceivingConveyor.GetActivesArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetActivesArray) + * [`RAReceivingConveyor.GetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAlignmentAngle) + * [`RAReceivingConveyor.GetAvailableMaterials()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetAvailableMaterials) + * [`RAReceivingConveyor.GetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStartTime) + * [`RAReceivingConveyor.GetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeginningStopTime) + * [`RAReceivingConveyor.GetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltInclineAngle) + * [`RAReceivingConveyor.GetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfile) + * [`RAReceivingConveyor.GetBeltProfileName()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltProfileName) + * [`RAReceivingConveyor.GetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltSpeed) + * [`RAReceivingConveyor.GetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltThickness) + * [`RAReceivingConveyor.GetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltWidth) + * [`RAReceivingConveyor.GetBoundingBox()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBoundingBox) + * [`RAReceivingConveyor.GetCellAreaAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellAreaAsArray) + * [`RAReceivingConveyor.GetCellCenterAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellCenterAsArray) + * [`RAReceivingConveyor.GetCellDzAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellDzAsArray) + * [`RAReceivingConveyor.GetCellFromIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellFromIJK) + * [`RAReceivingConveyor.GetCellIJK()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellIJK) + * [`RAReceivingConveyor.GetCellNumberOfVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellNumberOfVertices) + * [`RAReceivingConveyor.GetCellPointsAsFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellPointsAsFunction) + * [`RAReceivingConveyor.GetCellVolumeAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellVolumeAsArray) + * [`RAReceivingConveyor.GetCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurve) + * [`RAReceivingConveyor.GetCurveNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNames) + * [`RAReceivingConveyor.GetCurveNamesAssociation()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNamesAssociation) + * [`RAReceivingConveyor.GetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetDecelerationPeriod) + * [`RAReceivingConveyor.GetElementCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetElementCurve) + * [`RAReceivingConveyor.GetGeometryQuantity()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryQuantity) + * [`RAReceivingConveyor.GetGeometryUnit()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryUnit) + * [`RAReceivingConveyor.GetGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunction) + * [`RAReceivingConveyor.GetGridFunctionNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunctionNames) + * [`RAReceivingConveyor.GetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHeightOffset) + * [`RAReceivingConveyor.GetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetHorizontalOffset) + * [`RAReceivingConveyor.GetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLength) + * [`RAReceivingConveyor.GetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetLengthOffset) + * [`RAReceivingConveyor.GetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMaterial) + * [`RAReceivingConveyor.GetMeshColoring()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetMeshColoring) + * [`RAReceivingConveyor.GetModuleProperties()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperties) + * [`RAReceivingConveyor.GetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetModuleProperty) + * [`RAReceivingConveyor.GetNumberOfCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfCells) + * [`RAReceivingConveyor.GetNumberOfNodes()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumberOfNodes) + * [`RAReceivingConveyor.GetNumpyCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetNumpyCurve) + * [`RAReceivingConveyor.GetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutOfPlaneOffset) + * [`RAReceivingConveyor.GetOutputVariableValue()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetOutputVariableValue) + * [`RAReceivingConveyor.GetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetReturnBeltAngle) + * [`RAReceivingConveyor.GetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardHeight) + * [`RAReceivingConveyor.GetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSkirtboardLength) + * [`RAReceivingConveyor.GetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSphBoundaryType) + * [`RAReceivingConveyor.GetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetSurfaceTensionContactAngle) + * [`RAReceivingConveyor.GetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTemperature) + * [`RAReceivingConveyor.GetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetThermalBoundaryConditionType) + * [`RAReceivingConveyor.GetTimeSet()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeSet) + * [`RAReceivingConveyor.GetTimeStatistics()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStatistics) + * [`RAReceivingConveyor.GetTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTimeStep) + * [`RAReceivingConveyor.GetTopologyShape()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTopologyShape) + * [`RAReceivingConveyor.GetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetTriangleSize) + * [`RAReceivingConveyor.GetValidBeltProfileNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidBeltProfileNames) + * [`RAReceivingConveyor.GetValidOptionsForModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidOptionsForModuleProperty) + * [`RAReceivingConveyor.GetValidSphBoundaryTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues) + * [`RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues) + * [`RAReceivingConveyor.GetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVerticalOffset) + * [`RAReceivingConveyor.GetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetWidth) + * [`RAReceivingConveyor.HasGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.HasGridFunction) + * [`RAReceivingConveyor.IsCellActive()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IsCellActive) + * [`RAReceivingConveyor.IterCellVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCellVertices) + * [`RAReceivingConveyor.IterCells()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IterCells) + * [`RAReceivingConveyor.Modified()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.Modified) + * [`RAReceivingConveyor.RemoveCustomCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomCurve) + * [`RAReceivingConveyor.RemoveCustomProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveCustomProperty) + * [`RAReceivingConveyor.RemoveOutputVariable()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveOutputVariable) + * [`RAReceivingConveyor.RemoveProcess()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.RemoveProcess) + * [`RAReceivingConveyor.SetAccelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAccelerationPeriod) + * [`RAReceivingConveyor.SetAlignmentAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetAlignmentAngle) + * [`RAReceivingConveyor.SetBeginningStartTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStartTime) + * [`RAReceivingConveyor.SetBeginningStopTime()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeginningStopTime) + * [`RAReceivingConveyor.SetBeltInclineAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltInclineAngle) + * [`RAReceivingConveyor.SetBeltProfile()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltProfile) + * [`RAReceivingConveyor.SetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltSpeed) + * [`RAReceivingConveyor.SetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltThickness) + * [`RAReceivingConveyor.SetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltWidth) + * [`RAReceivingConveyor.SetCurrentTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCurrentTimeStep) + * [`RAReceivingConveyor.SetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetDecelerationPeriod) + * [`RAReceivingConveyor.SetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHeightOffset) + * [`RAReceivingConveyor.SetHorizontalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHorizontalOffset) + * [`RAReceivingConveyor.SetLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLength) + * [`RAReceivingConveyor.SetLengthOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetLengthOffset) + * [`RAReceivingConveyor.SetMaterial()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetMaterial) + * [`RAReceivingConveyor.SetModuleProperty()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetModuleProperty) + * [`RAReceivingConveyor.SetOutOfPlaneOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetOutOfPlaneOffset) + * [`RAReceivingConveyor.SetReturnBeltAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetReturnBeltAngle) + * [`RAReceivingConveyor.SetSkirtboardHeight()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardHeight) + * [`RAReceivingConveyor.SetSkirtboardLength()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSkirtboardLength) + * [`RAReceivingConveyor.SetSphBoundaryType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSphBoundaryType) + * [`RAReceivingConveyor.SetSurfaceTensionContactAngle()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetSurfaceTensionContactAngle) + * [`RAReceivingConveyor.SetTemperature()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTemperature) + * [`RAReceivingConveyor.SetThermalBoundaryConditionType()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetThermalBoundaryConditionType) + * [`RAReceivingConveyor.SetTriangleSize()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetTriangleSize) + * [`RAReceivingConveyor.SetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetVerticalOffset) + * [`RAReceivingConveyor.SetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetWidth) +* [RARectangularSurface](RARectangularSurface.md) + * [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface) + * [`RARectangularSurface.AddCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCurve) + * [`RARectangularSurface.AddCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomCurve) + * [`RARectangularSurface.AddCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.AddCustomProperty) + * [`RARectangularSurface.AddGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.AddGridFunction) + * [`RARectangularSurface.CreateCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateCurveOutputVariable) + * [`RARectangularSurface.CreateGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunction) + * [`RARectangularSurface.CreateGridFunctionArrayOnCells()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionArrayOnCells) + * [`RARectangularSurface.CreateGridFunctionStatisticOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateGridFunctionStatisticOutputVariable) + * [`RARectangularSurface.CreateTransientCurveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.CreateTransientCurveOutputVariable) + * [`RARectangularSurface.EditCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomCurve) + * [`RARectangularSurface.EditCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.EditCustomProperty) + * [`RARectangularSurface.GetActivesArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetActivesArray) + * [`RARectangularSurface.GetBoundingBox()`](RARectangularSurface.md#generated.RARectangularSurface.GetBoundingBox) + * [`RARectangularSurface.GetCellAreaAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellAreaAsArray) + * [`RARectangularSurface.GetCellCenterAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellCenterAsArray) + * [`RARectangularSurface.GetCellDzAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellDzAsArray) + * [`RARectangularSurface.GetCellFromIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellFromIJK) + * [`RARectangularSurface.GetCellIJK()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellIJK) + * [`RARectangularSurface.GetCellNumberOfVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellNumberOfVertices) + * [`RARectangularSurface.GetCellPointsAsFunction()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellPointsAsFunction) + * [`RARectangularSurface.GetCellVolumeAsArray()`](RARectangularSurface.md#generated.RARectangularSurface.GetCellVolumeAsArray) + * [`RARectangularSurface.GetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.GetCenter) + * [`RARectangularSurface.GetCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurve) + * [`RARectangularSurface.GetCurveNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNames) + * [`RARectangularSurface.GetCurveNamesAssociation()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNamesAssociation) + * [`RARectangularSurface.GetElementCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetElementCurve) + * [`RARectangularSurface.GetGeometryQuantity()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryQuantity) + * [`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.GetNumberOfCells()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfCells) + * [`RARectangularSurface.GetNumberOfNodes()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfNodes) + * [`RARectangularSurface.GetNumpyCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumpyCurve) + * [`RARectangularSurface.GetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientation) + * [`RARectangularSurface.GetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngleAndVector) + * [`RARectangularSurface.GetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromAngles) + * [`RARectangularSurface.GetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.GetOrientationFromBasisVector) + * [`RARectangularSurface.GetOutputVariableValue()`](RARectangularSurface.md#generated.RARectangularSurface.GetOutputVariableValue) + * [`RARectangularSurface.GetTimeSet()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeSet) + * [`RARectangularSurface.GetTimeStatistics()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStatistics) + * [`RARectangularSurface.GetTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStep) + * [`RARectangularSurface.GetTopologyShape()`](RARectangularSurface.md#generated.RARectangularSurface.GetTopologyShape) + * [`RARectangularSurface.GetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.GetWidth) + * [`RARectangularSurface.HasGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.HasGridFunction) + * [`RARectangularSurface.HasMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.HasMotionFrame) + * [`RARectangularSurface.IsCellActive()`](RARectangularSurface.md#generated.RARectangularSurface.IsCellActive) + * [`RARectangularSurface.IterCellVertices()`](RARectangularSurface.md#generated.RARectangularSurface.IterCellVertices) + * [`RARectangularSurface.IterCells()`](RARectangularSurface.md#generated.RARectangularSurface.IterCells) + * [`RARectangularSurface.Modified()`](RARectangularSurface.md#generated.RARectangularSurface.Modified) + * [`RARectangularSurface.RemoveCustomCurve()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomCurve) + * [`RARectangularSurface.RemoveCustomProperty()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveCustomProperty) + * [`RARectangularSurface.RemoveOutputVariable()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveOutputVariable) + * [`RARectangularSurface.RemoveProcess()`](RARectangularSurface.md#generated.RARectangularSurface.RemoveProcess) + * [`RARectangularSurface.SetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.SetCenter) + * [`RARectangularSurface.SetCurrentTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.SetCurrentTimeStep) + * [`RARectangularSurface.SetLength()`](RARectangularSurface.md#generated.RARectangularSurface.SetLength) + * [`RARectangularSurface.SetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientation) + * [`RARectangularSurface.SetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngleAndVector) + * [`RARectangularSurface.SetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngles) + * [`RARectangularSurface.SetOrientationFromBasisVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromBasisVector) + * [`RARectangularSurface.SetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.SetWidth) +* [RARegionOfInterestCube](RARegionOfInterestCube.md) + * [`RARegionOfInterestCube`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube) + * [`RARegionOfInterestCube.AddCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCurve) + * [`RARegionOfInterestCube.AddCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomCurve) + * [`RARegionOfInterestCube.AddCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddCustomProperty) + * [`RARegionOfInterestCube.AddGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.AddGridFunction) + * [`RARegionOfInterestCube.CreateCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateCurveOutputVariable) + * [`RARegionOfInterestCube.CreateGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunction) + * [`RARegionOfInterestCube.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionArrayOnCells) + * [`RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateGridFunctionStatisticOutputVariable) + * [`RARegionOfInterestCube.CreateTransientCurveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.CreateTransientCurveOutputVariable) + * [`RARegionOfInterestCube.EditCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomCurve) + * [`RARegionOfInterestCube.EditCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.EditCustomProperty) + * [`RARegionOfInterestCube.GetActivesArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetActivesArray) + * [`RARegionOfInterestCube.GetBoundingBox()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetBoundingBox) + * [`RARegionOfInterestCube.GetCellAreaAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellAreaAsArray) + * [`RARegionOfInterestCube.GetCellCenterAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellCenterAsArray) + * [`RARegionOfInterestCube.GetCellDzAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellDzAsArray) + * [`RARegionOfInterestCube.GetCellFromIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellFromIJK) + * [`RARegionOfInterestCube.GetCellIJK()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellIJK) + * [`RARegionOfInterestCube.GetCellNumberOfVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellNumberOfVertices) + * [`RARegionOfInterestCube.GetCellPointsAsFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellPointsAsFunction) + * [`RARegionOfInterestCube.GetCellVolumeAsArray()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCellVolumeAsArray) + * [`RARegionOfInterestCube.GetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenter) + * [`RARegionOfInterestCube.GetCenterAfterMovement()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCenterAfterMovement) + * [`RARegionOfInterestCube.GetCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurve) + * [`RARegionOfInterestCube.GetCurveNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNames) + * [`RARegionOfInterestCube.GetCurveNamesAssociation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNamesAssociation) + * [`RARegionOfInterestCube.GetElementCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetElementCurve) + * [`RARegionOfInterestCube.GetGeometryQuantity()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryQuantity) + * [`RARegionOfInterestCube.GetGeometryUnit()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryUnit) + * [`RARegionOfInterestCube.GetGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunction) + * [`RARegionOfInterestCube.GetGridFunctionNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunctionNames) + * [`RARegionOfInterestCube.GetMeshColoring()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMeshColoring) + * [`RARegionOfInterestCube.GetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetMotionFrame) + * [`RARegionOfInterestCube.GetNumberOfCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfCells) + * [`RARegionOfInterestCube.GetNumberOfNodes()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumberOfNodes) + * [`RARegionOfInterestCube.GetNumpyCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetNumpyCurve) + * [`RARegionOfInterestCube.GetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientation) + * [`RARegionOfInterestCube.GetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngleAndVector) + * [`RARegionOfInterestCube.GetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromAngles) + * [`RARegionOfInterestCube.GetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOrientationFromBasisVector) + * [`RARegionOfInterestCube.GetOutputVariableValue()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetOutputVariableValue) + * [`RARegionOfInterestCube.GetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetSize) + * [`RARegionOfInterestCube.GetTimeSet()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeSet) + * [`RARegionOfInterestCube.GetTimeStatistics()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStatistics) + * [`RARegionOfInterestCube.GetTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStep) + * [`RARegionOfInterestCube.GetTopologyShape()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTopologyShape) + * [`RARegionOfInterestCube.HasGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.HasGridFunction) + * [`RARegionOfInterestCube.IsCellActive()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IsCellActive) + * [`RARegionOfInterestCube.IterCellVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCellVertices) + * [`RARegionOfInterestCube.IterCells()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCells) + * [`RARegionOfInterestCube.Modified()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.Modified) + * [`RARegionOfInterestCube.RemoveCustomCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomCurve) + * [`RARegionOfInterestCube.RemoveCustomProperty()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveCustomProperty) + * [`RARegionOfInterestCube.RemoveOutputVariable()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveOutputVariable) + * [`RARegionOfInterestCube.RemoveProcess()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.RemoveProcess) + * [`RARegionOfInterestCube.SetCenter()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCenter) + * [`RARegionOfInterestCube.SetCurrentTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetCurrentTimeStep) + * [`RARegionOfInterestCube.SetMotionFrame()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetMotionFrame) + * [`RARegionOfInterestCube.SetOrientation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientation) + * [`RARegionOfInterestCube.SetOrientationFromAngleAndVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngleAndVector) + * [`RARegionOfInterestCube.SetOrientationFromAngles()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromAngles) + * [`RARegionOfInterestCube.SetOrientationFromBasisVector()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetOrientationFromBasisVector) + * [`RARegionOfInterestCube.SetSize()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.SetSize) +* [RARegionOfInterestCylinder](RARegionOfInterestCylinder.md) + * [`RARegionOfInterestCylinder`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder) + * [`RARegionOfInterestCylinder.AddCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCurve) + * [`RARegionOfInterestCylinder.AddCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomCurve) + * [`RARegionOfInterestCylinder.AddCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddCustomProperty) + * [`RARegionOfInterestCylinder.AddGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.AddGridFunction) + * [`RARegionOfInterestCylinder.CreateCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateCurveOutputVariable) + * [`RARegionOfInterestCylinder.CreateGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunction) + * [`RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionArrayOnCells) + * [`RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateGridFunctionStatisticOutputVariable) + * [`RARegionOfInterestCylinder.CreateTransientCurveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.CreateTransientCurveOutputVariable) + * [`RARegionOfInterestCylinder.EditCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomCurve) + * [`RARegionOfInterestCylinder.EditCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.EditCustomProperty) + * [`RARegionOfInterestCylinder.GetActivesArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetActivesArray) + * [`RARegionOfInterestCylinder.GetBoundingBox()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetBoundingBox) + * [`RARegionOfInterestCylinder.GetCellAreaAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellAreaAsArray) + * [`RARegionOfInterestCylinder.GetCellCenterAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellCenterAsArray) + * [`RARegionOfInterestCylinder.GetCellDzAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellDzAsArray) + * [`RARegionOfInterestCylinder.GetCellFromIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellFromIJK) + * [`RARegionOfInterestCylinder.GetCellIJK()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellIJK) + * [`RARegionOfInterestCylinder.GetCellNumberOfVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellNumberOfVertices) + * [`RARegionOfInterestCylinder.GetCellPointsAsFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellPointsAsFunction) + * [`RARegionOfInterestCylinder.GetCellVolumeAsArray()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCellVolumeAsArray) + * [`RARegionOfInterestCylinder.GetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenter) + * [`RARegionOfInterestCylinder.GetCenterAfterMovement()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCenterAfterMovement) + * [`RARegionOfInterestCylinder.GetCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurve) + * [`RARegionOfInterestCylinder.GetCurveNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNames) + * [`RARegionOfInterestCylinder.GetCurveNamesAssociation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation) + * [`RARegionOfInterestCylinder.GetElementCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetElementCurve) + * [`RARegionOfInterestCylinder.GetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFinalAngle) + * [`RARegionOfInterestCylinder.GetGeometryQuantity()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryQuantity) + * [`RARegionOfInterestCylinder.GetGeometryUnit()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryUnit) + * [`RARegionOfInterestCylinder.GetGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunction) + * [`RARegionOfInterestCylinder.GetGridFunctionNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunctionNames) + * [`RARegionOfInterestCylinder.GetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetHeight) + * [`RARegionOfInterestCylinder.GetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInitialAngle) + * [`RARegionOfInterestCylinder.GetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetInternalFactor) + * [`RARegionOfInterestCylinder.GetMeshColoring()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMeshColoring) + * [`RARegionOfInterestCylinder.GetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetMotionFrame) + * [`RARegionOfInterestCylinder.GetNumberOfCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfCells) + * [`RARegionOfInterestCylinder.GetNumberOfNodes()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumberOfNodes) + * [`RARegionOfInterestCylinder.GetNumpyCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetNumpyCurve) + * [`RARegionOfInterestCylinder.GetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientation) + * [`RARegionOfInterestCylinder.GetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngleAndVector) + * [`RARegionOfInterestCylinder.GetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromAngles) + * [`RARegionOfInterestCylinder.GetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOrientationFromBasisVector) + * [`RARegionOfInterestCylinder.GetOutputVariableValue()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetOutputVariableValue) + * [`RARegionOfInterestCylinder.GetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetRadius) + * [`RARegionOfInterestCylinder.GetTimeSet()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeSet) + * [`RARegionOfInterestCylinder.GetTimeStatistics()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStatistics) + * [`RARegionOfInterestCylinder.GetTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStep) + * [`RARegionOfInterestCylinder.GetTopologyShape()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTopologyShape) + * [`RARegionOfInterestCylinder.HasGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.HasGridFunction) + * [`RARegionOfInterestCylinder.IsCellActive()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IsCellActive) + * [`RARegionOfInterestCylinder.IterCellVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCellVertices) + * [`RARegionOfInterestCylinder.IterCells()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCells) + * [`RARegionOfInterestCylinder.Modified()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.Modified) + * [`RARegionOfInterestCylinder.RemoveCustomCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomCurve) + * [`RARegionOfInterestCylinder.RemoveCustomProperty()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveCustomProperty) + * [`RARegionOfInterestCylinder.RemoveOutputVariable()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveOutputVariable) + * [`RARegionOfInterestCylinder.RemoveProcess()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.RemoveProcess) + * [`RARegionOfInterestCylinder.SetCenter()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCenter) + * [`RARegionOfInterestCylinder.SetCurrentTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetCurrentTimeStep) + * [`RARegionOfInterestCylinder.SetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetFinalAngle) + * [`RARegionOfInterestCylinder.SetHeight()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetHeight) + * [`RARegionOfInterestCylinder.SetInitialAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInitialAngle) + * [`RARegionOfInterestCylinder.SetInternalFactor()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetInternalFactor) + * [`RARegionOfInterestCylinder.SetMotionFrame()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetMotionFrame) + * [`RARegionOfInterestCylinder.SetOrientation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientation) + * [`RARegionOfInterestCylinder.SetOrientationFromAngleAndVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngleAndVector) + * [`RARegionOfInterestCylinder.SetOrientationFromAngles()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromAngles) + * [`RARegionOfInterestCylinder.SetOrientationFromBasisVector()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetOrientationFromBasisVector) + * [`RARegionOfInterestCylinder.SetRadius()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.SetRadius) +* [RARegionsOfInterestCollection](RARegionsOfInterestCollection.md) + * [`RARegionsOfInterestCollection`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection) + * [`RARegionsOfInterestCollection.AddCube()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCube) + * [`RARegionsOfInterestCollection.AddCylinder()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.AddCylinder) + * [`RARegionsOfInterestCollection.Clear()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Clear) + * [`RARegionsOfInterestCollection.New()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.New) + * [`RARegionsOfInterestCollection.Remove()`](RARegionsOfInterestCollection.md#generated.RARegionsOfInterestCollection.Remove) +* [RARotation](RARotation.md) + * [`RARotation`](RARotation.md#generated.RARotation) + * [`RARotation.GetAngularAcceleration()`](RARotation.md#generated.RARotation.GetAngularAcceleration) + * [`RARotation.GetInitialAngularVelocity()`](RARotation.md#generated.RARotation.GetInitialAngularVelocity) + * [`RARotation.SetAngularAcceleration()`](RARotation.md#generated.RARotation.SetAngularAcceleration) + * [`RARotation.SetInitialAngularVelocity()`](RARotation.md#generated.RARotation.SetInitialAngularVelocity) +* [RASPHEulerianSolution](RASPHEulerianSolution.md) + * [`RASPHEulerianSolution`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution) + * [`RASPHEulerianSolution.DisableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.DisableEulerianSolution) + * [`RASPHEulerianSolution.EnableEulerianSolution()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.EnableEulerianSolution) + * [`RASPHEulerianSolution.GetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetEulerianSolutionEnabled) + * [`RASPHEulerianSolution.GetMeshColoring()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.GetMeshColoring) + * [`RASPHEulerianSolution.IsEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.IsEulerianSolutionEnabled) + * [`RASPHEulerianSolution.SetEulerianSolutionEnabled()`](RASPHEulerianSolution.md#generated.RASPHEulerianSolution.SetEulerianSolutionEnabled) +* [RASPHSettings](RASPHSettings.md) + * [`RASPHSettings`](RASPHSettings.md#generated.RASPHSettings) + * [`RASPHSettings.AddCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCurve) + * [`RASPHSettings.AddCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.AddCustomCurve) + * [`RASPHSettings.AddCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.AddCustomProperty) + * [`RASPHSettings.AddGridFunction()`](RASPHSettings.md#generated.RASPHSettings.AddGridFunction) + * [`RASPHSettings.CreateCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateCurveOutputVariable) + * [`RASPHSettings.CreateGridFunction()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunction) + * [`RASPHSettings.CreateGridFunctionArrayOnCells()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionArrayOnCells) + * [`RASPHSettings.CreateGridFunctionStatisticOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable) + * [`RASPHSettings.CreateTransientCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateTransientCurveOutputVariable) + * [`RASPHSettings.DisableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.DisableEulerianSolution) + * [`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.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) + * [`RASPHSettings.GetCellCenterAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellCenterAsArray) + * [`RASPHSettings.GetCellDzAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellDzAsArray) + * [`RASPHSettings.GetCellFromIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellFromIJK) + * [`RASPHSettings.GetCellIJK()`](RASPHSettings.md#generated.RASPHSettings.GetCellIJK) + * [`RASPHSettings.GetCellNumberOfVertices()`](RASPHSettings.md#generated.RASPHSettings.GetCellNumberOfVertices) + * [`RASPHSettings.GetCellPointsAsFunction()`](RASPHSettings.md#generated.RASPHSettings.GetCellPointsAsFunction) + * [`RASPHSettings.GetCellVolumeAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellVolumeAsArray) + * [`RASPHSettings.GetClearyFactor()`](RASPHSettings.md#generated.RASPHSettings.GetClearyFactor) + * [`RASPHSettings.GetCurve()`](RASPHSettings.md#generated.RASPHSettings.GetCurve) + * [`RASPHSettings.GetCurveNames()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNames) + * [`RASPHSettings.GetCurveNamesAssociation()`](RASPHSettings.md#generated.RASPHSettings.GetCurveNamesAssociation) + * [`RASPHSettings.GetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevMinus) + * [`RASPHSettings.GetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.GetDensityDevPlus) + * [`RASPHSettings.GetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.GetDensityRelativeErrorTolerance) + * [`RASPHSettings.GetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.GetDissFactor) + * [`RASPHSettings.GetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorNorm) + * [`RASPHSettings.GetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorTang) + * [`RASPHSettings.GetElementCurve()`](RASPHSettings.md#generated.RASPHSettings.GetElementCurve) + * [`RASPHSettings.GetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEulerianSolutionEnabled) + * [`RASPHSettings.GetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.GetFluidMaterial) + * [`RASPHSettings.GetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit) + * [`RASPHSettings.GetGeometryQuantity()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryQuantity) + * [`RASPHSettings.GetGeometryUnit()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryUnit) + * [`RASPHSettings.GetGridFunction()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunction) + * [`RASPHSettings.GetGridFunctionNames()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunctionNames) + * [`RASPHSettings.GetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetKernelDistFactor) + * [`RASPHSettings.GetKernelType()`](RASPHSettings.md#generated.RASPHSettings.GetKernelType) + * [`RASPHSettings.GetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.GetLimitTurbulentViscosity) + * [`RASPHSettings.GetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumExpectedVelocity) + * [`RASPHSettings.GetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.GetMaximumNumberOfIterations) + * [`RASPHSettings.GetMeshColoring()`](RASPHSettings.md#generated.RASPHSettings.GetMeshColoring) + * [`RASPHSettings.GetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetMinDistFactor) + * [`RASPHSettings.GetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.GetNegativePressureFactor) + * [`RASPHSettings.GetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumCellSteps) + * [`RASPHSettings.GetNumberOfCells()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfCells) + * [`RASPHSettings.GetNumberOfNodes()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfNodes) + * [`RASPHSettings.GetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.GetNumberOfSteps) + * [`RASPHSettings.GetNumpyCurve()`](RASPHSettings.md#generated.RASPHSettings.GetNumpyCurve) + * [`RASPHSettings.GetOutputVariableValue()`](RASPHSettings.md#generated.RASPHSettings.GetOutputVariableValue) + * [`RASPHSettings.GetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.GetPosCorrectionType) + * [`RASPHSettings.GetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.GetPressureDeg) + * [`RASPHSettings.GetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetPressureUnderRelaxationFactor) + * [`RASPHSettings.GetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) + * [`RASPHSettings.GetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) + * [`RASPHSettings.GetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.GetShiftingFactor) + * [`RASPHSettings.GetSize()`](RASPHSettings.md#generated.RASPHSettings.GetSize) + * [`RASPHSettings.GetSolver()`](RASPHSettings.md#generated.RASPHSettings.GetSolver) + * [`RASPHSettings.GetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.GetSolverModel) + * [`RASPHSettings.GetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.GetSoundSpeed) + * [`RASPHSettings.GetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityDegree) + * [`RASPHSettings.GetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityNegFactor) + * [`RASPHSettings.GetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStabilityPosFactor) + * [`RASPHSettings.GetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.GetStiffFactor) + * [`RASPHSettings.GetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryAngle) + * [`RASPHSettings.GetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionBoundaryFraction) + * [`RASPHSettings.GetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionCoefficient) + * [`RASPHSettings.GetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.GetSurfaceTensionType) + * [`RASPHSettings.GetTimeSet()`](RASPHSettings.md#generated.RASPHSettings.GetTimeSet) + * [`RASPHSettings.GetTimeStatistics()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStatistics) + * [`RASPHSettings.GetTimeStep()`](RASPHSettings.md#generated.RASPHSettings.GetTimeStep) + * [`RASPHSettings.GetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.GetTimestepFactor) + * [`RASPHSettings.GetTopologyShape()`](RASPHSettings.md#generated.RASPHSettings.GetTopologyShape) + * [`RASPHSettings.GetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.GetTurbDistanceFraction) + * [`RASPHSettings.GetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulenceType) + * [`RASPHSettings.GetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentPrandtl) + * [`RASPHSettings.GetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.GetTurbulentViscosityMaximumRatio) + * [`RASPHSettings.GetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.GetUpdateCoupledDensity) + * [`RASPHSettings.GetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.GetUseParticlesNeighborsList) + * [`RASPHSettings.GetValidKernelTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidKernelTypeValues) + * [`RASPHSettings.GetValidPosCorrectionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidPosCorrectionTypeValues) + * [`RASPHSettings.GetValidSolverModelValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSolverModelValues) + * [`RASPHSettings.GetValidSurfaceTensionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSurfaceTensionTypeValues) + * [`RASPHSettings.GetValidTurbulenceTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidTurbulenceTypeValues) + * [`RASPHSettings.GetValidViscosityTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscosityTypeValues) + * [`RASPHSettings.GetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.GetViscosityType) + * [`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.IsShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) + * [`RASPHSettings.IsShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) + * [`RASPHSettings.IterCellVertices()`](RASPHSettings.md#generated.RASPHSettings.IterCellVertices) + * [`RASPHSettings.IterCells()`](RASPHSettings.md#generated.RASPHSettings.IterCells) + * [`RASPHSettings.Modified()`](RASPHSettings.md#generated.RASPHSettings.Modified) + * [`RASPHSettings.RemoveCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.RemoveCustomCurve) + * [`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) + * [`RASPHSettings.SetDensityDevMinus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevMinus) + * [`RASPHSettings.SetDensityDevPlus()`](RASPHSettings.md#generated.RASPHSettings.SetDensityDevPlus) + * [`RASPHSettings.SetDensityRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.SetDensityRelativeErrorTolerance) + * [`RASPHSettings.SetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.SetDissFactor) + * [`RASPHSettings.SetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorNorm) + * [`RASPHSettings.SetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorTang) + * [`RASPHSettings.SetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEulerianSolutionEnabled) + * [`RASPHSettings.SetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.SetFluidMaterial) + * [`RASPHSettings.SetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit) + * [`RASPHSettings.SetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetKernelDistFactor) + * [`RASPHSettings.SetKernelType()`](RASPHSettings.md#generated.RASPHSettings.SetKernelType) + * [`RASPHSettings.SetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.SetLimitTurbulentViscosity) + * [`RASPHSettings.SetMaximumExpectedVelocity()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumExpectedVelocity) + * [`RASPHSettings.SetMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.SetMaximumNumberOfIterations) + * [`RASPHSettings.SetMinDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetMinDistFactor) + * [`RASPHSettings.SetNegativePressureFactor()`](RASPHSettings.md#generated.RASPHSettings.SetNegativePressureFactor) + * [`RASPHSettings.SetNumCellSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumCellSteps) + * [`RASPHSettings.SetNumberOfSteps()`](RASPHSettings.md#generated.RASPHSettings.SetNumberOfSteps) + * [`RASPHSettings.SetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.SetPosCorrectionType) + * [`RASPHSettings.SetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.SetPressureDeg) + * [`RASPHSettings.SetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetPressureUnderRelaxationFactor) + * [`RASPHSettings.SetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) + * [`RASPHSettings.SetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) + * [`RASPHSettings.SetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.SetShiftingFactor) + * [`RASPHSettings.SetSize()`](RASPHSettings.md#generated.RASPHSettings.SetSize) + * [`RASPHSettings.SetSolver()`](RASPHSettings.md#generated.RASPHSettings.SetSolver) + * [`RASPHSettings.SetSolverModel()`](RASPHSettings.md#generated.RASPHSettings.SetSolverModel) + * [`RASPHSettings.SetSoundSpeed()`](RASPHSettings.md#generated.RASPHSettings.SetSoundSpeed) + * [`RASPHSettings.SetStabilityDegree()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityDegree) + * [`RASPHSettings.SetStabilityNegFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityNegFactor) + * [`RASPHSettings.SetStabilityPosFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStabilityPosFactor) + * [`RASPHSettings.SetStiffFactor()`](RASPHSettings.md#generated.RASPHSettings.SetStiffFactor) + * [`RASPHSettings.SetSurfaceTensionBoundaryAngle()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryAngle) + * [`RASPHSettings.SetSurfaceTensionBoundaryFraction()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionBoundaryFraction) + * [`RASPHSettings.SetSurfaceTensionCoefficient()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionCoefficient) + * [`RASPHSettings.SetSurfaceTensionType()`](RASPHSettings.md#generated.RASPHSettings.SetSurfaceTensionType) + * [`RASPHSettings.SetTimestepFactor()`](RASPHSettings.md#generated.RASPHSettings.SetTimestepFactor) + * [`RASPHSettings.SetTurbDistanceFraction()`](RASPHSettings.md#generated.RASPHSettings.SetTurbDistanceFraction) + * [`RASPHSettings.SetTurbulenceType()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulenceType) + * [`RASPHSettings.SetTurbulentPrandtl()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentPrandtl) + * [`RASPHSettings.SetTurbulentViscosityMaximumRatio()`](RASPHSettings.md#generated.RASPHSettings.SetTurbulentViscosityMaximumRatio) + * [`RASPHSettings.SetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.SetUpdateCoupledDensity) + * [`RASPHSettings.SetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.SetUseParticlesNeighborsList) + * [`RASPHSettings.SetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.SetViscosityType) + * [`RASPHSettings.SetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.SetXsphFactor) +* [RASimulatorRun](RASimulatorRun.md) + * [`RASimulatorRun`](RASimulatorRun.md#generated.RASimulatorRun) + * [`RASimulatorRun.AddCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCurve) + * [`RASimulatorRun.AddCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomCurve) + * [`RASimulatorRun.AddCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.AddCustomProperty) + * [`RASimulatorRun.AddGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.AddGridFunction) + * [`RASimulatorRun.CreateCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateCurveOutputVariable) + * [`RASimulatorRun.CreateGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunction) + * [`RASimulatorRun.CreateGridFunctionArrayOnCells()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionArrayOnCells) + * [`RASimulatorRun.CreateGridFunctionStatisticOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateGridFunctionStatisticOutputVariable) + * [`RASimulatorRun.CreateTransientCurveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.CreateTransientCurveOutputVariable) + * [`RASimulatorRun.DisableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.DisableCompressedFile) + * [`RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.DisableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.DisableFEMForces) + * [`RASimulatorRun.DisableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.DisableHtcCalculator) + * [`RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.DisableMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.DisableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.DisableNegateInitialOverlaps) + * [`RASimulatorRun.DisableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.DisableSortingDistanceFactor) + * [`RASimulatorRun.DisableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.DisableUse3RdPowerForCfdCgm) + * [`RASimulatorRun.EditCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomCurve) + * [`RASimulatorRun.EditCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.EditCustomProperty) + * [`RASimulatorRun.EnableCompressedFile()`](RASimulatorRun.md#generated.RASimulatorRun.EnableCompressedFile) + * [`RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.EnableFEMForces()`](RASimulatorRun.md#generated.RASimulatorRun.EnableFEMForces) + * [`RASimulatorRun.EnableHtcCalculator()`](RASimulatorRun.md#generated.RASimulatorRun.EnableHtcCalculator) + * [`RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.EnableMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.EnableNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.EnableNegateInitialOverlaps) + * [`RASimulatorRun.EnableSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.EnableSortingDistanceFactor) + * [`RASimulatorRun.EnableUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.EnableUse3RdPowerForCfdCgm) + * [`RASimulatorRun.GetActivesArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetActivesArray) + * [`RASimulatorRun.GetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetArraysGrowthRate) + * [`RASimulatorRun.GetAvailableModulesOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableModulesOutputProperties) + * [`RASimulatorRun.GetAvailableOutputRootProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRootProperties) + * [`RASimulatorRun.GetAvailableOutputRoots()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableOutputRoots) + * [`RASimulatorRun.GetAvailableStandardOutputProperties()`](RASimulatorRun.md#generated.RASimulatorRun.GetAvailableStandardOutputProperties) + * [`RASimulatorRun.GetBoundingBox()`](RASimulatorRun.md#generated.RASimulatorRun.GetBoundingBox) + * [`RASimulatorRun.GetBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageDelayAfterRelease) + * [`RASimulatorRun.GetBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageOverlapFactor) + * [`RASimulatorRun.GetBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetBreakageStart) + * [`RASimulatorRun.GetCellAreaAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellAreaAsArray) + * [`RASimulatorRun.GetCellCenterAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellCenterAsArray) + * [`RASimulatorRun.GetCellDzAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellDzAsArray) + * [`RASimulatorRun.GetCellFromIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellFromIJK) + * [`RASimulatorRun.GetCellIJK()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellIJK) + * [`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) + * [`RASimulatorRun.GetCurveNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNames) + * [`RASimulatorRun.GetCurveNamesAssociation()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurveNamesAssociation) + * [`RASimulatorRun.GetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.GetDeformableMassMatrixType) + * [`RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries) + * [`RASimulatorRun.GetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetDragLimiterFactor) + * [`RASimulatorRun.GetElementCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetElementCurve) + * [`RASimulatorRun.GetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetFixedTimestep) + * [`RASimulatorRun.GetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.GetFluentOutputsMultiplier) + * [`RASimulatorRun.GetGeometryQuantity()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryQuantity) + * [`RASimulatorRun.GetGeometryUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryUnit) + * [`RASimulatorRun.GetGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunction) + * [`RASimulatorRun.GetGridFunctionNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunctionNames) + * [`RASimulatorRun.GetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.GetJointElasticRatio) + * [`RASimulatorRun.GetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.GetLinearHystDamp) + * [`RASimulatorRun.GetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.GetLoadingNSteps) + * [`RASimulatorRun.GetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.GetMaximumNumberOfIterations) + * [`RASimulatorRun.GetMeshColoring()`](RASimulatorRun.md#generated.RASimulatorRun.GetMeshColoring) + * [`RASimulatorRun.GetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumLengthDeformationTolerance) + * [`RASimulatorRun.GetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetMinimumVolumeTolerance) + * [`RASimulatorRun.GetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertiesData) + * [`RASimulatorRun.GetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertyEnabled) + * [`RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.GetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.GetMultiGpuSlicingDirection) + * [`RASimulatorRun.GetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.GetNegateInitialOverlaps) + * [`RASimulatorRun.GetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetNeighborSearchModel) + * [`RASimulatorRun.GetNumberOfCells()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfCells) + * [`RASimulatorRun.GetNumberOfNodes()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfNodes) + * [`RASimulatorRun.GetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumberOfProcessors) + * [`RASimulatorRun.GetNumpyCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetNumpyCurve) + * [`RASimulatorRun.GetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputPropertyEnabled) + * [`RASimulatorRun.GetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputRootEnabled) + * [`RASimulatorRun.GetOutputVariableValue()`](RASimulatorRun.md#generated.RASimulatorRun.GetOutputVariableValue) + * [`RASimulatorRun.GetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverRelaxationCoefficient) + * [`RASimulatorRun.GetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverlapParticlesDelay) + * [`RASimulatorRun.GetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.GetParticleSizeLimitForReordering) + * [`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) + * [`RASimulatorRun.GetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetStandardOutputPropertyEnabled) + * [`RASimulatorRun.GetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.GetSuccessiveOverRelaxationTolerance) + * [`RASimulatorRun.GetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpu) + * [`RASimulatorRun.GetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.GetTargetGpus) + * [`RASimulatorRun.GetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeInterval) + * [`RASimulatorRun.GetTimeSet()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeSet) + * [`RASimulatorRun.GetTimeStatistics()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStatistics) + * [`RASimulatorRun.GetTimeStep()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimeStep) + * [`RASimulatorRun.GetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetTimestepModel) + * [`RASimulatorRun.GetTopologyShape()`](RASimulatorRun.md#generated.RASimulatorRun.GetTopologyShape) + * [`RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2CellVolumeFractionUpdateApproach) + * [`RASimulatorRun.GetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse2023R2SourceTermsApproach) + * [`RASimulatorRun.GetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.GetUse3RdPowerForCfdCgm) + * [`RASimulatorRun.GetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseArraysGrowthRate) + * [`RASimulatorRun.GetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseBreakageOverlapFactor) + * [`RASimulatorRun.GetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseCompressedFiles) + * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticles) + * [`RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseContactNeighboringDistanceBetweenParticlesAndTriangles) + * [`RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.GetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDragLimiterFactor) + * [`RASimulatorRun.GetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseFixedTimestep) + * [`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.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.GetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateInterval) + * [`RASimulatorRun.GetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearStart) + * [`RASimulatorRun.HasFEMForcesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.HasFEMForcesEnabled) + * [`RASimulatorRun.HasGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.HasGridFunction) + * [`RASimulatorRun.HasHtcCalculatedData()`](RASimulatorRun.md#generated.RASimulatorRun.HasHtcCalculatedData) + * [`RASimulatorRun.IsCellActive()`](RASimulatorRun.md#generated.RASimulatorRun.IsCellActive) + * [`RASimulatorRun.IsCompressedFileEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsCompressedFileEnabled) + * [`RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled) + * [`RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsMoveCfdCellsWithRockyBoundariesEnabled) + * [`RASimulatorRun.IsNegateInitialOverlapsEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsNegateInitialOverlapsEnabled) + * [`RASimulatorRun.IsSortingDistanceFactorEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsSortingDistanceFactorEnabled) + * [`RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.IsUse3RdPowerForCfdCgmEnabled) + * [`RASimulatorRun.IterCellVertices()`](RASimulatorRun.md#generated.RASimulatorRun.IterCellVertices) + * [`RASimulatorRun.IterCells()`](RASimulatorRun.md#generated.RASimulatorRun.IterCells) + * [`RASimulatorRun.Modified()`](RASimulatorRun.md#generated.RASimulatorRun.Modified) + * [`RASimulatorRun.RemoveCustomCurve()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomCurve) + * [`RASimulatorRun.RemoveCustomProperty()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveCustomProperty) + * [`RASimulatorRun.RemoveOutputVariable()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveOutputVariable) + * [`RASimulatorRun.RemoveProcess()`](RASimulatorRun.md#generated.RASimulatorRun.RemoveProcess) + * [`RASimulatorRun.RestoreOutputPropertiesDefaults()`](RASimulatorRun.md#generated.RASimulatorRun.RestoreOutputPropertiesDefaults) + * [`RASimulatorRun.SetArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetArraysGrowthRate) + * [`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) + * [`RASimulatorRun.SetDeformableMassMatrixType()`](RASimulatorRun.md#generated.RASimulatorRun.SetDeformableMassMatrixType) + * [`RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetDisableTrianglesOnPeriodicBoundaries) + * [`RASimulatorRun.SetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetDragLimiterFactor) + * [`RASimulatorRun.SetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetFixedTimestep) + * [`RASimulatorRun.SetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.SetFluentOutputsMultiplier) + * [`RASimulatorRun.SetJointElasticRatio()`](RASimulatorRun.md#generated.RASimulatorRun.SetJointElasticRatio) + * [`RASimulatorRun.SetLinearHystDamp()`](RASimulatorRun.md#generated.RASimulatorRun.SetLinearHystDamp) + * [`RASimulatorRun.SetLoadingNSteps()`](RASimulatorRun.md#generated.RASimulatorRun.SetLoadingNSteps) + * [`RASimulatorRun.SetMaximumNumberOfIterations()`](RASimulatorRun.md#generated.RASimulatorRun.SetMaximumNumberOfIterations) + * [`RASimulatorRun.SetMinimumLengthDeformationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumLengthDeformationTolerance) + * [`RASimulatorRun.SetMinimumVolumeTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetMinimumVolumeTolerance) + * [`RASimulatorRun.SetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertiesData) + * [`RASimulatorRun.SetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertyEnabled) + * [`RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.SetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.SetMultiGpuSlicingDirection) + * [`RASimulatorRun.SetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.SetNegateInitialOverlaps) + * [`RASimulatorRun.SetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetNeighborSearchModel) + * [`RASimulatorRun.SetNumberOfProcessors()`](RASimulatorRun.md#generated.RASimulatorRun.SetNumberOfProcessors) + * [`RASimulatorRun.SetOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputPropertyEnabled) + * [`RASimulatorRun.SetOutputRootEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetOutputRootEnabled) + * [`RASimulatorRun.SetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverRelaxationCoefficient) + * [`RASimulatorRun.SetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverlapParticlesDelay) + * [`RASimulatorRun.SetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.SetParticleSizeLimitForReordering) + * [`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) + * [`RASimulatorRun.SetStandardOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetStandardOutputPropertyEnabled) + * [`RASimulatorRun.SetSuccessiveOverRelaxationTolerance()`](RASimulatorRun.md#generated.RASimulatorRun.SetSuccessiveOverRelaxationTolerance) + * [`RASimulatorRun.SetTargetGpu()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpu) + * [`RASimulatorRun.SetTargetGpus()`](RASimulatorRun.md#generated.RASimulatorRun.SetTargetGpus) + * [`RASimulatorRun.SetTimeConfiguration()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeConfiguration) + * [`RASimulatorRun.SetTimeInterval()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimeInterval) + * [`RASimulatorRun.SetTimestepModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetTimestepModel) + * [`RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2CellVolumeFractionUpdateApproach) + * [`RASimulatorRun.SetUse2023R2SourceTermsApproach()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse2023R2SourceTermsApproach) + * [`RASimulatorRun.SetUse3RdPowerForCfdCgm()`](RASimulatorRun.md#generated.RASimulatorRun.SetUse3RdPowerForCfdCgm) + * [`RASimulatorRun.SetUseArraysGrowthRate()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseArraysGrowthRate) + * [`RASimulatorRun.SetUseBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseBreakageOverlapFactor) + * [`RASimulatorRun.SetUseCompressedFiles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseCompressedFiles) + * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticles) + * [`RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseContactNeighboringDistanceBetweenParticlesAndTriangles) + * [`RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) + * [`RASimulatorRun.SetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDragLimiterFactor) + * [`RASimulatorRun.SetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseFixedTimestep) + * [`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) + * [`RASizeDistribution`](RASizeDistribution.md#generated.RASizeDistribution) + * [`RASizeDistribution.GetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.GetCumulativePercentage) + * [`RASizeDistribution.GetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.GetScaleFactor) + * [`RASizeDistribution.GetSize()`](RASizeDistribution.md#generated.RASizeDistribution.GetSize) + * [`RASizeDistribution.SetCumulativePercentage()`](RASizeDistribution.md#generated.RASizeDistribution.SetCumulativePercentage) + * [`RASizeDistribution.SetScaleFactor()`](RASizeDistribution.md#generated.RASizeDistribution.SetScaleFactor) + * [`RASizeDistribution.SetSize()`](RASizeDistribution.md#generated.RASizeDistribution.SetSize) +* [RASizeDistributionList](RASizeDistributionList.md) + * [`RASizeDistributionList`](RASizeDistributionList.md#generated.RASizeDistributionList) + * [`RASizeDistributionList.Clear()`](RASizeDistributionList.md#generated.RASizeDistributionList.Clear) + * [`RASizeDistributionList.GetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetCgmScaleFactor) + * [`RASizeDistributionList.GetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetSizeType) + * [`RASizeDistributionList.GetValidSizeTypeValues()`](RASizeDistributionList.md#generated.RASizeDistributionList.GetValidSizeTypeValues) + * [`RASizeDistributionList.New()`](RASizeDistributionList.md#generated.RASizeDistributionList.New) + * [`RASizeDistributionList.Remove()`](RASizeDistributionList.md#generated.RASizeDistributionList.Remove) + * [`RASizeDistributionList.SetCgmScaleFactor()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetCgmScaleFactor) + * [`RASizeDistributionList.SetSizeType()`](RASizeDistributionList.md#generated.RASizeDistributionList.SetSizeType) +* [RASolidMaterial](RASolidMaterial.md) + * [`RASolidMaterial`](RASolidMaterial.md#generated.RASolidMaterial) + * [`RASolidMaterial.GetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkDensity) + * [`RASolidMaterial.GetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkSolidFraction) + * [`RASolidMaterial.GetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetCurrentDensity) + * [`RASolidMaterial.GetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetDensity) + * [`RASolidMaterial.GetModuleProperties()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperties) + * [`RASolidMaterial.GetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetModuleProperty) + * [`RASolidMaterial.GetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.GetPoissonRatio) + * [`RASolidMaterial.GetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.GetSpecificHeat) + * [`RASolidMaterial.GetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.GetThermalConductivity) + * [`RASolidMaterial.GetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.GetUseBulkDensity) + * [`RASolidMaterial.GetValidOptionsForModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.GetValidOptionsForModuleProperty) + * [`RASolidMaterial.GetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.GetYoungsModulus) + * [`RASolidMaterial.SetBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkDensity) + * [`RASolidMaterial.SetBulkSolidFraction()`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkSolidFraction) + * [`RASolidMaterial.SetCurrentDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetCurrentDensity) + * [`RASolidMaterial.SetDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetDensity) + * [`RASolidMaterial.SetModuleProperty()`](RASolidMaterial.md#generated.RASolidMaterial.SetModuleProperty) + * [`RASolidMaterial.SetPoissonRatio()`](RASolidMaterial.md#generated.RASolidMaterial.SetPoissonRatio) + * [`RASolidMaterial.SetSpecificHeat()`](RASolidMaterial.md#generated.RASolidMaterial.SetSpecificHeat) + * [`RASolidMaterial.SetThermalConductivity()`](RASolidMaterial.md#generated.RASolidMaterial.SetThermalConductivity) + * [`RASolidMaterial.SetUseBulkDensity()`](RASolidMaterial.md#generated.RASolidMaterial.SetUseBulkDensity) + * [`RASolidMaterial.SetYoungsModulus()`](RASolidMaterial.md#generated.RASolidMaterial.SetYoungsModulus) +* [RASpringDashpotForce](RASpringDashpotForce.md) + * [`RASpringDashpotForce`](RASpringDashpotForce.md#generated.RASpringDashpotForce) + * [`RASpringDashpotForce.GetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDashpotCoefficient) + * [`RASpringDashpotForce.GetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetDirection) + * [`RASpringDashpotForce.GetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetSpringCoefficient) + * [`RASpringDashpotForce.GetValidDirectionValues()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.GetValidDirectionValues) + * [`RASpringDashpotForce.SetDashpotCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDashpotCoefficient) + * [`RASpringDashpotForce.SetDirection()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetDirection) + * [`RASpringDashpotForce.SetSpringCoefficient()`](RASpringDashpotForce.md#generated.RASpringDashpotForce.SetSpringCoefficient) +* [RASpringDashpotMoment](RASpringDashpotMoment.md) + * [`RASpringDashpotMoment`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment) + * [`RASpringDashpotMoment.GetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDashpotCoefficient) + * [`RASpringDashpotMoment.GetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetDirection) + * [`RASpringDashpotMoment.GetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetSpringCoefficient) + * [`RASpringDashpotMoment.GetValidDirectionValues()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.GetValidDirectionValues) + * [`RASpringDashpotMoment.SetDashpotCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDashpotCoefficient) + * [`RASpringDashpotMoment.SetDirection()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetDirection) + * [`RASpringDashpotMoment.SetSpringCoefficient()`](RASpringDashpotMoment.md#generated.RASpringDashpotMoment.SetSpringCoefficient) +* [RAStreamlinesUserProcess](RAStreamlinesUserProcess.md) + * [`RAStreamlinesUserProcess`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess) + * [`RAStreamlinesUserProcess.AddCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCurve) + * [`RAStreamlinesUserProcess.AddCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomCurve) + * [`RAStreamlinesUserProcess.AddCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddCustomProperty) + * [`RAStreamlinesUserProcess.AddGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.AddGridFunction) + * [`RAStreamlinesUserProcess.CreateCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateCurveOutputVariable) + * [`RAStreamlinesUserProcess.CreateGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunction) + * [`RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionArrayOnCells) + * [`RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateGridFunctionStatisticOutputVariable) + * [`RAStreamlinesUserProcess.CreateTransientCurveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.CreateTransientCurveOutputVariable) + * [`RAStreamlinesUserProcess.EditCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomCurve) + * [`RAStreamlinesUserProcess.EditCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.EditCustomProperty) + * [`RAStreamlinesUserProcess.GetActivesArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetActivesArray) + * [`RAStreamlinesUserProcess.GetAvailableSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetAvailableSources) + * [`RAStreamlinesUserProcess.GetBoundingBox()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetBoundingBox) + * [`RAStreamlinesUserProcess.GetCellAreaAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellAreaAsArray) + * [`RAStreamlinesUserProcess.GetCellCenterAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellCenterAsArray) + * [`RAStreamlinesUserProcess.GetCellDzAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellDzAsArray) + * [`RAStreamlinesUserProcess.GetCellFromIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellFromIJK) + * [`RAStreamlinesUserProcess.GetCellIJK()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellIJK) + * [`RAStreamlinesUserProcess.GetCellNumberOfVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellNumberOfVertices) + * [`RAStreamlinesUserProcess.GetCellPointsAsFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellPointsAsFunction) + * [`RAStreamlinesUserProcess.GetCellVolumeAsArray()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCellVolumeAsArray) + * [`RAStreamlinesUserProcess.GetCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurve) + * [`RAStreamlinesUserProcess.GetCurveNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNames) + * [`RAStreamlinesUserProcess.GetCurveNamesAssociation()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation) + * [`RAStreamlinesUserProcess.GetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetDirection) + * [`RAStreamlinesUserProcess.GetElementCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetElementCurve) + * [`RAStreamlinesUserProcess.GetGeometryQuantity()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryQuantity) + * [`RAStreamlinesUserProcess.GetGeometryUnit()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryUnit) + * [`RAStreamlinesUserProcess.GetGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunction) + * [`RAStreamlinesUserProcess.GetGridFunctionNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunctionNames) + * [`RAStreamlinesUserProcess.GetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMaximumLength) + * [`RAStreamlinesUserProcess.GetMeshColoring()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetMeshColoring) + * [`RAStreamlinesUserProcess.GetNumberOfCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfCells) + * [`RAStreamlinesUserProcess.GetNumberOfNodes()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfNodes) + * [`RAStreamlinesUserProcess.GetNumberOfParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumberOfParticles) + * [`RAStreamlinesUserProcess.GetNumpyCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetNumpyCurve) + * [`RAStreamlinesUserProcess.GetOutputVariableValue()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetOutputVariableValue) + * [`RAStreamlinesUserProcess.GetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSources) + * [`RAStreamlinesUserProcess.GetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetSpacing) + * [`RAStreamlinesUserProcess.GetTimeSet()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeSet) + * [`RAStreamlinesUserProcess.GetTimeStatistics()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStatistics) + * [`RAStreamlinesUserProcess.GetTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStep) + * [`RAStreamlinesUserProcess.GetTopologyShape()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTopologyShape) + * [`RAStreamlinesUserProcess.GetValidDirectionValues()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetValidDirectionValues) + * [`RAStreamlinesUserProcess.HasGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.HasGridFunction) + * [`RAStreamlinesUserProcess.IsCellActive()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IsCellActive) + * [`RAStreamlinesUserProcess.IterCellVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCellVertices) + * [`RAStreamlinesUserProcess.IterCells()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCells) + * [`RAStreamlinesUserProcess.IterParticles()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterParticles) + * [`RAStreamlinesUserProcess.Modified()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.Modified) + * [`RAStreamlinesUserProcess.RemoveCustomCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomCurve) + * [`RAStreamlinesUserProcess.RemoveCustomProperty()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveCustomProperty) + * [`RAStreamlinesUserProcess.RemoveOutputVariable()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveOutputVariable) + * [`RAStreamlinesUserProcess.RemoveProcess()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.RemoveProcess) + * [`RAStreamlinesUserProcess.SetCurrentTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetCurrentTimeStep) + * [`RAStreamlinesUserProcess.SetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetDirection) + * [`RAStreamlinesUserProcess.SetMaximumLength()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetMaximumLength) + * [`RAStreamlinesUserProcess.SetSources()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSources) + * [`RAStreamlinesUserProcess.SetSpacing()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.SetSpacing) + * [`RAStreamlinesUserProcess.UpdateStreamlines()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.UpdateStreamlines) +* [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) + * [`RAStudy.GetAirFlow()`](RAStudy.md#generated.RAStudy.GetAirFlow) + * [`RAStudy.GetCFDCoupling()`](RAStudy.md#generated.RAStudy.GetCFDCoupling) + * [`RAStudy.GetCalculations()`](RAStudy.md#generated.RAStudy.GetCalculations) + * [`RAStudy.GetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.GetCollectForcesForFemAnalysis) + * [`RAStudy.GetContactData()`](RAStudy.md#generated.RAStudy.GetContactData) + * [`RAStudy.GetCustomerName()`](RAStudy.md#generated.RAStudy.GetCustomerName) + * [`RAStudy.GetDescription()`](RAStudy.md#generated.RAStudy.GetDescription) + * [`RAStudy.GetDomainSettings()`](RAStudy.md#generated.RAStudy.GetDomainSettings) + * [`RAStudy.GetElementCurve()`](RAStudy.md#generated.RAStudy.GetElementCurve) + * [`RAStudy.GetExportToolkit()`](RAStudy.md#generated.RAStudy.GetExportToolkit) + * [`RAStudy.GetFEMForcesAnalysisModules()`](RAStudy.md#generated.RAStudy.GetFEMForcesAnalysisModules) + * [`RAStudy.GetGeometry()`](RAStudy.md#generated.RAStudy.GetGeometry) + * [`RAStudy.GetGeometryCollection()`](RAStudy.md#generated.RAStudy.GetGeometryCollection) + * [`RAStudy.GetInletsOutletsCollection()`](RAStudy.md#generated.RAStudy.GetInletsOutletsCollection) + * [`RAStudy.GetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.GetIntraParticleCollisionStatistics) + * [`RAStudy.GetJointsData()`](RAStudy.md#generated.RAStudy.GetJointsData) + * [`RAStudy.GetMaterialCollection()`](RAStudy.md#generated.RAStudy.GetMaterialCollection) + * [`RAStudy.GetMaterialsInteractionCollection()`](RAStudy.md#generated.RAStudy.GetMaterialsInteractionCollection) + * [`RAStudy.GetMeshedParticlesUpscalingEnabled()`](RAStudy.md#generated.RAStudy.GetMeshedParticlesUpscalingEnabled) + * [`RAStudy.GetModuleCollection()`](RAStudy.md#generated.RAStudy.GetModuleCollection) + * [`RAStudy.GetMotionFrameSource()`](RAStudy.md#generated.RAStudy.GetMotionFrameSource) + * [`RAStudy.GetParticleCollection()`](RAStudy.md#generated.RAStudy.GetParticleCollection) + * [`RAStudy.GetParticleInput()`](RAStudy.md#generated.RAStudy.GetParticleInput) + * [`RAStudy.GetParticles()`](RAStudy.md#generated.RAStudy.GetParticles) + * [`RAStudy.GetPhysics()`](RAStudy.md#generated.RAStudy.GetPhysics) + * [`RAStudy.GetPointCloudCollection()`](RAStudy.md#generated.RAStudy.GetPointCloudCollection) + * [`RAStudy.GetProgress()`](RAStudy.md#generated.RAStudy.GetProgress) + * [`RAStudy.GetSimulatorRun()`](RAStudy.md#generated.RAStudy.GetSimulatorRun) + * [`RAStudy.GetSolver()`](RAStudy.md#generated.RAStudy.GetSolver) + * [`RAStudy.GetStatus()`](RAStudy.md#generated.RAStudy.GetStatus) + * [`RAStudy.GetSurfaceFromFilename()`](RAStudy.md#generated.RAStudy.GetSurfaceFromFilename) + * [`RAStudy.GetTimeSet()`](RAStudy.md#generated.RAStudy.GetTimeSet) + * [`RAStudy.GetWallFromFilename()`](RAStudy.md#generated.RAStudy.GetWallFromFilename) + * [`RAStudy.HasCalculatedHTC()`](RAStudy.md#generated.RAStudy.HasCalculatedHTC) + * [`RAStudy.HasResults()`](RAStudy.md#generated.RAStudy.HasResults) + * [`RAStudy.ImportSurface()`](RAStudy.md#generated.RAStudy.ImportSurface) + * [`RAStudy.ImportSystemCouplingWall()`](RAStudy.md#generated.RAStudy.ImportSystemCouplingWall) + * [`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) + * [`RAStudy.SetCollectForcesForFemAnalysis()`](RAStudy.md#generated.RAStudy.SetCollectForcesForFemAnalysis) + * [`RAStudy.SetCustomerName()`](RAStudy.md#generated.RAStudy.SetCustomerName) + * [`RAStudy.SetDescription()`](RAStudy.md#generated.RAStudy.SetDescription) + * [`RAStudy.SetHTCCalculatorEnabled()`](RAStudy.md#generated.RAStudy.SetHTCCalculatorEnabled) + * [`RAStudy.SetIntraParticleCollisionStatistics()`](RAStudy.md#generated.RAStudy.SetIntraParticleCollisionStatistics) + * [`RAStudy.SetVariable()`](RAStudy.md#generated.RAStudy.SetVariable) + * [`RAStudy.StartSimulation()`](RAStudy.md#generated.RAStudy.StartSimulation) + * [`RAStudy.StopSimulation()`](RAStudy.md#generated.RAStudy.StopSimulation) + * [`RAStudy.customer_name`](RAStudy.md#generated.RAStudy.customer_name) + * [`RAStudy.description`](RAStudy.md#generated.RAStudy.description) +* [RASurface](RASurface.md) + * [`RASurface`](RASurface.md#generated.RASurface) + * [`RASurface.AddCurve()`](RASurface.md#generated.RASurface.AddCurve) + * [`RASurface.AddCustomCurve()`](RASurface.md#generated.RASurface.AddCustomCurve) + * [`RASurface.AddCustomProperty()`](RASurface.md#generated.RASurface.AddCustomProperty) + * [`RASurface.AddGridFunction()`](RASurface.md#generated.RASurface.AddGridFunction) + * [`RASurface.CreateCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateCurveOutputVariable) + * [`RASurface.CreateGridFunction()`](RASurface.md#generated.RASurface.CreateGridFunction) + * [`RASurface.CreateGridFunctionArrayOnCells()`](RASurface.md#generated.RASurface.CreateGridFunctionArrayOnCells) + * [`RASurface.CreateGridFunctionStatisticOutputVariable()`](RASurface.md#generated.RASurface.CreateGridFunctionStatisticOutputVariable) + * [`RASurface.CreateTransientCurveOutputVariable()`](RASurface.md#generated.RASurface.CreateTransientCurveOutputVariable) + * [`RASurface.EditCustomCurve()`](RASurface.md#generated.RASurface.EditCustomCurve) + * [`RASurface.EditCustomProperty()`](RASurface.md#generated.RASurface.EditCustomProperty) + * [`RASurface.GetActivesArray()`](RASurface.md#generated.RASurface.GetActivesArray) + * [`RASurface.GetBoundingBox()`](RASurface.md#generated.RASurface.GetBoundingBox) + * [`RASurface.GetCellAreaAsArray()`](RASurface.md#generated.RASurface.GetCellAreaAsArray) + * [`RASurface.GetCellCenterAsArray()`](RASurface.md#generated.RASurface.GetCellCenterAsArray) + * [`RASurface.GetCellDzAsArray()`](RASurface.md#generated.RASurface.GetCellDzAsArray) + * [`RASurface.GetCellFromIJK()`](RASurface.md#generated.RASurface.GetCellFromIJK) + * [`RASurface.GetCellIJK()`](RASurface.md#generated.RASurface.GetCellIJK) + * [`RASurface.GetCellNumberOfVertices()`](RASurface.md#generated.RASurface.GetCellNumberOfVertices) + * [`RASurface.GetCellPointsAsFunction()`](RASurface.md#generated.RASurface.GetCellPointsAsFunction) + * [`RASurface.GetCellVolumeAsArray()`](RASurface.md#generated.RASurface.GetCellVolumeAsArray) + * [`RASurface.GetCurve()`](RASurface.md#generated.RASurface.GetCurve) + * [`RASurface.GetCurveNames()`](RASurface.md#generated.RASurface.GetCurveNames) + * [`RASurface.GetCurveNamesAssociation()`](RASurface.md#generated.RASurface.GetCurveNamesAssociation) + * [`RASurface.GetElementCurve()`](RASurface.md#generated.RASurface.GetElementCurve) + * [`RASurface.GetGeometryQuantity()`](RASurface.md#generated.RASurface.GetGeometryQuantity) + * [`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.GetNumberOfCells()`](RASurface.md#generated.RASurface.GetNumberOfCells) + * [`RASurface.GetNumberOfNodes()`](RASurface.md#generated.RASurface.GetNumberOfNodes) + * [`RASurface.GetNumpyCurve()`](RASurface.md#generated.RASurface.GetNumpyCurve) + * [`RASurface.GetOrientation()`](RASurface.md#generated.RASurface.GetOrientation) + * [`RASurface.GetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.GetOrientationFromAngleAndVector) + * [`RASurface.GetOrientationFromAngles()`](RASurface.md#generated.RASurface.GetOrientationFromAngles) + * [`RASurface.GetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.GetOrientationFromBasisVector) + * [`RASurface.GetOutputVariableValue()`](RASurface.md#generated.RASurface.GetOutputVariableValue) + * [`RASurface.GetPivotPoint()`](RASurface.md#generated.RASurface.GetPivotPoint) + * [`RASurface.GetTimeSet()`](RASurface.md#generated.RASurface.GetTimeSet) + * [`RASurface.GetTimeStatistics()`](RASurface.md#generated.RASurface.GetTimeStatistics) + * [`RASurface.GetTimeStep()`](RASurface.md#generated.RASurface.GetTimeStep) + * [`RASurface.GetTopologyShape()`](RASurface.md#generated.RASurface.GetTopologyShape) + * [`RASurface.GetTranslation()`](RASurface.md#generated.RASurface.GetTranslation) + * [`RASurface.HasGridFunction()`](RASurface.md#generated.RASurface.HasGridFunction) + * [`RASurface.HasMotionFrame()`](RASurface.md#generated.RASurface.HasMotionFrame) + * [`RASurface.IsCellActive()`](RASurface.md#generated.RASurface.IsCellActive) + * [`RASurface.IterCellVertices()`](RASurface.md#generated.RASurface.IterCellVertices) + * [`RASurface.IterCells()`](RASurface.md#generated.RASurface.IterCells) + * [`RASurface.Modified()`](RASurface.md#generated.RASurface.Modified) + * [`RASurface.RemoveCustomCurve()`](RASurface.md#generated.RASurface.RemoveCustomCurve) + * [`RASurface.RemoveCustomProperty()`](RASurface.md#generated.RASurface.RemoveCustomProperty) + * [`RASurface.RemoveOutputVariable()`](RASurface.md#generated.RASurface.RemoveOutputVariable) + * [`RASurface.RemoveProcess()`](RASurface.md#generated.RASurface.RemoveProcess) + * [`RASurface.SetCurrentTimeStep()`](RASurface.md#generated.RASurface.SetCurrentTimeStep) + * [`RASurface.SetInvertNormal()`](RASurface.md#generated.RASurface.SetInvertNormal) + * [`RASurface.SetOrientation()`](RASurface.md#generated.RASurface.SetOrientation) + * [`RASurface.SetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.SetOrientationFromAngleAndVector) + * [`RASurface.SetOrientationFromAngles()`](RASurface.md#generated.RASurface.SetOrientationFromAngles) + * [`RASurface.SetOrientationFromBasisVector()`](RASurface.md#generated.RASurface.SetOrientationFromBasisVector) + * [`RASurface.SetPivotPoint()`](RASurface.md#generated.RASurface.SetPivotPoint) + * [`RASurface.SetTranslation()`](RASurface.md#generated.RASurface.SetTranslation) +* [RASurfaceUserProcess](RASurfaceUserProcess.md) + * [`RASurfaceUserProcess`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess) + * [`RASurfaceUserProcess.AddCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCurve) + * [`RASurfaceUserProcess.AddCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomCurve) + * [`RASurfaceUserProcess.AddCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddCustomProperty) + * [`RASurfaceUserProcess.AddGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.AddGridFunction) + * [`RASurfaceUserProcess.CreateCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateCurveOutputVariable) + * [`RASurfaceUserProcess.CreateGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunction) + * [`RASurfaceUserProcess.CreateGridFunctionArrayOnCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionArrayOnCells) + * [`RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateGridFunctionStatisticOutputVariable) + * [`RASurfaceUserProcess.CreateTransientCurveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.CreateTransientCurveOutputVariable) + * [`RASurfaceUserProcess.EditCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomCurve) + * [`RASurfaceUserProcess.EditCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.EditCustomProperty) + * [`RASurfaceUserProcess.GetActivesArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetActivesArray) + * [`RASurfaceUserProcess.GetBoundingBox()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetBoundingBox) + * [`RASurfaceUserProcess.GetCellAreaAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellAreaAsArray) + * [`RASurfaceUserProcess.GetCellCenterAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellCenterAsArray) + * [`RASurfaceUserProcess.GetCellDzAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellDzAsArray) + * [`RASurfaceUserProcess.GetCellFromIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellFromIJK) + * [`RASurfaceUserProcess.GetCellIJK()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellIJK) + * [`RASurfaceUserProcess.GetCellNumberOfVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellNumberOfVertices) + * [`RASurfaceUserProcess.GetCellPointsAsFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellPointsAsFunction) + * [`RASurfaceUserProcess.GetCellVolumeAsArray()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCellVolumeAsArray) + * [`RASurfaceUserProcess.GetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCenter) + * [`RASurfaceUserProcess.GetCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurve) + * [`RASurfaceUserProcess.GetCurveNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNames) + * [`RASurfaceUserProcess.GetCurveNamesAssociation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNamesAssociation) + * [`RASurfaceUserProcess.GetElementCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetElementCurve) + * [`RASurfaceUserProcess.GetGeometryQuantity()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryQuantity) + * [`RASurfaceUserProcess.GetGeometryUnit()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryUnit) + * [`RASurfaceUserProcess.GetGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunction) + * [`RASurfaceUserProcess.GetGridFunctionNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunctionNames) + * [`RASurfaceUserProcess.GetMeshColoring()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMeshColoring) + * [`RASurfaceUserProcess.GetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetMotionFrame) + * [`RASurfaceUserProcess.GetNumberOfCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfCells) + * [`RASurfaceUserProcess.GetNumberOfNodes()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfNodes) + * [`RASurfaceUserProcess.GetNumberOfParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumberOfParticles) + * [`RASurfaceUserProcess.GetNumpyCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetNumpyCurve) + * [`RASurfaceUserProcess.GetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientation) + * [`RASurfaceUserProcess.GetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngleAndVector) + * [`RASurfaceUserProcess.GetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromAngles) + * [`RASurfaceUserProcess.GetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOrientationFromBasisVector) + * [`RASurfaceUserProcess.GetOutputVariableValue()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetOutputVariableValue) + * [`RASurfaceUserProcess.GetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetScale) + * [`RASurfaceUserProcess.GetTimeSet()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeSet) + * [`RASurfaceUserProcess.GetTimeStatistics()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStatistics) + * [`RASurfaceUserProcess.GetTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStep) + * [`RASurfaceUserProcess.GetTopologyShape()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTopologyShape) + * [`RASurfaceUserProcess.HasGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.HasGridFunction) + * [`RASurfaceUserProcess.IsCellActive()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IsCellActive) + * [`RASurfaceUserProcess.IterCellVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCellVertices) + * [`RASurfaceUserProcess.IterCells()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCells) + * [`RASurfaceUserProcess.IterParticles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterParticles) + * [`RASurfaceUserProcess.Modified()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.Modified) + * [`RASurfaceUserProcess.RemoveCustomCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomCurve) + * [`RASurfaceUserProcess.RemoveCustomProperty()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveCustomProperty) + * [`RASurfaceUserProcess.RemoveOutputVariable()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveOutputVariable) + * [`RASurfaceUserProcess.RemoveProcess()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.RemoveProcess) + * [`RASurfaceUserProcess.SetCenter()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCenter) + * [`RASurfaceUserProcess.SetCurrentTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetCurrentTimeStep) + * [`RASurfaceUserProcess.SetMotionFrame()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetMotionFrame) + * [`RASurfaceUserProcess.SetOrientation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientation) + * [`RASurfaceUserProcess.SetOrientationFromAngleAndVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngleAndVector) + * [`RASurfaceUserProcess.SetOrientationFromAngles()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromAngles) + * [`RASurfaceUserProcess.SetOrientationFromBasisVector()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetOrientationFromBasisVector) + * [`RASurfaceUserProcess.SetSTL()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetSTL) + * [`RASurfaceUserProcess.SetScale()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetScale) +* [RASystemCouplingWall](RASystemCouplingWall.md) + * [`RASystemCouplingWall`](RASystemCouplingWall.md#generated.RASystemCouplingWall) + * [`RASystemCouplingWall.AddCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCurve) + * [`RASystemCouplingWall.AddCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomCurve) + * [`RASystemCouplingWall.AddCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddCustomProperty) + * [`RASystemCouplingWall.AddGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.AddGridFunction) + * [`RASystemCouplingWall.CreateCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateCurveOutputVariable) + * [`RASystemCouplingWall.CreateGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunction) + * [`RASystemCouplingWall.CreateGridFunctionArrayOnCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionArrayOnCells) + * [`RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateGridFunctionStatisticOutputVariable) + * [`RASystemCouplingWall.CreateTransientCurveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.CreateTransientCurveOutputVariable) + * [`RASystemCouplingWall.DisableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableStructuralCouplingType) + * [`RASystemCouplingWall.DisableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.DisableThermalCouplingType) + * [`RASystemCouplingWall.EditCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomCurve) + * [`RASystemCouplingWall.EditCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EditCustomProperty) + * [`RASystemCouplingWall.EnableStructuralCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableStructuralCouplingType) + * [`RASystemCouplingWall.EnableThermalCouplingType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.EnableThermalCouplingType) + * [`RASystemCouplingWall.GetActivesArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetActivesArray) + * [`RASystemCouplingWall.GetAvailableMaterials()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetAvailableMaterials) + * [`RASystemCouplingWall.GetBoundingBox()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetBoundingBox) + * [`RASystemCouplingWall.GetCellAreaAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellAreaAsArray) + * [`RASystemCouplingWall.GetCellCenterAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellCenterAsArray) + * [`RASystemCouplingWall.GetCellDzAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellDzAsArray) + * [`RASystemCouplingWall.GetCellFromIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellFromIJK) + * [`RASystemCouplingWall.GetCellIJK()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellIJK) + * [`RASystemCouplingWall.GetCellNumberOfVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellNumberOfVertices) + * [`RASystemCouplingWall.GetCellPointsAsFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellPointsAsFunction) + * [`RASystemCouplingWall.GetCellVolumeAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellVolumeAsArray) + * [`RASystemCouplingWall.GetCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurve) + * [`RASystemCouplingWall.GetCurveNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNames) + * [`RASystemCouplingWall.GetCurveNamesAssociation()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNamesAssociation) + * [`RASystemCouplingWall.GetElementCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetElementCurve) + * [`RASystemCouplingWall.GetGeometryQuantity()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryQuantity) + * [`RASystemCouplingWall.GetGeometryUnit()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryUnit) + * [`RASystemCouplingWall.GetGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunction) + * [`RASystemCouplingWall.GetGridFunctionNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunctionNames) + * [`RASystemCouplingWall.GetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMaterial) + * [`RASystemCouplingWall.GetMeshColoring()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMeshColoring) + * [`RASystemCouplingWall.GetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetMotionFrame) + * [`RASystemCouplingWall.GetNumberOfCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfCells) + * [`RASystemCouplingWall.GetNumberOfNodes()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumberOfNodes) + * [`RASystemCouplingWall.GetNumpyCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetNumpyCurve) + * [`RASystemCouplingWall.GetOutputVariableValue()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetOutputVariableValue) + * [`RASystemCouplingWall.GetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSphBoundaryType) + * [`RASystemCouplingWall.GetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetStructuralCouplingTypeEnabled) + * [`RASystemCouplingWall.GetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetSurfaceTensionContactAngle) + * [`RASystemCouplingWall.GetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetThermalCouplingTypeEnabled) + * [`RASystemCouplingWall.GetTimeSet()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeSet) + * [`RASystemCouplingWall.GetTimeStatistics()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStatistics) + * [`RASystemCouplingWall.GetTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTimeStep) + * [`RASystemCouplingWall.GetTopologyShape()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTopologyShape) + * [`RASystemCouplingWall.GetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTriangleSize) + * [`RASystemCouplingWall.GetValidSphBoundaryTypeValues()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues) + * [`RASystemCouplingWall.HasGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasGridFunction) + * [`RASystemCouplingWall.HasMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasMotionFrame) + * [`RASystemCouplingWall.IsCellActive()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsCellActive) + * [`RASystemCouplingWall.IsStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsStructuralCouplingTypeEnabled) + * [`RASystemCouplingWall.IsThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsThermalCouplingTypeEnabled) + * [`RASystemCouplingWall.IterCellVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCellVertices) + * [`RASystemCouplingWall.IterCells()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IterCells) + * [`RASystemCouplingWall.Modified()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.Modified) + * [`RASystemCouplingWall.RemoveCustomCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomCurve) + * [`RASystemCouplingWall.RemoveCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomProperty) + * [`RASystemCouplingWall.RemoveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveOutputVariable) + * [`RASystemCouplingWall.RemoveProcess()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveProcess) + * [`RASystemCouplingWall.SetCurrentTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCurrentTimeStep) + * [`RASystemCouplingWall.SetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMaterial) + * [`RASystemCouplingWall.SetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMotionFrame) + * [`RASystemCouplingWall.SetSphBoundaryType()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSphBoundaryType) + * [`RASystemCouplingWall.SetStructuralCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetStructuralCouplingTypeEnabled) + * [`RASystemCouplingWall.SetSurfaceTensionContactAngle()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetSurfaceTensionContactAngle) + * [`RASystemCouplingWall.SetThermalCouplingTypeEnabled()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetThermalCouplingTypeEnabled) + * [`RASystemCouplingWall.SetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetTriangleSize) +* [RATagging](RATagging.md) + * [`RATagging`](RATagging.md#generated.RATagging) + * [`RATagging.GetGridFunctionName()`](RATagging.md#generated.RATagging.GetGridFunctionName) + * [`RATagging.GetNameMask()`](RATagging.md#generated.RATagging.GetNameMask) + * [`RATagging.GetTagValue()`](RATagging.md#generated.RATagging.GetTagValue) + * [`RATagging.GetTimeRangeFilter()`](RATagging.md#generated.RATagging.GetTimeRangeFilter) + * [`RATagging.SetNameMask()`](RATagging.md#generated.RATagging.SetNameMask) + * [`RATagging.SetTagValue()`](RATagging.md#generated.RATagging.SetTagValue) +* [RAThreeRollsBeltProfile](RAThreeRollsBeltProfile.md) + * [`RAThreeRollsBeltProfile`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile) + * [`RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.DisableUse0371RatioForRollLengths) + * [`RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.EnableUse0371RatioForRollLengths) + * [`RAThreeRollsBeltProfile.GetAvailableMaterials()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetAvailableMaterials) + * [`RAThreeRollsBeltProfile.GetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetCenterRollLength) + * [`RAThreeRollsBeltProfile.GetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetLowerCornerRadius) + * [`RAThreeRollsBeltProfile.GetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetMaterial) + * [`RAThreeRollsBeltProfile.GetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetTroughingAngle) + * [`RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.GetUse0371RatioForRollLengths) + * [`RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.IsUse0371RatioForRollLengthsEnabled) + * [`RAThreeRollsBeltProfile.SetCenterRollLength()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetCenterRollLength) + * [`RAThreeRollsBeltProfile.SetLowerCornerRadius()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetLowerCornerRadius) + * [`RAThreeRollsBeltProfile.SetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetMaterial) + * [`RAThreeRollsBeltProfile.SetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetTroughingAngle) + * [`RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths) +* [RATimeRangeFilter](RATimeRangeFilter.md) + * [`RATimeRangeFilter`](RATimeRangeFilter.md#generated.RATimeRangeFilter) + * [`RATimeRangeFilter.GetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetDomainRange) + * [`RATimeRangeFilter.GetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetFinal) + * [`RATimeRangeFilter.GetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetInitial) + * [`RATimeRangeFilter.GetValidDomainRangeValues()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetValidDomainRangeValues) + * [`RATimeRangeFilter.SetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetDomainRange) + * [`RATimeRangeFilter.SetFinal()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetFinal) + * [`RATimeRangeFilter.SetInitial()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.SetInitial) +* [RATimeSeriesRotation](RATimeSeriesRotation.md) + * [`RATimeSeriesRotation`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation) + * [`RATimeSeriesRotation.ImportTimeSeriesMotion()`](RATimeSeriesRotation.md#generated.RATimeSeriesRotation.ImportTimeSeriesMotion) +* [RATimeSeriesTranslation](RATimeSeriesTranslation.md) + * [`RATimeSeriesTranslation`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation) + * [`RATimeSeriesTranslation.ImportTimeSeriesMotion()`](RATimeSeriesTranslation.md#generated.RATimeSeriesTranslation.ImportTimeSeriesMotion) +* [RATrajectoryProcess](RATrajectoryProcess.md) + * [`RATrajectoryProcess`](RATrajectoryProcess.md#generated.RATrajectoryProcess) + * [`RATrajectoryProcess.AddCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCurve) + * [`RATrajectoryProcess.AddCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomCurve) + * [`RATrajectoryProcess.AddCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddCustomProperty) + * [`RATrajectoryProcess.AddGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.AddGridFunction) + * [`RATrajectoryProcess.CreateCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateCurveOutputVariable) + * [`RATrajectoryProcess.CreateGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunction) + * [`RATrajectoryProcess.CreateGridFunctionArrayOnCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionArrayOnCells) + * [`RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateGridFunctionStatisticOutputVariable) + * [`RATrajectoryProcess.CreateTransientCurveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.CreateTransientCurveOutputVariable) + * [`RATrajectoryProcess.EditCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomCurve) + * [`RATrajectoryProcess.EditCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.EditCustomProperty) + * [`RATrajectoryProcess.GetActivesArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetActivesArray) + * [`RATrajectoryProcess.GetBoundingBox()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetBoundingBox) + * [`RATrajectoryProcess.GetCellAreaAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellAreaAsArray) + * [`RATrajectoryProcess.GetCellCenterAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellCenterAsArray) + * [`RATrajectoryProcess.GetCellDzAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellDzAsArray) + * [`RATrajectoryProcess.GetCellFromIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellFromIJK) + * [`RATrajectoryProcess.GetCellIJK()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellIJK) + * [`RATrajectoryProcess.GetCellNumberOfVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellNumberOfVertices) + * [`RATrajectoryProcess.GetCellPointsAsFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellPointsAsFunction) + * [`RATrajectoryProcess.GetCellVolumeAsArray()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCellVolumeAsArray) + * [`RATrajectoryProcess.GetCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurve) + * [`RATrajectoryProcess.GetCurveNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNames) + * [`RATrajectoryProcess.GetCurveNamesAssociation()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNamesAssociation) + * [`RATrajectoryProcess.GetElementCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetElementCurve) + * [`RATrajectoryProcess.GetGeometryQuantity()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryQuantity) + * [`RATrajectoryProcess.GetGeometryUnit()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryUnit) + * [`RATrajectoryProcess.GetGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunction) + * [`RATrajectoryProcess.GetGridFunctionNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunctionNames) + * [`RATrajectoryProcess.GetMeshColoring()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetMeshColoring) + * [`RATrajectoryProcess.GetNumberOfCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfCells) + * [`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.HasGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.HasGridFunction) + * [`RATrajectoryProcess.IsCellActive()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IsCellActive) + * [`RATrajectoryProcess.IterCellVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCellVertices) + * [`RATrajectoryProcess.IterCells()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCells) + * [`RATrajectoryProcess.IterParticles()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterParticles) + * [`RATrajectoryProcess.Modified()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.Modified) + * [`RATrajectoryProcess.RemoveCustomCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomCurve) + * [`RATrajectoryProcess.RemoveCustomProperty()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveCustomProperty) + * [`RATrajectoryProcess.RemoveOutputVariable()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveOutputVariable) + * [`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) + * [`RATranslation.GetAcceleration()`](RATranslation.md#generated.RATranslation.GetAcceleration) + * [`RATranslation.GetFinalVelocity()`](RATranslation.md#generated.RATranslation.GetFinalVelocity) + * [`RATranslation.GetInput()`](RATranslation.md#generated.RATranslation.GetInput) + * [`RATranslation.GetValidInputValues()`](RATranslation.md#generated.RATranslation.GetValidInputValues) + * [`RATranslation.GetVelocity()`](RATranslation.md#generated.RATranslation.GetVelocity) + * [`RATranslation.SetAcceleration()`](RATranslation.md#generated.RATranslation.SetAcceleration) + * [`RATranslation.SetFinalVelocity()`](RATranslation.md#generated.RATranslation.SetFinalVelocity) + * [`RATranslation.SetInput()`](RATranslation.md#generated.RATranslation.SetInput) + * [`RATranslation.SetVelocity()`](RATranslation.md#generated.RATranslation.SetVelocity) +* [RATwoRollsBeltProfile](RATwoRollsBeltProfile.md) + * [`RATwoRollsBeltProfile`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile) + * [`RATwoRollsBeltProfile.GetAvailableMaterials()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetAvailableMaterials) + * [`RATwoRollsBeltProfile.GetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetLowerCornerRadius) + * [`RATwoRollsBeltProfile.GetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetMaterial) + * [`RATwoRollsBeltProfile.GetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.GetTroughingAngle) + * [`RATwoRollsBeltProfile.SetLowerCornerRadius()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetLowerCornerRadius) + * [`RATwoRollsBeltProfile.SetMaterial()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetMaterial) + * [`RATwoRollsBeltProfile.SetTroughingAngle()`](RATwoRollsBeltProfile.md#generated.RATwoRollsBeltProfile.SetTroughingAngle) +* [RAUserProcessCollection](RAUserProcessCollection.md) + * [`RAUserProcessCollection`](RAUserProcessCollection.md#generated.RAUserProcessCollection) + * [`RAUserProcessCollection.CreateContactToParticleProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateContactToParticleProcess) + * [`RAUserProcessCollection.CreateCubeProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCubeProcess) + * [`RAUserProcessCollection.CreateCylinderProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateCylinderProcess) + * [`RAUserProcessCollection.CreateEulerianStatistics()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateEulerianStatistics) + * [`RAUserProcessCollection.CreateFilterProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateFilterProcess) + * [`RAUserProcessCollection.CreateInspectorProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateInspectorProcess) + * [`RAUserProcessCollection.CreateParticleTimeSelectionProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleTimeSelectionProcess) + * [`RAUserProcessCollection.CreateParticleToContactProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateParticleToContactProcess) + * [`RAUserProcessCollection.CreatePlaneProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePlaneProcess) + * [`RAUserProcessCollection.CreatePolyhedronProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePolyhedronProcess) + * [`RAUserProcessCollection.CreatePropertyProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreatePropertyProcess) + * [`RAUserProcessCollection.CreateStreamlinesUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateStreamlinesUserProcess) + * [`RAUserProcessCollection.CreateSurfaceUserProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateSurfaceUserProcess) + * [`RAUserProcessCollection.CreateTrajectoryProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.CreateTrajectoryProcess) + * [`RAUserProcessCollection.GetContactToParticleProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetContactToParticleProcessNames) + * [`RAUserProcessCollection.GetCubeProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCubeProcessNames) + * [`RAUserProcessCollection.GetCylinderProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetCylinderProcessNames) + * [`RAUserProcessCollection.GetEulerianStatisticsNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetEulerianStatisticsNames) + * [`RAUserProcessCollection.GetFilterProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetFilterProcessNames) + * [`RAUserProcessCollection.GetInspectorProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetInspectorProcessNames) + * [`RAUserProcessCollection.GetParticleTimeSelectionProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleTimeSelectionProcessNames) + * [`RAUserProcessCollection.GetParticleToContactProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetParticleToContactProcessNames) + * [`RAUserProcessCollection.GetPlaneProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPlaneProcessNames) + * [`RAUserProcessCollection.GetPolyhedronProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPolyhedronProcessNames) + * [`RAUserProcessCollection.GetProcess()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcess) + * [`RAUserProcessCollection.GetProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetProcessNames) + * [`RAUserProcessCollection.GetPropertyProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetPropertyProcessNames) + * [`RAUserProcessCollection.GetStreamlinesUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetStreamlinesUserProcessNames) + * [`RAUserProcessCollection.GetSurfaceUserProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetSurfaceUserProcessNames) + * [`RAUserProcessCollection.GetTrajectoryProcessNames()`](RAUserProcessCollection.md#generated.RAUserProcessCollection.GetTrajectoryProcessNames) +* [RAVibration](RAVibration.md) + * [`RAVibration`](RAVibration.md#generated.RAVibration) + * [`RAVibration.GetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.GetAmplitudeVariation) + * [`RAVibration.GetDirection()`](RAVibration.md#generated.RAVibration.GetDirection) + * [`RAVibration.GetFrequencyVariation()`](RAVibration.md#generated.RAVibration.GetFrequencyVariation) + * [`RAVibration.GetInitialAmplitude()`](RAVibration.md#generated.RAVibration.GetInitialAmplitude) + * [`RAVibration.GetInitialFrequency()`](RAVibration.md#generated.RAVibration.GetInitialFrequency) + * [`RAVibration.GetInitialPhase()`](RAVibration.md#generated.RAVibration.GetInitialPhase) + * [`RAVibration.SetAmplitudeVariation()`](RAVibration.md#generated.RAVibration.SetAmplitudeVariation) + * [`RAVibration.SetDirection()`](RAVibration.md#generated.RAVibration.SetDirection) + * [`RAVibration.SetFrequencyVariation()`](RAVibration.md#generated.RAVibration.SetFrequencyVariation) + * [`RAVibration.SetInitialAmplitude()`](RAVibration.md#generated.RAVibration.SetInitialAmplitude) + * [`RAVibration.SetInitialFrequency()`](RAVibration.md#generated.RAVibration.SetInitialFrequency) + * [`RAVibration.SetInitialPhase()`](RAVibration.md#generated.RAVibration.SetInitialPhase) +* [RAVolumetricInlet](RAVolumetricInlet.md) + * [`RAVolumetricInlet`](RAVolumetricInlet.md#generated.RAVolumetricInlet) + * [`RAVolumetricInlet.DisablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisablePeriodic) + * [`RAVolumetricInlet.EnablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnablePeriodic) + * [`RAVolumetricInlet.GetAvailableGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetAvailableGeometries) + * [`RAVolumetricInlet.GetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxCenter) + * [`RAVolumetricInlet.GetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxDimensions) + * [`RAVolumetricInlet.GetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGapScaleFactor) + * [`RAVolumetricInlet.GetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetGeometries) + * [`RAVolumetricInlet.GetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInitialVelocity) + * [`RAVolumetricInlet.GetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInjectionTime) + * [`RAVolumetricInlet.GetInputPropertiesList()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInputPropertiesList) + * [`RAVolumetricInlet.GetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientation) + * [`RAVolumetricInlet.GetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngleAndVector) + * [`RAVolumetricInlet.GetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngles) + * [`RAVolumetricInlet.GetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromBasisVector) + * [`RAVolumetricInlet.GetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriod) + * [`RAVolumetricInlet.GetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriodic) + * [`RAVolumetricInlet.GetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSeedCoordinates) + * [`RAVolumetricInlet.GetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphMass) + * [`RAVolumetricInlet.GetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphTemperature) + * [`RAVolumetricInlet.GetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetStopTime) + * [`RAVolumetricInlet.GetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseGeometriesToCompute) + * [`RAVolumetricInlet.IsPeriodicEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled) + * [`RAVolumetricInlet.SetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxCenter) + * [`RAVolumetricInlet.SetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxDimensions) + * [`RAVolumetricInlet.SetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGapScaleFactor) + * [`RAVolumetricInlet.SetGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGeometries) + * [`RAVolumetricInlet.SetInitialVelocity()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInitialVelocity) + * [`RAVolumetricInlet.SetInjectionTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInjectionTime) + * [`RAVolumetricInlet.SetOrientation()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientation) + * [`RAVolumetricInlet.SetOrientationFromAngleAndVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngleAndVector) + * [`RAVolumetricInlet.SetOrientationFromAngles()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngles) + * [`RAVolumetricInlet.SetOrientationFromBasisVector()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromBasisVector) + * [`RAVolumetricInlet.SetPeriod()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriod) + * [`RAVolumetricInlet.SetPeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriodic) + * [`RAVolumetricInlet.SetSeedCoordinates()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSeedCoordinates) + * [`RAVolumetricInlet.SetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphMass) + * [`RAVolumetricInlet.SetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphTemperature) + * [`RAVolumetricInlet.SetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetStopTime) + * [`RAVolumetricInlet.SetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseGeometriesToCompute) +* [RAVolumetricInletProperties](RAVolumetricInletProperties.md) + * [`RAVolumetricInletProperties`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties) + * [`RAVolumetricInletProperties.GetAvailableParticles()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetAvailableParticles) + * [`RAVolumetricInletProperties.GetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetMass) + * [`RAVolumetricInletProperties.GetModuleProperties()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperties) + * [`RAVolumetricInletProperties.GetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetModuleProperty) + * [`RAVolumetricInletProperties.GetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetParticle) + * [`RAVolumetricInletProperties.GetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetTemperature) + * [`RAVolumetricInletProperties.GetValidOptionsForModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.GetValidOptionsForModuleProperty) + * [`RAVolumetricInletProperties.SetMass()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetMass) + * [`RAVolumetricInletProperties.SetModuleProperty()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetModuleProperty) + * [`RAVolumetricInletProperties.SetParticle()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetParticle) + * [`RAVolumetricInletProperties.SetTemperature()`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties.SetTemperature) +* [RAVolumetricInletPropertiesList](RAVolumetricInletPropertiesList.md) + * [`RAVolumetricInletPropertiesList`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList) + * [`RAVolumetricInletPropertiesList.Clear()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Clear) + * [`RAVolumetricInletPropertiesList.New()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.New) + * [`RAVolumetricInletPropertiesList.Remove()`](RAVolumetricInletPropertiesList.md#generated.RAVolumetricInletPropertiesList.Remove) +* [RAWall](RAWall.md) + * [`RAWall`](RAWall.md#generated.RAWall) + * [`RAWall.AddCurve()`](RAWall.md#generated.RAWall.AddCurve) + * [`RAWall.AddCustomCurve()`](RAWall.md#generated.RAWall.AddCustomCurve) + * [`RAWall.AddCustomProperty()`](RAWall.md#generated.RAWall.AddCustomProperty) + * [`RAWall.AddGridFunction()`](RAWall.md#generated.RAWall.AddGridFunction) + * [`RAWall.CreateCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateCurveOutputVariable) + * [`RAWall.CreateGridFunction()`](RAWall.md#generated.RAWall.CreateGridFunction) + * [`RAWall.CreateGridFunctionArrayOnCells()`](RAWall.md#generated.RAWall.CreateGridFunctionArrayOnCells) + * [`RAWall.CreateGridFunctionStatisticOutputVariable()`](RAWall.md#generated.RAWall.CreateGridFunctionStatisticOutputVariable) + * [`RAWall.CreateTransientCurveOutputVariable()`](RAWall.md#generated.RAWall.CreateTransientCurveOutputVariable) + * [`RAWall.EditCustomCurve()`](RAWall.md#generated.RAWall.EditCustomCurve) + * [`RAWall.EditCustomProperty()`](RAWall.md#generated.RAWall.EditCustomProperty) + * [`RAWall.GetActivesArray()`](RAWall.md#generated.RAWall.GetActivesArray) + * [`RAWall.GetAvailableMaterials()`](RAWall.md#generated.RAWall.GetAvailableMaterials) + * [`RAWall.GetBoundaryMass()`](RAWall.md#generated.RAWall.GetBoundaryMass) + * [`RAWall.GetBoundingBox()`](RAWall.md#generated.RAWall.GetBoundingBox) + * [`RAWall.GetCellAreaAsArray()`](RAWall.md#generated.RAWall.GetCellAreaAsArray) + * [`RAWall.GetCellCenterAsArray()`](RAWall.md#generated.RAWall.GetCellCenterAsArray) + * [`RAWall.GetCellDzAsArray()`](RAWall.md#generated.RAWall.GetCellDzAsArray) + * [`RAWall.GetCellFromIJK()`](RAWall.md#generated.RAWall.GetCellFromIJK) + * [`RAWall.GetCellIJK()`](RAWall.md#generated.RAWall.GetCellIJK) + * [`RAWall.GetCellNumberOfVertices()`](RAWall.md#generated.RAWall.GetCellNumberOfVertices) + * [`RAWall.GetCellPointsAsFunction()`](RAWall.md#generated.RAWall.GetCellPointsAsFunction) + * [`RAWall.GetCellVolumeAsArray()`](RAWall.md#generated.RAWall.GetCellVolumeAsArray) + * [`RAWall.GetCurve()`](RAWall.md#generated.RAWall.GetCurve) + * [`RAWall.GetCurveNames()`](RAWall.md#generated.RAWall.GetCurveNames) + * [`RAWall.GetCurveNamesAssociation()`](RAWall.md#generated.RAWall.GetCurveNamesAssociation) + * [`RAWall.GetDisableTime()`](RAWall.md#generated.RAWall.GetDisableTime) + * [`RAWall.GetElementCurve()`](RAWall.md#generated.RAWall.GetElementCurve) + * [`RAWall.GetEnableTime()`](RAWall.md#generated.RAWall.GetEnableTime) + * [`RAWall.GetGeometryQuantity()`](RAWall.md#generated.RAWall.GetGeometryQuantity) + * [`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) + * [`RAWall.GetModuleProperty()`](RAWall.md#generated.RAWall.GetModuleProperty) + * [`RAWall.GetMomentXDirection()`](RAWall.md#generated.RAWall.GetMomentXDirection) + * [`RAWall.GetMomentYDirection()`](RAWall.md#generated.RAWall.GetMomentYDirection) + * [`RAWall.GetMomentZDirection()`](RAWall.md#generated.RAWall.GetMomentZDirection) + * [`RAWall.GetNumberOfCells()`](RAWall.md#generated.RAWall.GetNumberOfCells) + * [`RAWall.GetNumberOfNodes()`](RAWall.md#generated.RAWall.GetNumberOfNodes) + * [`RAWall.GetNumberOfReplications()`](RAWall.md#generated.RAWall.GetNumberOfReplications) + * [`RAWall.GetNumpyCurve()`](RAWall.md#generated.RAWall.GetNumpyCurve) + * [`RAWall.GetOrientation()`](RAWall.md#generated.RAWall.GetOrientation) + * [`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) + * [`RAWall.GetPrincipalMomentOfInertia()`](RAWall.md#generated.RAWall.GetPrincipalMomentOfInertia) + * [`RAWall.GetReplicateGeometry()`](RAWall.md#generated.RAWall.GetReplicateGeometry) + * [`RAWall.GetReplicateTime()`](RAWall.md#generated.RAWall.GetReplicateTime) + * [`RAWall.GetSphBoundaryType()`](RAWall.md#generated.RAWall.GetSphBoundaryType) + * [`RAWall.GetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.GetSurfaceTensionContactAngle) + * [`RAWall.GetTemperature()`](RAWall.md#generated.RAWall.GetTemperature) + * [`RAWall.GetThermalBoundaryConditionType()`](RAWall.md#generated.RAWall.GetThermalBoundaryConditionType) + * [`RAWall.GetTimeSet()`](RAWall.md#generated.RAWall.GetTimeSet) + * [`RAWall.GetTimeStatistics()`](RAWall.md#generated.RAWall.GetTimeStatistics) + * [`RAWall.GetTimeStep()`](RAWall.md#generated.RAWall.GetTimeStep) + * [`RAWall.GetTopologyShape()`](RAWall.md#generated.RAWall.GetTopologyShape) + * [`RAWall.GetTranslation()`](RAWall.md#generated.RAWall.GetTranslation) + * [`RAWall.GetTriangleSize()`](RAWall.md#generated.RAWall.GetTriangleSize) + * [`RAWall.GetValidOptionsForModuleProperty()`](RAWall.md#generated.RAWall.GetValidOptionsForModuleProperty) + * [`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.GetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.GetVolumeShearWorkRatio) + * [`RAWall.GetWearModel()`](RAWall.md#generated.RAWall.GetWearModel) + * [`RAWall.HasGridFunction()`](RAWall.md#generated.RAWall.HasGridFunction) + * [`RAWall.HasMotionFrame()`](RAWall.md#generated.RAWall.HasMotionFrame) + * [`RAWall.IsCellActive()`](RAWall.md#generated.RAWall.IsCellActive) + * [`RAWall.IterCellVertices()`](RAWall.md#generated.RAWall.IterCellVertices) + * [`RAWall.IterCells()`](RAWall.md#generated.RAWall.IterCells) + * [`RAWall.LoadFile()`](RAWall.md#generated.RAWall.LoadFile) + * [`RAWall.Modified()`](RAWall.md#generated.RAWall.Modified) + * [`RAWall.OrientationAnglesOrder`](RAWall.md#generated.RAWall.OrientationAnglesOrder) + * [`RAWall.RemoveCustomCurve()`](RAWall.md#generated.RAWall.RemoveCustomCurve) + * [`RAWall.RemoveCustomProperty()`](RAWall.md#generated.RAWall.RemoveCustomProperty) + * [`RAWall.RemoveOutputVariable()`](RAWall.md#generated.RAWall.RemoveOutputVariable) + * [`RAWall.RemoveProcess()`](RAWall.md#generated.RAWall.RemoveProcess) + * [`RAWall.SetBoundaryMass()`](RAWall.md#generated.RAWall.SetBoundaryMass) + * [`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.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) + * [`RAWall.SetReplicateGeometry()`](RAWall.md#generated.RAWall.SetReplicateGeometry) + * [`RAWall.SetReplicateTime()`](RAWall.md#generated.RAWall.SetReplicateTime) + * [`RAWall.SetSphBoundaryType()`](RAWall.md#generated.RAWall.SetSphBoundaryType) + * [`RAWall.SetSurfaceTensionContactAngle()`](RAWall.md#generated.RAWall.SetSurfaceTensionContactAngle) + * [`RAWall.SetTemperature()`](RAWall.md#generated.RAWall.SetTemperature) + * [`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)