A primitive-equation ocean model upgraded by the
NCAR Oceanography Section
National Center for Atmospheric Research *
PO Box 3000, Boulder, CO 80307
This model is based upon, but differs substantially from the
GFDL Modular Ocean Model (MOM 1.1)
which was implemented by
R.C. Pacanowski K. Dixon A. Rosati
Geophysical Fluid Dynamics Laboratory /NOAA
Princeton, NJ. 08542
based on the work of
Kirk Bryan: A numerical method for the study of the of the
circulation world ocean: 1969, J. Computat. Phys 4 347-376
and
the invaluable work of Mike Cox & Bert Semtner on earlier
fortran implementations.
Substantial changes to MOM 1.1 have been made in the
NCOM, and present MOM 1.1 users should be alert to such
changes and familiarize themselves with the many differences.
The user should pay particular attention
to the added model features and to the list of preprocessor
options: many of the MOM 1.1 options have been removed (see
checks.F), and several new options have been added.
Many of these differences have been noted where they occur in
the code, but it was impractical to mark all such differences.
Documentation of the NCOM is available in the NCAR technical
note referenced below. Hard-copies of the technical note were
distributed at the May 1996 and June 1997 CSM Workshops; electronic
copies are available from the NCOM website (see url below).
The NCOM user is encouraged to periodically check our website
for code updates and announcements. Several new and
updated links were added in June, 1997 when NCOM 1.3 was officially
released.
The NCOM is presently designed to execute on the NCAR Cray
Y-MP computers. In the future, we anticipate that the code
will be available for use on other architectures.
Note: CRAY = Cray Parallel Vector Processing Machines built by
Cray Research, Inc.
This version of the NCOM is presently configured to run in the two
resolutions documented in the NCOM Technical Note, 2x2 and 3x3,
in both stand-alone and coupled modes.
The present release of the NCAR CSM models relies on a locally modified
version of MPI.
The NCOM distribution (ocn_public_1.3.tar.gz) consists of the NCOM 1.3
Fortran source code and a collection of shell scripts.
An ascii file with a diagram of the ocn_public_1.3
structure is available here.
There are two scripts within the ~/ocn_public_1.3/Scripts/Coupled
subdirectory. The first, ocn.setup.csh, is described in general
terms in the Flux-Coupler documentation, and should be copied
to the directory specified by the environment variable $NQSDIR.
This is the setup script that the Flux-Coupler driver code will
invoke in order to create an executable image and generate and
collect all necessary start-up files, and it can be used for
two ocean-model resolutions: 2x2 and 3x3.
NOTE: The script ocn.setup.csh must be edited before
it is used for the first time. The user must define the
script variable MainDir, which identifies the parent
directory of the Source_code/ directory; e.g.,
set MainDir = ${FS}/username/ocn_public_1.3
Also, the resolution must be properly set:
setenv OCNRES 3x3 OR
setenv OCNRES 2x2
The second script, "setdefs.csh", is executed
by the first and is the script which creates the executable
binary file "ocn". This script specifies the C preprocessor
options for the ocean code; it is presently configured as
documented in the NCOM manual, but if the user wishes to
customize her/his application, this is the script in which to
specify the various available options.
NOTE: Unlike the ocn.setup.csh script, this script may remain
in the "Scripts" subdirectory when creating the ocn binary;
by default, the ocn.setup.csh script will look for setdefs.csh
there. The user may wish to move the binary-creation script
to another location, but then s/he must edit the
ocn.setup.csh script to indicate the new location (see
the ScriptDir definition)
The files with the ".2x2" and ".3x3" suffixes are resolution-
dependent files containing information for the creation of
the namelist-input file, ocn.parm.
The batch-job script stand-alone.csh compiles, loads, and executes
the stand-alone ocean model on the NCAR CRAY Y-MP computers, and is
designed to be self-documenting. Please read the documentation
that accompanies each script and follow the instructions listed
there.
NOTE: This script must be edited before being used.
The script comments indicate which variables should be set
by the user before execution -- do not attempt to use the
scripts without first setting these values.
setdefs_sa.csh is executed
by stand-alone.cshand is the script which creates the executable
binary file "ocn". This script specifies the C preprocessor
options for the ocean code; it is presently configured as
documented in the NCOM manual, but if the user wishes to
customize her/his application, this is the script in which to
specify the various available options.
The files with the ".2x2" and ".3x3" suffixes are resolution-
dependent files containing information for the creation of
the namelist-input file, ocn.parm.
The script list_revision_numbers_from_Cray is used to document the
RCS revision number of each file used in the compilation of the NCOM
source code. It is called from within ocn.setup.csh, and it will
produce a listing of each file and its corresponding revision number
in the file ocn_compile_output_mm_dd_yyyy_hh:mm:ss, which is
generated each time ocn.setup.csh is invoked.
The script output_file_print_statement is called from
list_revision_numbers_from_Cray and is used to format the
revision-number information.
The Source_Code subdirectory and its subdirectories contain
all of the Fortran source code for the NCOM. There are
two subdirectories of Source_Code: 2x2 and 3x3. Both of these
subdirectories contain resolution-dependent files.
This subdirectory contains the set of netCDF filters used to
convert the ocean-model history files from their native format
to netCDF format. Included are makefiles, filters, and readme.doc.
Please refer to the readme.doc file for details.
(c) Copyright 1997 University Corporation for Atmospheric Research/
National Center for Atmospheric Research/
Climate and Global Dynamics Division
This software, the NCAR CSM Ocean Model (NCOM), version 1.3 , was
upgraded by the Oceanography Section of the Climate and
Global Dynamics Division (CGD) of the National Center for Atmospheric
Research (NCAR), which is operated by the University Corporation for
Atmospheric Research (UCAR) and sponsored by the National Science
Foundation (NSF).
Access and use of this software shall impose the following obligations
and understandings on the user. The user is granted the right,
without any fee or cost, to use, copy, modify, alter, enhance and
distribute this software, and any derivative works thereof, and its
supporting documentation for any purpose whatsoever, except commercial
sales, provided that this entire notice appears in all copies of the
software, derivative works and supporting documentation. Further, the
user agrees to credit UCAR/NCAR/CGD in any publications that result
from the use of this software or in any software package that includes
this software. The names UCAR/NCAR/CGD, however, may not be used in
any advertising or publicity to endorse or promote any products or
commercial entity unless specific written permission is obtained from
UCAR/NCAR/CGD.
THE NCOM MATERIALS ARE MADE AVAILABLE WITH THE UNDERSTANDING THAT
UCAR/NCAR/CGD IS NOT OBLIGATED TO PROVIDE (AND WILL NOT PROVIDE) THE
USER WITH ANY SUPPORT, CONSULTING, TRAINING, OR ASSISTANCE OF ANY KIND
WITH REGARD TO THE USE, OPERATION AND PERFORMANCE OF THIS SOFTWARE, NOR
TO PROVIDE THE USER WITH ANY UPDATES, REVISIONS, NEW VERSIONS, OR "BUG
FIXES."
THIS SOFTWARE IS PROVIDED BY UCAR/NCAR/CGD "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL UCAR/NCAR/CGD BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER,
INCLUDING BUT NOT LIMITED TO CLAIMS ASSOCIATED WITH THE LOSS OF DATA
OR PROFITS, WHICH MAY RESULT FROM AN ACTION IN CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS CLAIM THAT ARISES OUT OF OR IN CONNECTION WITH THE
ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
* The National Center for Atmospheric Research is sponsored by
the National Science Foundation.
NCAR CSM Ocean Model, Version 1.3
All upgrades from the GFDL MOM 1.1 code
are subject to Copyright (C) 1996, 1997
University Corporation for Atmospheric Research
All Rights Reserved
This page is maintained by Nancy Norton
( njn01@ncar.ucar.edu )
Last modified on 19 June 1997.
Introduction
Documentation
General Notes on NCOM
Description of Distribution Contents
Stand-alone Ocean Scripts
File-documentation Scripts
Source_Code Directory
netCDF_Filters Directory
Copyright
DISTRIBUTION TERMS AND CONDITIONS NOTICE