diff --git a/doc/latex/NEMO/subfiles/chap_DOM.tex b/doc/latex/NEMO/subfiles/chap_DOM.tex index 5cf84c5e8c4aa409cdf0c0d8a8956bd0cba9b135..89f3b487ba87f9f0f645f40faa125fd4b371f8cf 100644 --- a/doc/latex/NEMO/subfiles/chap_DOM.tex +++ b/doc/latex/NEMO/subfiles/chap_DOM.tex @@ -365,14 +365,34 @@ and the vertical grid (\autoref{subsec:DOM_zgr}). \subsection{Domain size} \label{subsec:DOM_size} -The total size of the computational domain is set by the parameters \forcode{Ni0glo}, \forcode{NjOglo} and -\forcode{jpkglo} for the $i$, $j$ and $k$ directions, respectively. Note that \forcode{Ni0glo} and \forcode{NjOglo} do not contain any additional MPI or boundary halos, see \autoref{sec:LBC_mpp}. The name of the configuration is set through the optional parameter \np{cn_cfg}{cn\_cfg}, and the nominal resolution through the optional parameter \np{nn_cfg}{nn\_cfg}. -The way these variables are defined will differ accoring to the value of \np{ln_read_cfg}{ln\_read\_cfg} parameter in -namelist \nam{cfg}{cfg}, which usage is detailed in \autoref{subsec:DOM_config}. If \np[=.false.]{ln_read_cfg}{ln\_read\_cfg} the user must define \forcode{cn_cfg, nn_cfg, Ni0glo, Nj0glo, jpkglo} trough the routine \mdl{usrdef\_nam}. If \np[=.true.]{ln_read_cfg}{ln\_read\_cfg} they will be defined from the NetCDF domain configuration file defined by \np{cn_domcfg}{cn\_domcfg} parameter in namelist \nam{cfg}{cfg}. \forcode{Ni0glo, Nj0glo, jpkglo} are defined with the size \texttt{e3t\_0} dimensions. \forcode{cn_cfg, nn_cfg} are defined by the global attributes named \texttt{CfgName} and \texttt{CfgIndex}. +The total size of the computational domain is set by the parameters \forcode{Ni0glo}, +\forcode{NjOglo} and \forcode{jpkglo} for the $i$, $j$ and $k$ directions, +respectively. Note that \forcode{Ni0glo} and \forcode{NjOglo} do not contain any +additional MPI or boundary halos, see \autoref{sec:LBC_mpp}. -The global lateral boundary condition type is selected by using parameters \forcode{l\_Iperio}, \forcode{l\_Jperio}, \forcode{l\_NFold} and \forcode{c\_NFtype}. +The name of the configuration is set through the optional parameter \np{cn_cfg}{cn\_cfg}, +and the nominal resolution through the optional parameter \np{nn_cfg}{nn\_cfg}. +The way all these variables are defined will differ accoring to the value of +\np{ln_read_cfg}{ln\_read\_cfg} parameter in namelist \nam{cfg}{cfg}, whose usage is +detailed in \autoref{subsec:DOM_config}. + +\begin{itemize} +\item If \np[=.false.]{ln_read_cfg}{ln\_read\_cfg} the user must define + \forcode{cn_cfg, nn_cfg, Ni0glo, Nj0glo, jpkglo} through the routine \mdl{usrdef\_nam}. +\item If \np[=.true.]{ln_read_cfg}{ln\_read\_cfg} they will be defined from the NetCDF domain + configuration file defined by the value of the \np{cn_domcfg}{cn\_domcfg} parameter + set in namelist \nam{cfg}{cfg}. + \begin{itemize} + \item \forcode{Ni0glo, Nj0glo, jpkglo} do not need to be set explicitly but are, instead, + inferred from the dimensions of the \texttt{e3t\_0} array. + \item \forcode{cn_cfg, nn_cfg} are defined by the global attributes named \texttt{CfgName} + and \texttt{CfgIndex}. + \end{itemize} +\end{itemize} + +The global lateral boundary condition type is selected by using parameters \forcode{l_Iperio}, \forcode{l_Jperio}, \forcode{l_NFold} and \forcode{c_NFtype}. See \autoref{sec:LBC_jperio} for details on the available options and -the corresponding values for \forcode{l\_Iperio}, \forcode{l\_Jperio}, \forcode{l\_NFold} and \forcode{c\_NFtype}. +the corresponding values for \forcode{l_Iperio}, \forcode{l_Jperio}, \forcode{l_NFold} and \forcode{c_NFtype}. %% ================================================================================================= \subsection[Horizontal grid mesh (\textit{domhgr.F90}]{Horizontal grid mesh (\protect\mdl{domhgr})} diff --git a/doc/namelists/namelist_abl_tools b/doc/namelists/namelist_abl_tools new file mode 100644 index 0000000000000000000000000000000000000000..42b2a4cfa5f1cd36578bba9c7b6c81da49eddbd1 --- /dev/null +++ b/doc/namelists/namelist_abl_tools @@ -0,0 +1,53 @@ +: +:----------------------------------------------------------------------------- +: Atmospheric Boundary Layer preprocessing tool +:----------------------------------------------------------------------------- +: +&nml_dom + jpka = 50, ! ABL vertical levels number + hmax = 2000., ! ABL last level altitude + theta_s = 2., ! vertical grid stretching parameters + hc = 100., ! + ln_impose_z1 = .true., ! force ABL first level altitude + z1 = 10., ! ABL firt level imposed altitude [m] +/ + +&nml_opt + ptemp_method = 3 , ! potential temperature computation method + ln_slp_smth = .true. , ! smooth slp and ghw at high latitudes only + ln_drw_smth = .false. , ! smooth after drowning + ln_slp_log = .false. , ! read log(slp) + ln_read_zsurf = .false. , ! read surface geopotential + ln_hpg_frc = .true. , ! compute horizontal pressure gradient + ln_geo_wnd = .false. , ! compute geostrophic wind + ln_c1d = .false. , ! 1D case + ln_read_mask = .true. , ! read mask file + ln_lsm_land = .false. , ! inverse land & sea masks + ln_perio_latbc = .true. , ! periodic lateral boundary conditions +/ + +&nml_fld + cn_dir = '', + mask_var = 'LSM', + file_m = 'MASK.nc', + file_u = 'U3D.nc', + file_v = 'V3D.nc', + file_t = 'T3D.nc', + file_q = 'Q3D.nc', + file_p = 'P2D.nc', + file_z = 'Z2D.nc', + file_geos = 'UVG_OUT.nc', + file_hpg = 'HPG_OUT.nc', +/ + +&nml_out + grd_file = 'dom_cfg_abl_L50Z10.nc', + abl_file = 'ABL_L50Z10_OUT.nc', + drwn_file = 'ABL_DRWN_L50Z10_OUT.nc', + var_name = '', +/ + +&nml_c1d + iloc = 283, + jloc = 52, +/