mom_tracer_advect mom_tracer_advect::tracer_advect_cs integer integer mom_tracer_advect::id_clock_advect id_clock_advect CPU time clocks. advect_tracer tracer_advect_init integer integer mom_tracer_advect::id_clock_pass id_clock_pass CPU time clocks. advect_tracer tracer_advect_init integer integer mom_tracer_advect::id_clock_sync id_clock_sync CPU time clocks. advect_tracer tracer_advect_init subroutine, public subroutine, public mom_tracer_advect::advect_tracer (h_end, uhtr, vhtr, OBC, dt, G, GV, US, CS, Reg, h_prev_opt, max_iter_in, x_first_in, uhr_out, vhr_out, h_out) advect_tracer h_end h_end uhtr uhtr vhtr vhtr OBC OBC dt dt G G GV GV US US CS CS Reg Reg h_prev_opt h_prev_opt max_iter_in max_iter_in x_first_in x_first_in uhr_out uhr_out vhr_out vhr_out h_out h_out This routine time steps the tracer concentration using a monotonic, conservative, weakly diffusive scheme. g ocean grid structure gv ocean vertical grid structure h_end layer thickness after advection [H ~> m or kg m-2] uhtr accumulated volume/mass flux through zonal face [H L2 ~> m3 or kg] vhtr accumulated volume/mass flux through merid face [H L2 ~> m3 or kg] obc specifies whether, where, and what OBCs are used dt time increment [T ~> s] us A dimensional unit scaling type cs control structure for module reg pointer to tracer registry h_prev_opt layer thickness before advection [H ~> m or kg m-2] max_iter_in The maximum number of iterations x_first_in If present, indicate whether to update first in the x- or y-direction. uhr_out accumulated volume/mass flux through zonal face vhr_out accumulated volume/mass flux through merid face h_out layer thickness before advection [H ~> m or kg m-2] advect_x advect_y mom_domains::do_group_pass id_clock_advect id_clock_pass id_clock_sync mom_error_handler::mom_error mom_offline_main::offline_advection_ale mom_offline_main::offline_advection_layer mom_offline_main::offline_redistribute_residual subroutine subroutine mom_tracer_advect::advect_x (Tr, hprev, uhr, uh_neglect, OBC, domore_u, ntr, Idt, is, ie, js, je, k, G, GV, US, usePPM, useHuynh) advect_x Tr Tr hprev hprev uhr uhr uh_neglect uh_neglect OBC OBC domore_u domore_u ntr ntr Idt Idt is is ie ie js js je je k k G G GV GV US US usePPM usePPM useHuynh useHuynh This subroutine does 1-d flux-form advection in the zonal direction using a monotonic piecewise linear scheme. g The ocean's grid structure gv The ocean's vertical grid structure tr The array of registered tracers to work on hprev cell volume at the end of previous tracer change [H L2 ~> m3 or kg] uhr accumulated volume/mass flux through the zonal face [H L2 ~> m3 or kg] uh_neglect A tiny zonal mass flux that can be neglected [H L2 ~> m3 or kg] obc specifies whether, where, and what OBCs are used domore_u If true, there is more advection to be done in this u-row idt The inverse of dt [T-1 ~> s-1] ntr The number of tracers is The starting tracer i-index to work on ie The ending tracer i-index to work on js The starting tracer j-index to work on je The ending tracer j-index to work on k The k-level to work on us A dimensional unit scaling type useppm If true, use PPM instead of PLM usehuynh If true, use the Huynh scheme for PPM interface values advect_tracer subroutine subroutine mom_tracer_advect::advect_y (Tr, hprev, vhr, vh_neglect, OBC, domore_v, ntr, Idt, is, ie, js, je, k, G, GV, US, usePPM, useHuynh) advect_y Tr Tr hprev hprev vhr vhr vh_neglect vh_neglect OBC OBC domore_v domore_v ntr ntr Idt Idt is is ie ie js js je je k k G G GV GV US US usePPM usePPM useHuynh useHuynh This subroutine does 1-d flux-form advection using a monotonic piecewise linear scheme. g The ocean's grid structure gv The ocean's vertical grid structure tr The array of registered tracers to work on hprev cell volume at the end of previous tracer change [H L2 ~> m3 or kg] vhr accumulated volume/mass flux through the meridional face [H L2 ~> m3 or kg] vh_neglect A tiny meridional mass flux that can be neglected [H L2 ~> m3 or kg] obc specifies whether, where, and what OBCs are used domore_v If true, there is more advection to be done in this v-row idt The inverse of dt [T-1 ~> s-1] ntr The number of tracers is The starting tracer i-index to work on ie The ending tracer i-index to work on js The starting tracer j-index to work on je The ending tracer j-index to work on k The k-level to work on us A dimensional unit scaling type useppm If true, use PPM instead of PLM usehuynh If true, use the Huynh scheme for PPM interface values advect_tracer subroutine, public subroutine, public mom_tracer_advect::tracer_advect_init (Time, G, US, param_file, diag, CS) tracer_advect_init Time Time G G US US param_file param_file diag diag CS CS Initialize lateral tracer advection module. time current model time g ocean grid structure us A dimensional unit scaling type param_file open file to parse for model parameters diag regulates diagnostic output cs module control structure id_clock_advect id_clock_pass id_clock_sync mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_advect::tracer_advect_end (CS) tracer_advect_end CS CS Close the tracer advection module. cs module control structure mom::mom_end This module contains the subroutines that advect tracers along coordinate surfaces. This program contains the subroutines that advect tracers horizontally (i.e. along layers). advect_tracer advects tracer concentrations using a combination of the modified flux advection scheme from Easter (Mon. Wea. Rev., 1993) with tracer distributions given by the monotonic modified van Leer scheme proposed by Lin et al. (Mon. Wea. Rev., 1994). This scheme conserves the total amount of tracer while avoiding spurious maxima and minima of the tracer concentration. If a higher order accuracy scheme is needed, suggest monotonic piecewise parabolic method, as described in Carpenter et al. (MWR, 1990). advect_tracer has 4 arguments, described below. This subroutine determines the volume of a layer in a grid cell at the previous instance when the tracer concentration was changed, so it is essential that the volume fluxes should be correct. It is also important that the tracer advection occurs before each calculation of the diabatic forcing.