dimensionSets.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "dimensionSet.H"
27 #include "dimensionedScalar.H"
28 #include "simpleRegIOobject.H"
29 #include "demandDrivenData.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 /* * * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * */
37 
38 // Since dimensionSystems() can be reread we actually store a copy of
39 // the controlDict subDict (v.s. a reference to the subDict for e.g.
40 // dimensionedConstants)
41 dictionary* dimensionSystemsPtr_(nullptr);
42 HashTable<dimensionedScalar>* unitSetPtr_(nullptr);
43 dimensionSets* writeUnitSetPtr_(nullptr);
44 
45 // Helper class to
46 // register re-reader
47 // deallocate demand-driven data
49 :
50  public simpleRegIOobject
51 {
52 
53 public:
54 
56  :
58  {}
59 
61  {
65 
66  }
67 
68  virtual void readData(Istream& is)
69  {
74  }
75 
76  virtual void writeData(Ostream& os) const
77  {
78  os << dimensionSystems();
79  }
80 };
81 
83 
84 
86 {
88  {
89  dictionary* cachedPtr = nullptr;
91  (
93  (
94  "DimensionSets",
95  cachedPtr
96  )
97  );
98  }
99  return *dimensionSystemsPtr_;
100 }
101 
102 
104 {
105  if (!unitSetPtr_)
106  {
107  const dictionary& dict = dimensionSystems();
108 
109  if (!dict.found("unitSet"))
110  {
112  << "Cannot find unitSet in dictionary " << dict.name()
113  << exit(FatalIOError);
114  }
115 
116  const word unitSetCoeffs(word(dict.lookup("unitSet")) + "Coeffs");
117 
118  if (!dict.found(unitSetCoeffs))
119  {
121  << "Cannot find " << unitSetCoeffs << " in dictionary "
122  << dict.name() << exit(FatalIOError);
123  }
124 
125  const dictionary& unitDict = dict.subDict(unitSetCoeffs);
126 
127  unitSetPtr_ = new HashTable<dimensionedScalar>(unitDict.size());
128 
129  forAllConstIter(dictionary, unitDict, iter)
130  {
131  if (iter().keyword() != "writeUnits")
132  {
133  dimensionedScalar dt(iter().keyword(), iter().stream());
134  const bool ok = unitSetPtr_->insert(iter().keyword(), dt);
135  if (!ok)
136  {
138  << "Duplicate unit " << iter().keyword()
139  << " in DimensionSets dictionary"
140  << exit(FatalIOError);
141  }
142  }
143  }
144 
145  const wordList writeUnitNames
146  (
147  unitDict.lookupOrDefault<wordList>
148  (
149  "writeUnits",
150  wordList(0)
151  )
152  );
153 
154  writeUnitSetPtr_ = new dimensionSets(*unitSetPtr_, writeUnitNames);
155 
156  if (writeUnitNames.size() != 0 && writeUnitNames.size() != 7)
157  {
159  << "Cannot find entry \"writeUnits\" in " << unitDict.name()
160  << " or it is not a wordList of size 7"
161  << exit(FatalIOError);
162  }
163  }
164 
165  return *unitSetPtr_;
166 }
167 
168 
170 {
171  if (!writeUnitSetPtr_)
172  {
173  (void)unitSet();
174  }
175  return *writeUnitSetPtr_;
176 }
177 
178 
179 const dimensionSet dimless(0, 0, 0, 0, 0, 0, 0);
180 
181 const dimensionSet dimMass(1, 0, 0, 0, 0, 0, 0);
182 const dimensionSet dimLength(0, 1, 0, 0, 0, 0, 0);
183 const dimensionSet dimTime(0, 0, 1, 0, 0, 0, 0);
184 const dimensionSet dimTemperature(0, 0, 0, 1, 0, 0, 0);
185 const dimensionSet dimMoles(0, 0, 0, 0, 1, 0, 0);
186 const dimensionSet dimCurrent(0, 0, 0, 0, 0, 1, 0);
187 const dimensionSet dimLuminousIntensity(0, 0, 0, 0, 0, 0, 1);
188 
189 const dimensionSet dimArea(sqr(dimLength));
190 const dimensionSet dimVolume(pow3(dimLength));
191 const dimensionSet dimVol(dimVolume);
192 
193 const dimensionSet dimVelocity(dimLength/dimTime);
194 const dimensionSet dimAcceleration(dimVelocity/dimTime);
195 
196 const dimensionSet dimDensity(dimMass/dimVolume);
197 const dimensionSet dimForce(dimMass*dimAcceleration);
198 const dimensionSet dimEnergy(dimForce*dimLength);
199 const dimensionSet dimPower(dimEnergy/dimTime);
200 
201 const dimensionSet dimPressure(dimForce/dimArea);
202 const dimensionSet dimCompressibility(dimDensity/dimPressure);
203 const dimensionSet dimGasConstant(dimEnergy/dimMass/dimTemperature);
204 const dimensionSet dimSpecificHeatCapacity(dimGasConstant);
205 const dimensionSet dimViscosity(dimArea/dimTime);
206 const dimensionSet dimDynamicViscosity(dimDensity*dimViscosity);
207 
208 
209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
210 
211 } // End namespace Foam
212 
213 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
214 
216 (
217  const HashTable<dimensionedScalar>& units,
218  const wordList& unitNames
219 )
220 :
221  units_(unitNames.size()),
222  conversion_(unitNames.size()),
223  conversionPivots_(unitNames.size()),
224  valid_(false)
225 {
226  forAll(unitNames, i)
227  {
228  units_.set
229  (
230  i,
232  (
233  units[unitNames[i]]
234  )
235  );
236  }
237 
238  if (unitNames.size() == 7)
239  {
240  valid_ = true;
241 
242  // Determine conversion from basic units to write units
243  for (label rowI = 0; rowI < conversion_.m(); rowI++)
244  {
245  scalar* row = conversion_[rowI];
246 
247  for (label columnI = 0; columnI < conversion_.n(); columnI++)
248  {
249  const dimensionedScalar& dSet = units_[columnI];
250  row[columnI] = dSet.dimensions()[rowI];
251  }
252  }
253 
254  conversionPivots_.setSize(conversion_.m());
255  LUDecompose(conversion_, conversionPivots_);
256  }
257 }
258 
259 
261 {
262  LUBacksubstitute(conversion_, conversionPivots_, exponents);
263 }
264 
265 
266 // ************************************************************************* //
Abstract base class for registered object with I/O. Used in debug symbol registration.
dictionary dict
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:667
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
dictionary & switchSet(const char *subDictName, dictionary *&subDictPtr)
Internal function to lookup a sub-dictionary from controlDict.
Definition: debug.C:131
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
void LUDecompose(scalarSquareMatrix &matrix, labelList &pivotIndices)
LU decompose the matrix with pivoting.
dimensionedSymmTensor sqr(const dimensionedVector &dv)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
const dimensionSet dimViscosity
HashTable< dimensionedScalar > * unitSetPtr_(nullptr)
const dimensionSet dimSpecificHeatCapacity(dimGasConstant)
Definition: dimensionSets.H:71
const dimensionSet dimVol(dimVolume)
Definition: dimensionSets.H:59
const dimensionSet dimDynamicViscosity
dimensionSets(const HashTable< dimensionedScalar > &, const wordList &unitNames)
Construct from all units and set of units to use for inversion.
dimensionSets * writeUnitSetPtr_(nullptr)
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:934
addDimensionSetsToDebug addDimensionSetsToDebug_("DimensionSets")
const dimensionSet dimVolume(pow3(dimLength))
Definition: dimensionSets.H:58
const dimensionSet dimAcceleration
Dimension set for the base types.
Definition: dimensionSet.H:120
const fileName & name() const
Return the dictionary name.
Definition: dictionary.H:111
A class for handling words, derived from string.
Definition: word.H:59
const dimensionSet dimTemperature(0, 0, 0, 1, 0, 0, 0)
Definition: dimensionSets.H:52
const HashTable< dimensionedScalar > & unitSet()
Set of all dimensions.
An STL-conforming hash table.
Definition: HashTable.H:61
const dimensionSet dimPressure
forAllConstIter(PtrDictionary< phaseModel >, mixture.phases(), phase)
Definition: pEqn.H:29
const dimensionSet dimPower
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
const dimensionSet dimForce
const dimensionSet dimMoles(0, 0, 0, 0, 1, 0, 0)
Definition: dimensionSets.H:53
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
const dimensionSet dimEnergy
const dimensionSet dimDensity
dimensionedScalar pow3(const dimensionedScalar &ds)
dictionary & dimensionSystems()
Top level dictionary.
Definition: dimensionSets.C:85
Template functions to aid in the implementation of demand driven data.
const dimensionSet dimless(0, 0, 0, 0, 0, 0, 0)
Definition: dimensionSets.H:47
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
const dimensionSet dimLength(0, 1, 0, 0, 0, 0, 0)
Definition: dimensionSets.H:50
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:331
const dimensionSet dimCurrent(0, 0, 0, 0, 0, 1, 0)
Definition: dimensionSets.H:54
const dimensionSet dimGasConstant
const dimensionSet dimTime(0, 0, 1, 0, 0, 0, 0)
Definition: dimensionSets.H:51
const dimensionSet & dimensions() const
Return const reference to dimensions.
virtual void writeData(Ostream &os) const
Write.
Definition: dimensionSets.C:76
const dimensionSet dimMass(1, 0, 0, 0, 0, 0, 0)
Definition: dimensionSets.H:49
const dimensionSet dimLuminousIntensity(0, 0, 0, 0, 0, 0, 1)
Definition: dimensionSets.H:55
const dimensionSets & writeUnitSet()
Set of units.
void addDimensionSetObject(const char *name, simpleRegIOobject *obj)
Register DimensionSets read/write object.
Definition: debug.C:286
const dimensionSet dimCompressibility
dictionary * dimensionSystemsPtr_(nullptr)
void deleteDemandDrivenData(DataPtr &dataPtr)
void coefficients(scalarField &) const
(if valid) obtain set of coefficients of unitNames
virtual void readData(Istream &is)
Read.
Definition: dimensionSets.C:68
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:57
Namespace for OpenFOAM.
void LUBacksubstitute(const scalarSquareMatrix &luMmatrix, const labelList &pivotIndices, List< Type > &source)
LU back-substitution with given source, returning the solution.
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:812
IOerror FatalIOError
const dimensionSet dimVelocity
addDimensionSetsToDebug(const char *name)
Definition: dimensionSets.C:55