mom_particles_mod module reference¶
A set of dummy interfaces for compiling the MOM6 drifters code.
Functions/Subroutines¶
Initializes particles container “parts”. |
|
The main driver the steps updates particles. |
|
Save particle locations (and sometimes other vars) to restart file. |
|
Deallocate all memory and disassociated pointer. |
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)¶ 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 [s]
u :: [in] Zonal velocity field [m s-1]
v :: [in] Meridional velocity field [m s-1]
- Called from:
-
subroutine
mom_particles_mod/particles_run(parts, time, uo, vo, ho, tv, stagger)¶ The main driver the steps updates particles.
- Parameters:
parts :: Container for all types and memory
time :: [in] Model time
uo :: [in] Ocean zonal velocity [m s-1]
vo :: [in] Ocean meridional velocity [m s-1]
ho :: [in] Ocean layer thickness [H ~> m or kg m-2]
tv :: [in] structure containing pointers to available thermodynamic fields
stagger :: [in] Flag for whether velocities are staggered
- Called from:
-
subroutine
mom_particles_mod/particles_save_restart(parts, temp, salt)¶ Save particle locations (and sometimes other vars) to restart file.
- Parameters:
parts :: Container for all types and memory
temp :: [in] Optional container for temperature
salt :: [in] Optional container for salinity
- Called from:
-
subroutine
mom_particles_mod/particles_end(parts, temp, salt)¶ Deallocate all memory and disassociated pointer.
- Parameters:
parts :: Container for all types and memory
temp :: [in] Optional container for temperature
salt :: [in] Optional container for salinity
- Called from: