Documentation of NCAR CCM0B Program Modules

This report describes the program modules (main program, subroutines, functions, and common blocks) included in the NCAR Community Climate Model CCMOB library, except those involved with the radiation parameterization. These radiation routines are currently being converted to the CCMOB library standards and will be documented in the future. The governing equations and algorithms defining the model are described mathematically in a companion NCAR Technical Note Description of the NCAR Community Climate Model (CCMOB) (Williamson, 1983). The basic code design and structure is described in a second companion report Users' Guide to NCAR CCMOB (Sato et al., 1983). This Users' Guide also includes instructions for modifying and running the model. The present report describing the individual subroutines is designed to be a bridge between these two reports and the actual code. For example, with subroutines dealing with the various physical parameterizations, the primary difference between this report and the Description . . . is one of algebra, while the difference between this report and the code itself is primarily in the symbols involved in each. The subroutines are described in alphabetical order with a standard format. The routine name and calling arguments (if present) are listed on the left of the first line, followed on the next line by the UPDATE DECK which contains the subroutine. This title information is followed by a brief description of the purpose of the subroutine. The arguments are then presented in the order of the calling statement. Each is followed by one or both of the symbols [in] or [out] indicating whether the variable serves as input to the routine, output from the routine, or both, with a description of the argument in each case. For many routines the brief initial description of the routine is then augmented by additional details of the algorithms involved. Numbered comments in this section refer to the corresponding numbered comments in the code itself. Finally, the recent programming history of the routine is indicated. This represents the history since the acquisition of the basic code from ECMWF.