GeoDict User Guide 2025

Share This Topic
GeoDict Software
Forum
Support
Math2Market

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Share This Topic
Save Permalink URL

Navigation: GeoDict 2025 - User Guide > Automation > GeoPy Scripting > Advanced Scripting > GeoDict API

Particle Functions

For the following particle specific functions a visualization of particles (from FilterDict or AddiDict) must be loaded.

gd.getParticlesInfo

Get the current view status as dictionary or plot.

Returns a Python dictionary containing the number of batches and the maximal and minimal batch animation times.

Input: None

Example:

Info = gd.getParticlesInfo()

# assign the Particles Info

# dictionary to the variable Info

Num = Info['NumberOfBatches']

# assign the number of batches

# to the variable Number

gd.msgBox (f"The number of batches is {Num}.")

# show message dialog

gd.getParticles

Returns the Particles object which gives access to currently loaded particle data. To obtain the data the GeoParticles class is used. It works only in combination with this command.

Input:

GeoDict version, string

Example: For an example, see below in the subfunctions of the getParticles class.

Subfunctions

.getBatchInfo

Returns information about a batch of particles as a Python dictionary. The resulting dictionary contains:

"minTime": start time of batch
"maxTime": end time of batch
"minRadius": minimal particle radius in batch
"maxRadius": maximum particle radius in batch
"particleIds": list of particle IDs present in this batch

This command only works in combination with the gd.getParticles command.

Input:

batch index, integer

Example:

particles = gd.getParticles("2025")

# assigns the particles object

# to the variable particles

BatchInfo = particles.getBatchInfo(1)

# dictionary containing batch

# info is assigned to the

# variable BatchInfo

print(BatchInfo["minTime"])

# prints the start time

# of batch 1 to the console

.getDiameter

Returns the (interpolated) particle diameter at a given time. This command only works in combination with the gd.getParticles command.

Input:

batch index, integer
particle index, integer
time, float

Example:

particles = gd.getParticles("2025")

# assigns the particles object

# to the variable particles

Diameter = particles.getDiameter(1, 2000, 1)

# the diameter of the particle

# in batch 1 with particle ID 2000

# at time 1 is assigned to

# the variable Diameter

print(f"The particle diameter is {Diameter}m")

# prints the diameter to the console

.getDiameters

Computes the (interpolated) particle diameters with a given step size. Sampling starts at “minTime” and increments by step size up to “maxTime”. Returns a list of tuples (time, radius). This command only works in combination with the gd.getParticles command. The command makes sense, only when the particle with the given particle index changes its diameter over time. Otherwise, an empty list is returned.

Input:

batch index, integer
particle index, integer
time step, float

.getLoadedBatchIndices

Returns a list of valid particle batches that are currently loaded in memory. This command only works in combination with the gd.getParticles command.

Input: None

Example:

particles = gd.getParticles("2025")

# assigns the particles object
# to the variable particles

Batches = particles.getLoadedBatchIndices()

# assign the list of the batch

# indices to the variable Batches

print(Batches)

# prints the list to the console

.getMultiplicities

Computes the (interpolated) particle multiplicity with a given step size. Sampling starts at “minTime” and increments by step size up to “maxTime”. Returns a list of tuples (time, multiplicity). This command only works in combination with the gd.getParticles command.

Input:

batch index, integer
particle index, integer
time step, float

Example:

particles = gd.getParticles("2025")

# assigns the particles

# object to the variable

# particles

M = particles.getMultiplicities(1, 2000, 0.0001)

# assign the list of

# tuples to the

# variable M

print(f"In batch 1 the particle 2000 has multiplicity {M[1][1]} at time {M[1][0]}.")

# prints the values

# of the second tuple

# to the console

.getMultiplicity

Computes the (interpolated) particle multiplicity at a given time. This command only works in combination with the gd.getParticles command.

Input:

batch index, integer
particle index, integer
time, float

Example:

particles = gd.getParticles("2025")

# assigns the particles

# object to the variable

# particles

M = particles.getMultiplicity(1, 2000, 0.0001)

# assign the multiplicity

# to the variable M

print(f"In batch 1 the particle 2000 has multiplicity {M} at time 0.0001.")

# prints the multiplicity

# to the console

.getParticleInfo

Returns information about a particle inside a batch as a Python dictionary. This command only works in combination with the gd.getParticles command.

The resulting dictionary contains:

"minTime", "maxTime": start/end time of particle trajectory
"material_id": the material ID of the particle
"type": type index of the particle
"status_code": numerical status of the particle
"status": human-readable interpretation of particle status (e.g. "EXIT_OUTFLOW", "TRAPPED_SIEVING")
"end_material_id": if status is "HIT_END_MATERIAL", this contains the material id which the particle hit
"is_ghost": True if ghost particle
"times": time values for individual sample points along the trajectory
"positions": particle position for each time
"radii": particle radius for each time or single value if not time-dependent
"multiplicities": particle multiplicity for each time

Input:

batch index, integer
particle index, integer

Example:

particles = gd.getParticles("2025")	# assigns the particles # object to the variable # particles
Info = particles.getParticleInfo(1, 3500)	# assign the material ID # to the variable M
M_ID = Info["material_id"]
print(f"The material ID of the particle is {M_ID}.")	# prints the material ID # to the console

.getPosition

Returns the (interpolated) particle position at a given time. This command only works in combination with the gd.getParticles command.

Input:

batch index, integer
particle index, integer
time, float

Example:

particles = gd.getParticles("2025")

# assigns the particles object

# to the variable particles

Pos = particles.getPosition(1, 3500, 0.0001)

# assign the position of a

# particle to the variable Pos

print(f"The position of the particle is {Pos}.")

# prints the position

# to the console

.getPositions

Computes the (interpolated) particle positions with a given step size. Sampling starts at “minTime” and increments by step size up to “maxTime”. Returns a list of tuples (time, position). This command only works in combination with the gd.getParticles command.

Input:

batch index, integer
particle index, integer

Example:

particles = gd.getParticles("2025")

# assigns the particles object

# to the variable particles

Pos = particles.getPositions(1, 3500, 0.0001)

# assign the list of tuples

# (time, position) of a particle

# to the variable Pos

print(f"The position of the particle is {Pos[0][1][1]} at time {Pos[0][1][0]}.")

# prints the second

# (time, position) tuple

# to the console

.getPositionsAtTime

Computes all (interpolated) particle positions at a given time. This command only works in combination with the gd.getParticles command.

Input:

batch index, integer
time, float

Example:

particles = gd.getParticles("2025")

# assigns the particles object to

# the variable particles

Pos = particles.getPositionsAtTime(1, 0.0001)

# assign the list of positions of

# all particle at the given time

# to the variable Pos

print(f"The position of the particles are {Pos}.")

# prints positions to the console

Contents
Search

Please enable JavaScript to view this site.

GeoDict User Guide 2025

Particle Functions

gd.getParticlesInfo

gd.getParticles

Subfunctions