mom_generic_tracer mom_generic_tracer::mom_generic_tracer_cs logical logical mom_generic_tracer::g_registered g_registered = .false. An state hidden in module data that is very much not allowed in MOM6. mom_generic_flux_init register_mom_generic_tracer logical function, public logical function, public mom_generic_tracer::register_mom_generic_tracer (HI, GV, param_file, CS, tr_Reg, restart_CS) register_mom_generic_tracer HI HI GV GV param_file param_file CS CS tr_Reg tr_Reg restart_CS restart_CS Initializes the generic tracer packages and adds their tracers to the list Adds the tracers in the list of generic tracers to the set of MOM tracers (i.e., MOM-register them) Register these tracers for restart. hi Horizontal index ranges gv The ocean's vertical grid structure param_file A structure to parse for run-time parameters cs Pointer to the control structure for this module tr_reg Pointer to the control structure for the tracer advection and diffusion module. restart_cs Pointer to the restart control structure. g_registered g_tracer_utils::g_tracer_get_alias mom_error_handler::mom_error mom_tracer_registry::register_tracer subroutine, public subroutine, public mom_generic_tracer::initialize_mom_generic_tracer (restart, day, G, GV, US, h, param_file, diag, OBC, CS, sponge_CSp, ALE_sponge_CSp) initialize_mom_generic_tracer 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 Initialize phase II: Initialize required variables for generic tracers There are some steps of initialization that cannot be done in register_MOM_generic_tracer This is the place and time to do them: Set the grid mask and initial time for all generic tracers. Diag_register them. Z_diag_register them. This subroutine initializes the NTR tracer fields in tr(:,:,:,:) and it 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] param_file A structure to parse for run-time parameters diag Regulates diagnostic output. obc This open boundary condition type specifies whether, where, and what open boundary conditions are used. cs Pointer to the control structure for this module. sponge_csp Pointer to the control structure for the sponges. ale_sponge_csp Pointer to the control structure for the ALE sponges. g_tracer_utils::g_tracer_get_alias g_tracer_utils::g_tracer_set_csdiag mom_error_handler::mom_error mom_tracer_initialization_from_z::mom_initialize_tracer_from_z mom_tracer_z_init::tracer_z_init subroutine, public subroutine, public mom_generic_tracer::mom_generic_tracer_column_physics (h_old, h_new, ea, eb, fluxes, Hml, dt, G, GV, CS, tv, optics, evap_CFL_limit, minimum_forcing_depth) mom_generic_tracer_column_physics h_old h_old h_new h_new ea ea eb eb fluxes fluxes Hml Hml dt dt G G GV GV CS CS tv tv optics optics evap_CFL_limit evap_CFL_limit minimum_forcing_depth minimum_forcing_depth Column physics for generic tracers. Get the coupler values for generic tracers that exchange with atmosphere Update generic tracer concentration fields from sources and sinks. Vertically diffuse generic tracer concentration fields. Update generic tracers from bottom and their bottom reservoir. This subroutine applies diapycnal diffusion and any other column tracer physics or chemistry to the tracers from this file. CFCs are relatively simple, as they are passive tracers. with only a surface flux as a source. 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 The amount of fluid entrained from the layer eb The amount of fluid entrained from the layer fluxes A structure containing pointers to thermodynamic and tracer forcing fields. hml Mixed layer depth [Z ~> m] dt The amount of time covered by this call [s] cs Pointer to the control structure for this module. tv A structure pointing to various thermodynamic variables optics The structure containing optical properties. evap_cfl_limit Limits how much water can be fluxed out of the top layer Stored previously in diabatic CS. minimum_forcing_depth The smallest depth over which fluxes can be applied [H ~> m or kg m-2] mom_tracer_diabatic::applytracerboundaryfluxesinout g_tracer_utils::g_tracer_get_alias g_tracer_utils::g_tracer_set_csdiag mom_diag_mediator::get_diag_time_end mom_spatial_means::global_area_mean mom_error_handler::mom_error integer function, public integer function, public mom_generic_tracer::mom_generic_tracer_stock (h, stocks, G, GV, CS, names, units, stock_index) mom_generic_tracer_stock h h stocks stocks G G GV GV CS CS names names units units stock_index stock_index This subroutine calculates mass-weighted integral on the PE either of all available tracer concentrations, or of a tracer that is being requested specifically, returning the number of stocks it has calculated. If the stock_index is present, only the stock corresponding to that coded index is returned. g The ocean's grid structure gv The ocean's vertical 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]. cs Pointer to the control structure for this module. 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. Return value, the number of stocks calculated here. g_tracer_utils::g_tracer_get_alias mom_tracer_flow_control::call_tracer_stocks integer function, public integer function, public mom_generic_tracer::mom_generic_tracer_min_max (ind_start, got_minmax, gmin, gmax, xgmin, ygmin, zgmin, xgmax, ygmax, zgmax, G, CS, names, units) mom_generic_tracer_min_max ind_start ind_start got_minmax got_minmax gmin gmin gmax gmax xgmin xgmin ygmin ygmin zgmin zgmin xgmax xgmax ygmax ygmax zgmax zgmax G G CS CS names names units units This subroutine find the global min and max of either of all available tracer concentrations, or of a tracer that is being requested specifically, returning the number of tracers it has gone through. ind_start The index of the tracer to start with got_minmax Indicates whether the global min and max are found for each tracer gmin Global minimum of each tracer, in kg times concentration units. gmax Global maximum of each tracer, in kg times concentration units. 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 g The ocean's grid structure cs Pointer to the control structure for this module. names The names of the stocks calculated. units The units of the stocks calculated. Return value, the number of tracers done here. g_tracer_utils::g_tracer_get_alias mom_tracer_flow_control::call_tracer_stocks subroutine, public subroutine, public mom_generic_tracer::mom_generic_tracer_surface_state (sfc_state, h, G, CS) mom_generic_tracer_surface_state sfc_state sfc_state h h G G CS CS This subroutine calculates the surface state and sets coupler values for those generic tracers that have flux exchange with atmosphere. This subroutine sets up the fields that the coupler needs to calculate the CFC fluxes between the ocean and atmosphere. g The ocean's grid structure sfc_state A structure containing fields that describe the surface state of the ocean. h Layer thicknesses [H ~> m or kg m-2] cs Pointer to the control structure for this module. mom_diag_mediator::get_diag_time_end mom_spatial_means::global_area_mean subroutine, public subroutine, public mom_generic_tracer::mom_generic_flux_init (verbosity) mom_generic_flux_init verbosity verbosity verbosity A 0-9 integer indicating a level of verbosity. g_registered mom_error_handler::mom_error subroutine, public subroutine, public mom_generic_tracer::mom_generic_tracer_fluxes_accumulate (flux_tmp, weight) mom_generic_tracer_fluxes_accumulate flux_tmp flux_tmp weight weight flux_tmp A structure containing pointers to thermodynamic and tracer forcing fields. weight A weight for accumulating this flux generic_tracer::generic_tracer_coupler_accumulate ocean_model_mod::update_ocean_model subroutine, public subroutine, public mom_generic_tracer::mom_generic_tracer_get (name, member, array, CS) mom_generic_tracer_get name name member member array array CS CS Copy the requested tracer into an array. name Name of requested tracer. member The tracer element to return. array Array filled by this routine. cs Pointer to the control structure for this module. subroutine, public subroutine, public mom_generic_tracer::end_mom_generic_tracer (CS) end_mom_generic_tracer CS CS This subroutine deallocates the memory owned by this module. cs Pointer to the control structure for this module. Drives the generic version of tracers TOPAZ and CFC and other GFDL BGC components.