FrictionVelocity#
Doc:
short class_name: FrictionVelocity
full class_name : oceantracker.fields.friction_velocity.FrictionVelocity
Warning
Class is under development may not yet work in all cases, if errors contact developer
Inheritance: > ParameterBaseClass> _BaseField> CustomFieldBase> FrictionVelocity
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'>deprecated:
False
create_particle_property_with_same_name<class 'bool'><optional>
default:
Truedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
is3D<class 'bool'><optional>
default:
Falsedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
is_vector<class 'bool'><optional>
default:
Falsedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
name<class 'str'><optional>Description: Name to refer to this field internally within code
default:
friction_velocitydata_type:
<class 'str'>deprecated:
False
requires3D<class 'bool'><optional>
default:
Truedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
time_varying<class 'bool'><optional>
default:
Truedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
user_note<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>deprecated:
False
write_interp_particle_prop_to_tracks_file<class 'bool'><optional>
default:
Truedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
Expert Parameters:#
is_layer_value<class 'bool'><optional>Description: 3D field holds one value per layer, stored at the layer’s lower interface, eg a vertical gradient. Particles get the value of the layer they are in, without interpolating in the vertical
default:
Falsedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]