/[MITgcm]/manual/s_phys_pkgs/text/sbo_description.tex
ViewVC logotype

Contents of /manual/s_phys_pkgs/text/sbo_description.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (show annotations) (download) (as text)
Mon Aug 1 19:14:05 2005 UTC (19 years, 11 months ago) by cnh
Branch: MAIN
File MIME type: application/x-tex
Added sbo package .tex that is not referenced yet.
This tex used to be in pkg/sbo but the pkg/sbo file
now only contains the short description .tex.

1 %%
2 %% $Header: /u/gcmpack/MITgcm/pkg/sbo/sbo_description.tex,v 1.2 2004/05/05 22:50:54 dimitri Exp $
3 %% $Name: $
4 %%
5
6 \chapter{Online computation of angular momentum terms}
7
8 \begin{verbatim}
9 Subdirectory pkg/sbo contains a small diagnostic package that computes IERS
10 Special Bureau for the Oceans (SBO) core products, including oceanic mass,
11 center-of-mass, angular, and bottom pressure. The package is enabled by
12 adding sbo to packages.conf and "useSBO=.TRUE." in data.pkg during model
13 execution. There are two separate output products, SBO_DIAG.* and
14 OBPtave*, which are described below.
15
16 ===========
17
18 SBO_DIAG.data is a single file that contains the following fields at every
19 model time step:
20
21 myCurrentTime - model integration time (s)
22 xoamc - x-comp oam due to currents (kg-m**2/s)
23 yoamc - y-comp oam due to currents (kg-m**2/s)
24 zoamc - z-comp oam due to currents (kg-m**2/s)
25 xoamp - x-comp oam due to pressure (kg-m**2/s)
26 yoamp - y-comp oam due to pressure (kg-m**2/s)
27 zoamp - z-comp oam due to pressure (kg-m**2/s)
28 mass - mass of oceans (kg)
29 xcom - x-comp of center-of-mass of oceans (m)
30 ycom - y-comp of center-of-mass of oceans (m)
31 zcom - z-comp of center-of-mass of oceans (m)
32
33 The file is direct access, real*8, binary. Its dimensions are 11 X nt, where
34 nt is number of records. For example, in matlab you can use
35
36 sbo=readbin('SBO_DIAG.data',[11 nt],1,'real*8',0,'native');
37
38 to obtain the 11 X nt matlab array sbo. A copy of readbin.m resides in
39 subdirectory verification/lab_sea/matlab.
40
41 ===========
42
43 OBPtave* files contain ocean-bottom pressure in Pascals (N/m^2). Ocean bottom
44 pressure is cumulated and averaged for sbo_taveFreq seconds. Parameter
45 sbo_taveFreq is specified in data.sbo during model execution. For example:
46
47 # SBO parameters
48 &SBO_PARM01
49 sbo_taveFreq = 86400.
50 &
51
52 will average and dump bottom pressure once per day. The bottom pressure files
53 are 2-dimensional fields with dimension nx X ny equal to those of the model
54 domain. The files have standard MITgcmUV mdsio output format. The files are
55 direct access, real*4, binary. They can be global or tiled (depending on
56 whether "globalFiles=.TRUE." is set in parameter file data). For example, in
57 matlab you can use
58
59 obp=readbin('OBPtave0000000020.data',[nx ny],1);
60
61 to read a global bottom pressure file output at model time step 20. Land is
62 flagged with -999.99 values.
63
64 ===========
65
66 SBO package file description
67
68 Added:
69 pkg/sbo/sbo_calc.F - main SBO routine, lots of comments
70 pkg/sbo/sbo_check.F - check for package consistency
71 pkg/sbo/sbo_diags.F - SBO diagnostics
72 pkg/sbo/sbo_readparms.F - read parameter file data.sbo
73 pkg/sbo/sbo_rho.F - in-situ density computation
74 pkg/sbo/sbo_writevector.F - write direct access binary vector
75 pkg/sbo/SBO.h - main header file
76 pkg/sbo/SBO_OPTIONS.h - SBO compiler time options
77 doc/README.sbo - description of SBO package
78 utils/matlab/read_record.m - matlab routine for reading binary files
79 utils/matlab/readbin.m - matlab routine for reading binary files
80 verification/natl_box/input/data.sbo - example parameter file
81
82 Modified:
83 model/inc/CPP_OPTIONS.h - added ALLOW_SBO
84 model/inc/PARAMS.h - added useSBO
85 model/src/do_the_model_io.F - added call to SBO package
86 model/src/packages_boot.F - added call to SBO package
87 model/src/packages_check.F - added call to SBO package
88 model/src/packages_readparms.F - added call to SBO package
89 \end{verbatim}

  ViewVC Help
Powered by ViewVC 1.1.22