FractionalWaterDepth¶
Doc: Calculate the fraction of total water depth from particle’s z, ie fraction of depth including tide is zero at bottom 1 at sea surface
short class_name: FractionalWaterDepth
full class_name : oceantracker.particle_properties.fractional_water_depth.FractionalWaterDepth
Warning
Class is under development may not yet work in all cases, if errors contact developer
Inheritance: > ParameterBaseClass> _BaseParticleProperty> ManuallyUpdatedParticleProperty> FractionalWaterDepth
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']
extra_dimensions: <optional>Description: - list of the names of dimensions for vectors, or those with prop_dim3 set. Partile is added automatically
a list containing type:
[]default list :
Nonedata_type:
<class 'str'>possible_types:
[]make_list_unique:
Falsemin_len:
0
initial_value<class 'float'><optional>Description: Value given to particle property on release
default:
0.0data_type:
<class 'float'>
is3D<class 'bool'><optional>
default:
Falsedata_type:
<class 'bool'>possible_values:
[True, False]
name<class 'str'><optional>Description: name used within code and in output
default:
fractional_water_depthdata_type:
<class 'str'>
prop_dim3<class 'int'><optional>Description: size of a 3d dimension 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