mark_inserted_particles command

Purpose

Command for marking inserted particles as tracers.

Warning

GPU support for this command has not been tested and may not work as expected.

Syntax

mark_inserted_particles mark_time t mark_every_time dt insertion_id stream-ID number_of_particles np keyword arg

  • mark_time = obligatory keyword

  • t = time at which the particles are marked

  • mark_every_time = obligatory keyword

  • dt = once or time interval between two consecutive markings (positive float)

  • insertion_id = obligatory keyword

  • stream-ID = ID of an insertion command

  • number_of_particles = obligatory keyword

  • np = number of tracer particles to be marked

  • zero or more keyword/arg pairs may be appended

  • keyword = id or particle_group

id value = command-ID
   command-ID = user-assigned name for the command call
particle_group value = group-id
   group-id = ID of a group of particles

Examples

mark_inserted_particles id insMarker insertion_id ins mark_time 1e-3 mark_every_time once number_of_particles 10

Description

This command marks a given number of particles while being inserted inserted as a stream via the insertion command (denoted by keyword stream-ID). The first np particles to be marked are the once crossing the insertion face after time t. Particles are marked only once if mark_every_time is set to once, otherwise the procedure is repeated for the next np particles which pass the insertion face after time t + dt.

Additional information

This command can be used as an input for the calculate marked_particles command to evaluate the number and mass of the marked particles in a specific region.

Warning

The particles are un-marked after being counted by the calculate marked_particles command. This prevents counting the same particle multiple times in presence, for example, of a recirculation zone.

Information about this command is written to binary restart files. This command computes a per-particle scalar (the marker) which can be accessed by various output commands. This scalar is equal to one if a particle has been marked and zero otherwise. This command also computes a global scalar indicating how many particles were marked since the last time the global scalar was computed. This scalar can also be accessed by various output commands.

Restrictions

The insertion command must include the keyword/style pair mode stream. Currently, this feature does not support multi-sphere particles.