source: trunk/LMDZ.GENERIC/DOC/input/makegcm_help.tex @ 3058

Last change on this file since 3058 was 987, checked in by jleconte, 12 years ago

11/06/2013 == JL+EM

  • User manual (+ sources) added in DOC.
File size: 3.1 KB
RevLine 
[987]1{\footnotesize
2\begin{verbatim}
3makegcm [Options] prog
4
5
6The makegcm script:
7-------------------
8
91. compiles a series of subroutines located in the $LMDGCM/libf
10 sub-directories.
11 The objects are then stored in the libraries in $LIBOGCM.
12
132. then, makegcm compiles program prog.f located by default in
14$LMDGCM/libf/dyn3d and makes the link with the libraries.
15
16Environment Variables '$LMDGCM' and '$LIBOGCM'
17 must be set as environment variables or directly
18 in the makegcm file.
19
20The makegcm command is used to control the different versions of the model
21 in parallel, compiled using the compilation options
22 and the various dimensions, without having to recompile the whole model.
23
24The FORTRAN libraries are stored in directory $LIBOGCM.
25
26
27OPTIONS:
28--------
29
30The following options can either be defined by default by editing the
31makegcm "script", or in interactive mode:
32
33-d imxjmxlm  where im, jm, and lm are the number of longitudes,
34             latitudes and vertical layers respectively.
35
36-t ntrac   Selects the number of tracers present in the model
37
38             Options -d and -t overwrite file
39             $LMDGCM/libf/grid/dimensions.h
40             which contains the 3 dimensions of the
41             horizontal grid
42             im, jm, lm plus the number of tracers passively advected
43             by the dynamics ntrac,
44             in 4 PARAMETER FORTRAN format
45             with a new file:
46             $LMDGCM/libf/grid/dimension/dimensions.im.jm.lm.tntrac
47             If the file does not exist already
48             it is created by the script
49             $LMDGCM/libf/grid/dimension/makdim
50
51-p PHYS    Selects the set of physical parameterizations
52           you want to compile the model with.
53           The model is then compiled using the physical
54           parameterization sources in directory:
55            $LMDGCM/libf/phyPHYS
56
57-g grille  Selects the grid type.
58           This option overwrites file
59           $LMDGCM/libf/grid/fxyprim.h
60           with file
61           $LMDGCM/libf/grid/fxy_grille.h
62           the grid can take the following values:
63           1. reg - the regular grid
64           2. sin - to obtain equidistant points in terms of sin(latitude)
65           3. new - to zoom into a part of the globe
66
67-O "compilation options" set of fortran compilation options to use
68
69-include path
70           Used if the subroutines contain #include files (ccp) that
71           are located in directories that are not referenced by default.
72
73-adjnt     Compiles the adjoint model to the dynamical code.
74
75-filtre  filter
76           To select the longitudinal filter in the polar regions.
77           "filter" corresponds to the name of a directory located in
78           $LMDGCM/libf. The standard filter for the model is "filtrez"
79           which can be used for a regular grid and for a 
80           grid with longitudinal zoom.
81
82-link "-Ldir1 -lfile1 -Ldir2 -lfile2 ..."
83           Adds a link to FORTRAN libraries
84           libfile1.a, libfile2.a ...
85           located in directories dir1, dir2 ...respectively
86           If dirn is a directory with an automatic path
87           (/usr/lib ... for example) 
88           there is no need to specify  -Ldirn.
89
90\end{verbatim}
91}
Note: See TracBrowser for help on using the repository browser.