doubleScalar.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-2018 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::doubleScalar
26 
27 Description
28  Double precision floating point scalar type.
29 
30 SourceFiles
31  doubleScalar.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef doubleScalar_H
36 #define doubleScalar_H
37 
38 #include "doubleFloat.H"
39 #include "direction.H"
40 #include "word.H"
41 
42 #include <limits>
43 using std::numeric_limits;
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 typedef double doubleScalar;
53 
54 // Largest and smallest scalar values allowed in certain parts of the code.
55 static const doubleScalar doubleScalarVGreat = numeric_limits<double>::max()/10;
56 static const doubleScalar doubleScalarVSmall = numeric_limits<double>::min();
57 
58 static const doubleScalar doubleScalarSmall = numeric_limits<double>::epsilon();
59 static const doubleScalar doubleScalarGreat = 1.0/doubleScalarSmall;
60 
61 static const doubleScalar doubleScalarRootVGreat = ::sqrt(doubleScalarVGreat);
62 static const doubleScalar doubleScalarRootVSmall = ::sqrt(doubleScalarVSmall);
63 
64 static const doubleScalar doubleScalarRootGreat = ::sqrt(doubleScalarGreat);
65 static const doubleScalar doubleScalarRootSmall = ::sqrt(doubleScalarSmall);
66 
67 //- Read whole of buf as a scalar. Return true if successful.
68 inline bool readScalar(const char* buf, doubleScalar& s)
69 {
70  char* endPtr;
71  s = strtod(buf, &endPtr);
72 
73  return (*endPtr == '\0');
74 }
75 
76 #define Scalar doubleScalar
77 #define ScalarVGreat doubleScalarVGreat
78 #define ScalarVSmall doubleScalarVSmall
79 #define ScalarRootVGreat doubleScalarRootVGreat
80 #define ScalarRootVSmall doubleScalarRootVSmall
81 #define readScalar readDoubleScalar
82 
83 inline Scalar mag(const Scalar s)
84 {
85  return ::fabs(s);
86 }
87 
88 
89 #define MAXMINPOW(retType, type1, type2) \
90  \
91 MAXMIN(retType, type1, type2) \
92  \
93 inline double pow(const type1 s, const type2 e) \
94 { \
95  return ::pow(Scalar(s), Scalar(e)); \
96 }
97 
99 MAXMINPOW(Scalar, Scalar, int)
100 MAXMINPOW(Scalar, int, Scalar)
101 MAXMINPOW(Scalar, Scalar, long)
102 MAXMINPOW(Scalar, long, Scalar)
103 MAXMINPOW(Scalar, Scalar, float)
104 MAXMINPOW(Scalar, float, Scalar)
105 
106 #undef MAXMINPOW
107 
108 #define transFunc(func) \
109 inline Scalar func(const Scalar s) \
110 { \
111  return ::func(s); \
112 }
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #include "Scalar.H"
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 namespace Foam
125 {
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 inline Scalar hypot(const Scalar x, const Scalar y)
130 {
131  return ::hypot(x, y);
132 }
133 
134 inline Scalar atan2(const Scalar y, const Scalar x)
135 {
136  return ::atan2(y, x);
137 }
138 
139 inline Scalar jn(const int n, const Scalar s)
140 {
141  return ::jn(n, s);
142 }
143 
144 inline Scalar yn(const int n, const Scalar s)
145 {
146  return ::yn(n, s);
147 }
148 
149 #undef Scalar
150 #undef ScalarVGreat
151 #undef ScalarVSmall
152 #undef ScalarRootVGreat
153 #undef ScalarRootVSmall
154 #undef readScalar
155 #undef transFunc
156 
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 } // End namespace Foam
161 
162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
163 
164 #endif
165 
166 // ************************************************************************* //
#define Scalar
Definition: doubleScalar.H:76
doubleScalar jn(const int n, const doubleScalar s)
Definition: doubleScalar.H:139
#define MAXMINPOW(retType, type1, type2)
Definition: doubleScalar.H:89
dimensioned< Type > max(const dimensioned< Type > &, const dimensioned< Type > &)
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
dimensionedScalar sqrt(const dimensionedScalar &ds)
doubleScalar yn(const int n, const doubleScalar s)
Definition: doubleScalar.H:144
scalar y
gmvFile<< "tracers "<< particles.size()<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().x()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().y()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
double doubleScalar
Double precision floating point scalar type.
Definition: doubleScalar.H:52
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if successful.
Definition: doubleScalar.H:68
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)
doubleScalar atan2(const doubleScalar y, const doubleScalar x)
Definition: doubleScalar.H:134
static const doubleScalar doubleScalarSmall
Definition: doubleScalar.H:58
doubleScalar hypot(const doubleScalar x, const doubleScalar y)
Definition: doubleScalar.H:129
Direction is an 8-bit unsigned integer type used to represent the Cartesian directions etc...
scalar epsilon
dimensioned< scalar > mag(const dimensioned< Type > &)
label n
dimensionedScalar hypot(const dimensionedScalar &x, const dimensionedScalar &y)
Namespace for OpenFOAM.