scalarField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Typedef
28  Foam::scalarField
29 
30 Description
31  Specialisation of Field<T> for scalar.
32 
33 SourceFiles
34  scalarField.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef scalarField_H
39 #define scalarField_H
40 
41 #include "Field.H"
42 #include "scalar.H"
43 
44 #define TEMPLATE
45 #include "FieldFunctionsM.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 typedef Field<scalar> scalarField;
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 template<>
57 tmp<scalarField> scalarField::component(const direction) const;
58 
59 void component
60 (
61  scalarField& sf,
62  const UList<scalar>& f,
63  const direction
64 );
65 
66 template<>
67 void scalarField::replace(const direction, const UList<scalar>& sf);
68 
69 template<>
70 void scalarField::replace(const direction, const scalar& s);
71 
72 
73 void stabilise(scalarField& Res, const UList<scalar>& sf, const scalar s);
74 tmp<scalarField> stabilise(const UList<scalar>&, const scalar s);
75 tmp<scalarField> stabilise(const tmp<scalarField>&, const scalar s);
76 
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 //- Sum product for float
81 template<>
82 float sumProd(const UList<float>& f1, const UList<float>& f2);
83 
84 //- Sum product for double
85 template<>
86 double sumProd(const UList<double>& f1, const UList<double>& f2);
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, add)
92 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, subtract)
93 
94 BINARY_OPERATOR(scalar, scalar, scalar, *, multiply)
95 BINARY_OPERATOR(scalar, scalar, scalar, /, divide)
96 
97 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, divide)
98 
99 BINARY_FUNCTION(scalar, scalar, scalar, pow)
100 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
101 
102 BINARY_FUNCTION(scalar, scalar, scalar, atan2)
103 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
104 
105 BINARY_FUNCTION(scalar, scalar, scalar, hypot)
106 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, hypot)
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 UNARY_FUNCTION(scalar, scalar, pow3)
112 UNARY_FUNCTION(scalar, scalar, pow4)
113 UNARY_FUNCTION(scalar, scalar, pow5)
114 UNARY_FUNCTION(scalar, scalar, pow6)
115 UNARY_FUNCTION(scalar, scalar, pow025)
116 UNARY_FUNCTION(scalar, scalar, sqrt)
117 UNARY_FUNCTION(scalar, scalar, cbrt)
118 UNARY_FUNCTION(scalar, scalar, sign)
119 UNARY_FUNCTION(scalar, scalar, pos)
120 UNARY_FUNCTION(scalar, scalar, pos0)
121 UNARY_FUNCTION(scalar, scalar, neg)
122 UNARY_FUNCTION(scalar, scalar, neg0)
123 UNARY_FUNCTION(scalar, scalar, posPart)
124 UNARY_FUNCTION(scalar, scalar, negPart)
125 UNARY_FUNCTION(scalar, scalar, exp)
126 UNARY_FUNCTION(scalar, scalar, log)
127 UNARY_FUNCTION(scalar, scalar, log10)
128 UNARY_FUNCTION(scalar, scalar, sin)
129 UNARY_FUNCTION(scalar, scalar, cos)
130 UNARY_FUNCTION(scalar, scalar, tan)
131 UNARY_FUNCTION(scalar, scalar, asin)
132 UNARY_FUNCTION(scalar, scalar, acos)
133 UNARY_FUNCTION(scalar, scalar, atan)
134 UNARY_FUNCTION(scalar, scalar, sinh)
135 UNARY_FUNCTION(scalar, scalar, cosh)
136 UNARY_FUNCTION(scalar, scalar, tanh)
137 UNARY_FUNCTION(scalar, scalar, asinh)
138 UNARY_FUNCTION(scalar, scalar, acosh)
139 UNARY_FUNCTION(scalar, scalar, atanh)
140 UNARY_FUNCTION(scalar, scalar, erf)
141 UNARY_FUNCTION(scalar, scalar, erfc)
142 UNARY_FUNCTION(scalar, scalar, lgamma)
143 UNARY_FUNCTION(scalar, scalar, j0)
144 UNARY_FUNCTION(scalar, scalar, j1)
145 UNARY_FUNCTION(scalar, scalar, y0)
146 UNARY_FUNCTION(scalar, scalar, y1)
147 
148 UNARY_FUNCTION(scalar, scalar, degToRad)
149 UNARY_FUNCTION(scalar, scalar, radToDeg)
150 UNARY_FUNCTION(scalar, scalar, atmToPa)
151 UNARY_FUNCTION(scalar, scalar, barToPa)
152 UNARY_FUNCTION(scalar, scalar, paToAtm)
153 UNARY_FUNCTION(scalar, scalar, paToBar)
154 
155 #define BesselFunc(func) \
156 void func(scalarField& Res, const int n, const UList<scalar>& sf); \
157 tmp<scalarField> func(const int n, const UList<scalar>&); \
158 tmp<scalarField> func(const int n, const tmp<scalarField>&);
159 
160 BesselFunc(jn)
161 BesselFunc(yn)
162 
163 #undef BesselFunc
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #include "undefFieldFunctionsM.H"
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 #endif
177 
178 // ************************************************************************* //
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:515
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:405
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:46
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:933
Foam::component
void component(FieldField< Field, typename FieldField< Field, Type >::cmptType > &sf, const FieldField< Field, Type > &f, const direction d)
Definition: FieldFieldFunctions.C:37
Foam::tan
dimensionedScalar tan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:259
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:26
s
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.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))
Definition: gmvOutputSpray.H:25
Foam::cosh
dimensionedScalar cosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:264
Foam::y1
dimensionedScalar y1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:275
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:257
Foam::jn
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:298
Foam::posPart
dimensionedScalar posPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:214
Foam::atan2
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:305
Foam::neg0
dimensionedScalar neg0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:203
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:667
undefFieldFunctionsM.H
Foam::pos0
dimensionedScalar pos0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:181
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:254
BINARY_FUNCTION
#define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:134
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:159
Foam::erf
dimensionedScalar erf(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:269
Foam::sumProd
complex sumProd(const UList< complex > &f1, const UList< complex > &f2)
Definition: complexField.C:184
Foam::divide
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::pow025
dimensionedScalar pow025(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:126
Foam::hypot
dimensionedScalar hypot(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:320
Foam::atanh
dimensionedScalar atanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:268
Foam::lgamma
dimensionedScalar lgamma(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:271
Foam::pow4
dimensionedScalar pow4(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:93
Foam::pow6
dimensionedScalar pow6(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:115
Foam::atmToPa
constexpr scalar atmToPa(const scalar atm) noexcept
Definition: unitConversion.H:110
Foam::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:265
FieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:82
Foam::paToAtm
constexpr scalar paToAtm(const scalar pa) noexcept
Definition: unitConversion.H:127
Foam::stabilise
tmp< DimensionedField< scalar, GeoMesh > > stabilise(const DimensionedField< scalar, GeoMesh > &dsf, const dimensioned< scalar > &ds)
Definition: DimensionedScalarField.C:36
Foam::log10
dimensionedScalar log10(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:256
Foam::y0
dimensionedScalar y0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:274
Field.H
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:270
Foam::radToDeg
constexpr scalar radToDeg(const scalar rad) noexcept
Definition: unitConversion.H:52
Foam::Field::replace
void replace(const direction, const UList< cmptType > &)
Foam::asinh
dimensionedScalar asinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:266
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:68
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:932
scalar.H
Foam::pow5
dimensionedScalar pow5(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:104
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:255
Foam
Definition: atmBoundaryLayer.C:26
Foam::Field::component
tmp< Field< cmptType > > component(const direction) const
Definition: Field.C:532
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:398
Foam::degToRad
constexpr scalar degToRad(const scalar deg) noexcept
Definition: unitConversion.H:44
Foam::yn
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:299
Foam::acosh
dimensionedScalar acosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:267
Foam::barToPa
constexpr scalar barToPa(const scalar bar) noexcept
Definition: unitConversion.H:118
Foam::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:225
f
labelList f(nPoints)
Foam::paToBar
constexpr scalar paToBar(const scalar pa) noexcept
Definition: unitConversion.H:135
Foam::sqrt
dimensionedScalar sqrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:137
Foam::j0
dimensionedScalar j0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:272
Foam::acos
dimensionedScalar acos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:261
Foam::direction
uint8_t direction
Definition: direction.H:46
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:262
BesselFunc
#define BesselFunc(func)
Definition: scalarField.H:155
Foam::multiply
void multiply(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::cbrt
dimensionedScalar cbrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:148
Foam::j1
dimensionedScalar j1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:273
Foam::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:192
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:260
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:258
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:170
Foam::sinh
dimensionedScalar sinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:263

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17