New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 9019 for branches/2017/dev_merge_2017/DOC/TexFiles – NEMO

Ignore:
Timestamp:
2017-12-13T15:58:53+01:00 (6 years ago)
Author:
timgraham
Message:

Merge of dev_CNRS_2017 into branch

Location:
branches/2017/dev_merge_2017/DOC/TexFiles
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • branches/2017/dev_merge_2017/DOC/TexFiles/Chapters/Chap_CFG.tex

    r7705 r9019  
    2525in the code, though by no means are all options exercised in the reference configurations. 
    2626 
    27 Configuration is defined mainly through the \ngn{namcfg}  namelist variables: 
    28 \sfcomment {Here change namcfg part of namelist. Configuration is defined throughout domain\_cfg.nc file now}   
    29  
    3027%------------------------------------------namcfg---------------------------------------------------- 
    3128\namdisplay{namcfg} 
     
    3734\section{Water column model: 1D model (C1D) (\key{c1d}) } 
    3835\label{CFG_c1d} 
     36 
     37$\ $\newline 
     38BE careful: to be re-written according to suppression of jpizoom and jpjzoom !!!! 
     39$\ $\newline 
    3940 
    4041The 1D model option simulates a stand alone water column within the 3D \NEMO system.  
     
    8586the LIM sea-ice model (ORCA-LIM) and possibly with PISCES biogeochemical model  
    8687(ORCA-LIM-PISCES), using various resolutions. 
    87 The appropriate namelist is available in \textit{CONFIG/ORCA2\_LIM3\_PISCES/EXP00/namelist\_cfg}  
    88 for ORCA2 and in \textit{CONFIG/SHARED/README\_configs\_namcfg\_namdom}  \sfcomment {not really true, they are obsolete namelists, where find these informations?}   
    89 for other resolutions 
    90  
     88An appropriate namelist is available in \textit{CONFIG/ORCA2\_LIM3\_PISCES/EXP00/namelist\_cfg}  
     89for ORCA2. 
     90The domain of ORCA2 configuration is defined in ORCA\_R2\_zps\_domcfg.nc file, this file is available in tar file in the wiki of NEMO : \\ 
     91https://forge.ipsl.jussieu.fr/nemo/wiki/Users/ReferenceConfigurations/ORCA2\_LIM3\_PISCES \\ 
     92In this namelist\_cfg the name of domain input file is set in \ngn{namcfg} block of namelist.  
    9193 
    9294%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    140142than the smallest one in the southern hemisphere. 
    141143The resulting mesh is shown in Fig.~\ref{Fig_MISC_ORCA_msh} and \ref{Fig_MISC_ORCA_e1e2}  
    142 for a half a degree grid (ORCA\_R05). The smallest ocean scale factor is found in along   
    143 Antarctica, while the ratio of anisotropy remains close to one except near the Victoria Island  
     144for a half a degree grid (ORCA\_R05). 
     145The smallest ocean scale factor is found in along  Antarctica, while the ratio of anisotropy remains close to one except near the Victoria Island  
    144146in the Canadian Archipelago.  
    145147 
     
    153155The NEMO system is provided with five built-in ORCA configurations which differ in the  
    154156horizontal resolution. The value of the resolution is given by the resolution at the Equator  
    155 expressed in degrees. Each of configuration is set through the \textit{domain\_cfg} file,  
    156 which sets the grid size and configuration name parameters \sfcomment {I would like to change tab_ORCA but I can not find it, wrong jp_cfg}   
    157  (Tab. \ref{Tab_ORCA}). 
     157expressed in degrees. Each of configuration is set through the \textit{domain\_cfg} domain configuration file,  
     158which sets the grid size and configuration name parameters. The NEMO System Team provides only ORCA2 domain input file "ORCA\_R2\_zps\_domcfg.nc" file  (Tab. \ref{Tab_ORCA}). 
    158159 
    159160 
     
    175176\end{tabular} 
    176177\caption{ \label{Tab_ORCA}    
    177 Set of predefined parameters for ORCA family configurations. 
    178 In all cases, the flag for configurations of ORCA family is set to 1 in \textit{domain\_cfg} } 
     178Domain size of ORCA family configurations. 
     179The flag for configurations of ORCA family need to be set in \textit{domain\_cfg} file. } 
    179180\end{center} 
    180181\end{table} 
  • branches/2017/dev_merge_2017/DOC/TexFiles/Chapters/Chap_DOM.tex

    r7705 r9019  
    268268 
    269269The total size of the computational domain is set by the parameters \np{jpiglo},  
    270 \np{jpjglo} and \np{jpkglo} in the $i$, $j$ and $k$ directions respectively. They are  
    271 given as namelist variables in the \ngn{namcfg} namelist.  
     270\np{jpjglo} and \np{jpkglo} in the $i$, $j$ and $k$ directions respectively.  
    272271%%% 
    273272%%% 
     
    278277 
    279278$\ $\newline    % force a new line 
    280  
    281 %%% 
    282 \sfcomment {Hereafter I want to create new subsection 4.2: "fields needed by opa engine or something like this" 
    283 and add list of fields : 
    284 case 1: read in domain.nc 
    285 case 2: defined in userdef\_hrg\/zgr.F90 
    286 longitude, latitude, domaine size  
    287 number of points 
    288 factor scales (e1, e2, e3) 
    289 coriolis 
    290 k\_top, k\_bottom (first and last ocean level) 
    291 periodicity 
    292 } 
    293 %%% 
    294279 
    295280% ================================================================ 
     
    303288The grid-points are located at integer or integer and a half values of as indicated  
    304289in Table~\ref{Tab_cell}. The associated scale factors are defined using the   
    305 analytical first derivative of the transformation \eqref{Eq_scale_factors}. These  
    306 definitions are done in two modules given by example, \mdl{userdef\_hgr} and \mdl{userdef\_zgr}, which  
    307 provide the horizontal and vertical meshes, respectively. Otherwise all needed fields can be read in file \np{cn\_domcfg} specified in \ngn{namcfg}. 
     290analytical first derivative of the transformation \eqref{Eq_scale_factors}.  
     291Necessary fields for configuration definition are: \\ 
     292Geographic position : 
     293 
     294longitude : glamt , glamu , glamv and glamf  (at T, U, V and F point) 
     295 
     296latitude : gphit , gphiu , gphiv and gphif (at T, U, V and F point)\\ 
     297Coriolis parameter (if domain not on the sphere):  
     298 
     299 ff\_f  and  ff\_t (at T and F point)\\ 
     300Scale factors :  
    308301  
    309 The needed fields for domain are:  
    310  
    311 geographic position : 
    312  
    313 longitude : glamt , glamu , glamv and glamf  (at T, U, V and F point) 
    314  
    315 latitude : gphit , gphiu , gphiv and gphif (at T, U, V and F point) 
    316  
    317 Coriolis parameter (if domain not on the sphere):  ff\_f  and  ff\_t (at T and F point) 
    318  
    319 Scale factors : e1t, e1u, e1v and e1f (on i direction), 
    320  
    321    e2t, e2u, e2v and e2f (on j direction) 
    322  
    323    and ie1e2u\_v, e1e2u , e1e2v    
    324  
    325 %%% 
    326 \sfcomment { 
    327 say something about ie1e2u\_v, e1e2u , e1e2v 
    328  
    329 and add list of fields : 
    330 case 1: read in domain.nc 
    331 case 2: defined in userdef\_hrg\/zgr.F90 
    332 longitude, latitude, domaine size 
    333 number of points 
    334 factor scales (e1, e2, e3) 
    335 coriolis 
    336 k\_top, k\_bottom (first and last ocean level) 
    337 periodicity 
    338 ---- 
    339         int ORCA ; 
    340    int ORCA\_index ; 
    341    int jpiglo ; j, k 
    342    int jperio ; 
    343    int ln_zco ; zps, sco 
    344    int ln_isfcav ; 
    345    double glamt(t, y, x) ; u,v,f 
    346    double gphit(t, y, x) ; u,v,f 
    347    double e1t(t, y, x) ; u,v,w, 
    348    double e2t(t, y, x) ; u,v,w 
    349    double ff\_f(t, y, x) ;  double ff\_t(t, y, x) ; 
    350    double e3t\_1d(t, z) ; 
    351    double e3w\_1d(t, z) ; 
    352    double e3t\_0(t, z, y, x) ; u0, v0 , w0 
    353 ---- 
    354 } 
    355  
     302 e1t, e1u, e1v and e1f (on i direction), 
     303 
     304 e2t, e2u, e2v and e2f (on j direction) 
     305 
     306 and ie1e2u\_v, e1e2u , e1e2v    
     307  
     308e1e2u , e1e2v are u and v surfaces (if gridsize reduction in some straits)\\ 
     309ie1e2u\_v is a flag to flag set u and  v surfaces are neither read nor computed.\\ 
     310  
     311These fields can be read in an domain input file which name is setted in \np{cn\_domcfg} parameter specified in \ngn{namcfg}. 
     312\namdisplay{namcfg} 
     313or they can be defined in an analytical way in MY\_SRC directory of the configuration. 
     314For Reference Configurations of NEMO input domain files are supplied by NEMO System Team. For analytical definition of input fields two routines are supplied: \mdl{userdef\_hgr} and \mdl{userdef\_zgr}. They are an example of GYRE configuration parameters, and they are available in NEMO/OPA\_SRC/USR directory, they provide the horizontal and vertical mesh.  
    356315% ------------------------------------------------------------------------------------------------------------- 
    357316%        Needed fields  
     
    446405\label{DOM_hgr_msh_choice} 
    447406 
    448 The user has three options available in defining a horizontal grid, which involve  
    449 the namelist variable \np{jphgr\_mesh} of the \ngn{namcfg} namelist.  
    450 \begin{description} 
    451 \item[\np{jphgr\_mesh}=0]  The most general curvilinear orthogonal grids. 
    452 The coordinates and their first derivatives with respect to $i$ and $j$ are provided 
    453 in a input file (\ifile{coordinates}), read in \rou{hgr\_read} subroutine of the domhgr module. 
    454 \item[\np{jphgr\_mesh}=1 to 5] A few simple analytical grids are provided (see below).  
    455 For other analytical grids, the \mdl{domhgr} module must be modified by the user.  
    456 \end{description} 
    457  
    458 There are two simple cases of geographical grids on the sphere. With  
    459 \np{jphgr\_mesh}=1, the grid (expressed in degrees) is regular in space,  
    460 with grid sizes specified by parameters \np{ppe1\_deg} and \np{ppe2\_deg},  
    461 respectively. Such a geographical grid can be very anisotropic at high latitudes  
    462 because of the convergence of meridians (the zonal scale factors $e_1$  
    463 become much smaller than the meridional scale factors $e_2$). The Mercator  
    464 grid (\np{jphgr\_mesh}=4) avoids this anisotropy by refining the meridional scale  
    465 factors in the same way as the zonal ones. In this case, meridional scale factors  
    466 and latitudes are calculated analytically using the formulae appropriate for  
    467 a Mercator projection, based on \np{ppe1\_deg} which is a reference grid spacing  
    468 at the equator (this applies even when the geographical equator is situated outside  
    469 the model domain).  
    470 %%% 
    471 \gmcomment{ give here the analytical expression of the Mercator mesh} 
    472 %%% 
    473 In these two cases (\np{jphgr\_mesh}=1 or 4), the grid position is defined by the  
    474 longitude and latitude of the south-westernmost point (\np{ppglamt0}  
    475 and \np{ppgphi0}). Note that for the Mercator grid the user need only provide  
    476 an approximate starting latitude: the real latitude will be recalculated analytically,  
    477 in order to ensure that the equator corresponds to line passing through $t$-  
    478 and $u$-points.   
    479  
    480 Rectangular grids ignoring the spherical geometry are defined with  
    481 \np{jphgr\_mesh} = 2, 3, 5. The domain is either an $f$-plane (\np{jphgr\_mesh} = 2,  
    482 Coriolis factor is constant) or a beta-plane (\np{jphgr\_mesh} = 3, the Coriolis factor  
    483 is linear in the $j$-direction). The grid size is uniform in meter in each direction,  
    484 and given by the parameters \np{ppe1\_m} and \np{ppe2\_m} respectively.  
    485 The zonal grid coordinate (\textit{glam} arrays) is in kilometers, starting at zero  
    486 with the first $t$-point. The meridional coordinate (gphi. arrays) is in kilometers,  
    487 and the second $t$-point corresponds to coordinate $gphit=0$. The input  
    488 variable \np{ppglam0} is ignored. \np{ppgphi0} is used to set the reference  
    489 latitude for computation of the Coriolis parameter. In the case of the beta plane,  
    490 \np{ppgphi0} corresponds to the center of the domain. Finally, the special case  
    491 \np{jphgr\_mesh}=5 corresponds to a beta plane in a rotated domain for the  
    492 GYRE configuration, representing a classical mid-latitude double gyre system.  
    493 The rotation allows us to maximize the jet length relative to the gyre areas  
    494 (and the number of grid points).  
    495  
    496 The choice of the grid must be consistent with the boundary conditions specified  
    497 by \np{jperio}, a parameter found in \ngn{namcfg} namelist (see {\S\ref{LBC}). 
    498407 
    499408% ------------------------------------------------------------------------------------------------------------- 
     
    684593(Fig.~\ref{Fig_zgr}). 
    685594 
    686 If the ice shelf cavities are opened (\np{ln\_isfcav}=~true~}), the definition of $z_0$ is the same.  
     595If the ice shelf cavities are opened (\np{ln\_isfcav}=~true~), the definition of $z_0$ is the same.  
    687596However, definition of $e_3^0$ at $t$- and $w$-points is respectively changed to: 
    688597\begin{equation} \label{DOM_zgr_ana} 
     
    737646\begin{table}     \begin{center} \begin{tabular}{c||r|r|r|r} 
    738647\hline 
    739 \textbf{LEVEL}& \textbf{gdept}& \textbf{gdepw}& \textbf{e3t }& \textbf{e3w  } \\ \hline 
     648\textbf{LEVEL}& \textbf{gdept\_1d}& \textbf{gdepw\_1d}& \textbf{e3t\_1d }& \textbf{e3w\_1d  } \\ \hline 
    7406491  &  \textbf{  5.00}   &       0.00 & \textbf{ 10.00} &  10.00 \\   \hline 
    7416502  &  \textbf{15.00} &    10.00 &   \textbf{ 10.00} &  10.00 \\   \hline 
  • branches/2017/dev_merge_2017/DOC/TexFiles/Chapters/Chap_MISC.tex

    r7646 r9019  
    22\begin{document} 
    33% ================================================================ 
    4 % Chapter ——— Miscellaneous Topics 
     4% Chapter ---€” Miscellaneous Topics 
    55% ================================================================ 
    66\chapter{Miscellaneous Topics} 
     
    8787 
    8888% ================================================================ 
    89 % Sub-Domain Functionality (\textit{nizoom, njzoom}, namelist parameters) 
    90 % ================================================================ 
    91 \section{Sub-Domain Functionality (\np{jpizoom}, \np{jpjzoom})} 
     89% Sub-Domain Functionality  
     90% ================================================================ 
     91\section{Sub-Domain Functionality} 
    9292\label{MISC_zoom} 
    93  
    94 The sub-domain functionality, also improperly called the zoom option  
    95 (improperly because it is not associated with a change in model resolution)  
    96 is a quite simple function that allows a simulation over a sub-domain of an  
    97 already defined configuration ($i.e.$ without defining a new mesh, initial  
    98 state and forcings). This option can be useful for testing the user settings  
    99 of surface boundary conditions, or the initial ocean state of a huge ocean  
    100 model configuration while having a small computer memory requirement.  
    101 It can also be used to easily test specific physics in a sub-domain (for example,  
    102 see \citep{Madec_al_JPO96} for a test of the coupling used in the global ocean  
    103 version of OPA between sea-ice and ocean model over the Arctic or Antarctic  
    104 ocean, using a sub-domain). In the standard model, this option does not  
    105 include any specific treatment for the ocean boundaries of the sub-domain:  
    106 they are considered as artificial vertical walls. Nevertheless, it is quite easy  
    107 to add a restoring term toward a climatology in the vicinity of such boundaries  
    108 (see \S\ref{TRA_dmp}). 
    109  
    110 In order to easily define a sub-domain over which the computation can be  
    111 performed, the dimension of all input arrays (ocean mesh, bathymetry,  
    112 forcing, initial state, ...) are defined as \np{jpidta}, \np{jpjdta} and \np{jpkdta}  
    113 ( in \ngn{namcfg} namelist), while the computational domain is defined through  
    114 \np{jpiglo}, \np{jpjglo} and \jp{jpk} (\ngn{namcfg} namelist). When running the  
    115 model over the whole domain, the user sets \np{jpiglo}=\np{jpidta} \np{jpjglo}=\np{jpjdta}  
    116 and \jp{jpk}=\jp{jpkdta}. When running the model over a sub-domain, the user  
    117 has to provide the size of the sub-domain, (\np{jpiglo}, \np{jpjglo}, \np{jpkglo}),  
    118 and the indices of the south western corner as \np{jpizoom} and \np{jpjzoom} in  
    119 the  \ngn{namcfg} namelist (Fig.~\ref{Fig_LBC_zoom}).  
    120  
    121 Note that a third set of dimensions exist, \jp{jpi}, \jp{jpj} and \jp{jpk} which is  
    122 actually used to perform the computation. It is set by default to \jp{jpi}=\np{jpjglo}  
    123 and \jp{jpj}=\np{jpjglo}, except for massively parallel computing where the  
    124 computational domain is laid out on local processor memories following a 2D  
    125 horizontal splitting. % (see {\S}IV.2-c) ref to the section to be updated 
    12693 
    12794\subsection{Simple subsetting of input files via netCDF attributes} 
     
    165132\noindent Add the logical switch to \ngn{namcfg} in the configuration namelist and set true: 
    166133%--------------------------------------------namcfg-------------------------------------------------------- 
    167 \namdisplay{namcfg_orca1} 
     134\namdisplay{namcfg} 
    168135%-------------------------------------------------------------------------------------------------------------- 
    169136 
  • branches/2017/dev_merge_2017/DOC/TexFiles/Chapters/Chap_SBC.tex

    r7646 r9019  
    12661266ice-ocean fluxes, that are combined with the air-sea fluxes using the ice fraction of  
    12671267each model cell to provide the surface ocean fluxes. Note that the activation of a  
    1268 sea-ice model is is done by defining a CPP key (\key{lim2}, \key{lim3} or \key{cice}).  
     1268sea-ice model is is done by defining a CPP key (\key{lim3} or \key{cice}).  
    12691269The activation automatically overwrites the read value of nn{\_}ice to its appropriate  
    1270 value ($i.e.$ $2$ for LIM-2, $3$ for LIM-3 or $4$ for CICE). 
     1270value ($i.e.$ $2$ for LIM-3 or $3$ for CICE). 
    12711271\end{description} 
    12721272 
  • branches/2017/dev_merge_2017/DOC/TexFiles/Chapters/Chap_ZDF.tex

    r6997 r9019  
    612612Examples of performance of the 4 turbulent closure scheme can be found in \citet{Warner_al_OM05}. 
    613613 
     614% ------------------------------------------------------------------------------------------------------------- 
     615%        OSM OSMOSIS BL Scheme  
     616% ------------------------------------------------------------------------------------------------------------- 
     617\subsection{OSM OSMOSIS Boundary Layer scheme (\key{zdfosm})} 
     618\label{ZDF_osm} 
     619 
     620%--------------------------------------------namzdf_osm--------------------------------------------------------- 
     621\namdisplay{namzdf_osm} 
     622%-------------------------------------------------------------------------------------------------------------- 
     623 
     624The OSMOSIS turbulent closure scheme is based on......   TBC 
    614625 
    615626% ================================================================ 
     
    734745%       Turbulent Closure Scheme  
    735746% ------------------------------------------------------------------------------------------------------------- 
    736 \subsection{Turbulent Closure Scheme (\key{zdftke} or \key{zdfgls})} 
     747\subsection{Turbulent Closure Scheme (\key{zdftke}, \key{zdfgls} or \key{zdfosm})} 
    737748\label{ZDF_tcs} 
    738749 
  • branches/2017/dev_merge_2017/DOC/TexFiles/Chapters/Introduction.tex

    r6997 r9019  
    255255$\bullet$ The main modifications from NEMO/OPA v3.4 and  v3.6 are :\\ 
    256256\begin{enumerate} 
     257 \item ... ;  
     258\end{enumerate} 
     259 
     260 
     261 \vspace{1cm} 
     262$\bullet$ The main modifications from NEMO/OPA v3.6 and  v4.0 are :\\ 
     263\begin{enumerate} 
     264\item new definition of configurations ; 
     265\item bulk formulation ; 
    257266\item ... ;  
    258267\end{enumerate} 
    259268 
    260269 
    261  \vspace{1cm} 
    262 $\bullet$ The main modifications from NEMO/OPA v3.6 and  v4.0 are :\\ 
    263 \begin{enumerate} 
    264 \item ... ;  
    265  
    266  
    267 \end{enumerate} 
    268  
    269  
    270270\end{document} 
  • branches/2017/dev_merge_2017/DOC/TexFiles/Top_Matter.tex

    r7646 r9019  
    1717%\date{\today} 
    1818\date{ 
    19 January 2017  \\ 
     19Decembre 2017  \\ 
    2020{\small  -- version 4.0 alpha --} \\ 
    2121~  \\ 
Note: See TracChangeset for help on using the changeset viewer.