programmer's documentation
Home
Modules
Data Structures
Files
User examples
Variables and structures reference
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Modules
Pages
src
base
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-2017 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
38
BEGIN_C_DECLS
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
cdo
;
/* CDO mode:
75
-1: not used
76
0: used with Finite Volume schemes
77
1: only the CDO kernel */
78
79
int
benchmark
;
/* Benchmark mode:
80
0: not used;
81
1: timing (CPU + Walltime) mode
82
2: MPI trace-friendly mode */
83
84
/* Connection with YACS */
85
86
char
*
yacs_module
;
/* Path to YACS module */
87
88
}
cs_opts_t
;
89
90
/*=============================================================================
91
* Public function prototypes
92
*============================================================================*/
93
94
/*----------------------------------------------------------------------------
95
* Define options and call some associated initializations
96
* based on command line arguments
97
*
98
* parameters:
99
* argc --> number of command line arguments
100
* argv --> array of command line arguments
101
* opts <-- options structure
102
*----------------------------------------------------------------------------*/
103
104
void
105
cs_opts_define
(
int
argc,
106
char
*argv[],
107
cs_opts_t
*opts);
108
109
/*----------------------------------------------------------------------------*/
110
111
END_C_DECLS
112
113
#endif
/* __CS_OPTS_H__ */
cs_base.h
cs_opts_define
void cs_opts_define(int argc, char *argv[], cs_opts_t *opts)
Definition:
cs_opts.c:231
cs_opts_t::preprocess
bool preprocess
Definition:
cs_opts.h:72
cs_opts_t::benchmark
int benchmark
Definition:
cs_opts.h:79
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition:
cs_defs.h:453
cs_int_t
int cs_int_t
Fortran-compatible integer.
Definition:
cs_defs.h:296
cs_opts_t::sig_defaults
bool sig_defaults
Definition:
cs_opts.h:68
cs_opts_t::yacs_module
char * yacs_module
Definition:
cs_opts.h:86
cs_opts_t::cdo
int cdo
Definition:
cs_opts.h:74
cs_opts_t::verif
bool verif
Definition:
cs_opts.h:73
cs_opts_t
Definition:
cs_opts.h:52
END_C_DECLS
#define END_C_DECLS
Definition:
cs_defs.h:454
cs_opts_t::ilisrp
cs_int_t ilisrp
Definition:
cs_opts.h:61
cs_opts_t::ilisr0
cs_int_t ilisr0
Definition:
cs_opts.h:58
cs_opts_t::app_name
char * app_name
Definition:
cs_opts.h:54
Generated on Tue Oct 10 2017 20:03:39 by
1.8.8