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: None

  • data_type: <class 'str'>

• create_particle_property_with_same_name<class 'bool'> <optional>

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• is3D<class 'bool'> <optional>

  • default: False

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• is_vector<class 'bool'> <optional>

  • default: False

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• name<class 'str'> <optional>

  Description: Name to refer to this field internally within code

  • default: friction_velocity

  • data_type: <class 'str'>

• requires3D<class 'bool'> <optional>

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• time_varying<class 'bool'> <optional>

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

• user_note<class 'str'> <optional>

  • default: None

  • data_type: <class 'str'>

• write_interp_particle_prop_to_tracks_file<class 'bool'> <optional>

  • default: True

  • data_type: <class 'bool'>

  • possible_values: [True, False]

Expert Parameters: