Skip to content

ParticleStart

ParticleStart

Defines a single particle's starting position and initial tracking step.

Attributes:

Name Type Description
id int

User-supplied integer identifier for this particle.

x float

Starting X coordinate (model units, global).

y float

Starting Y coordinate (model units, global).

z float

Starting Z coordinate — local normalized value in [0, 1]. 0.0 = cell bottom, 1.0 = cell top, 0.5 = layer midpoint. This is NOT a physical elevation. To convert: z_local = (z_physical - bot) / (top - bot). Passing a physical elevation (e.g. z=5.0 when top=10, bot=0) causes immediate ExitedDomain because 5.0 > 1.0.

cell_id int

Zero-based index of the MODFLOW cell that contains the particle's starting position.

initial_dt float

Initial time-step size for the adaptive tracker (model time units). Set to a small positive value; the solver adjusts automatically afterwards.

id instance-attribute

id: int

x instance-attribute

x: float

y instance-attribute

y: float

z instance-attribute

z: float

cell_id instance-attribute

cell_id: int

initial_dt instance-attribute

initial_dt: float

__init__

__init__(id: int, x: float, y: float, z: float, cell_id: int, initial_dt: float) -> None