Code_Saturne
CFD tool
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-2012 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  /* MPI-IO mode */
67 
68  int mpi_io_mode; /* MPI-IO mode:
69  0: no MPI-IO
70  1: MPI-IO with explicit offsets
71  2: MPI-IO with individual file pointers */
72 
73  /* Other options */
74 
75  bool preprocess; /* Mesh preprocessing mode */
76  bool verif; /* Mesh quality verification mode */
77 
78  int benchmark; /* Benchmark mode:
79  0: not used;
80  1: timing (CPU + Walltime) mode
81  2: MPI trace-friendly mode */
82 
83  /* Connection with YACS */
84 
85  char *yacs_module; /* Path to YACS module */
86 
87 } cs_opts_t;
88 
89 /*=============================================================================
90  * Public function prototypes
91  *============================================================================*/
92 
93 /*----------------------------------------------------------------------------
94  * Define options and call some associated initializations
95  * based on command line arguments
96  *
97  * parameters:
98  * argc --> number of command line arguments
99  * argv --> array of command line arguments
100  * opts <-- options structure
101  *----------------------------------------------------------------------------*/
102 
103 void
104 cs_opts_define(int argc,
105  char *argv[],
106  cs_opts_t *opts);
107 
108 /*----------------------------------------------------------------------------*/
109 
111 
112 #endif /* __CS_OPTS_H__ */
void cs_opts_define(int argc, char *argv[], cs_opts_t *opts)
Definition: cs_opts.c:222
bool preprocess
Definition: cs_opts.h:75
int benchmark
Definition: cs_opts.h:78
#define BEGIN_C_DECLS
Definition: cs_defs.h:365
int cs_int_t
Definition: cs_defs.h:263
char * yacs_module
Definition: cs_opts.h:85
bool verif
Definition: cs_opts.h:76
Definition: cs_opts.h:52
#define END_C_DECLS
Definition: cs_defs.h:366
cs_int_t ilisrp
Definition: cs_opts.h:61
int mpi_io_mode
Definition: cs_opts.h:68
cs_int_t ilisr0
Definition: cs_opts.h:58
char * app_name
Definition: cs_opts.h:54