1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
%-------------------------------------------------------------------------------
% This file is part of Code_Saturne, a general-purpose CFD tool.
%
% Copyright (C) 1998-2018 EDF S.A.
%
% This program is free software; you can redistribute it and/or modify it under
% the terms of the GNU General Public License as published by the Free Software
% Foundation; either version 2 of the License, or (at your option) any later
% version.
%
% This program is distributed in the hope that it will be useful, but WITHOUT
% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
% FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
% details.
%
% You should have received a copy of the GNU General Public License along with
% this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
% Street, Fifth Floor, Boston, MA 02110-1301, USA.
%-------------------------------------------------------------------------------
\documentclass[a4paper,11pt]{article}
\usepackage{hyperref}
\usepackage[landscape]{geometry}
\usepackage{fullpage}
\usepackage{multicol}
\usepackage{graphicx}
\usepackage{xspace}
\input{csvers}
\pagestyle{empty}
\setlength\columnseprule{0.4pt}
\addtolength\columnsep{2pt}
\newcommand{\refword}[1]{\texttt{$\bullet$ \bf{#1}}}
\begin{document}
\begin{multicols*}{3}
\begin{center}
\includegraphics[width=4cm]{cs_logo_flux}
{\Large {\bf \CS~\verscs\\Quick reference card}}
\end{center}
% User scripts
% ------------
\section*{User scripts}
All \CS commands are available under a single script: \texttt{code\_saturne}.
Here below are the most useful commands for a \CS user from the study
creation to the post-processing. Complete information for each
\texttt{command} can be obtained by typing:\\
\texttt{code\_saturne <command> --help}.\\
\refword{info}\\
Get information on \CS. Open the documentation (user, theory).\\
\textit{e.g.} \texttt{code\_saturne info --guide \emph{user}}\\
\refword{config}\\
Get information on the configuration and installation of \CS.\\
\textit{e.g.} \texttt{code\_saturne config}\\
\refword{create}\\
Create a \CS template study or case.\\
\textit{e.g.} \texttt{code\_saturne create --study \emph{study1}}\\
\refword{gui}\\
Launch \CS graphical user interface.\\
\textit{e.g.} \texttt{code\_saturne gui --file \emph{xmlfile}}\\
\refword{trackcvg}\\
Launch \CS track convergence tool.\\
\textit{e.g.} \texttt{code\_saturne trackcvg RESU/run\_name}\\
\refword{compile}\\
Create a specific solver executable when some user subroutines are
present.\\
\textit{e.g.} \texttt{code\_saturne compile --test}\\
\refword{studymanager}\\
Launch studymanager.\\
\textit{e.g.} \texttt{code\_saturne studymanager --file \emph{xmlfile} --run}\\
% User subroutines
% ----------------
\section*{Main user subroutines}
Here below are the most useful user subroutines to run a standard
simulation. Some of them are useless if the graphical user interface
is used.\\
\refword{cs\_user\_parameters.f90}\\
Initialization of the main keywords.\\
\refword{cs\_user\_boundary\_conditions.f90}\\
Management of the boundary conditions.\\
\refword{cs\_user\_physical\_properties.f90}\\
Management of the variable physical properties.\\
\refword{cs\_user\_initialization.f90}\\
Non-standard initialization of the variables.\\
\refword{cs\_user\_extra\_operations.f90}\\
User project files.\\
\refword{cs\_user\_head\_losses.f90}\\
Management of the head loss.\\
\refword{cs\_user\_source\_terms.f90}\\
User source terms related subroutines.\\
\refword{cs\_user\_postprocess\_var.f90}\\
Post-processing related subroutines.\\
% Main variables
% --------------
%\section*{Main variables}
% Practical information
% ---------------------
\section*{Practical information}
\url{http://www.code-saturne.org}\\
Related software:\\
\url{http://www.syrthes.org}\\
\url{http://www.code-aster.org}\\
\url{http://www.salome-platform.org}
\begin{center}
\includegraphics[width=2cm]{logoedf}
\end{center}
\end{multicols*}
\end{document}
|
