# isomip_tracer module reference¶

Routines used to set up and use a set of (one for now) dynamically passive tracers in the ISOMIP configuration.

More…

## Data Types¶

 isomip_tracer_cs ISOMIP tracer package control structure.

## Functions/Subroutines¶

 register_isomip_tracer() This subroutine is used to register tracer fields. initialize_isomip_tracer() Initializes the NTR tracer fields in tr(:,:,:,:) isomip_tracer_column_physics() This subroutine applies diapycnal diffusion, including the surface boundary conditions and any other column tracer physics or chemistry to the tracers from this file. isomip_tracer_surface_state() This subroutine extracts the surface fields from this tracer package that are to be shared with the atmosphere in coupled configurations. isomip_tracer_end() Deallocate any memory used by the ISOMIP tracer package.

## Detailed Description¶

For now, just one passive tracer is injected in the sponge layer.

## Type Documentation¶

type isomip_tracer/isomip_tracer_cs

ISOMIP tracer package control structure.

Type fields
• % coupled_tracers [logical] :: These tracers are not offered to the coupler.

• % tracer_ic_file [character (len=200)] :: The full path to the IC file, or ” ” to initialize internally.

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

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

• % tr [real(:,:,:,:),pointer] :: The array of tracers used in this package, in g m-3?

• % land_val [real( ntr )] :: The value of tr used where land is masked out.

• % use_sponge [logical] :: If true, sponges may be applied somewhere in the domain.

• % ind_tr [integer( ntr )] :: Indices returned by atmos_ocn_coupler_flux if it is used and the surface tracer concentrations are to be provided to the coupler.

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

• % tr_desc [type(vardesc)( ntr )] :: Descriptions and metadata for the tracers in this package.

## Function/Subroutine Documentation¶

function isomip_tracer/register_isomip_tracer(HI, GV, param_file, CS, tr_Reg, restart_CS) [logical]

This subroutine is used to register tracer fields.

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

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

• param_file :: [in] A structure indicating the open file to parse for model parameter values.

• cs :: A pointer that is set to point to the control structure for this module (in/out).

• tr_reg :: A pointer to the tracer registry.

• restart_cs :: A pointer to the restart control structure.

Call to
subroutine isomip_tracer/initialize_isomip_tracer(restart, day, G, GV, h, diag, OBC, CS, ALE_sponge_CSp)

Initializes the NTR tracer fields in tr(:,:,:,:)

Parameters
• g :: [in] Grid structure.

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

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

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

• h :: [in] Layer thickness [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. This is not being used for now.

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

• ale_sponge_csp :: A pointer to the control structure for the sponges, if they are in use. Otherwise this may be unassociated.

Call to
subroutine isomip_tracer/isomip_tracer_column_physics(h_old, h_new, ea, eb, fluxes, dt, G, GV, US, CS, evap_CFL_limit, minimum_forcing_depth)

This subroutine applies diapycnal diffusion, including the surface boundary conditions and any other column tracer physics or chemistry to the tracers from this file.

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 ISOMIP_register_tracer.

• 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
subroutine isomip_tracer/isomip_tracer_surface_state(sfc_state, h, G, GV, CS)

This subroutine extracts the surface fields from this tracer package that are to be shared with the atmosphere in coupled configurations. This particular tracer package does not report anything back to the coupler.

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

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

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

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

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

Call to

ntr mom_coupler_types::set_coupler_type_data

subroutine isomip_tracer/isomip_tracer_end(CS)

Deallocate any memory used by the ISOMIP tracer package.

Parameters

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