Theses general rules should be seen as basic golden rules helping the whole documentation to be consistent. They are strongly recommended:
*i.e*
usepackage{csmacros}`).csbiblio.bib
file located in the doc/style
directory.csdoc.csl
class (for long documents as a report) csshortdoc.cls
class (for short documents as an article).This section does not pretend to describe how to write a \( \mbox{\LaTeX} \) document, but is to present the macros defined in csmacro.sty
and give some typographic pieces of advice.
The \CS
macro in the csdoc.sty
package is used to allow a short syntax and typeset the code_saturne name in a proper and consistant manner.
The available macros for mathematical symbols are available through the csmacros.sty
package.
\( \mbox{\LaTeX} \) code | preview | comment |
---|---|---|
$\divs$ | \( \divs \) | |
$\divv$ | \( \divv \) | |
$\divt$ | \( \divt \) | |
$\grad$ | \( \grad \) | |
$\ggrad$ | \( \ggrad \) | |
$\gradv$ | \( \gradv \) | |
$\gradt$ | \( \gradt \) | |
$\gradtt$ | \( \gradtt \) | |
$\mat{M}$ | \( \mat{M} \) | |
$\matt{M}$ | \( \matt{M} \) | |
$\rot$ | \( \rot \) | |
$\vect{V}$ | \( \vect{V} \) | |
$\tens{T}$ | \( \tens{T} \) | |
$\transpose{M}$ | \( \transpose{M} \) | |
$\symmetric{M}$ | \( \symmetric{M} \) | |
$\trace$ | \( \trace \) | |
$\deviator{M}$ | \( \deviator{M} \) | |
$\norm{M}$ | \( \norm{M} \) | |
$\rans{M}$ | \( \rans{M} \) | |
$\fluct{M}$ | \( \fluct{M} \) | |
$\fluctt{M}$ | \( \fluctt{M} \) | |
$\favre{M}$ | \( \favre{M} \) | |
$\ints{M}{N}$ | \( \int{M}{N} \) | |
$\intss{M}{N}$ | \( \intss{M}{N} \) | |
$\intt{M}{N}$ | \( \intt{M}{N} \) | |
\degresC | \(\mbox{\degresC}\) | |
$\Max$ | \( \Max \) | |
$\Min$ | \( \Min \) | |
$\dd$ | \( \dd \) | total derivative |
Many macros are dedicated to discretized quantity notations used throughout code_saturne. The following table lists the main ones, but may not be complete, so checking the actual contents of csmacros.sty
is always recommened.
\( \mbox{\LaTeX} \) code | preview | comment |
---|---|---|
$\Facei{\celli}$ | \( \Facei{\celli} \) | set of internal faces |
$\Faceb{\cellj}$ | \( \Faceb{\cellj} \) | set of boundary faces |
$\Face{\celli}$ | \( \Face{\celli} \) | set of faces |
$\face$ | \( \face \) | face |
$\fij$ | \( \fij \) | internal face |
$\fib$ | \( \fib \) | boundary face |
$\iface$ | \( \iface \) | oriented face |
$\ij$ | \( \ij \) | oriented internal face |
$\ib$ | \( \ib \) | oriented boundary face |
$\celli$ | \( \celli \) | name of the current cell |
$\cellj$ | \( \cellj \) | name of the adjacent cell |
$\ipf$ | \( \ipf \) | orthogonal center index of the current cell |
$\jpf$ | \( \jpf \) | orthogonal center index of the adjacent cell |
$\centi$ | \( \centi \) | center of the current cell |
$\centj$ | \( \centj \) | center of the adjacent cell |
$\centip$ | \( \centip \) | orthogonal center of the current cell |
$\centjp$ | \( \centjp \) | orthogonal center of the adjacent cell |
$\cento$ | \( \cento \) | intersection between the cell centers and the face |
$\centf$ | \( \centf \) | center of the face |
Here are some useful tricks:
\begin{itemize} \item \end{itemize}
environment.\textcolor{blueedf}{text}
, its darker version \textcolor{bluededf}{text}
, or the orange \textcolor{orangeedf}{text}
and its the dark version \textcolor{orangededf}{text}
.\label{eq:label}
, \label{sec:label}
, \label{ap:label}
, \label{fig:label}
and \label{tab:label}
prefixes.\emph{}
mode for acronyms (e.g., EDF).\emph{}
mode for Latin words (e.g., i.e., a priori, etc.).\left(
instead of (
and \right)
instead of )
in math mode.\newline
or \\
except in a tabular environment or an array.\figurename~
and \tablename~
to write \( \figurename \) and \( \tablename \).\begin{remark} \end{remark}
and example \begin{example} \end{example}
environments defined in csdoc.cls
: