mom_particles_mod module reference

A set of dummy interfaces for compiling the MOM6 drifters code.

More…

Functions/Subroutines

particles_init()

Initializes particles container “parts”.

particles_run()

The main driver the steps updates particles.

particles_save_restart()

Save particle locations (and sometimes other vars) to restart file.

particles_end()

Deallocate all memory and disassociated pointer.

particles_to_k_space()

particles_to_z_space()

Detailed Description

A set of dummy interfaces for compiling the MOM6 drifters code.

Function/Subroutine Documentation

subroutine mom_particles_mod/particles_init(parts, Grid, Time, dt, u, v, h)

Initializes particles container “parts”.

Parameters:

  • parts :: [out] Container for all types and memory

  • grid :: [in] Grid type from parent model

  • time :: [in] Time type from parent model

  • dt :: [in] particle timestep in seconds [T ~> s]

  • u :: [in] Zonal velocity field [L T-1 ~> m s-1]

  • v :: [in] Meridional velocity field [L T-1 ~> m s-1]

  • h :: [in] Thickness of each layer [H ~> m or kg m-2]

subroutine mom_particles_mod/particles_run(parts, time, uo, vo, ho, tv, use_uh, stagger)

The main driver the steps updates particles.

Parameters:

  • parts :: Container for all types and memory

  • time :: [in] Model time

  • uo :: [in] If use_uh is false, ocean zonal velocity [L T-1 ~>m s-1]. If use_uh is true, accumulated zonal thickness fluxes that are used to advect tracers [H L2 ~> m3 or kg]

  • vo :: [in] If use_uh is false, ocean meridional velocity [L T-1 ~>m s-1]. If use_uh is true, accumulated meridional thickness fluxes that are used to advect tracers [H L2 ~> m3 or kg]

  • ho :: [in] Ocean layer thickness [H ~> m or kg m-2]

  • tv :: [in] structure containing pointers to available thermodynamic fields

  • use_uh :: Flag for whether u and v are weighted by thickness

  • stagger :: [in] Flag for whether velocities are staggered

subroutine mom_particles_mod/particles_save_restart(parts, h, directory, time, time_stamped)

Save particle locations (and sometimes other vars) to restart file.

Parameters:

  • parts :: Container for all types and memory

  • h :: [in] Thickness of each layer [H ~> m or kg m-2]

  • directory :: [in] The directory where the restart files are to be written

  • time :: [in] The current model time

  • time_stamped :: [in] If present and true, add time-stamp to the restart file names

subroutine mom_particles_mod/particles_end(parts, h, temp, salt)

Deallocate all memory and disassociated pointer.

Parameters:

  • parts :: Container for all types and memory

  • h :: [in] Thickness of each layer [H ~> m or kg m-2]

  • temp :: [in] Optional container for temperature [C ~> degC]

  • salt :: [in] Optional container for salinity [S ~> ppt]

subroutine mom_particles_mod/particles_to_k_space(parts, h)
Parameters:

  • parts :: Container for all types and memory

  • h :: [in] Thickness of layers [H ~> m or kg m-2]

Called from:

mom::step_mom_thermo

subroutine mom_particles_mod/particles_to_z_space(parts, h)
Parameters:

  • parts :: Container for all types and memory

  • h :: [in] Thickness of layers [H ~> m or kg m-2]

Called from:

mom::step_mom_thermo