mom_check_scaling module reference

This module is used to check the dimensional scaling factors used by the MOM6 ocean model.

More…

Functions/Subroutines

check_mom6_scaling_factors()

Evaluate whether the dimensional scaling factors provide unique tests for all of the combinations of dimensions that are used in MOM6 (or perhaps widely used), and if they are not unique, explore whether another combination of scaling factors can be found that is unique or has less common cases with coinciding scaling.

compose_dimension_list()

This routine composes a list of the commonly used dimensional scaling factors in the MOM6 code, along with weights reflecting the frequency of their occurrence in the MOM6 code or other considerations of how likely the variables are be used.

add_scaling()

Augment the count the valid unit descriptions, and add the provided description and its weight to the end of the list if that list is allocated.

Detailed Description

This module is used to check the dimensional scaling factors used by the MOM6 ocean model.

Function/Subroutine Documentation

subroutine mom_check_scaling/check_mom6_scaling_factors(GV, US)

Evaluate whether the dimensional scaling factors provide unique tests for all of the combinations of dimensions that are used in MOM6 (or perhaps widely used), and if they are not unique, explore whether another combination of scaling factors can be found that is unique or has less common cases with coinciding scaling.

Parameters:

  • gv :: The container for vertical grid data

  • us :: [in] A dimensional unit scaling type

Call to:

mom_unique_scales::check_scaling_uniqueness compose_dimension_list mom_unique_scales::scales_to_powers

Called from:

mom::initialize_mom

subroutine mom_check_scaling/compose_dimension_list(ns, des, wts)

This routine composes a list of the commonly used dimensional scaling factors in the MOM6 code, along with weights reflecting the frequency of their occurrence in the MOM6 code or other considerations of how likely the variables are be used.

Parameters:

  • ns :: [out] The running sum of valid descriptions

  • des :: [inout] The unit descriptions that have been converted

  • wts :: [inout] A list of the integer weights for each scaling factor, perhaps the number of times it occurs in the MOM6 code.

Call to:

add_scaling

Called from:

check_mom6_scaling_factors

subroutine mom_check_scaling/add_scaling(ns, descs, wts, scaling, weight)

Augment the count the valid unit descriptions, and add the provided description and its weight to the end of the list if that list is allocated.

Parameters:

  • ns :: [inout] The running sum of valid descriptions.

  • descs :: [inout] The unit descriptions that have been converted

  • wts :: [inout] A list of the integers for each scaling

  • scaling :: [in] The unit description that will be converted

  • weight :: [in] An optional weight or occurrence count for this unit description, 1 by default.

Call to:

mom_error_handler::mom_mesg

Called from:

compose_dimension_list