AgeDecay¶
Description: Exponentially decaying particle property based on age.
class_name: oceantracker.particle_properties.age_decay.AgeDecay
File: oceantracker/particle_properties/age_decay.py
Inheritance: _BasePropertyInfo> ParticleProperty> AgeDecay
Parameters:¶
class_name
<class 'str'>
<optional>Description: Class name as string A.B.C, used to import this class from python path
default:
None
decay_time_scale
<class 'float'>
<optional>
default:
86400.0
description
<class 'str'>
<optional>
default:
None
dtype
<class 'numpy.dtype'>
<optional>
default:
<class 'numpy.float64'>
fill_value
[<class 'int'>, <class 'float'>]
<optional>
default:
None
initial_value
<class 'float'>
<optional>Description: Particle property at the time of release
default:
1.0
prop_dim3
<class 'int'>
<optional>
default:
1
min:
1
release_group_parameters
: nested parameter dictionary
time_varying
<class 'bool'>
<optional>
default:
True
possible_values:
[True, False]
type
<class 'str'>
<optional>Description: type of particle property, used to manage how to update particle property
default:
user
possible_values:
['manual_update', 'from_fields', 'user']
update
<class 'bool'>
<optional>
default:
True
possible_values:
[True, False]
user_note
<class 'str'>
<optional>
default:
None
vector_dim
<class 'int'>
<optional>
default:
1
min:
1
write
<class 'bool'>
<optional>Description: Write particle property to tracks or event files file
default:
True
possible_values:
[True, False]