## On this page
# RAPlaneProcess
Last update: 17.07.2025
### *class* RAPlaneProcess
**Methods:**
NameDescription[`AddCurve`](#generated.RAPlaneProcess.AddCurve)(curve\_name, timesteps, values, unit)Add a curve to the element with a time-steps domain[`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).[`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)()\* **return:**[`GetMotionFrame`](#generated.RAPlaneProcess.GetMotionFrame)()\* **returns:**[`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)()\* **return:**[`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)()\* **return:**[`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.[`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)\* **param plane\_mode:**
'Exact' or 'Select'[`SetMotionFrame`](#generated.RAPlaneProcess.SetMotionFrame)(motion\_frame)Assign a Motion Frame to the process.[`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)\* **param x:**[`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)\* **param 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
#### 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: Optional\[str\] = 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.
#### 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.
#### GetMotionFrame()
- **Returns:**The motion frame set in the process, or None if no motion is set.
#### 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.
#### 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
#### SetMotionFrame(motion\_frame: Optional\[Union\[[RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame), str\]\])
Assign a Motion Frame to the process.
- **Parameters:****motion\_frame** – Either the API object or its name.
#### 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.