rgc_tracer rgc_tracer::rgc_tracer_cs integer, parameter integer, parameter rgc_tracer::ntr ntr = 1 The number of tracers in this module. initialize_rgc_tracer register_rgc_tracer rgc_tracer_column_physics logical function, public logical function, public rgc_tracer::register_rgc_tracer (HI, GV, param_file, CS, tr_Reg, restart_CS) register_rgc_tracer HI HI GV GV param_file param_file CS CS tr_Reg tr_Reg restart_CS restart_CS This subroutine is used to register tracer fields. hi A horizontal index type structure. gv The ocean's vertical grid structure. param_file A structure indicating the open file to parse for model parameter values. cs A pointer that is set to point to the control structure for this module (in/out). tr_reg A pointer to the tracer registry. restart_cs A pointer to the restart control structure. mom_error_handler::mom_error ntr mom_tracer_registry::register_tracer mom_io::var_desc subroutine, public subroutine, public rgc_tracer::initialize_rgc_tracer (restart, day, G, GV, h, diag, OBC, CS, layer_CSp, sponge_CSp) initialize_rgc_tracer restart restart day day G G GV GV h h diag diag OBC OBC CS CS layer_CSp layer_CSp sponge_CSp sponge_CSp Initializes the NTR tracer fields in tr(:,:,:,:) and it sets up the tracer output. g Grid structure. gv The ocean's vertical grid structure. restart .true. if the fields have already been read from a restart file. day Time of the start of the run. h Layer thickness, in m or kg m-2. diag Structure used to regulate diagnostic output. obc This open boundary condition type specifies whether, where, and what open boundary conditions are used. This is not being used for now. cs The control structure returned by a previous call to RGC_register_tracer. layer_csp A pointer to the control structure sponge_csp A pointer to the control structure for the sponges, if they are in use. Otherwise this may be unassociated. mom_ale_sponge::get_ale_sponge_nz_data mom_error_handler::mom_error ntr mom_io::query_vardesc mom_sponge::set_up_sponge_field subroutine, public subroutine, public rgc_tracer::rgc_tracer_column_physics (h_old, h_new, ea, eb, fluxes, dt, G, GV, US, CS, evap_CFL_limit, minimum_forcing_depth) rgc_tracer_column_physics h_old h_old h_new h_new ea ea eb eb fluxes fluxes dt dt G G GV GV US US CS CS evap_CFL_limit evap_CFL_limit minimum_forcing_depth minimum_forcing_depth This subroutine applies diapycnal diffusion and any other column tracer physics or chemistry to the tracers from this file. This is a simple example of a set of advected passive tracers. g The ocean's grid structure. gv The ocean's vertical grid structure. h_old Layer thickness before entrainment [H ~> m or kg m-2]. h_new Layer thickness after entrainment [H ~> m or kg m-2]. ea an array to which the amount of fluid entrained eb an array to which the amount of fluid entrained fluxes A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs. dt The amount of time covered by this call [T ~> s]. us A dimensional unit scaling type cs The control structure returned by a previous call. evap_cfl_limit Limit on the fraction of the water that can be fluxed out of the top layer in a timestep [nondim]. minimum_forcing_depth The smallest depth over which fluxes can be applied [H ~> m or kg m-2]. mom_tracer_diabatic::applytracerboundaryfluxesinout ntr mom_tracer_diabatic::tracer_vertdiff subroutine, public subroutine, public rgc_tracer::rgc_tracer_end (CS) rgc_tracer_end CS CS cs The control structure returned by a previous call to RGC_register_tracer. This module contains the routines used to set up a dynamically passive tracer. Set up and use passive tracers requires the following: (1) register_RGC_tracer (2) apply diffusion, physics/chemistry and advect the tracer.