namespace mom_variables

Overview

Provides transparent structures with groups of MOM6 variables and supporting routines. More…

namespace mom_variables {

// global functions

subroutine, public allocate_surface_state(
    sfc_state sfc_state,
    G G,
    use_temperature use_temperature,
    do_integrals do_integrals,
    gas_fields_ocn gas_fields_ocn,
    use_meltpot use_meltpot
    );

subroutine, public deallocate_surface_state(sfc_state sfc_state);
subroutine, public alloc_bt_cont_type(BT_cont BT_cont, G G, alloc_faces alloc_faces);
subroutine, public dealloc_bt_cont_type(BT_cont BT_cont);
subroutine, public mom_thermovar_chksum(mesg mesg, tv tv, G G);

} // namespace mom_variables

Detailed Documentation

Provides transparent structures with groups of MOM6 variables and supporting routines.

Global Functions

subroutine, public allocate_surface_state(
    sfc_state sfc_state,
    G G,
    use_temperature use_temperature,
    do_integrals do_integrals,
    gas_fields_ocn gas_fields_ocn,
    use_meltpot use_meltpot
    )

Allocates the fields for the surface (return) properties of the ocean model. Unused fields are unallocated.

Parameters:

g	ocean grid structure
sfc_state	ocean surface state type to be allocated.
use_temperature	If true, allocate the space for thermodynamic variables.
do_integrals	If true, allocate the space for vertically integrated fields.
gas_fields_ocn	If present, this type describes the ocean
use_meltpot	If true, allocate the space for melt potential

subroutine, public deallocate_surface_state(sfc_state sfc_state)

Deallocates the elements of a surface state type.

Parameters:

sfc_state

ocean surface state type to be deallocated here.

subroutine, public alloc_bt_cont_type(
    BT_cont BT_cont,
    G G,
    alloc_faces alloc_faces
    )

Allocates the arrays contained within a BT_cont_type and initializes them to 0.

Parameters:

bt_cont	The BT_cont_type whose elements will be allocated
g	The ocean’s grid structure
alloc_faces	If present and true, allocate memory for effective face thicknesses.

subroutine, public dealloc_bt_cont_type(BT_cont BT_cont)

Deallocates the arrays contained within a BT_cont_type.

Parameters:

bt_cont

The BT_cont_type whose elements will be deallocated.

subroutine, public mom_thermovar_chksum(mesg mesg, tv tv, G G)

Diagnostic checksums on various elements of a thermo_var_ptrs type for debugging.

Parameters:

mesg	A message that appears in the checksum lines
tv	A structure pointing to various thermodynamic variables
g	The ocean’s grid structure