VerticalGradient#
Doc: Add a vertical gradient field of the “get_grad_of_field_named” param, as a custom field named “get_grad_of_field_named_vertical_grad”’ Holds the gradient of each layer, ie. the slope of the named field between the layer’s two interfaces, stored at the layer’s lower interface. This is the exact vertical derivative of the linearly interpolated named field, so particles get the value of the layer they are in (is_layer_value=True), without vertical interpolation. Interpolating it vertically would give the particle the gradient from about half a layer higher.
short class_name: VerticalGradient
full class_name : oceantracker.fields.field_vertical_gradient.VerticalGradient
Warning
Class is under development may not yet work in all cases, if errors contact developer
Inheritance: > ParameterBaseClass> _BaseField> CustomFieldBase> VerticalGradient
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]
get_grad_of_field_named<class 'str'><isrequired>Description: Name of field to calculate the vertical gradient of
default:
Nonedata_type:
<class 'str'>deprecated:
False
is3D<class 'bool'><optional>
default:
Truedata_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'><isrequired>Description: Name to refer to this field internally within code, must be given
default:
Nonedata_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: Gradient is per layer, particles get the value of the layer they are in
default:
Truedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]