Cardinal
UserErrorChecking.h
Go to the documentation of this file.
1 /********************************************************************/
2 /* SOFTWARE COPYRIGHT NOTIFICATION */
3 /* Cardinal */
4 /* */
5 /* (c) 2021 UChicago Argonne, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by UChicago Argonne, LLC */
9 /* Under Contract No. DE-AC02-06CH11357 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* Prepared by Battelle Energy Alliance, LLC */
13 /* Under Contract No. DE-AC07-05ID14517 */
14 /* With the U. S. Department of Energy */
15 /* */
16 /* See LICENSE for full restrictions */
17 /********************************************************************/
18 
19 #pragma once
20 
21 #include "InputParameters.h"
22 
30 void checkUnusedParam(const InputParameters & p,
31  const std::vector<std::string> & names,
32  const std::string & explanation,
33  const bool error = false);
34 
42 void checkUnusedParam(const InputParameters & p,
43  const std::string & name,
44  const std::string & explanation,
45  const bool error = false);
46 
53 void checkRequiredParam(const InputParameters & p,
54  const std::vector<std::string> & names,
55  const std::string & explanation);
56 
63 void checkRequiredParam(const InputParameters & p,
64  const std::string & name,
65  const std::string & explanation);
66 
73 void checkJointParams(const InputParameters & p,
74  const std::vector<std::string> & name,
75  const std::string & explanation);
checkJointParams
void checkJointParams(const InputParameters &p, const std::vector< std::string > &name, const std::string &explanation)
Definition: UserErrorChecking.C:66
checkRequiredParam
void checkRequiredParam(const InputParameters &p, const std::vector< std::string > &names, const std::string &explanation)
Definition: UserErrorChecking.C:48
checkUnusedParam
void checkUnusedParam(const InputParameters &p, const std::vector< std::string > &names, const std::string &explanation, const bool error=false)
Definition: UserErrorChecking.C:23