mom_ocmip2_cfc mom_ocmip2_cfc::ocmip2_cfc_cs integer, parameter integer, parameter mom_ocmip2_cfc::ntr ntr = 2 the number of tracers in this module. logical function, public logical function, public mom_ocmip2_cfc::register_ocmip2_cfc (HI, GV, param_file, CS, tr_Reg, restart_CS) register_ocmip2_cfc HI HI GV GV param_file param_file CS CS tr_Reg tr_Reg restart_CS restart_CS Register the OCMIP2 CFC tracers to be used with MOM and read the parameters that are used with this tracer package. hi A horizontal index type structure. gv The ocean's vertical grid structure. 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 to the tracer registry. restart_cs A pointer to the restart control structure. flux_init_ocmip2_cfc mom_error_handler::mom_error mom_tracer_registry::register_tracer mom_io::var_desc subroutine, public subroutine, public mom_ocmip2_cfc::flux_init_ocmip2_cfc (CS, verbosity) flux_init_ocmip2_cfc CS CS verbosity verbosity This subroutine initializes the air-sea CFC fluxes, and optionally returns the indicies of these fluxes. It can safely be called multiple times. cs An optional pointer to the control structure for this module; if not present, the flux indicies are not stored. verbosity A 0-9 integer indicating a level of verbosity. atmos_ocean_fluxes_mod::aof_set_coupler_flux register_ocmip2_cfc subroutine, public subroutine, public mom_ocmip2_cfc::initialize_ocmip2_cfc (restart, day, G, GV, US, h, diag, OBC, CS, sponge_CSp) initialize_ocmip2_cfc restart restart day day G G GV GV US US h h diag diag OBC OBC CS CS sponge_CSp sponge_CSp Initialize the OCMP2 CFC tracer fields and set 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_OCMIP2_CFC. sponge_csp A pointer to the control structure for the sponges, if they are in use. Otherwise this may be unassociated. init_tracer_cfc subroutine subroutine mom_ocmip2_cfc::init_tracer_cfc (h, tr, name, land_val, IC_val, G, US, CS) init_tracer_cfc h h tr tr name name land_val land_val IC_val IC_val G G US US CS CS This subroutine initializes a tracer array. g The ocean's grid structure us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2] tr The tracer concentration array name The tracer name land_val A value the tracer takes over land ic_val The initial condition value for the tracer cs The control structure returned by a previous call to register_OCMIP2_CFC. mom_error_handler::mom_error mom_tracer_z_init::tracer_z_init initialize_ocmip2_cfc subroutine, public subroutine, public mom_ocmip2_cfc::ocmip2_cfc_column_physics (h_old, h_new, ea, eb, fluxes, dt, G, GV, US, CS, evap_CFL_limit, minimum_forcing_depth) ocmip2_cfc_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, souces and sinks and any other column tracer physics or chemistry to the OCMIP2 CFC tracers. 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 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_OCMIP2_CFC. 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 mom_ocmip2_cfc::ocmip2_cfc_stock (h, stocks, G, GV, CS, names, units, stock_index) ocmip2_cfc_stock h h stocks stocks G G GV GV CS CS names names units units stock_index stock_index This function calculates the mass-weighted integral of all tracer stocks, 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 The control structure returned by a previous call to register_OCMIP2_CFC. 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 mom_ocmip2_cfc::ocmip2_cfc_surface_state (sfc_state, h, G, CS) ocmip2_cfc_surface_state sfc_state sfc_state h h G G CS CS This subroutine extracts the surface CFC concentrations and other fields that are shared with the atmosphere to calculate CFC fluxes. 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_OCMIP2_CFC. subroutine, public subroutine, public mom_ocmip2_cfc::ocmip2_cfc_end (CS) ocmip2_cfc_end CS CS Deallocate any memory associated with the OCMIP2 CFC tracer package. cs The control structure returned by a previous call to register_OCMIP2_CFC. Simulates CFCs using the OCMIP2 protocols. By Robert Hallberg, 2007 This module contains the code that is needed to set up and use CFC-11 and CFC-12 in a fully coupled or ice-ocean model context using the OCMIP2 protocols