/
reducedUnits.H
189 lines (114 loc) · 4.42 KB
/
reducedUnits.H
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::reducedUnits
Description
SourceFiles
reducedUnitsI.H
reducedUnits.C
reducedUnitsIO.C
\*---------------------------------------------------------------------------*/
#ifndef reducedUnits_H
#define reducedUnits_H
#include "scalar.H"
#include "IOdictionary.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class reducedUnits;
Ostream& operator<<(Ostream&, const reducedUnits&);
/*---------------------------------------------------------------------------*\
Class reducedUnits Declaration
\*---------------------------------------------------------------------------*/
class reducedUnits
{
// Private data
// Reduced units
// Fundamental values
scalar refLength_;
scalar refTime_;
scalar refMass_;
// Derived values
scalar refEnergy_;
scalar refTemp_;
scalar refForce_;
scalar refVelocity_;
scalar refVolume_;
scalar refPressure_;
scalar refMassDensity_;
scalar refNumberDensity_;
// Private Member Functions
void calcRefValues();
//- Disallow default bitwise copy construct
reducedUnits(const reducedUnits&);
//- Disallow default bitwise assignment
void operator=(const reducedUnits&);
public:
// Static data members
//- Static data someStaticData
static const scalar kb;
// Constructors
//- Construct with no argument, uses default values:
// length = 1nm
// mass = 1.660538782e-27kg (unified atomic mass unit)
// temperature = 1K (therefore, energy = 1*kb)
reducedUnits();
//- Construct from components
reducedUnits
(
scalar refLength,
scalar refTime,
scalar refMass
);
//- Construct from dictionary
reducedUnits(const IOdictionary& reducedUnitsDict);
//- Destructor
~reducedUnits();
// Member Functions
void setRefValues
(
scalar refLength,
scalar refTime,
scalar refMass
);
void setRefValues(const IOdictionary& reducedUnitsDict);
// Access
inline scalar refLength() const;
inline scalar refTime() const;
inline scalar refMass() const;
inline scalar refTemp() const;
inline scalar refEnergy() const;
inline scalar refForce() const;
inline scalar refVelocity() const;
inline scalar refVolume() const;
inline scalar refPressure() const;
inline scalar refMassDensity() const;
inline scalar refNumberDensity() const;
// IOstream Operators
friend Ostream& operator<<(Ostream&, const reducedUnits&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "reducedUnitsI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //