mom_tracer_flow_control mom_tracer_flow_control::tracer_flow_control_cs subroutine, public subroutine, public mom_tracer_flow_control::call_tracer_flux_init (verbosity) call_tracer_flux_init verbosity verbosity This subroutine carries out a series of calls to initialize the air-sea tracer fluxes, but it does not record the generated indicies, and it may be called before the ocean model has been initialized and may be called on non-ocean PEs. It is not necessary to call this routine for ocean-only runs, because the same calls are made again inside of the routines called by call_tracer_register. verbosity A 0-9 integer indicating a level of verbosity. mom_file_parser::close_param_file mom_get_input::get_mom_input ocean_model_mod::ocean_model_flux_init subroutine, public subroutine, public mom_tracer_flow_control::call_tracer_register (HI, GV, US, param_file, CS, tr_Reg, restart_CS) call_tracer_register HI HI GV GV US US param_file param_file CS CS tr_Reg tr_Reg restart_CS restart_CS This subroutine determines which tracer packages are to be used and does the calls to register their tracers to be advected, diffused, and read from restarts. hi A horizontal index type structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type param_file A structure to parse for run-time parameters. cs A pointer that is set to point to the control structure for this module. 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. mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_flow_control::tracer_flow_control_init (restart, day, G, GV, US, h, param_file, diag, OBC, CS, sponge_CSp, ALE_sponge_CSp, tv) tracer_flow_control_init restart restart day day G G GV GV US US h h param_file param_file diag diag OBC OBC CS CS sponge_CSp sponge_CSp ALE_sponge_CSp ALE_sponge_CSp tv tv This subroutine calls all registered tracer initialization subroutines. restart 1 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] param_file A structure to parse for run-time parameters 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 call_tracer_register. sponge_csp A pointer to the control structure for the sponges, if they are in use. Otherwise this may be unassociated. ale_sponge_csp A pointer to the control structure for the ALE sponges, if they are in use. Otherwise this may be unassociated. tv A structure pointing to various thermodynamic variables mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_flow_control::get_chl_from_model (Chl_array, G, CS) get_chl_from_model Chl_array Chl_array G G CS CS This subroutine extracts the chlorophyll concentrations from the model state, if possible. g The ocean's grid structure. chl_array The array in which to store the model's cs The control structure returned by a previous call to call_tracer_register. mom_error_handler::mom_error mom_diabatic_aux::set_pen_shortwave subroutine, public subroutine, public mom_tracer_flow_control::call_tracer_set_forcing (sfc_state, fluxes, day_start, day_interval, G, CS) call_tracer_set_forcing sfc_state sfc_state fluxes fluxes day_start day_start day_interval day_interval G G CS CS This subroutine calls the individual tracer modules' subroutines to specify or read quantities related to their surface forcing. sfc_state A structure containing fields that describe the surface state of the ocean. fluxes A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs. day_start Start time of the fluxes. day_interval Length of time over which these fluxes will be applied. g The ocean's grid structure. cs The control structure returned by a previous call to call_tracer_register. mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_flow_control::call_tracer_column_fns (h_old, h_new, ea, eb, fluxes, Hml, dt, G, GV, US, tv, optics, CS, debug, evap_CFL_limit, minimum_forcing_depth) call_tracer_column_fns h_old h_old h_new h_new ea ea eb eb fluxes fluxes Hml Hml dt dt G G GV GV US US tv tv optics optics CS CS debug debug evap_CFL_limit evap_CFL_limit minimum_forcing_depth minimum_forcing_depth This subroutine calls all registered tracer column physics subroutines. 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 from the layer above during this call will be added [H ~> m or kg m-2]. eb an array to which the amount of fluid entrained from the layer below during this call will be added [H ~> m or kg m-2]. fluxes A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs. hml Mixed layer depth [Z ~> m] dt The amount of time covered by this call [T ~> s] us A dimensional unit scaling type tv A structure pointing to various thermodynamic variables. optics The structure containing optical properties. cs The control structure returned by a previous call to call_tracer_register. debug If true calculate checksums 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_error_handler::mom_error mom_diabatic_driver::adiabatic mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_diabatic_driver::layered_diabatic mom_offline_main::offline_advection_layer mom_offline_main::offline_diabatic_ale subroutine, public subroutine, public mom_tracer_flow_control::call_tracer_stocks (h, stock_values, G, GV, CS, stock_names, stock_units, num_stocks, stock_index, got_min_max, global_min, global_max, xgmin, ygmin, zgmin, xgmax, ygmax, zgmax) call_tracer_stocks h h stock_values stock_values G G GV GV CS CS stock_names stock_names stock_units stock_units num_stocks num_stocks stock_index stock_index got_min_max got_min_max global_min global_min global_max global_max xgmin xgmin ygmin ygmin zgmin zgmin xgmax xgmax ygmax ygmax zgmax zgmax This subroutine calls all registered tracer packages to enable them to add to the surface state returned to the coupler. These routines are optional. g The ocean's grid structure. gv The ocean's vertical grid structure. h Layer thicknesses [H ~> m or kg m-2] stock_values The integrated amounts of a tracer on the current PE, usually in kg x concentration [kg conc]. cs The control structure returned by a previous call to call_tracer_register. stock_names Diagnostic names to use for each stock. stock_units Units to use in the metadata for each stock. num_stocks The number of tracer stocks being returned. stock_index The integer stock index from stocks_constants_mod of the stock to be returned. If this is present and greater than 0, only a single stock can be returned. got_min_max Indicates whether the global min and global_min The global minimum of each tracer global_max The global maximum of each tracer xgmin The x-position of the global minimum ygmin The y-position of the global minimum zgmin The z-position of the global minimum xgmax The x-position of the global maximum ygmax The y-position of the global maximum zgmax The z-position of the global maximum advection_test_tracer::advection_test_stock regional_dyes::dye_stock ideal_age_example::ideal_age_stock mom_error_handler::mom_error mom_generic_tracer::mom_generic_tracer_min_max mom_generic_tracer::mom_generic_tracer_stock mom_ocmip2_cfc::ocmip2_cfc_stock oil_tracer::oil_stock pseudo_salt_tracer::pseudo_salt_stock store_stocks mom_sum_output::write_energy subroutine subroutine mom_tracer_flow_control::store_stocks (pkg_name, ns, names, units, values, index, stock_values, set_pkg_name, max_ns, ns_tot, stock_names, stock_units) store_stocks pkg_name pkg_name ns ns names names units units values values index index stock_values stock_values set_pkg_name set_pkg_name max_ns max_ns ns_tot ns_tot stock_names stock_names stock_units stock_units This routine stores the stocks and does error handling for call_tracer_stocks. pkg_name The tracer package name ns The number of stocks associated with this tracer package names Diagnostic names to use for each stock. units Units to use in the metadata for each stock. values The values of the tracer stocks index The integer stock index from stocks_constants_mod of the stock to be returned. If this is present and greater than 0, only a single stock can be returned. stock_values The master list of stock values set_pkg_name The name of the last tracer package whose stocks were stored for a specific index. This is used to trigger an error if there are redundant stocks. max_ns The maximum size of the master stock list ns_tot The total number of stocks in the master list stock_names Diagnostic names to use for each stock in the master list stock_units Units to use in the metadata for each stock in the master list mom_error_handler::mom_error call_tracer_stocks subroutine, public subroutine, public mom_tracer_flow_control::call_tracer_surface_state (sfc_state, h, G, CS) call_tracer_surface_state sfc_state sfc_state h h G G CS CS This subroutine calls all registered tracer packages to enable them to add to the surface state returned to the coupler. These routines are optional. sfc_state A structure containing fields that describe the surface state of the ocean. g The ocean's grid structure. h Layer thicknesses [H ~> m or kg m-2] cs The control structure returned by a previous call to call_tracer_register. mom_error_handler::mom_error subroutine, public subroutine, public mom_tracer_flow_control::tracer_flow_control_end (CS) tracer_flow_control_end CS CS cs The control structure returned by a previous call to call_tracer_register. Orchestrates the registration and calling of tracer packages.