mom_cfc_cap module reference

Simulates CFCs using atmospheric pressure, wind speed and sea ice cover provided via cap (only NUOPC cap is implemented so far).

More…

Data Types

cfc_cap_cs

The control structure for the CFC_cap tracer package.

Functions/Subroutines

register_cfc_cap()

Register the CFCs to be used with MOM and read the parameters that are used with this tracer package.

initialize_cfc_cap()

Initialize the CFC tracer fields and set up the tracer output.

init_tracer_cfc()

This subroutine initializes a tracer array.

cfc_cap_column_physics()

Applies diapycnal diffusion, souces and sinks and any other column tracer physics to the CFC cap tracers.

cfc_cap_stock()

Calculates the mass-weighted integral of all tracer stocks, returning the number of stocks it has calculated.

cfc_cap_surface_state()

Extracts the ocean surface CFC concentrations and copies them to sfc_state.

cfc_cap_fluxes()

Orchestrates the calculation of the CFC fluxes [mol m-2 s-1], including getting the ATM concentration, and calculating the solubility, Schmidt number, and gas exchange.

get_solubility()

Calculates the CFC’s solubility function following Warner and Weiss (1985) DSR, vol 32.

comp_cfc_schmidt()

Compute Schmidt numbers of CFCs following Wanninkhof (2014); doi:10.4319/lom.2014.12.351 Range of validity of fit is -2:40.

cfc_cap_end()

Deallocate any memory associated with the CFC cap tracer package.

cfc_cap_unit_tests()

Unit tests for the CFC cap module.

compare_values()

Test that ans and calc are approximately equal by computing the difference and comparing it against limit.

Detailed Description

Simulates CFCs using atmospheric pressure, wind speed and sea ice cover provided via cap (only NUOPC cap is implemented so far).

Type Documentation

type mom_cfc_cap/cfc_cap_cs

The control structure for the CFC_cap tracer package.

Type fields
  • % id_cfc11_cmor [integer] :: Diagnostic IDs.

  • % id_cfc12_cmor [integer] :: Diagnostic IDs.

  • % ic_file [character (len=200)] :: The file in which the CFC initial values can be found, or an empty string for internal initilaization.

  • % z_ic_file [logical] :: If true, the IC_file is in Z-space. The default is false.

  • % time [type(time_type),pointer] :: A pointer to the ocean model’s clock.

  • % tr_reg [type(tracer_registry_type),pointer] :: A pointer to the MOM6 tracer registry.

  • % cfc11 [real(:,:,:),pointer] :: The CFC11 concentration [mol kg-1].

  • % cfc12 [real(:,:,:),pointer] :: The CFC12 concentration [mol kg-1].

  • % cfc11_ic_val [real] :: The initial value assigned to CFC11 [mol kg-1].

  • % cfc12_ic_val [real] :: The initial value assigned to CFC12 [mol kg-1].

  • % cfc11_land_val [real] :: The value of CFC11 used where land is masked out [mol kg-1].

  • % cfc12_land_val [real] :: The value of CFC12 used where land is masked out [mol kg-1].

  • % tracers_may_reinit [logical] :: If true, tracers may be reset via the initialization code if they are not found in the restart files.

  • % cfc11_name [character (len=16)] :: CFC11 variable name.

  • % cfc12_name [character (len=16)] :: CFC12 variable name.

  • % diag [type(diag_ctrl),pointer] :: A structure that is used to regulate the timing of diagnostic output.

  • % restart_csp [type(mom_restart_cs),pointer] :: Model restart control structure.

  • % cfc11_desc [type(vardesc)] :: A set of metadata for the CFC11 tracer.

  • % cfc12_desc [type(vardesc)] :: A set of metadata for the CFC12 tracer.

Function/Subroutine Documentation

function mom_cfc_cap/register_cfc_cap(HI, GV, param_file, CS, tr_Reg, restart_CS) [logical]

Register the CFCs to be used with MOM and read the parameters that are used with this tracer package.

Parameters
  • hi :: [in] A horizontal index type structure.

  • gv :: [in] The ocean’s vertical grid structure.

  • param_file :: [in] 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.

Call to

mom_error_handler::mom_error mom_tracer_registry::register_tracer mom_io::var_desc

subroutine mom_cfc_cap/initialize_cfc_cap(restart, day, G, GV, US, h, diag, OBC, CS)

Initialize the CFC tracer fields and set up the tracer output.

Parameters
  • restart :: [in] .true. if the fields have already been read from a restart file.

  • day :: [in] Time of the start of the run.

  • g :: [in] The ocean’s grid structure.

  • gv :: [in] The ocean’s vertical grid structure.

  • us :: [in] A dimensional unit scaling type

  • h :: [in] Layer thicknesses [H ~> m or kg m-2].

  • diag :: [in] 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_CFC_cap.

Call to

init_tracer_cfc mom_diag_mediator::register_diag_field

subroutine mom_cfc_cap/init_tracer_cfc(h, tr, name, land_val, IC_val, G, GV, US, CS)

This subroutine initializes a tracer array.

Parameters
  • g :: [in] The ocean’s grid structure

  • gv :: [in] The ocean’s vertical grid structure.

  • us :: [in] A dimensional unit scaling type

  • h :: [in] Layer thicknesses [H ~> m or kg m-2]

  • tr :: [out] The tracer concentration array

  • name :: [in] The tracer name

  • land_val :: [in] A value the tracer takes over land

  • ic_val :: [in] The initial condition value for the tracer

  • cs :: The control structure returned by a previous call to register_CFC_cap.

Call to

mom_error_handler::mom_error mom_tracer_z_init::tracer_z_init

Called from

initialize_cfc_cap

subroutine mom_cfc_cap/cfc_cap_column_physics(h_old, h_new, ea, eb, fluxes, dt, G, GV, US, CS, evap_CFL_limit, minimum_forcing_depth)

Applies diapycnal diffusion, souces and sinks and any other column tracer physics to the CFC cap tracers. CFCs are relatively simple, as they are passive tracers with only a surface flux as a source.

Parameters
  • g :: [in] The ocean’s grid structure

  • gv :: [in] The ocean’s vertical grid structure

  • h_old :: [in] Layer thickness before entrainment [H ~> m or kg m-2].

  • h_new :: [in] Layer thickness after entrainment [H ~> m or kg m-2].

  • ea :: [in] an array to which the amount of fluid entrained

  • eb :: [in] an array to which the amount of fluid entrained

  • fluxes :: [in] A structure containing pointers to thermodynamic and tracer forcing fields. Unused fields have NULL ptrs.

  • dt :: [in] The amount of time covered by this call [T ~> s]

  • us :: [in] A dimensional unit scaling type

  • cs :: The control structure returned by a previous call to register_CFC_cap.

  • evap_cfl_limit :: [in] Limit on the fraction of the water that can be fluxed out of the top layer in a timestep [nondim]

  • minimum_forcing_depth :: [in] The smallest depth over which fluxes can be applied [H ~> m or kg m-2]

Call to

mom_tracer_diabatic::applytracerboundaryfluxesinout mom_tracer_diabatic::tracer_vertdiff

function mom_cfc_cap/cfc_cap_stock(h, stocks, G, GV, CS, names, units, stock_index) [integer]

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.

Parameters
  • g :: [in] The ocean’s grid structure.

  • gv :: [in] The ocean’s vertical grid structure.

  • h :: [in] Layer thicknesses [H ~> m or kg m-2].

  • stocks :: [out] 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_CFC_cap.

  • names :: [out] The names of the stocks calculated.

  • units :: [out] The units of the stocks calculated.

  • stock_index :: [in] The coded index of a specific stock being sought.

Return

undefined :: The number of stocks calculated here.

Call to

mom_io::query_vardesc

Called from

mom_tracer_flow_control::call_tracer_stocks

subroutine mom_cfc_cap/cfc_cap_surface_state(sfc_state, G, CS)

Extracts the ocean surface CFC concentrations and copies them to sfc_state.

Parameters
  • g :: [in] The ocean’s grid structure.

  • sfc_state :: [inout] A structure containing fields that describe the surface state of the ocean.

  • cs :: The control structure returned by a previous call to register_CFC_cap.

subroutine mom_cfc_cap/cfc_cap_fluxes(fluxes, sfc_state, G, US, Rho0, Time, id_cfc11_atm, id_cfc12_atm)

Orchestrates the calculation of the CFC fluxes [mol m-2 s-1], including getting the ATM concentration, and calculating the solubility, Schmidt number, and gas exchange.

Parameters
  • g :: [in] The ocean’s grid structure.

  • us :: [in] A dimensional unit scaling type

  • sfc_state :: [in] A structure containing fields that describe the surface state of the ocean.

  • fluxes :: [inout] A structure containing pointers to thermodynamic and tracer forcing fields. Unused fields have NULL ptrs.

  • rho0 :: [in] The mean ocean density [R ~> kg m-3]

  • time :: [in] The time of the fluxes, used for interpolating the CFC’s concentration in the atmosphere.

  • id_cfc11_atm :: [inout] id number for time_interp_external.

  • id_cfc12_atm :: [inout] id number for time_interp_external.

Call to

comp_cfc_schmidt get_solubility mom_error_handler::mom_error

subroutine mom_cfc_cap/get_solubility(alpha_11, alpha_12, ta, sal, mask)

Calculates the CFC’s solubility function following Warner and Weiss (1985) DSR, vol 32.

Parameters
  • alpha_11 :: [inout] The solubility of CFC 11 [mol kg-1 atm-1]

  • alpha_12 :: [inout] The solubility of CFC 12 [mol kg-1 atm-1]

  • ta :: [in] Absolute sea surface temperature [hectoKelvin]

  • sal :: [in] Surface salinity [PSU].

  • mask :: [in] ocean mask

Called from

cfc_cap_fluxes cfc_cap_unit_tests

subroutine mom_cfc_cap/comp_cfc_schmidt(sst_in, cfc11_sc, cfc12_sc)

Compute Schmidt numbers of CFCs following Wanninkhof (2014); doi:10.4319/lom.2014.12.351 Range of validity of fit is -2:40.

Parameters
  • sst_in :: [in] The sea surface temperature [degC].

  • cfc11_sc :: [inout] Schmidt number of CFC11 [nondim].

  • cfc12_sc :: [inout] Schmidt number of CFC12 [nondim].

Called from

cfc_cap_fluxes cfc_cap_unit_tests

subroutine mom_cfc_cap/cfc_cap_end(CS)

Deallocate any memory associated with the CFC cap tracer package.

Parameters

cs :: The control structure returned by a previous call to register_CFC_cap.

function mom_cfc_cap/cfc_cap_unit_tests(verbose) [logical]

Unit tests for the CFC cap module.

Parameters

verbose :: [in] If true, output additional information for debugging unit tests

Call to

comp_cfc_schmidt compare_values get_solubility mom_io::stdout

Called from

mom_unit_tests::unit_tests

function mom_cfc_cap/compare_values(verbose, test_name, calc, ans, limit) [logical]

Test that ans and calc are approximately equal by computing the difference and comparing it against limit.

Parameters
  • verbose :: [in] If true, write results to stdout

  • test_name :: [in] Brief description of the unit test

  • calc :: [in] computed value

  • ans :: [in] correct value

  • limit :: [in] value above which test fails

Called from

cfc_cap_unit_tests