RAParticleTimeSelectionProcess#

class ansys.rocky.app.ra_particle_time_selection_process.RAParticleTimeSelectionProcess#

Bases: ansys.rocky.app.ra_process_element.RAUserProcess

Select particles over a time range.

Overview#

GetWrappedClass

GetClassName

SetAbsoluteTimeRange

Configure this process to use an absolute time range.

SetTimeRange

Set the values for this process’ time range.

GetTimeRange

Get a dictionary with the current time range configuration.

Import detail#

from ansys.rocky.app.ra_particle_time_selection_process import RAParticleTimeSelectionProcess

Method detail#

classmethod RAParticleTimeSelectionProcess.GetWrappedClass()#
classmethod RAParticleTimeSelectionProcess.GetClassName()#
RAParticleTimeSelectionProcess.SetAbsoluteTimeRange(initial_time, final_time, unit: str = 's') → None#

Configure this process to use an absolute time range.

Parameters:

  • initial_time (float) – The initial time for the particle time selection to consider particles.

  • final_time (float) – The final time for the particle time selection to consider particles.

  • unit (unicode) – The unit for the range given (by default seconds).

RAParticleTimeSelectionProcess.SetTimeRange(range_definition=None, initial=None, final=None, unit: str = 's') → None#

Set the values for this process’ time range.

Parameters:

  • range_definition – One of: ‘app_time_filter’, ‘all’, ‘last_output’, ‘absolute’, ‘single’, ‘absolute_only_start’, ‘relative_to_end’.

  • initial (float) – The initial value for the particle time selection to consider particles. May be ignored depending on the range definition.

  • final (float) – The final time for the particle time selection to consider particles. May be ignored depending on the range definition.

  • unit – The unit for the initial/final values passed.

RAParticleTimeSelectionProcess.GetTimeRange()#

Get a dictionary with the current time range configuration.

Return {‘range_definition’:

unicode, ‘initial’: int, ‘final’: int, ‘unit’: unicode}: Returns a dict with the details currently set as the time range.