namespace isomip_tracer

Overview

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

namespace isomip_tracer {

// global functions

logical function, public register_isomip_tracer(
    HI HI,
    GV GV,
    param_file param_file,
    CS CS,
    tr_Reg tr_Reg,
    restart_CS restart_CS
    );

subroutine, public initialize_isomip_tracer(
    restart restart,
    day day,
    G G,
    GV GV,
    h h,
    diag diag,
    OBC OBC,
    CS CS,
    ALE_sponge_CSp ALE_sponge_CSp
    );

subroutine, public isomip_tracer_column_physics(
    h_old h_old,
    h_new h_new,
    ea ea,
    eb eb,
    fluxes fluxes,
    dt dt,
    G G,
    GV GV,
    CS CS,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth minimum_forcing_depth
    );

subroutine, public isomip_tracer_surface_state(state state, h h, G G, CS CS);
subroutine, public isomip_tracer_end(CS CS);

} // namespace isomip_tracer

Detailed Documentation

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

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

Global Functions

logical function, public register_isomip_tracer(
    HI HI,
    GV GV,
    param_file param_file,
    CS CS,
    tr_Reg tr_Reg,
    restart_CS restart_CS
    )

This subroutine is used to register tracer fields.

Parameters:

hi	A horizontal index type structure.
gv	The ocean’s vertical grid structure.
param_file	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.

subroutine, public initialize_isomip_tracer(
    restart restart,
    day day,
    G G,
    GV GV,
    h h,
    diag diag,
    OBC OBC,
    CS CS,
    ALE_sponge_CSp ALE_sponge_CSp
    )

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

Parameters:

g	Grid structure.
gv	The ocean’s vertical grid structure.
restart	.true. if the fields have already been read from a restart file.
day	Time of the start of the run.
h	Layer thickness [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. 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.

subroutine, public isomip_tracer_column_physics(
    h_old h_old,
    h_new h_new,
    ea ea,
    eb eb,
    fluxes fluxes,
    dt dt,
    G G,
    GV GV,
    CS CS,
    evap_CFL_limit evap_CFL_limit,
    minimum_forcing_depth 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	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 [s]
cs	The control structure returned by a previous call to ISOMIP_register_tracer.
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 [m]

subroutine, public isomip_tracer_surface_state(state state, h h, G G, CS 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	The ocean’s grid structure.
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 ISOMIP_register_tracer.

subroutine, public isomip_tracer_end(CS CS)

Deallocate any memory used by the ISOMIP tracer package.

Parameters:

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