MOM6
|
Provides transparent structures with groups of MOM6 variables and supporting routines.
Data Types | |
type | accel_diag_ptrs |
Pointers to arrays with accelerations, which can later be used for derived diagnostics, like energy balances. More... | |
type | bt_cont_type |
Container for information about the summed layer transports and how they will vary as the barotropic velocity is changed. More... | |
type | cont_diag_ptrs |
Pointers to arrays with transports, which can later be used for derived diagnostics, like energy balances. More... | |
type | ocean_internal_state |
Pointers to all of the prognostic variables allocated in MOM_variables.F90 and MOM.F90. More... | |
type | p2d |
A structure for creating arrays of pointers to 2D arrays. More... | |
type | p3d |
A structure for creating arrays of pointers to 3D arrays. More... | |
type | surface |
Pointers to various fields which may be used describe the surface state of MOM, and which will be returned to a the calling program. More... | |
type | thermo_var_ptrs |
Pointers to an assortment of thermodynamic fields that may be available, including potential temperature, salinity, heat capacity, and the equation of state control structure. More... | |
type | vertvisc_type |
Vertical viscosities, drag coefficients, and related fields. More... | |
Functions/Subroutines | |
subroutine, public | allocate_surface_state (sfc_state, G, use_temperature, do_integrals, gas_fields_ocn, use_meltpot, use_iceshelves) |
Allocates the fields for the surface (return) properties of the ocean model. Unused fields are unallocated. More... | |
subroutine, public | deallocate_surface_state (sfc_state) |
Deallocates the elements of a surface state type. More... | |
subroutine, public | alloc_bt_cont_type (BT_cont, G, alloc_faces) |
Allocates the arrays contained within a BT_cont_type and initializes them to 0. More... | |
subroutine, public | dealloc_bt_cont_type (BT_cont) |
Deallocates the arrays contained within a BT_cont_type. More... | |
subroutine, public | mom_thermovar_chksum (mesg, tv, G) |
Diagnostic checksums on various elements of a thermo_var_ptrs type for debugging. More... | |
subroutine, public mom_variables::alloc_bt_cont_type | ( | type(bt_cont_type), pointer | BT_cont, |
type(ocean_grid_type), intent(in) | G, | ||
logical, intent(in), optional | alloc_faces | ||
) |
Allocates the arrays contained within a BT_cont_type and initializes them to 0.
bt_cont | The BT_cont_type whose elements will be allocated | |
[in] | g | The ocean's grid structure |
[in] | alloc_faces | If present and true, allocate memory for effective face thicknesses. |
Definition at line 395 of file MOM_variables.F90.
References mom_error_handler::mom_error().
Referenced by mom_barotropic::barotropic_init().
subroutine, public mom_variables::allocate_surface_state | ( | type(surface), intent(inout) | sfc_state, |
type(ocean_grid_type), intent(in) | G, | ||
logical, intent(in), optional | use_temperature, | ||
logical, intent(in), optional | do_integrals, | ||
type(coupler_1d_bc_type), intent(in), optional | gas_fields_ocn, | ||
logical, intent(in), optional | use_meltpot, | ||
logical, intent(in), optional | use_iceshelves | ||
) |
Allocates the fields for the surface (return) properties of the ocean model. Unused fields are unallocated.
[in] | g | ocean grid structure |
[in,out] | sfc_state | ocean surface state type to be allocated. |
[in] | use_temperature | If true, allocate the space for thermodynamic variables. |
[in] | do_integrals | If true, allocate the space for vertically integrated fields. |
[in] | gas_fields_ocn | If present, this type describes the ocean |
[in] | use_meltpot | If true, allocate the space for melt potential |
[in] | use_iceshelves | If true, allocate the space for the stresses under ice shelves. |
Definition at line 297 of file MOM_variables.F90.
subroutine, public mom_variables::dealloc_bt_cont_type | ( | type(bt_cont_type), pointer | BT_cont | ) |
Deallocates the arrays contained within a BT_cont_type.
bt_cont | The BT_cont_type whose elements will be deallocated. |
Definition at line 431 of file MOM_variables.F90.
subroutine, public mom_variables::deallocate_surface_state | ( | type(surface), intent(inout) | sfc_state | ) |
Deallocates the elements of a surface state type.
[in,out] | sfc_state | ocean surface state type to be deallocated here. |
Definition at line 370 of file MOM_variables.F90.
subroutine, public mom_variables::mom_thermovar_chksum | ( | character(len=*), intent(in) | mesg, |
type(thermo_var_ptrs), intent(in) | tv, | ||
type(ocean_grid_type), intent(in) | G | ||
) |
Diagnostic checksums on various elements of a thermo_var_ptrs type for debugging.
[in] | mesg | A message that appears in the checksum lines |
[in] | tv | A structure pointing to various thermodynamic variables |
[in] | g | The ocean's grid structure |
Definition at line 452 of file MOM_variables.F90.
Referenced by mom_diabatic_driver::diabatic_ale(), mom_diabatic_driver::diabatic_ale_legacy(), and mom_diabatic_driver::layered_diabatic().