DimensionedScalarField.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 InClass
25  Foam::DimensionedScalarField
26 
27 Description
28  Scalar specific part of the implementation of DimensionedField.
29 
30 SourceFiles
31  DimensionedScalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef DimensionedScalarField_H
36 #define DimensionedScalarField_H
37 
38 #include "DimensionedField.H"
39 #include "scalar.H"
40 
41 #define TEMPLATE template<class GeoMesh>
42 #include "DimensionedFieldFunctionsM.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 template<class GeoMesh>
52 tmp<DimensionedField<scalar, GeoMesh>> stabilise
53 (
54  const DimensionedField<scalar, GeoMesh>&,
55  const dimensioned<scalar>&
56 );
57 
58 template<class GeoMesh>
59 tmp<DimensionedField<scalar, GeoMesh>> stabilise
60 (
61  const tmp<DimensionedField<scalar, GeoMesh>>&,
62  const dimensioned<scalar>&
63 );
64 
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, '+', add)
69 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, '-', subtract)
70 
71 BINARY_OPERATOR(scalar, scalar, scalar, *, '*', multiply)
72 BINARY_OPERATOR(scalar, scalar, scalar, /, '|', divide)
73 
74 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, '|', divide)
75 
76 BINARY_FUNCTION(scalar, scalar, scalar, pow)
77 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
78 
79 BINARY_FUNCTION(scalar, scalar, scalar, atan2)
80 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 UNARY_FUNCTION(scalar, scalar, pow3, pow3)
86 UNARY_FUNCTION(scalar, scalar, pow4, pow4)
87 UNARY_FUNCTION(scalar, scalar, pow5, pow5)
88 UNARY_FUNCTION(scalar, scalar, pow6, pow6)
89 UNARY_FUNCTION(scalar, scalar, pow025, pow025)
90 UNARY_FUNCTION(scalar, scalar, sqrt, sqrt)
91 UNARY_FUNCTION(scalar, scalar, cbrt, cbrt)
92 UNARY_FUNCTION(scalar, scalar, sign, sign)
93 UNARY_FUNCTION(scalar, scalar, pos, pos)
94 UNARY_FUNCTION(scalar, scalar, pos0, pos0)
95 UNARY_FUNCTION(scalar, scalar, neg, neg)
96 UNARY_FUNCTION(scalar, scalar, neg0, neg0)
97 UNARY_FUNCTION(scalar, scalar, posPart, posPart)
98 UNARY_FUNCTION(scalar, scalar, negPart, negPart)
99 
100 UNARY_FUNCTION(scalar, scalar, exp, trans)
101 UNARY_FUNCTION(scalar, scalar, log, trans)
102 UNARY_FUNCTION(scalar, scalar, log10, trans)
103 UNARY_FUNCTION(scalar, scalar, sin, trans)
104 UNARY_FUNCTION(scalar, scalar, cos, trans)
105 UNARY_FUNCTION(scalar, scalar, tan, trans)
106 UNARY_FUNCTION(scalar, scalar, asin, trans)
107 UNARY_FUNCTION(scalar, scalar, acos, trans)
108 UNARY_FUNCTION(scalar, scalar, atan, trans)
109 UNARY_FUNCTION(scalar, scalar, sinh, trans)
110 UNARY_FUNCTION(scalar, scalar, cosh, trans)
111 UNARY_FUNCTION(scalar, scalar, tanh, trans)
112 UNARY_FUNCTION(scalar, scalar, asinh, trans)
113 UNARY_FUNCTION(scalar, scalar, acosh, trans)
114 UNARY_FUNCTION(scalar, scalar, atanh, trans)
115 UNARY_FUNCTION(scalar, scalar, erf, trans)
116 UNARY_FUNCTION(scalar, scalar, erfc, trans)
117 UNARY_FUNCTION(scalar, scalar, lgamma, trans)
118 UNARY_FUNCTION(scalar, scalar, j0, trans)
119 UNARY_FUNCTION(scalar, scalar, j1, trans)
120 UNARY_FUNCTION(scalar, scalar, y0, trans)
121 UNARY_FUNCTION(scalar, scalar, y1, trans)
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #define BesselFunc(func) \
127  \
128 template<class GeoMesh> \
129 tmp<DimensionedField<scalar, GeoMesh>> func \
130 ( \
131  const int n, \
132  const DimensionedField<scalar, GeoMesh>& \
133 ); \
134  \
135 template<class GeoMesh> \
136 tmp<DimensionedField<scalar, GeoMesh>> func \
137 ( \
138  const int n, \
139  const tmp<DimensionedField<scalar, GeoMesh>>& \
140 );
141 
142 BesselFunc(jn)
143 BesselFunc(yn)
144 
145 #undef BesselFunc
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #include "undefFieldFunctionsM.H"
155 
156 #ifdef NoRepository
157  #include "DimensionedScalarField.C"
158 #endif
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #endif
163 
164 // ************************************************************************* //
Foam::divide
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:179
Foam::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:285
Foam::trans
dimensionSet trans(const dimensionSet &)
Definition: dimensionSet.C:450
Foam::acos
dimensionedScalar acos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:281
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:391
Foam::multiply
void multiply(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:275
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:30
Foam::yn
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:319
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:499
Foam::sqrt
dimensionedScalar sqrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:142
Foam::pow025
dimensionedScalar pow025(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:131
Foam::y0
dimensionedScalar y0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:294
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:384
Foam::subtract
void subtract(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:901
Foam::posPart
dimensionedScalar posPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:234
Foam::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:212
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:280
Foam::pow5
dimensionedScalar pow5(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:109
Foam::j1
dimensionedScalar j1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:293
BINARY_FUNCTION
#define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:132
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:190
Foam::acosh
dimensionedScalar acosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:287
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:278
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:274
Foam::asinh
dimensionedScalar asinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:286
Foam::jn
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:318
Foam::cbrt
dimensionedScalar cbrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:153
Foam::neg0
dimensionedScalar neg0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:223
Foam::atanh
dimensionedScalar atanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:288
Foam::y1
dimensionedScalar y1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:295
Foam::pos0
dimensionedScalar pos0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:201
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:277
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:900
Foam::erf
dimensionedScalar erf(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:289
Foam::atan2
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:325
Foam::lgamma
dimensionedScalar lgamma(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:291
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:73
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:87
Foam::stabilise
tmp< DimensionedField< scalar, GeoMesh > > stabilise(const DimensionedField< scalar, GeoMesh > &dsf, const dimensioned< scalar > &ds)
Definition: DimensionedScalarField.C:40
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:290
Foam::sinh
dimensionedScalar sinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:283
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:282
Foam::pow4
dimensionedScalar pow4(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:98
Foam::pow6
dimensionedScalar pow6(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:120
Foam::cosh
dimensionedScalar cosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:284
Foam::tan
dimensionedScalar tan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:279
Foam::j0
dimensionedScalar j0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:292
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:642
BesselFunc
#define BesselFunc(func)
Definition: DimensionedScalarField.H:126
Foam::log10
dimensionedScalar log10(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:276
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:213
Foam::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:245