programmer's documentation
cs_opts.h
Go to the documentation of this file.
1 #ifndef __CS_OPTS_H__
2 #define __CS_OPTS_H__
3 
4 /*============================================================================
5  * Parsing of program arguments and associated initializations
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Code_Saturne base options structure
50  *----------------------------------------------------------------------------*/
51 
52 typedef struct {
53 
54  char *app_name; /* Application name */
55 
56  /* Redirection of standard output */
57 
58  cs_int_t ilisr0; /* Redirection for rank 0
59  (0: not redirected;
60  1: redirected to "listing" file) */
61  cs_int_t ilisrp; /* Redirection for ranks > 0
62  (0: not redirected;
63  1: redirected to "listing_n*" file;
64  2: redirected to "/dev/null", suppressed) */
65 
66  /* Signal handling */
67 
68  bool sig_defaults; /* use default signal handlers */
69 
70  /* Other options */
71 
72  bool preprocess; /* Mesh preprocessing mode */
73  bool verif; /* Mesh quality verification mode */
74  int benchmark; /* Benchmark mode:
75  0: not used;
76  1: timing (CPU + Walltime) mode
77  2: MPI trace-friendly mode */
78 
79  /* Connection with YACS */
80 
81  char *yacs_module; /* Path to YACS module */
82 
83 } cs_opts_t;
84 
85 /*=============================================================================
86  * Public function prototypes
87  *============================================================================*/
88 
89 /*----------------------------------------------------------------------------
90  * Define options and call some associated initializations
91  * based on command line arguments
92  *
93  * parameters:
94  * argc --> number of command line arguments
95  * argv --> array of command line arguments
96  * opts <-- options structure
97  *----------------------------------------------------------------------------*/
98 
99 void
100 cs_opts_define(int argc,
101  char *argv[],
102  cs_opts_t *opts);
103 
104 /*----------------------------------------------------------------------------*/
105 
107 
108 #endif /* __CS_OPTS_H__ */
void cs_opts_define(int argc, char *argv[], cs_opts_t *opts)
Definition: cs_opts.c:234
bool preprocess
Definition: cs_opts.h:72
int benchmark
Definition: cs_opts.h:74
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
int cs_int_t
Fortran-compatible integer.
Definition: cs_defs.h:296
bool sig_defaults
Definition: cs_opts.h:68
char * yacs_module
Definition: cs_opts.h:81
bool verif
Definition: cs_opts.h:73
Definition: cs_opts.h:52
#define END_C_DECLS
Definition: cs_defs.h:462
cs_int_t ilisrp
Definition: cs_opts.h:61
cs_int_t ilisr0
Definition: cs_opts.h:58
char * app_name
Definition: cs_opts.h:54