sanity module

Generic sanity check routines.

gridtools.sanity.saneDepthOptions(**kwargs)

Sanity check *_DEPTH options for MOM6.

The following equation must be true for this routine to return True:

MAXIMUM_DEPTH >= MINIMUM_DEPTH >= MASKING_DEPTH

A land mask is applied if a depth is equal to or shallower than the MASKING_DEPTH. If MASKING_DEPTH is undefined or deeper than MINIMUM_DEPTH, the land mask will use the MINIMUM_DEPTH to apply the land mask.

Returns

True of depth options are sane, False otherwise.

Return type

boolean

As the model is initialized, if this parameter is undefined, it is set to the maximum as seen from the supplied topography grid.

References