RATrajectoryProcess

class ansys.rocky.app.ra_process_element.RATrajectoryProcess

Bases: RAUserProcess

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().

Overview

Constructors

GetWrappedClass
GetClassName

Methods

SetStartingTime	Set the initial time step for the computed trajectories.
GetStartingTime	Get the time step currently configured as the initial one for the particle trajectories.
SetNumberOfIntervals	Set the total number of intervals in the computed trajectories.
GetNumberOfIntervals	Get the total number of intervals in the computed trajectories.
SetParticleStride	Set the particle stride for computed trajectories.
GetParticleStride	Get the particle stride for computed trajectories.
UpdateParticlesSelection	Recompute the trajectories from the current values of starting timestep, number of timesteps

Import detail

from ansys.rocky.app.ra_process_element import RATrajectoryProcess

Method detail

classmethod RATrajectoryProcess.GetWrappedClass()

classmethod RATrajectoryProcess.GetClassName()

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

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.

RATrajectoryProcess.GetStartingTime() → coilib50.time.time_step_interface.ITimeStep

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

RATrajectoryProcess.SetNumberOfIntervals(number_of_intervals: int)

Set the total number of intervals in the computed trajectories.

RATrajectoryProcess.GetNumberOfIntervals() → int

Get the total number of intervals in the computed trajectories.

RATrajectoryProcess.SetParticleStride(particle_stride) → None

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)

RATrajectoryProcess.GetParticleStride()

Get the particle stride for computed trajectories.

See:

SetParticleStride()

Return type:

int

RATrajectoryProcess.UpdateParticlesSelection() → None

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.