Changeset 14336 for NEMO/branches/2021/dev_r14312_MPI_Interface/doc

Timestamp:

2021-01-23T11:09:54+01:00 (3 years ago)

Author:

smasson

Message:

dev_r14312_MPI_Interface: replace jperio by l_Iperio, l_Jperio, l_NFold, c_NFtype, #2598

Location:

NEMO/branches/2021/dev_r14312_MPI_Interface/doc

Files:

• NEMO_manual_state.txt (modified) (1 diff)
• latex/NEMO/subfiles/chap_DOM.tex (modified) (2 diffs)
• latex/NEMO/subfiles/chap_LBC.tex (modified) (5 diffs)

NEMO/branches/2021/dev_r14312_MPI_Interface/doc/NEMO_manual_state.txt

@@ -15 +15 @@
 chap_misc.tex: key{mpp\_mpi} key{nosignedzero} key{vectopt\_loop} np{iom\_get} np{jpjdta} np{jpjglo} np{nn\_bench} np{nn\_bit\_cmp} np{open\_ocean\_jstart} 
 chap_LDF.tex: hf{dynldf\_cNd} hf{ldfdyn\_substitute} hf{ldftra\_substitute} hf{traldf\_c1d} hf{traldf\_cNd} key{dynldf\_c1d} key{dynldf\_c2d} key{dynldf\_c3d} key{traldf\_c1d} key{traldf\_c2d} key{traldf\_c3d} key{traldf\_cNd} key{traldf\_eiv} mdl{ldfdyn\_c2d} mdl{ldfeiv} mdl{traadv\_eiv} np{ln\_dynldf\_bilap} np{ln\_sco} np{nn\_eos} np{rn\_aeih\_0} np{rn\_aeiv} np{rn\_aeiv\_0} np{rn\_ahm0} np{rn\_ahmb0} np{rn\_aht0} np{rn\_ahtb0} np{traldf\_grif} np{traldf\_grif\_iso} rou{ldf\_dyn\_c2d\_orca} rou{ldfslp\_init} 
-chap_LBC.tex: jp{jpreci} key{mpp\_mpi} np{jperio} np{jpiglo} np{jpindt} np{jpinft} np{jpjglo} np{jpjnob} np{nbdysegn} np{nn\_bdy\_jpk} np{nn\_msh} np{nn\_tra} rou{inimpp2} 
-chap_DOM.tex: key{mpp\_mpi} ngn{namzgr} ngn{namzgr\_sco} nlst{namzgr} nlst{namzgr_sco} np{jperio} np{jpiglo} np{jpjglo} np{jpkglo} np{ln\_sco} np{ln\_sigcrit} np{ln\_s\_SF12} np{ln\_s\_SH94} np{ln\_tsd\_ini} np{ln\_zco} np{ln\_zps} np{nn\_bathy} np{nn\_msh} np{ppa0} np{ppa1} np{ppacr} np{ppdzmin} np{pphmax} np{ppkth} np{ppsur} np{rn\_alpha} np{rn\_bb} np{rn\_e3zps\_min} np{rn\_e3zps\_rat} np{rn\_hc} np{rn\_rmax} np{rn\_sbot\_max} np{rn\_sbot\_min} np{rn\_theta} np{rn\_zb\_a} np{rn\_zb\_b} np{rn\_zs} rou{istate\_t\_s} 
+chap_LBC.tex: jp{jpreci} key{mpp\_mpi} np{jpiglo} np{jpindt} np{jpinft} np{jpjglo} np{jpjnob} np{nbdysegn} np{nn\_bdy\_jpk} np{nn\_msh} np{nn\_tra} rou{inimpp2} 
+chap_DOM.tex: key{mpp\_mpi} ngn{namzgr} ngn{namzgr\_sco} nlst{namzgr} nlst{namzgr_sco} np{jpiglo} np{jpjglo} np{jpkglo} np{ln\_sco} np{ln\_sigcrit} np{ln\_s\_SF12} np{ln\_s\_SH94} np{ln\_tsd\_ini} np{ln\_zco} np{ln\_zps} np{nn\_bathy} np{nn\_msh} np{ppa0} np{ppa1} np{ppacr} np{ppdzmin} np{pphmax} np{ppkth} np{ppsur} np{rn\_alpha} np{rn\_bb} np{rn\_e3zps\_min} np{rn\_e3zps\_rat} np{rn\_hc} np{rn\_rmax} np{rn\_sbot\_max} np{rn\_sbot\_min} np{rn\_theta} np{rn\_zb\_a} np{rn\_zb\_b} np{rn\_zs} rou{istate\_t\_s} 
 chap_conservation.tex: key{\_} 
 annex_iso.tex: key{trabbl} key{traldf\_eiv} np{ln\_traldf\_eiv} np{ln\_traldf\_gdia} 

NEMO/branches/2021/dev_r14312_MPI_Interface/doc/latex/NEMO/subfiles/chap_DOM.tex

@@ -377 +377 @@
 in which case \np{cn_cfg}{cn\_cfg} and \np{nn_cfg}{nn\_cfg} are set from these values accordingly).
 
-The global lateral boundary condition type is selected from 8 options using parameter \texttt{jperio}.
+The global lateral boundary condition type is selected from 8 options using parameters \texttt{l\_Iperio}, \texttt{l\_Jperio}, \texttt{l\_NFold} and \texttt{c\_NFtype}.
 See \autoref{sec:LBC_jperio} for details on the available options and
-the corresponding values for \texttt{jperio}.
+the corresponding values for \texttt{l\_Iperio}, \texttt{l\_Jperio}, \texttt{l\_NFold} and \texttt{c\_NFtype}.
 
 %% =================================================================================================
@@ -394 +394 @@
 
 \begin{clines}
-int    jpiglo, jpjglo, jpkglo     /* global domain sizes                                    */
-int    jperio                     /* lateral global domain b.c.                             */
-double glamt, glamu, glamv, glamf /* geographic longitude (t,u,v and f points respectively) */
-double gphit, gphiu, gphiv, gphif /* geographic latitude                                    */
-double e1t, e1u, e1v, e1f         /* horizontal scale factors                               */
-double e2t, e2u, e2v, e2f         /* horizontal scale factors                               */
+integer   Ni0glo, NjOglo, jpkglo       /* global domain sizes (without MPI halos)                */
+logical   l\_Iperio, l\_Jperio         /* lateral global domain b.c.: i- j-periodicity           */
+logical   l\_NFold                     /* lateral global domain b.c.: North Pole folding         */
+char(1)   c\_NFtype                    /*    type of North pole Folding: T or F point            */
+real      glamt, glamu, glamv, glamf   /* geographic longitude (t,u,v and f points respectively) */
+real      gphit, gphiu, gphiv, gphif   /* geographic latitude                                    */
+real      e1t, e1u, e1v, e1f           /* horizontal scale factors                               */
+real      e2t, e2u, e2v, e2f           /* horizontal scale factors                               */
 \end{clines}
 

NEMO/branches/2021/dev_r14312_MPI_Interface/doc/latex/NEMO/subfiles/chap_LBC.tex

@@ -159 +159 @@
 
 %% =================================================================================================
-\section{Model domain boundary condition (\forcode{jperio})}
+\section{Model domain boundary condition}
 \label{sec:LBC_jperio}
 
@@ -168 +168 @@
 
 %% =================================================================================================
-\subsection{Closed, cyclic (\forcode{jperio={0,1,2,7}})}
+\subsection{Closed, cyclic (\forcode{l\_Iperio,l\_jperio})}
 \label{subsec:LBC_jperio012}
 
 The choice of closed or cyclic model domain boundary condition is made by
-setting \forcode{jperio} to 0, 1, 2 or 7 in namelist \nam{cfg}{cfg}.
+setting \forcode{l\_Iperio,l\_jperio} to true or false in namelist \nam{cfg}{cfg}.
 Each time such a boundary condition is needed, it is set by a call to routine \mdl{lbclnk}.
 The computation of momentum and tracer trends proceeds from $i=2$ to $i=jpi-1$ and from $j=2$ to $j=jpj-1$,
@@ -181 +181 @@
 \begin{description}
 
-\item [For closed boundary (\forcode{jperio=0})], solid walls are imposed at all model boundaries:
+\item [For closed boundary (\forcode{l\_Iperio = .false.,l\_jperio = .false.})], solid walls are imposed at all model boundaries:
   first and last rows and columns are set to zero.
 
-\item [For cyclic east-west boundary (\forcode{jperio=1})], first and last rows are set to zero (closed) whilst the first column is set to
+\item [For cyclic east-west boundary (\forcode{l\_Iperio = .true.,l\_jperio = .false.})], first and last rows are set to zero (closed) whilst the first column is set to
   the value of the last-but-one column and the last column to the value of the second one
   (\autoref{fig:LBC_jperio}-a).
   Whatever flows out of the eastern (western) end of the basin enters the western (eastern) end.
 
-\item [For cyclic north-south boundary (\forcode{jperio=2})], first and last columns are set to zero (closed) whilst the first row is set to
+\item [For cyclic north-south boundary (\forcode{l\_Iperio = .false.,l\_jperio = .true.})], first and last columns are set to zero (closed) whilst the first row is set to
   the value of the last-but-one row and the last row to the value of the second one
   (\autoref{fig:LBC_jperio}-a).
   Whatever flows out of the northern (southern) end of the basin enters the southern (northern) end.
 
-\item [Bi-cyclic east-west and north-south boundary (\forcode{jperio=7})] combines cases 1 and 2.
+\item [Bi-cyclic east-west and north-south boundary (\forcode{l\_Iperio = .true.,l\_jperio = .true.})] combines cases 1 and 2.
 
 \end{description}
@@ -207 +207 @@
 
 %% =================================================================================================
-\subsection{North-fold (\forcode{jperio={3,6}})}
+\subsection{North-fold (\forcode{l\_NFold = .true.})}
 \label{subsec:LBC_north_fold}
 
@@ -220 +220 @@
   \includegraphics[width=0.66\textwidth]{LBC_North_Fold_T}
   \caption[North fold boundary in ORCA 2\deg, 1/4\deg and 1/12\deg]{
-    North fold boundary with a $T$-point pivot and cyclic east-west boundary condition ($jperio=4$),
+    North fold boundary with a $T$-point pivot and cyclic east-west boundary condition ($c\_NFtype='T'$),
     as used in ORCA 2\deg, 1/4\deg and 1/12\deg.
     Pink shaded area corresponds to the inner domain mask (see text).}