ParticleLoad¶
Doc: Particle property which carries a constant load or mass, which can be used to calculate spatial and temporal statistics of this load or mass.
short class_name: ParticleLoad
full class_name : oceantracker.particle_properties.load_carrying.ParticleLoad
Inheritance: > ParameterBaseClass> _BaseParticleProperty> CustomParticleProperty> ParticleLoad
Parameters:¶
class_name<class 'str'><optional>Description: Class name as string A.B.C, used to import this class from python path
default:
Nonedata_type:
<class 'str'>
description<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>
dtype<class 'str'><optional>
default:
float64data_type:
<class 'str'>possible_values:
['float64', 'float32', 'bool', 'int32', 'int16', 'int8', 'int64']
initial_value<class 'float'><optional>Description: Value of the particle property when it is released
default:
1.0data_type:
<class 'float'>
name<class 'str'><isrequired>Description: Name used to refer to this particle property in code and output
default:
Nonedata_type:
<class 'str'>
prop_dim3<class 'int'><optional>Description: size of a 3d dimesion of particle property
default:
1data_type:
<class 'int'>min:
1
time_varying<class 'bool'><optional>
default:
Truedata_type:
<class 'bool'>possible_values:
[True, False]
units<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>
update<class 'bool'><optional>
default:
Truedata_type:
<class 'bool'>possible_values:
[True, False]
user_note<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>
vector_dim<class 'int'><optional>
default:
1data_type:
<class 'int'>min:
1
write<class 'bool'><optional>Description: Write particle property to tracks or event files file
default:
Truedata_type:
<class 'bool'>possible_values:
[True, False]
Expert Parameters:¶
release_group_parameters: <optional>Description: - In development: release group specific particle prop params
a list containing type:
[]default list :
Nonedata_type:
<class 'str'>possible_types:
[]make_list_unique:
Falsemin_len:
0