sedtrails.particle_tracer.state_checker

Module Contents

Classes

Status	Enumeration for particle status.
StateChecker	Class to check the state of particles in a simulation.

API

class sedtrails.particle_tracer.state_checker.Status(*args, **kwds)

Bases: enum.Enum

Enumeration for particle status.

Initialization

ACTIVE = 'active'

DEAD = 'dead'

ALIVE = 'alive'

STUCK = 'stuck'

class sedtrails.particle_tracer.state_checker.StateChecker(**config)

Class to check the state of particles in a simulation.

Initialization

Initialize the StateChecker with configuration parameters.

**configdict

Configuration parameters for the state checker provided by the cofiguration interface.

check_state(particle: sedtrails.particle_tracer.particle.Particle, flow_field) → str

Check the state of a particle based on its properties.

particleParticle

The particle to check.

flow_fieldobject

The flow field data to use for checking the state.

Status

The state of the particle (e.g., ACTIVE, ALIVE, etc).