ug4
parameter_parsing.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2015: G-CSC, Goethe University Frankfurt
3  * Author: Sebastian Reiter
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG__parameter_parsing__
34 #define __H__UG__parameter_parsing__
35 
36 #include "common/ug_config.h"
37 
38 namespace ug
39 {
40 
43 
45 
48 UG_API int GetParamIndex(const char* param, int argc, const char * const * argv);
49 
51 
53 UG_API bool FindParam(const char* param, int argc, const char * const * argv);
54 
56 
60 UG_API bool ParamToInt(int& iOut, const char* param, int argc, const char * const * argv);
61 
63 
67 UG_API bool ParamToDouble(double &dOut, const char *param, int argc, const char * const * argv);
68 
70 
76 UG_API bool ParamToString(const char** strOut, const char* param, int argc, const char * const * argv);
77 
78 
79 
80 UG_API double ParamToDouble(const char *param, int argc, const char * const * argv, double dDefault);
81 UG_API int ParamToInt(const char *param, int argc, const char * const * argv, int iDefault);
82 
83 // end group ugbase_common_util
85 
86 }// end of namespace
87 
88 #endif
ug::FindParam
bool FindParam(const char *param, int argc, const char *const *argv)
Definition: parameter_parsing.cpp:50
ug::ParamToDouble
bool ParamToDouble(double &dOut, const char *param, int argc, const char *const *argv)
Definition: parameter_parsing.cpp:66
ug::ParamToInt
bool ParamToInt(int &iOut, const char *param, int argc, const char *const *argv)
Definition: parameter_parsing.cpp:56
ug::GetParamIndex
int GetParamIndex(const char *param, int argc, const char *const *argv)
Definition: parameter_parsing.cpp:40
ug::ParamToString
bool ParamToString(const char **strOut, const char *param, int argc, const char *const *argv)
Definition: parameter_parsing.cpp:78
UG_API
#define UG_API
Definition: ug_config.h:65
ug
the ug namespace
ug_config.h