virtualargofleet.app_parcels.ArgoParticle#
- class ArgoParticle(*args, **kwargs)[source]#
Default class to represent an Argo float
ArgoParticle
inherits fromparcels.particle.JITParticle
.A
VirtualFleet
will create and work with aparcels.particleset.particlesetsoa.ParticleSetSOA
of this class.- Return type:
parcels.particle.JITParticle
- __init__(*args, **kwargs)#
Methods
__init__
(*args, **kwargs)add_variable
(var, *args, **kwargs)Add a new variable to the Particle class
add_variables
(variables)Add multiple new variables to the Particle class
getPType
()setLastID
(offset)set_lonlatdepth_dtype
(dtype)Attributes
Elapsed time since the beginning of the current cycle
cycle_duration
Float mission parameter cycle duration in hours
Cycle number (starts at 1)
Cycle phase (init_descend = 0, drift = 1, profile_descend = 2, profile_ascend = 3, transmit = 4)
depth
Descriptor class that delegates data access to particle data.
depth_nextloop
Descriptor class that delegates data access to particle data.
Elapsed time since the beginning of the drifting phase
dt
Descriptor class that delegates data access to particle data.
id
Descriptor class that delegates data access to particle data.
Boolean indicating if the virtual float is in land (0) or water (1), used to detect grounding, based on fieldset.mask
lastID
lat
Descriptor class that delegates data access to particle data.
lat_nextloop
Descriptor class that delegates data access to particle data.
life_expectancy
Float mission parameter life expectancy in cycle
lon
Descriptor class that delegates data access to particle data.
lon_nextloop
Descriptor class that delegates data access to particle data.
obs_written
Descriptor class that delegates data access to particle data.
parking_depth
Float mission parameter parking depth in m
profile_depth
Float mission parameter profile depth in m
state
Descriptor class that delegates data access to particle data.
time
Descriptor class that delegates data access to particle data.
time_nextloop
Descriptor class that delegates data access to particle data.
vertical_speed
Float mission parameter vertical speed in m/s