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) 2011-2015 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 Typedef
25  Foam::scalar
26 
27 Description
28  Single floating point number identical to float or double depending on
29  whether WM_SP or WM_DP is defined.
30 
31 SourceFiles
32  scalar.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef scalar_H
37 #define scalar_H
38 
39 #include "floatScalar.H"
40 #include "doubleScalar.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 #if defined(WM_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 ROOTSMALL = floatScalarROOTSMALL;
57  static const scalar VSMALL = floatScalarVSMALL;
58  static const scalar ROOTVSMALL = floatScalarROOTVSMALL;
59 
60  scalar readScalar(Istream& is);
61 }
62 
63 #elif defined(WM_DP)
64 
65 // Define scalar as a double
66 
67 namespace Foam
68 {
69  typedef doubleScalar scalar;
70 
71  static const scalar GREAT = doubleScalarGREAT;
72  static const scalar VGREAT = doubleScalarVGREAT;
73  static const scalar ROOTVGREAT = doubleScalarROOTVGREAT;
74  static const scalar SMALL = doubleScalarSMALL;
75  static const scalar ROOTSMALL = doubleScalarROOTSMALL;
76  static const scalar VSMALL = doubleScalarVSMALL;
77  static const scalar ROOTVSMALL = doubleScalarROOTVSMALL;
78 
79  scalar readScalar(Istream& is);
80 }
81 
82 #endif
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 #endif
88 
89 // ************************************************************************* //
static const doubleScalar doubleScalarSMALL
Definition: doubleScalar.H:57
static const floatScalar floatScalarROOTSMALL
Definition: floatScalar.H:58
float floatScalar
Float precision floating point scalar type.
Definition: floatScalar.H:49
static const doubleScalar doubleScalarVGREAT
Definition: doubleScalar.H:55
static const doubleScalar doubleScalarROOTVSMALL
Definition: doubleScalar.H:60
Namespace for OpenFOAM.
static const floatScalar floatScalarVGREAT
Definition: floatScalar.H:55
static const doubleScalar doubleScalarROOTSMALL
Definition: doubleScalar.H:58
static const floatScalar floatScalarVSMALL
Definition: floatScalar.H:59
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if succesful.
Definition: doubleScalar.H:63
static const doubleScalar doubleScalarVSMALL
Definition: doubleScalar.H:59
static const floatScalar floatScalarGREAT
Definition: floatScalar.H:54
static const doubleScalar doubleScalarROOTVGREAT
Definition: doubleScalar.H:56
static const floatScalar floatScalarROOTVSMALL
Definition: floatScalar.H:60
static const doubleScalar doubleScalarGREAT
Definition: doubleScalar.H:54
static const floatScalar floatScalarSMALL
Definition: floatScalar.H:57
double doubleScalar
Double precision floating point scalar type.
Definition: doubleScalar.H:49
static const floatScalar floatScalarROOTVGREAT
Definition: floatScalar.H:56