1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122 | // *****************************************************************************
/*!
\file src/Base/Types.hpp
\copyright 2012-2015 J. Bakosi,
2016-2018 Los Alamos National Security, LLC.,
2019-2021 Triad National Security, LLC.
All rights reserved. See the LICENSE file for details.
\brief Toolkit-level type definitions
\details Toolkit-level type definitions
*/
// *****************************************************************************
#ifndef Types_h
#define Types_h
#include <cstddef>
#include <string>
#include <optional>
namespace tk {
//! Real number type used throughout the whole code.
// TODO Test with single precision and possibly others.
using real = double;
//! uint type used throughout the whole code.
using ncomp_t = std::size_t;
//! Struct for storing info
struct info_t {
std::string kw;
std::string sDescr;
std::string lDescr;
std::string tDescr;
// constructor
info_t(
std::string k,<--- Function parameter 'k' should be passed by const reference. [+]Parameter 'k' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
std::string s,<--- Function parameter 's' should be passed by const reference. [+]Parameter 's' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
std::string l,<--- Function parameter 'l' should be passed by const reference. [+]Parameter 'l' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
std::string t ) :<--- Function parameter 't' should be passed by const reference. [+]Parameter 't' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
kw(k),
sDescr(s),
lDescr(l),
tDescr(t)
{}
// Accessors
std::string keyword() const {return kw;}
std::string shortDescription() const {return sDescr;}
std::string longDescription() const {return lDescr;}
std::string typeDescription() const {return tDescr;}
};
//! Struct for storing keyword in the input deck
struct entry_t {
info_t info;
// constructor
entry_t(
std::string kw,<--- Function parameter 'kw' should be passed by const reference. [+]Parameter 'kw' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
std::string sDescr,<--- Function parameter 'sDescr' should be passed by const reference. [+]Parameter 'sDescr' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
std::string lDescr,<--- Function parameter 'lDescr' should be passed by const reference. [+]Parameter 'lDescr' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
std::string tDescr="" ) :<--- Function parameter 'tDescr' should be passed by const reference. [+]Parameter 'tDescr' is passed by value. It could be passed as a const reference which is usually faster and recommended in C++.
info(kw, sDescr, lDescr, tDescr)
{}
//! Accessor to keyword as std::string
//! \return Keyword as std::string
const std::string string() const { return info.keyword(); }
//! Accessor to required short name of a keyword
//! \return Name of keyword as std::string
const std::string name() const { return info.keyword(); }
//! Accessor to required short description of a keyword
//! \return Short help as std::string
const std::string shortDescription() const { return info.shortDescription(); }
//! Accessor to required long description of a keyword
//! \return Long help as std::string
const std::string longDescription() const { return info.longDescription(); }
//! Alias accessor for keyword
//! \return Null. This is a punt to fit in the existing HelpFactory
//! infrastructure; needs to be removed.
const std::optional< std::string > alias() const { return std::nullopt; }
//! Expected type description accessor for keyword
//! \return Type description for keyword
const std::optional< std::string > expt() const {
if (!info.typeDescription().empty())
return info.typeDescription();
else
return std::nullopt;
}
//! Expected lower bound accessor for a keyword
//! \return Null.
const std::optional< std::string > lower() const { return std::nullopt; }
//! Expected upper bound accessor for a keyword
//! \return Null.
const std::optional< std::string > upper() const { return std::nullopt; }
//! Expected choices description accessor for a keyword
//! \return Null.
const std::optional< std::string > choices() const { return std::nullopt; }
//! \brief Less-than operator for ordering, used by, e.g., std::set::insert
//! \param[in] en entry_t to compare
//! \return Boolean indicating if en is less than 'this'
bool operator< ( const entry_t& en ) const {
if (info.kw < en.info.kw)
return true;
else
return false;
}
};
} // tk::
#endif // Types_h
|