FreeFOAM The Cross-Platform CFD Toolkit
scalar.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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 Typedef
25  Foam::scalar
26 
27 Description
28  Single floating point number identical to float or double depending on
29  whether SP or DP is defined.
30 
31 SourceFiles
32  scalar.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef scalar_H
37 #define scalar_H
38 
39 #include <OpenFOAM/floatScalar.H>
40 #include <OpenFOAM/doubleScalar.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 #if defined(SP)
45 
46 // Define scalar as a float
47 
48 namespace Foam
49 {
50  typedef floatScalar scalar;
51 
52  static const scalar GREAT = floatScalarGREAT;
53  static const scalar VGREAT = floatScalarVGREAT;
54  static const scalar ROOTVGREAT = floatScalarROOTVGREAT;
55  static const scalar SMALL = floatScalarSMALL;
56  static const scalar VSMALL = floatScalarVSMALL;
57  static const scalar ROOTVSMALL = floatScalarROOTVSMALL;
58 
59  scalar readScalar(Istream& is);
60 }
61 
62 #elif defined(DP)
63 
64 // Define scalar as a double
65 
66 namespace Foam
67 {
68  typedef doubleScalar scalar;
69 
70  static const scalar GREAT = doubleScalarGREAT;
71  static const scalar VGREAT = doubleScalarVGREAT;
72  static const scalar ROOTVGREAT = doubleScalarROOTVGREAT;
73  static const scalar SMALL = doubleScalarSMALL;
74  static const scalar VSMALL = doubleScalarVSMALL;
75  static const scalar ROOTVSMALL = doubleScalarROOTVSMALL;
76 
77  scalar readScalar(Istream& is);
78 }
79 
80 #endif
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************ vim: set sw=4 sts=4 et: ************************ //