Rocky PrePost scripting 2024 R2

RATrajectoryProcess

Last update: 17.07.2025

class RATrajectoryProcess

PrePost Scripting wrapper for Particle Trajectory Processes.

Trajectory processes only work on particle-based processes. Before the trajectories can be analyzed the process must first be configured by calling SetStartingTimeStep(), SetNumberOfTimeSteps() and SetParticleStride(), followed by UpdateParticlesSelection().

Methods:

Name Description
AddCurve(curve_name, timesteps, values, unit) Add a curve to the element with a time-steps domain
AddGridFunction(grid_function_name, ...[, ...]) Adds a grid function to the grid.
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(values[, location, time_step]) Create a grid function from the given values, location and time-step.
CreateGridFunctionArrayOnCells([time_step]) Creates a numpy array with the number of elements based on the cells and returns it.
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(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([time_step]) Get an array representing the cells' "active" status.
GetBoundingBox([unit, time_step]) Get the element's bounding box.
GetCellAreaAsArray([time_step]) Get an array containing the area of each cell.
GetCellCenterAsArray([time_step]) Get an array containing the center coordinates of each cell.
GetCellDzAsArray([time_step]) Get an array containing the thickness (in Z) of each cell.
GetCellFromIJK(i, j, k[, time_step]) Creates a grid cell handle from the current I, J, K indexes
GetCellIJK(cell_handle[, time_step]) Converts the given cell handle to it's I, J, K indexes
GetCellNumberOfVertices(cell[, time_step]) Get an array containing the number of vertices of each cell.
GetCellPointsAsFunction([time_step]) Get a function for the points (vertices) of each cell.
GetCellVolumeAsArray([time_step]) Get an array with the volume of each cell.
GetCurve(curve_name[, simulation_name, ...]) Override base class method to check for a request of a grid function statistic.
GetCurveNames([simulation_name]) @param simulation_name: unicode
GetCurveNamesAssociation([simulation_name]) Get this element's curve names.
GetElementCurve(element_name, curve_name[, ...]) Return the curves for the given element and name.
GetGeometryQuantity() Get the quantity corresponding to the grid's geometry.
GetGeometryUnit() Get the grid's geometry's unit.
GetGridFunction(grid_function_name[, ...]) Gets a grid function given its name.
GetGridFunctionNames([translated, context]) Get a list of the available grid functions for this grid.
GetMeshColoring(window) Get the RAMeshColoring related to the current object and a window.
GetNumberOfCells([time_step]) Get the total number of cells.
GetNumberOfIntervals() Get the total number of intervals in the computed trajectories.
GetNumberOfNodes([time_step]) Get the total number of nodes (vertices).
GetNumberOfParticles(time_step) Get the total number of particles in this selection.
GetNumberOfTimeSteps() Deprecated: Use GetNumberOfIntervals instead.
GetNumpyCurve(curve_name[, unit, realization]) Returns a curve as a tuple of numpy arrays (time, property) for the given element and name.
GetOutputVariableValue(variable_name) Get the value of a previously-created output variable.
GetParticleStride() Get the particle stride for computed trajectories.
GetStartingTime() Get the time step currently configured as the initial one for the particle trajectories.
GetStartingTimeStep() Deprecated: Use GetStartingTime instead.
GetTimeSet() Get the list of time-steps associated to the grid.
GetTimeStatistics() Get the object responsible for handling time-statistics grid functions for this process.
GetTimeStep(time_step[, accept_global]) Get the timestep corresponding to the given time.
GetTopologyShape([time_step]) Get the shape of the topology (similar to the shape of numpy arrays).
HasGridFunction(grid_function_name) Whether the grid has the given grid function.
IsCellActive(i, j, k[, time_step]) Checks if the given cell is active or not
IterCellVertices(cell[, time_step]) Iterate on the vertices of active grid cells at the given time.
IterCells([time_step]) Iterate on the active grid cells at the given time.
IterParticles(time_step) Iterate on particles in this selection at the given time.
Modified(*args, **kwargs) Resets all the cache information after a change in the subject being tracked.
RemoveOutputVariable(variable_name) Removes some output variable.
RemoveProcess() Removes the process from the project.
SetCurrentTimeStep(time_step) Sets the current time step.
SetNumberOfIntervals(number_of_intervals) Set the total number of intervals in the computed trajectories.
SetNumberOfTimeSteps(number_of_intervals) Deprecated: Use SetNumberOfIntervals instead.
SetParticleStride(particle_stride) Set the particle stride for computed trajectories.
SetStartingTime(time) Set the initial time step for the computed trajectories.
SetStartingTimeStep(time_step) Deprecated: Use SetStartingTime instead.
UpdateParticlesSelection() Recompute the trajectories from the current values of starting timestep, number of timesteps and particle stride.

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:

#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:

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

GetNumberOfIntervals()

Get the total number of intervals in the computed trajectories.

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

GetNumberOfTimeSteps()

Deprecated: Use GetNumberOfIntervals instead.

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.

GetParticleStride()

Get the particle stride for computed trajectories.

  • See: SetParticleStride()
  • Return type: int

GetStartingTime()

Get the time step currently configured as the initial one for the particle trajectories.

GetStartingTimeStep()

Deprecated: Use GetStartingTime 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.

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.

SetNumberOfIntervals(number_of_intervals: int)

Set the total number of intervals in the computed trajectories.

SetNumberOfTimeSteps(number_of_intervals)

Deprecated: Use SetNumberOfIntervals instead.

SetParticleStride(particle_stride)

Set the particle stride for computed trajectories.

The “stride” is the number of particles that are “skipped” when selecting the particles whose trajectories will be computed. For example, if this value is 1 then the trajectories of all particles in the starting timestep will be computed. If 2, the trajectory of every other particle (one out of every two) will be computed, etc.

  • Parameters: particle_stride (int) –

SetStartingTime(time: str | coilib50.time.time_step_interface.ITimeStep | int)

Set the initial time step for the computed trajectories.

  • Parameters: time – The time step to use as the initial one to compute the trajectories. Can be either a TimeStep, an integer representing the timestep’s index in the timeset or the string ‘current’ for the current application time step.

SetStartingTimeStep(time_step)

Deprecated: Use SetStartingTime instead.

UpdateParticlesSelection()

Recompute the trajectories from the current values of starting timestep, number of timesteps and particle stride.

Since computing the trajectories is potentially slow when the number of particles and/or timesteps is big, this method must be explicitly called in order to update the trajectories.

Connect with Ansys