generic_tracer module reference

A non-functioning template of the GFDL ocean BGC.

More…

Functions/Subroutines

generic_tracer_register()

Unknown.

generic_tracer_init()

Initialize generic tracers.

generic_tracer_register_diag()

Unknown.

generic_tracer_coupler_get()

Get coupler values.

generic_tracer_coupler_accumulate()

Unknown.

generic_tracer_source()

Calls the corresponding generic_X_update_from_source routine for each package X.

generic_tracer_update_from_bottom()

Update the tracers from bottom fluxes.

generic_tracer_vertdiff_g()

Vertically diffuse all generic tracers for GOLD ocean.

generic_tracer_coupler_set()

Set the coupler values for each generic tracer.

generic_tracer_end()

End this module by calling the corresponding generic_X_end for each package X.

generic_tracer_get_list()

Get a pointer to the head of the generic tracers list.

generic_tracer_get_diag_list()

Unknown.

Detailed Description

A non-functioning template of the GFDL ocean BGC.

Function/Subroutine Documentation

subroutine generic_tracer/generic_tracer_registerNone()

Unknown.

subroutine generic_tracer/generic_tracer_init(isc, iec, jsc, jec, isd, ied, jsd, jed, nk, ntau, axes, grid_tmask, grid_kmt, init_time)

Initialize generic tracers.

Parameters
  • isc :: [in] Computation start index in i direction

  • iec :: [in] Computation end index in i direction

  • jsc :: [in] Computation start index in j direction

  • jec :: [in] Computation end index in j direction

  • isd :: [in] Data start index in i direction

  • ied :: [in] Data end index in i direction

  • jsd :: [in] Data start index in j direction

  • jed :: [in] Data end index in j direction

  • nk :: [in] Number of levels in k direction

  • ntau :: [in] Unknown

  • axes :: [in] Domain axes?

  • init_time :: [in] Time

  • grid_tmask :: [in] Mask

  • grid_kmt :: [in] Number of wet cells in column

subroutine generic_tracer/generic_tracer_register_diagNone()

Unknown.

subroutine generic_tracer/generic_tracer_coupler_get(IOB_struc)

Get coupler values.

Parameters

iob_struc :: [in] Ice Ocean Boundary flux structure

subroutine generic_tracer/generic_tracer_coupler_accumulate(IOB_struc, weight, model_time)

Unknown.

Parameters
  • iob_struc :: [in] Ice Ocean Boundary flux structure

  • weight :: [in] Unknown

  • model_time :: [in] Time

Called from

mom_generic_tracer::mom_generic_tracer_fluxes_accumulate

subroutine generic_tracer/generic_tracer_source(Temp, Salt, rho_dzt, dzt, hblt_depth, ilb, jlb, tau, dtts, grid_dat, model_time, nbands, max_wavelength_band, sw_pen_band, opacity_band, internal_heat, frunoff, grid_ht, current_wave_stress, sosga)

Calls the corresponding generic_X_update_from_source routine for each package X.

Parameters
  • temp :: [in] Potential temperature [deg C]

  • salt :: [in] Salinity [psu]

  • rho_dzt :: [in] Unknown

  • dzt :: [in] Ocean layer thickness [m]

  • hblt_depth :: [in] Boundary layer depth

  • ilb :: [in] Lower bounds of x extent of input arrays on data domain

  • jlb :: [in] Lower bounds of y extent of input arrays on data domain

  • tau :: [in] Time step index of field

  • dtts :: [in] Unknown

  • grid_dat :: [in] Unknown

  • model_time :: [in] Time

  • nbands :: [in] Unknown

  • max_wavelength_band :: [in] Unknown

  • sw_pen_band :: [in] Shortwave penetration

  • opacity_band :: [in] Unknown

  • internal_heat :: [in] Unknown

  • frunoff :: [in] Unknown

  • grid_ht :: [in] Unknown

  • current_wave_stress :: [in] Unknown

  • sosga :: [in] Global average sea surface salinity

subroutine generic_tracer/generic_tracer_update_from_bottom(dt, tau, model_time)

Update the tracers from bottom fluxes.

Parameters
  • dt :: [in] Time step increment

  • tau :: [in] Time step index used for the concentration field

  • model_time :: [in] Time

subroutine generic_tracer/generic_tracer_vertdiff_g(h_old, ea, eb, dt, kg_m2_to_H, m_to_H, tau)

Vertically diffuse all generic tracers for GOLD ocean.

Parameters
  • h_old :: [in] Unknown

  • ea :: [in] Unknown

  • eb :: [in] Unknown

  • dt :: [in] Unknown

  • kg_m2_to_h :: [in] Unknown

  • m_to_h :: [in] Unknown

  • tau :: [in] Unknown

subroutine generic_tracer/generic_tracer_coupler_set(IOB_struc, ST, SS, rho, ilb, jlb, tau, dzt, sosga, model_time)

Set the coupler values for each generic tracer.

Parameters
  • iob_struc :: [inout] Ice Ocean Boundary flux structure

  • ilb :: [in] Lower bounds of x extent of input arrays on data domain

  • jlb :: [in] Lower bounds of y extent of input arrays on data domain

  • tau :: [in] Time step index of field

  • st :: [in] Sea surface temperature [deg C]

  • ss :: [in] Sea surface salinity [psu]

  • rho :: [in] Ocean density [kg m-3]

  • dzt :: [in] Layer thickness [m]

  • sosga :: [in] Unknown

  • model_time :: [in] Time

subroutine generic_tracer/generic_tracer_endNone()

End this module by calling the corresponding generic_X_end for each package X.

subroutine generic_tracer/generic_tracer_get_list(list)

Get a pointer to the head of the generic tracers list.

Parameters

list :: Pointer to head of the linked list

subroutine generic_tracer/generic_tracer_get_diag_list(list)

Unknown.

Parameters

list :: Pointer to head of the linked list