dimensionedConstants.H
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-2020 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 Global
25  dimensionedConstants
26 
27 Description
28  Dictionary reading and supplying the dimensioned constants used within
29  OpenFOAM, particularly for thermodynamics.
30 
31  The values are read from the OpenFOAM etc/controlDict and should be
32  changed to run with a different set of units from the default SI units.
33 
34 SourceFiles
35  dimensionedConstants.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef dimensionedConstants_H
40 #define dimensionedConstants_H
41 
42 #include "dictionary.H"
43 #include "dimensionedScalar.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 dictionary& dimensionedConstants();
53 
55 (
56  const char* const group,
57  const char* name,
58  const dimensionSet& dimensions
59 );
60 
62 (
63  const char* const group,
64  const char* name,
65  const dimensionedScalar& defaultValue
66 );
67 
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 } // End namespace Foam
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 #endif
76 
77 // ************************************************************************* //
const char *const group
Group name for atomic constants.
Namespace for OpenFOAM.
const HashTable< dimensionSet > & dimensions()
Get the table of dimension sets.
Definition: dimensionSets.C:96
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
dimensionedScalar dimensionedConstant(const char *const group, const char *name, const dimensionSet &dimensions)
dictionary & dimensionedConstants()
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.