cpl_aim%2Bocn/ocn/SIZE.xml

<!-- $Header: $ -->
<!-- $Name: $ -->


<description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             xsi:noNamespaceSchemaLocation="http://deslab.mit.edu/LCML/lcml.xsd"
             xmlns:dc="http://purl.org/dc/elements/1.1/">

  <descriptionName>Ocean SIZE Parameters</descriptionName>

  <descriptionInfo>Use to create the SIZE.h file that is used when building MITgcm.</descriptionInfo>

  <descriptionMetadata>
    <dc:creator>Constantinos Evangelinos</dc:creator>
    <dc:date>2006-06-06</dc:date>
  </descriptionMetadata>

  <descriptionTarget>
    <file>SIZE.h</file>
  </descriptionTarget>

  <descriptionContent>
   <startText>      INTEGER sNx
      INTEGER sNy
      INTEGER OLx
      INTEGER OLy
      INTEGER nSx
      INTEGER nSy
      INTEGER nPx
      INTEGER nPy
      INTEGER Nx
      INTEGER Ny
      INTEGER Nr</startText>
   <endText>

      INTEGER MAX_OLX
      INTEGER MAX_OLY
      PARAMETER ( MAX_OLX = OLx,
     $            MAX_OLY = OLy )&#x000A;</endText>

   <set>
      <setName>SIZE Parameters</setName>
      <setInfo>Compile Time array SIZE parameters.</setInfo>
      <startText>&#x000A;      PARAMETER (&#x000A;     $</startText>
      <endText>&#x000A;     $           Nx  = sNx*nSx*nPx,
     $           Ny  = sNy*nSy*nPy)</endText>
      <separator>&#x000A;     $</separator>
      <var>
        <name>sNx</name>
        <info>No. X points in sub-grid.</info>
        <type>numeric</type>
        <value>32</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           sNx = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>sNy</name>
        <info>No. Y points in sub-grid.</info>
        <type>numeric</type>
        <value>32</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           sNy = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>OLx</name>
        <info>Overlap extent in X.</info>
        <type>numeric</type>
        <value>2</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           OLx = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>OLy</name>
        <info>Overlap extent in Y.</info>
        <type>numeric</type>
        <value>2</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           OLy = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>nSx</name>
        <info>No. of sub-grids in X.</info>
        <type>numeric</type>
        <value>6</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           nSx = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>nSy</name>
        <info>No. of sub-grids in Y.</info>
        <type>numeric</type>
        <value>1</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           nSy = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>nPx</name>
        <info>No. of processes in X.</info>
        <type>numeric</type>
        <value>1</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           nPx = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>nPy</name>
        <info>No. of processes in Y.</info>
        <type>numeric</type>
        <value>1</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>           nPy = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
      <var>
        <name>Nr</name>
        <info>No. of points in Z for full process domain.</info>
        <type>numeric</type>
        <value>15</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>            Nr = </header>
        <trailer>,</trailer>
        <precision>integer</precision> 
        <range>[1,INFINITY)</range>
      </var>
   </set>
   <set>
      <setName>OBC Parameters</setName>
      <setInfo>Compile Time OBC SIZE parameters.</setInfo>
      <startText>&#x000A;      INTEGER nobcs &#x000A;      PARAMETER (&#x000A;     $</startText>
      <endText>)</endText>
      <separator>&#x000A;     $</separator>

      <var>
        <name>nobcs</name>
        <info>No. of open boundaries.</info>
        <type>numeric</type>
        <value>4</value>
        <use>true</use>
        <hidden>false</hidden>
        <header>      nobcs = </header>
        <trailer></trailer>
        <precision>integer</precision> 
        <range>[0,INFINITY)</range>
      </var>
   </set>
  </descriptionContent>
</description>
1	ce107	1.1	<!-- $Header: $ -->
2			<!-- $Name: $ -->
3
4
5
6			<description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7			xsi:noNamespaceSchemaLocation="http://deslab.mit.edu/LCML/lcml.xsd"
8			xmlns:dc="http://purl.org/dc/elements/1.1/">
9
10			<descriptionName>Ocean SIZE Parameters</descriptionName>
11
12			<descriptionInfo>Use to create the SIZE.h file that is used when building MITgcm.</descriptionInfo>
13
14			<descriptionMetadata>
15			<dc:creator>Constantinos Evangelinos</dc:creator>
16			<dc:date>2006-06-06</dc:date>
17			</descriptionMetadata>
18
19			<descriptionTarget>
20			<file>SIZE.h</file>
21			</descriptionTarget>
22
23			<descriptionContent>
24			<startText> INTEGER sNx
25			INTEGER sNy
26			INTEGER OLx
27			INTEGER OLy
28			INTEGER nSx
29			INTEGER nSy
30			INTEGER nPx
31			INTEGER nPy
32			INTEGER Nx
33			INTEGER Ny
34			INTEGER Nr</startText>
35			<endText>
36
37			INTEGER MAX_OLX
38			INTEGER MAX_OLY
39			PARAMETER ( MAX_OLX = OLx,
40			$ MAX_OLY = OLy ) </endText>
41
42			<set>
43			<setName>SIZE Parameters</setName>
44			<setInfo>Compile Time array SIZE parameters.</setInfo>
45			<startText> PARAMETER ( $</startText>
46			<endText> $ Nx = sNxnSxnPx,
47			$ Ny = sNynSynPy)</endText>
48			<separator> $</separator>
49			<var>
50			<name>sNx</name>
51			<info>No. X points in sub-grid.</info>
52			<type>numeric</type>
53			<value>32</value>
54			<use>true</use>
55			<hidden>false</hidden>
56			<header> sNx = </header>
57			<trailer>,</trailer>
58			<precision>integer</precision>
59			<range>[1,INFINITY)</range>
60			</var>
61			<var>
62			<name>sNy</name>
63			<info>No. Y points in sub-grid.</info>
64			<type>numeric</type>
65			<value>32</value>
66			<use>true</use>
67			<hidden>false</hidden>
68			<header> sNy = </header>
69			<trailer>,</trailer>
70			<precision>integer</precision>
71			<range>[1,INFINITY)</range>
72			</var>
73			<var>
74			<name>OLx</name>
75			<info>Overlap extent in X.</info>
76			<type>numeric</type>
77			<value>2</value>
78			<use>true</use>
79			<hidden>false</hidden>
80			<header> OLx = </header>
81			<trailer>,</trailer>
82			<precision>integer</precision>
83			<range>[1,INFINITY)</range>
84			</var>
85			<var>
86			<name>OLy</name>
87			<info>Overlap extent in Y.</info>
88			<type>numeric</type>
89			<value>2</value>
90			<use>true</use>
91			<hidden>false</hidden>
92			<header> OLy = </header>
93			<trailer>,</trailer>
94			<precision>integer</precision>
95			<range>[1,INFINITY)</range>
96			</var>
97			<var>
98			<name>nSx</name>
99			<info>No. of sub-grids in X.</info>
100			<type>numeric</type>
101			<value>6</value>
102			<use>true</use>
103			<hidden>false</hidden>
104			<header> nSx = </header>
105			<trailer>,</trailer>
106			<precision>integer</precision>
107			<range>[1,INFINITY)</range>
108			</var>
109			<var>
110			<name>nSy</name>
111			<info>No. of sub-grids in Y.</info>
112			<type>numeric</type>
113			<value>1</value>
114			<use>true</use>
115			<hidden>false</hidden>
116			<header> nSy = </header>
117			<trailer>,</trailer>
118			<precision>integer</precision>
119			<range>[1,INFINITY)</range>
120			</var>
121			<var>
122			<name>nPx</name>
123			<info>No. of processes in X.</info>
124			<type>numeric</type>
125			<value>1</value>
126			<use>true</use>
127			<hidden>false</hidden>
128			<header> nPx = </header>
129			<trailer>,</trailer>
130			<precision>integer</precision>
131			<range>[1,INFINITY)</range>
132			</var>
133			<var>
134			<name>nPy</name>
135			<info>No. of processes in Y.</info>
136			<type>numeric</type>
137			<value>1</value>
138			<use>true</use>
139			<hidden>false</hidden>
140			<header> nPy = </header>
141			<trailer>,</trailer>
142			<precision>integer</precision>
143			<range>[1,INFINITY)</range>
144			</var>
145			<var>
146			<name>Nr</name>
147			<info>No. of points in Z for full process domain.</info>
148			<type>numeric</type>
149			<value>15</value>
150			<use>true</use>
151			<hidden>false</hidden>
152			<header> Nr = </header>
153			<trailer>,</trailer>
154			<precision>integer</precision>
155			<range>[1,INFINITY)</range>
156			</var>
157			</set>
158			<set>
159			<setName>OBC Parameters</setName>
160			<setInfo>Compile Time OBC SIZE parameters.</setInfo>
161			<startText> INTEGER nobcs PARAMETER ( $</startText>
162			<endText>)</endText>
163			<separator> $</separator>
164
165			<var>
166			<name>nobcs</name>
167			<info>No. of open boundaries.</info>
168			<type>numeric</type>
169			<value>4</value>
170			<use>true</use>
171			<hidden>false</hidden>
172			<header> nobcs = </header>
173			<trailer></trailer>
174			<precision>integer</precision>
175			<range>[0,INFINITY)</range>
176			</var>
177			</set>
178			</descriptionContent>
179			</description>