ideal_age_example ideal_age_example::ideal_age_tracer_cs integer, parameter integer, parameter ideal_age_example::ntr_max ntr_max = 3 the maximum number of tracers in this module. logical function, public logical function, public ideal_age_example::register_ideal_age_tracer (HI, GV, param_file, CS, tr_Reg, restart_CS) register_ideal_age_tracer HI HI GV GV param_file param_file CS CS tr_Reg tr_Reg restart_CS restart_CS Register the ideal age tracer fields to be used with MOM. hi A horizontal index type structure gv The ocean's vertical grid structure param_file A structure to parse for run-time parameters cs The control structure returned by a previous call to register_ideal_age_tracer. tr_reg A pointer that is set to point to the control structure for the tracer advection and diffusion module restart_cs A pointer to the restart control structure atmos_ocean_fluxes_mod::aof_set_coupler_flux mom_error_handler::mom_error mom_io::query_vardesc mom_tracer_registry::register_tracer mom_io::var_desc subroutine, public subroutine, public ideal_age_example::initialize_ideal_age_tracer (restart, day, G, GV, US, h, diag, OBC, CS, sponge_CSp) initialize_ideal_age_tracer restart restart day day G G GV GV US US h h diag diag OBC OBC CS CS sponge_CSp sponge_CSp Sets the ideal age traces to their initial values and sets up the tracer output. restart .true. if the fields have already been read from a restart file. day Time of the start of the run. g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2] diag A structure that is used to regulate diagnostic output. obc This open boundary condition type specifies whether, where, and what open boundary conditions are used. cs The control structure returned by a previous call to register_ideal_age_tracer. sponge_csp Pointer to the control structure for the sponges. mom_error_handler::mom_error mom_io::query_vardesc mom_tracer_z_init::tracer_z_init subroutine, public subroutine, public ideal_age_example::ideal_age_tracer_column_physics (h_old, h_new, ea, eb, fluxes, dt, G, GV, US, CS, evap_CFL_limit, minimum_forcing_depth) ideal_age_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 Applies diapycnal diffusion, aging and regeneration at the surface to the ideal age 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 thermodynamic and tracer 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 to register_ideal_age_tracer. 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 mom_tracer_diabatic::tracer_vertdiff integer function, public integer function, public ideal_age_example::ideal_age_stock (h, stocks, G, GV, CS, names, units, stock_index) ideal_age_stock h h stocks stocks G G GV GV CS CS names names units units stock_index stock_index Calculates the mass-weighted integral of all tracer stocks, returning the number of stocks it has calculated. If stock_index is present, only the stock corresponding to that coded index is found. g The ocean's grid structure h Layer thicknesses [H ~> m or kg m-2] stocks the mass-weighted integrated amount of each tracer, in kg times concentration units [kg conc]. gv The ocean's vertical grid structure cs The control structure returned by a previous call to register_ideal_age_tracer. names the names of the stocks calculated. units the units of the stocks calculated. stock_index the coded index of a specific stock being sought. The number of stocks calculated here. mom_io::query_vardesc mom_tracer_flow_control::call_tracer_stocks subroutine, public subroutine, public ideal_age_example::ideal_age_tracer_surface_state (sfc_state, h, G, CS) ideal_age_tracer_surface_state sfc_state sfc_state h h G G CS CS This subroutine extracts the surface fields from this tracer package that are to be shared with the atmosphere in coupled configurations. This particular tracer package does not report anything back to the coupler. g The ocean's grid structure. sfc_state A structure containing fields that describe the surface state of the ocean. h Layer thickness [H ~> m or kg m-2]. cs The control structure returned by a previous call to register_ideal_age_tracer. subroutine, public subroutine, public ideal_age_example::ideal_age_example_end (CS) ideal_age_example_end CS CS Deallocate any memory associated with this tracer package. cs The control structure returned by a previous call to register_ideal_age_tracer. A tracer package of ideal age tracers. Originally by Robert Hallberg, 2002.This file contains an example of the code that is needed to set up and use a set (in this case two) of dynamically passive tracers for diagnostic purposes. The tracers here are an ideal age tracer that ages at a rate of 1/year once it is isolated from the surface, and a vintage tracer, whose surface concentration grows exponen- with time with a 30-year timescale (similar to CFCs).