/[MITgcm]/manual/s_getstarted/text/main-parms.tex
ViewVC logotype

Annotation of /manual/s_getstarted/text/main-parms.tex

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


Revision 1.1 - (hide annotations) (download) (as text)
Mon Apr 24 21:11:11 2006 UTC (19 years, 2 months ago) by molod
Branch: MAIN
File MIME type: application/x-tex
Add parameter list for model namelist

1 molod 1.1 \newpage
2    
3     \begin{table}
4     %\hspace*{-1.5in}
5     \begin{tabular}{lllc}
6    
7     \textbf{Name} & \textbf{value}
8     & \textbf{Description} & \textbf{Reference} \\
9     & & & \\
10    
11     buoyancyRelation &
12     & buoyancyRelation = OCEANIC
13     & %---ref---
14     \\
15     fluidIsAir & F
16     & fluid major constituent is Air
17     & %---ref---
18     \\
19     fluidIsWater & T
20     & fuild major constituent is Water
21     & %---ref---
22     \\
23     usingPCoords & F
24     & use p (or p
25     & %---ref---
26     \\
27     usingZCoords & T
28     & use z (or z
29     & %---ref---
30     \\
31     tRef & 2.0E+01 at K= top
32     & Reference temperature profile ( oC or K )
33     & %---ref---
34     \\
35     sRef & 3.0E+01 at K= top
36     & Reference salinity profile ( psu )
37     & %---ref---
38     \\
39     viscAh & 0.0E+00
40     & Lateral eddy viscosity ( $m^2/s$ )
41     & %---ref---
42     \\
43     viscAhMax & 1.0E+21
44     & Maximum lateral eddy viscosity ( $m^2/s$ )
45     & %---ref---
46     \\
47     viscAhGrid & 0.0E+00
48     & Grid dependent lateral eddy viscosity ( non-dim. )
49     & %---ref---
50     \\
51     useFullLeith & F
52     & Use Full Form of Leith Viscosity on/off flag
53     & %---ref---
54     \\
55     useStrainTensionVisc & F
56     & Use StrainTension Form of Viscous Operator on/off flag
57     & %---ref---
58     \\
59     useAreaViscLength & F
60     & Use area for visc length instead of geom. mean
61     & %---ref---
62     \\
63     viscC2leith & 0.0E+00
64     & Leith harmonic visc. factor (on grad(vort),non-dim.)
65     & %---ref---
66     \\
67     viscC2leithD & 0.0E+00
68     & Leith harmonic viscosity factor (on grad(div),non-dim.)
69     & %---ref---
70     \\
71     viscC2smag & 0.0E+00
72     & Smagorinsky harmonic viscosity factor (non-dim.)
73     & %---ref---
74     \\
75     viscA4 & 0.0E+00
76     & Lateral biharmonic viscosity ( $m^4/s$ )
77     & %---ref---
78     \\
79     viscA4Max & 1.0E+21
80     & Maximum biharmonic viscosity ( $m^2/s$ )
81     & %---ref---
82     \\
83     viscA4Grid & 0.0E+00
84     & Grid dependent biharmonic viscosity ( non-dim. )
85     & %---ref---
86     \\
87     viscC4leith & 0.0E+00
88     & Leith biharm viscosity factor (on grad(vort), non-dim.)
89     & %---ref---
90     \\
91     viscC4leithD & 0.0E+00
92     & Leith biharm viscosity factor (on grad(div), non-dim.)
93     & %---ref---
94     \\
95     viscC4Smag & 0.0E+00
96     & Smagorinsky biharm viscosity factor (non-dim)
97     & %---ref---
98     \\
99     no\_slip\_sides & T
100     & Viscous BCs: No-slip sides
101     & %---ref---
102     \\
103     sideDragFactor & 2.0E+00
104     & side-drag scaling factor (non-dim)
105     & %---ref---
106     \\
107     viscAr & 0.0E+00
108     & Vertical eddy viscosity ( units of $r^2/s$ )
109     & %---ref---
110     \\
111     no\_slip\_bottom & T
112     & Viscous BCs: No-slip bottom
113     & %---ref---
114     \\
115     bottomDragLinear & 0.0E+00
116     & linear bottom-drag coefficient ( 1/s )
117     & %---ref---
118     \\
119     bottomDragQuadratic & 0.0E+00
120     & quadratic bottom-drag coeff. ( 1/m )
121     & %---ref---
122     \\
123     diffKhT & 0.0E+00
124     & Laplacian diffusion of heat laterally ( $m^2/s$ )
125     & %---ref---
126     \\
127     diffK4T & 0.0E+00
128     & Bihaarmonic diffusion of heat laterally ( $m^4/s$ )
129     & %---ref---
130     \\
131     diffKhS & 0.0E+00
132     & Laplacian diffusion of salt laterally ( $m^2/s$ )
133     & %---ref---
134     \\
135     diffK4S & 0.0E+00
136     & Bihaarmonic diffusion of salt laterally ( $m^4/s$ )
137     & %---ref---
138     \\
139     diffKrNrT & 0.0E+00 at K= top
140     & vertical profile of vertical diffusion of Temp ( $m^2/s$ )
141     & %---ref---
142     \\
143     diffKrNrS & 0.0E+00 at K= top
144     & vertical profile of vertical diffusion of Salt ( $m^2/s$ )
145     & %---ref---
146     \\
147     diffKrBL79surf & 0.0E+00
148     & Surface diffusion for Bryan and Lewis 1979 ( $m^2/s$ )
149     & %---ref---
150     \\
151     diffKrBL79deep & 0.0E+00
152     & Deep diffusion for Bryan and Lewis 1979 ( $m^2/s$ )
153     & %---ref---
154     \\
155     diffKrBL79scl & 2.0E+02
156     & Depth scale for Bryan and Lewis 1979 ( m )
157     & %---ref---
158     \\
159     diffKrBL79Ho & -2.0E+03
160     & Turning depth for Bryan and Lewis 1979 ( m )
161     & %---ref---
162     \\
163     eosType & LINEAR
164     & Equation of State
165     & %---ref---
166     \\
167     tAlpha & 2.0E-04
168     & Linear EOS thermal expansion coefficient ( 1/oC )
169     & %---ref---
170     \\
171     \end{tabular}
172     \end{table}
173    
174     \newpage
175     \begin{table}
176     %\hspace*{-1.5in}
177     \begin{tabular}{lllc}
178    
179     \textbf{Name} & \textbf{value}
180     & \textbf{Description} & \textbf{Reference} \\
181     & & & \\
182     sBeta & 7.4E-04
183     & Linear EOS haline contraction coef ( 1/psu )
184     & %---ref---
185     \\
186     rhonil & 9.998E+02
187     & Reference density ( $kg/m^3$ )
188     & %---ref---
189     \\
190     rhoConst & 9.998E+02
191     & Reference density ( $kg/m^3$ )
192     & %---ref---
193     \\
194     rhoConstFresh & 9.998E+02
195     & Reference density ( $kg/m^3$ )
196     & %---ref---
197     \\
198     gravity & 9.81E+00
199     & Gravitational acceleration ( $m/s^2$ )
200     & %---ref---
201     \\
202     gBaro & 9.81E+00
203     & Barotropic gravity ( $m/s^2$ )
204     & %---ref---
205     \\
206     rotationPeriod & 8.6164E+04
207     & Rotation Period ( s )
208     & %---ref---
209     \\
210     omega & 7.292123516990375E-05
211     & Angular velocity ( rad/s )
212     & %---ref---
213     \\
214     f0 & 1.0E-04
215     & Reference coriolis parameter ( 1/s )
216     & %---ref---
217     \\
218     beta & 9.999999999999999E-12
219     & Beta ( 1/(m.s) )
220     & %---ref---
221     \\
222     freeSurfFac & 1.0E+00
223     & Implicit free surface factor
224     & %---ref---
225     \\
226     implicitFreeSurface & T
227     & Implicit free surface on/off flag
228     & %---ref---
229     \\
230     rigidLid & F
231     & Rigid lid on/off flag
232     & %---ref---
233     \\
234     implicSurfPress & 1.0E+00
235     & Surface Pressure implicit factor (0-1)
236     & %---ref---
237     \\
238     implicDiv2Dflow & 1.0E+00
239     & Barot. Flow Div. implicit factor (0-1)
240     & %---ref---
241     \\
242     exactConserv & F
243     & Exact Volume Conservation on/off flag
244     & %---ref---
245     \\
246     uniformLin\_PhiSurf & T
247     & use uniform Bo\_surf on/off flag
248     & %---ref---
249     \\
250     nonlinFreeSurf & 0
251     & Non-linear Free Surf. options (-1,0,1,2,3)
252     & %---ref---
253     \\
254     hFacInf & 2.0E-01
255     & lower threshold for hFac (nonlinFreeSurf only)
256     & %---ref---
257     \\
258     hFacSup & 2.0E+00
259     & upper threshold for hFac (nonlinFreeSurf only)
260     & %---ref---
261     \\
262     select\_rStar & 0
263     & r
264     & %---ref---
265     \\
266     useRealFreshWaterFlux & F
267     & Real Fresh Water Flux on/off flag
268     & %---ref---
269     \\
270     convertFW2Salt & 3.5E+01
271     & convert F.W. Flux to Salt Flux (-1=use local S)
272     & %---ref---
273     \\
274     use3Dsolver & F
275     & use 3-D pressure solver on/off flag
276     & %---ref---
277     \\
278     nonHydrostatic & F
279     & Non-Hydrostatic on/off flag
280     & %---ref---
281     \\
282     nh\_Am2 & 1.0E+00
283     & Non-Hydrostatic terms scaling factor
284     & %---ref---
285     \\
286     quasiHydrostatic & F
287     & Quasi-Hydrostatic on/off flag
288     & %---ref---
289     \\
290     momStepping & T
291     & Momentum equation on/off flag
292     & %---ref---
293     \\
294     vectorInvariantMomentum & F
295     & Vector-Invariant Momentum on/off
296     & %---ref---
297     \\
298     momAdvection & T
299     & Momentum advection on/off flag
300     & %---ref---
301     \\
302     momViscosity & T
303     & Momentum viscosity on/off flag
304     & %---ref---
305     \\
306     momImplVertAdv & F
307     & Momentum implicit vert. advection on/off
308     & %---ref---
309     \\
310     implicitViscosity & F
311     & Implicit viscosity on/off flag
312     & %---ref---
313     \\
314     metricTerms & F
315     & metric-Terms on/off flag
316     & %---ref---
317     \\
318     useNHMTerms & F
319     & Non-Hydrostatic Metric-Terms on/off
320     & %---ref---
321     \\
322     useCoriolis & T
323     & Coriolis on/off flag
324     & %---ref---
325     \\
326     useCDscheme & F
327     & CD scheme on/off flag
328     & %---ref---
329     \\
330     useJamartWetPoints & F
331     & Coriolis WetPoints method flag
332     & %---ref---
333     \\
334     useJamartMomAdv & F
335     & V.I. Non-linear terms Jamart flag
336     & %---ref---
337     \\
338     \end{tabular}
339     \end{table}
340    
341     \newpage
342     \begin{table}
343     %\hspace*{-1.5in}
344     \begin{tabular}{lllc}
345    
346     \textbf{Name} & \textbf{value}
347     & \textbf{Description} & \textbf{Reference} \\
348     & & & \\
349     SadournyCoriolis & F
350     & Sadourny Coriolis discr. flag
351     & %---ref---
352     \\
353     upwindVorticity & F
354     & Upwind bias vorticity flag
355     & %---ref---
356     \\
357     useAbsVorticity & F
358     & Work with f
359     & %---ref---
360     \\
361     highOrderVorticity & F
362     & High order interp. of vort. flag
363     & %---ref---
364     \\
365     upwindShear & F
366     & Upwind vertical Shear advection flag
367     & %---ref---
368     \\
369     selectKEscheme & 0
370     & Kinetic Energy scheme selector
371     & %---ref---
372     \\
373     momForcing & T
374     & Momentum forcing on/off flag
375     & %---ref---
376     \\
377     momPressureForcing & T
378     & Momentum pressure term on/off flag
379     & %---ref---
380     \\
381     implicitIntGravWave & F
382     & Implicit Internal Gravity Wave flag
383     & %---ref---
384     \\
385     staggerTimeStep & F
386     & Stagger time stepping on/off flag
387     & %---ref---
388     \\
389     multiDimAdvection & T
390     & enable/disable Multi-Dim Advection
391     & %---ref---
392     \\
393     useMultiDimAdvec & F
394     & Multi-Dim Advection is/is-not used
395     & %---ref---
396     \\
397     implicitDiffusion & F
398     & Implicit Diffusion on/off flag
399     & %---ref---
400     \\
401     tempStepping & T
402     & Temperature equation on/off flag
403     & %---ref---
404     \\
405     tempAdvection & T
406     & Temperature advection on/off flag
407     & %---ref---
408     \\
409     tempImplVertAdv & F
410     & Temp. implicit vert. advection on/off
411     & %---ref---
412     \\
413     tempForcing & T
414     & Temperature forcing on/off flag
415     & %---ref---
416     \\
417     saltStepping & T
418     & Salinity equation on/off flag
419     & %---ref---
420     \\
421     saltAdvection & T
422     & Salinity advection on/off flag
423     & %---ref---
424     \\
425     saltImplVertAdv & F
426     & Sali. implicit vert. advection on/off
427     & %---ref---
428     \\
429     saltForcing & T
430     & Salinity forcing on/off flag
431     & %---ref---
432     \\
433     readBinaryPrec & 32
434     & Precision used for reading binary files
435     & %---ref---
436     \\
437     writeBinaryPrec & 32
438     & Precision used for writing binary files
439     & %---ref---
440     \\
441     globalFiles & F
442     & write "global" (=not per tile) files
443     & %---ref---
444     \\
445     useSingleCpuIO & F
446     & only master MPI process does I/O
447     & %---ref---
448     \\
449     debugMode & F
450     & Debug Mode on/off flag
451     & %---ref---
452     \\
453     debLevA & 1
454     & 1rst level of debugging
455     & %---ref---
456     \\
457     debLevB & 2
458     & 2nd level of debugging
459     & %---ref---
460     \\
461     debugLevel & 1
462     & select debugging level
463     & %---ref---
464     \\
465     cg2dMaxIters & 150
466     & Upper limit on 2d con. grad iterations
467     & %---ref---
468     \\
469     cg2dChkResFreq & 1
470     & 2d con. grad convergence test frequency
471     & %---ref---
472     \\
473     cg2dTargetResidual & 1.0E-07
474     & 2d con. grad target residual
475     & %---ref---
476     \\
477     cg2dTargetResWunit & -1.0E+00
478     & CG2d target residual [W units]
479     & %---ref---
480     \\
481     cg2dPreCondFreq & 1
482     & Freq. for updating cg2d preconditioner
483     & %---ref---
484     \\
485     nIter0 & 0
486     & Run starting timestep number
487     & %---ref---
488     \\
489     nTimeSteps & 0
490     & Number of timesteps
491     & %---ref---
492     \\
493     deltatTmom & 6.0E+01
494     & Momentum equation timestep ( s )
495     & %---ref---
496     \\
497     deltaTfreesurf & 6.0E+01
498     & FreeSurface equation timestep ( s )
499     & %---ref---
500     \\
501     dTtracerLev & 6.0E+01 at K= top
502     & Tracer equation timestep ( s )
503     & %---ref---
504     \\
505     deltatTClock & 6.0E+01
506     & Model clock timestep ( s )
507     & %---ref---
508     \\
509     \end{tabular}
510     \end{table}
511    
512     \newpage
513     \begin{table}
514     %\hspace*{-1.5in}
515     \begin{tabular}{lllc}
516    
517     \textbf{Name} & \textbf{value}
518     & \textbf{Description} & \textbf{Reference} \\
519     & & & \\
520     cAdjFreq & 0.0E+00
521     & Convective adjustment interval ( s )
522     & %---ref---
523     \\
524     momForcingOutAB & 0
525     & =1: take Momentum Forcing out of Adams-Bash.
526     & %---ref---
527     \\
528     tracForcingOutAB & 0
529     & =1: take T,S,pTr Forcing out of Adams-Bash.
530     & %---ref---
531     \\
532     momDissip\_In\_AB & T
533     & put Dissipation Tendency in Adams-Bash.
534     & %---ref---
535     \\
536     doAB\_onGtGs & T
537     & apply AB on Tendencies (rather than on T,S)
538     & %---ref---
539     \\
540     abEps & 1.0E-02
541     & Adams-Bashforth-2 stabilizing weight
542     & %---ref---
543     \\
544     baseTime & 0.0E+00
545     & Model base time ( s ).
546     & %---ref---
547     \\
548     startTime & 0.0E+00
549     & Run start time ( s ).
550     & %---ref---
551     \\
552     endTime & 0.0E+00
553     & Integration ending time ( s ).
554     & %---ref---
555     \\
556     pChkPtFreq & 0.0E+00
557     & Permanent restart/checkpoint file interval ( s ).
558     & %---ref---
559     \\
560     chkPtFreq & 0.0E+00
561     & Rolling restart/checkpoint file interval ( s ).
562     & %---ref---
563     \\
564     pickup\_write\_mdsio & T
565     & Model IO flag.
566     & %---ref---
567     \\
568     pickup\_read\_mdsio & T
569     & Model IO flag.
570     & %---ref---
571     \\
572     pickup\_write\_immed & F
573     & Model IO flag.
574     & %---ref---
575     \\
576     dumpFreq & 0.0E+00
577     & Model state write out interval ( s ).
578     & %---ref---
579     \\
580     dumpInitAndLast & T
581     & write out Initial and Last iter. model state
582     & %---ref---
583     \\
584     snapshot\_mdsio & T
585     & Model IO flag.
586     & %---ref---
587     \\
588     monitorFreq & 6.0E+01
589     & Monitor output interval ( s ).
590     & %---ref---
591     \\
592     monitor\_stdio & T
593     & Model IO flag.
594     & %---ref---
595     \\
596     externForcingPeriod & 0.0E+00
597     & forcing period (s)
598     & %---ref---
599     \\
600     externForcingCycle & 0.0E+00
601     & period of the cyle (s).
602     & %---ref---
603     \\
604     tauThetaClimRelax & 0.0E+00
605     & relaxation time scale (s)
606     & %---ref---
607     \\
608     tauSaltClimRelax & 0.0E+00
609     & relaxation time scale (s)
610     & %---ref---
611     \\
612     latBandClimRelax & 3.703701E+05
613     & max. Lat. where relaxation
614     & %---ref---
615     \\
616     usingCartesianGrid & T
617     & Cartesian coordinates flag ( True / False )
618     & %---ref---
619     \\
620     usingSphericalPolarGrid & F
621     & Spherical coordinates flag ( True / False )
622     & %---ref---
623     \\
624     usingCylindricalGrid & F
625     & Spherical coordinates flag ( True / False )
626     & %---ref---
627     \\
628     Ro\_SeaLevel & 0.0E+00
629     & r(1) ( units of r )
630     & %---ref---
631     \\
632     rkSign & -1.0E+00
633     & index orientation relative to vertical coordinate
634     & %---ref---
635     \\
636     horiVertRatio & 1.0E+00
637     & Ratio on units : Horiz - Vertical
638     & %---ref---
639     \\
640     drC & 5.0E+03 at K=1
641     & C spacing ( units of r )
642     & %---ref---
643     \\
644     drF & 1.0E+04 at K= top
645     & W spacing ( units of r )
646     & %---ref---
647     \\
648     delX & 1.234567E+05 at I= east
649     & U spacing ( m - cartesian, degrees - spherical )
650     & %---ref---
651     \\
652     delY & 1.234567E+05 at J=1
653     & V spacing ( m - cartesian, degrees - spherical )
654     & %---ref---
655     \\
656     phiMin & 0.0E+00
657     & South edge (ignored - cartesian, degrees - spherical )
658     & %---ref---
659     \\
660     thetaMin & 0.0E+00
661     & West edge ( ignored - cartesian, degrees - spherical )
662     & %---ref---
663     \\
664     rSphere & 6.37E+06
665     & Radius ( ignored - cartesian, m - spherical )
666     & %---ref---
667     \\
668     xcoord & 6.172835E+04 at I=1
669     & P-point X coord ( m - cartesian, degrees - spherical )
670     & %---ref---
671     \\
672     ycoord & 6.172835E+04 at J=1
673     & P-point Y coord ( m - cartesian, degrees - spherical )
674     & %---ref---
675     \\
676     rcoord & -5.0E+03 at K=1
677     & P-point R coordinate ( units of r )
678     & %---ref---
679     \\
680     rF & 0.0E+00 at K=1
681     & W-Interf. R coordinate ( units of r )
682     & %---ref---
683     \\
684     dBdrRef & 0.0E+00 at K= top
685     & Vertical gradient of reference boyancy [$(m/s/r)^2)$]
686     & %---ref---
687     \\
688     \end{tabular}
689     \end{table}
690    
691     \newpage
692     \begin{table}
693     %\hspace*{-1.5in}
694     \begin{tabular}{lllc}
695    
696     \textbf{Name} & \textbf{value}
697     & \textbf{Description} & \textbf{Reference} \\
698     & & & \\
699     dxF & 1.234567E+05 at K= top
700     & dxF(:,1,:,1) ( m - cartesian, degrees - spherical )
701     & %---ref---
702     \\
703     dyF & 1.234567E+05 at I= east
704     & dyF(:,1,:,1) ( m - cartesian, degrees - spherical )
705     & %---ref---
706     \\
707     dxG & 1.234567E+05 at I= east
708     & dxG(:,1,:,1) ( m - cartesian, degrees - spherical )
709     & %---ref---
710     \\
711     dyG & 1.234567E+05 at I= east
712     & dyG(:,1,:,1) ( m - cartesian, degrees - spherical )
713     & %---ref---
714     \\
715     dxC & 1.234567E+05 at I= east
716     & dxC(:,1,:,1) ( m - cartesian, degrees - spherical )
717     & %---ref---
718     \\
719     dyC & 1.234567E+05 at I= east
720     & dyC(:,1,:,1) ( m - cartesian, degrees - spherical )
721     & %---ref---
722     \\
723     dxV & 1.234567E+05 at I= east
724     & dxV(:,1,:,1) ( m - cartesian, degrees - spherical )
725     & %---ref---
726     \\
727     dyU & 1.234567E+05 at I= east
728     & dyU(:,1,:,1) ( m - cartesian, degrees - spherical )
729     & %---ref---
730     \\
731     rA & 1.524155677489E+10 at I= east
732     & rA(:,1,:,1) ( m - cartesian, degrees - spherical )
733     & %---ref---
734     \\
735     rAw & 1.524155677489E+10 at K= top
736     & rAw(:,1,:,1) ( m - cartesian, degrees - spherical )
737     & %---ref---
738     \\
739     rAs & 1.524155677489E+10 at K= top
740     & rAs(:,1,:,1) ( m - cartesian, degrees - spherical )
741     & %---ref---
742     \\
743    
744     \end{tabular}
745     \end{table}
746    
747     \begin{table}
748     %\hspace*{-1.5in}
749     \begin{tabular}{lllc}
750    
751     \textbf{Name} & \textbf{Default value}
752     & \textbf{Description} & \textbf{Reference} \\
753     & & & \\
754    
755     tempAdvScheme & 2
756     & Temp. Horiz.Advection scheme selector
757     & %---ref---
758     \\
759     tempVertAdvScheme & 2
760     & Temp. Vert. Advection scheme selector
761     & %---ref---
762     \\
763     tempMultiDimAdvec & F
764     & use Muti-Dim Advec method for Temp
765     & %---ref---
766     \\
767     tempAdamsBashforth & T
768     & use Adams-Bashforth time-stepping for Temp
769     & %---ref---
770     \\
771     saltAdvScheme & 2
772     & Salt. Horiz.advection scheme selector
773     & %---ref---
774     \\
775     saltVertAdvScheme & 2
776     & Salt. Vert. Advection scheme selector
777     & %---ref---
778     \\
779     saltMultiDimAdvec & F
780     & use Muti-Dim Advec method for Salt
781     & %---ref---
782     \\
783     saltAdamsBashforth & T
784     & use Adams-Bashforth time-stepping for Salt
785     & %---ref---
786     \\
787    
788     \end{tabular}
789     \end{table}
790    

  ViewVC Help
Powered by ViewVC 1.1.22