programmer's documentation
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
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-2013 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
/* Other options */
67
68
bool
preprocess
;
/* Mesh preprocessing mode */
69
bool
verif
;
/* Mesh quality verification mode */
70
71
int
benchmark
;
/* Benchmark mode:
72
0: not used;
73
1: timing (CPU + Walltime) mode
74
2: MPI trace-friendly mode */
75
76
/* Connection with YACS */
77
78
char
*
yacs_module
;
/* Path to YACS module */
79
80
}
cs_opts_t
;
81
82
/*=============================================================================
83
* Public function prototypes
84
*============================================================================*/
85
86
/*----------------------------------------------------------------------------
87
* Define options and call some associated initializations
88
* based on command line arguments
89
*
90
* parameters:
91
* argc --> number of command line arguments
92
* argv --> array of command line arguments
93
* opts <-- options structure
94
*----------------------------------------------------------------------------*/
95
96
void
97
cs_opts_define
(
int
argc,
98
char
*argv[],
99
cs_opts_t
*opts);
100
101
/*----------------------------------------------------------------------------*/
102
103
END_C_DECLS
104
105
#endif
/* __CS_OPTS_H__ */
Generated on Thu Feb 27 2014 19:21:34 by
1.8.3.1