38.5 Regional masks

For use with certain diagnostics calculations, the model domain may be sub-divided into a number of regions over which calculations are averaged. An arbitrary number of non-overlapping regions of areal extent are defined by setting a horizontal region mask number =m where (i,jrow) is in region m for $m=1\cdots nhreg$ and nhreg is the number of regions. One way to do this is to use the subroutine sethr which assigns to a region number within a rectangular region. Regions may be built up from calls to sethr but in general need not be simply rectangular.

In a similar fashion, the vertical region mask number $=\ell$ where k is in vertical region $\ell$ for $\ell=1\cdots nvreg$ and nvreg is the number of vertical regions. Unlike which may contain a region which is multiply connected, the kindices within a vertical region $\ell$ must be contiguous.

Regional volumes are constructed in subroutine setocn by the union of and such that the regional volume numbers are given by

$$nreg = nhreg\cdot(\mskvr-1) + \mskhr$$ (38.1)