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.
new_cmds.tex in NEMO/releases/release-4.0.1/doc/latex/global – NEMO

source: NEMO/releases/release-4.0.1/doc/latex/global/new_cmds.tex

Last change on this file was 14456, checked in by nicolasmartin, 3 years ago

Fix documentation generation (manual and guide)

File size: 3.0 KB
Line 
1%% Global custom commands: \newcommand{<name>}[<args>][<first argument value>]{<code>}
2%% ==============================================================================
3
4%% Same slanted font for NEMO and its core engines
5\newcommand{\NEMO  }{\textsl{NEMO}}
6\newcommand{\OPA   }{\textsl{OPA}}
7\newcommand{\SIcube}{\textsl{SI$^3$}}
8\newcommand{\TOP   }{\textsl{TOP}}
9\newcommand{\PISCES}{\textsl{PISCES}}
10\newcommand{\NEMOVAR}{\textsl{NEMOVAR}}
11
12%% Links for external components
13\newcommand{\AGRIF}{\href{http://agrif.imag.fr}{AGRIF}}
14\newcommand{\CICE }{\href{http://github.com/CICE-Consortium/CICE}{CICE}}
15\newcommand{\OASIS}{\href{http://portal.enes.org/oasis}{OASIS}}
16\newcommand{\XIOS }{\href{http://forge.ipsl.jussieu.fr/ioserver}{XIOS}}
17
18%% Fortran in small capitals
19\newcommand{\fortran}{\textsc{Fortran}}
20\newcommand{\fninety}{\textsc{Fortran 90}}
21
22%% Common aliases
23\renewcommand{\deg}[1][]{\ensuremath{^{\circ}#1}}
24\newcommand{\zstar }{\ensuremath{z^\star}}
25\newcommand{\sstar }{\ensuremath{s^\star}}
26\newcommand{\ztilde}{\ensuremath{\tilde z}}
27\newcommand{\stilde}{\ensuremath{\tilde s}}
28\newcommand{\ie}{\ensuremath{i.e.}}
29\newcommand{\eg}{\ensuremath{e.g.}}
30
31%% Inline maths
32\newcommand{\fractext}[2]{\textstyle \frac{#1}{#2}}
33\newcommand{\rdt}{\Delta t}
34
35%% Gurvan's comments
36\newcommand{\cmtgm}[1]{}
37
38%% Maths
39\newcommand{\lt}{\left}
40\newcommand{\rt}{\right}
41\newcommand{\vect}[1]{\ensuremath{ \mathbf{#1} }}
42\newcommand{\pd}[2][]{\ensuremath{\frac{\partial #1}{\partial #2}}}
43
44%% Convert chapter/section headings to lowercase
45\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
46\renewcommand{\sectionmark}[1]{\markright{#1}{}}
47
48%% Retrieve month name
49\renewcommand{\today}{
50  \ifcase \month\or January\or February\or March\or
51                    April\or   May\or      June\or
52                    July\or    August\or   September\or
53                    October\or November\or December
54  \fi, \number \year
55}
56
57%% Link to orcid profile
58\newcommand{\orcid}[1]{\href{http://orcid.org/#1}{\textcolor{orcidcolor}\aiOrcidSquare}}
59
60%% Local cmds
61\newcommand{\cf}{\ensuremath{C\kern-0.14em f}}
62\newcommand{\rML}[1][i]{\ensuremath{_{\mathrm{ML}\,#1}}}
63\newcommand{\rMLt}[1][i]{\tilde{r}_{\mathrm{ML}\,#1}}
64\newcommand{\triad}[6][]{\ensuremath{{}_{#2}^{#3}{\mathbb{#4}_{#1}}_{#5}^{\,#6}}}
65\newcommand{\triadd}[5]{\ensuremath{{}_{#1}^{#2}{\mathbb{#3}}_{#4}^{\,#5}}}
66\newcommand{\triadt}[5]{\ensuremath{{}_{#1}^{#2}{\tilde{\mathbb{#3}}}_{#4}^{\,#5}}}
67\newcommand{\rtriad}[2][]{\ensuremath{\triad[#1]{i}{k}{#2}{i_p}{k_p}}}
68\newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}}
69\newcommand{\cd}{\mathrm{CO_2}}
70\newcommand{\Ct}{\mathrm{C_T}}
71\newcommand{\pacd}{\mathrm{p^a_{CO_2}}}
72\newcommand{\cq}{\mathrm{^{14}C}}
73\newcommand{\Dcq}{\Delta ^{14}\mathrm{C}}
74\newcommand{\Rq}{\mathrm{^{14}{R}}}
75\newcommand{\CODE}[1]{\textsc{#1}}
76%\newcommand{\CODE}[1]{\textcolor{black}{\textsc{#1}}\xspace}
77
78%% New command for ToC
79\newcommand{\chaptertoc}[1][Table of contents]{%
80  \thispagestyle{empty}
81  \etocsettocstyle{\addsec*{#1}}{}%
82  \localtableofcontents%
83  \vfill
84}
Note: See TracBrowser for help on using the repository browser.