scalarField.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-2023 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::scalarField
26 
27 Description
28  Specialisation of Field<T> for scalar.
29 
30 SourceFiles
31  scalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef scalarField_H
36 #define scalarField_H
37 
38 #include "Field.H"
39 #include "scalar.H"
40 
41 #define TEMPLATE
42 #include "FieldFunctionsM.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 typedef Field<scalar> scalarField;
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 template<>
54 tmp<scalarField> scalarField::component(const direction) const;
55 
56 void component
57 (
58  scalarField& sf,
59  const UList<scalar>& f,
60  const direction
61 );
62 
63 
64 template<>
65 void scalarField::replace(const direction, const UList<scalar>& sf);
66 
67 template<>
68 void scalarField::replace(const direction, const scalar& s);
69 
70 
71 void stabilise(scalarField& Res, const UList<scalar>& sf, const scalar s);
72 
73 tmp<scalarField> stabilise(const UList<scalar>&, const scalar s);
74 
75 tmp<scalarField> stabilise(const tmp<scalarField>&, const scalar s);
76 
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 template<>
81 scalar sumProd(const UList<scalar>& f1, const UList<scalar>& f2);
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, add)
87 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, subtract)
88 
89 BINARY_OPERATOR(scalar, scalar, scalar, *, multiply)
90 BINARY_OPERATOR(scalar, scalar, scalar, /, divide)
91 
92 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, divide)
93 
94 BINARY_FUNCTION(scalar, scalar, scalar, pow)
95 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
96 BINARY_FUNCTION(scalar, scalar, label, integerPow)
97 BINARY_TYPE_FUNCTION_FS(scalar, scalar, label, integerPow)
98 BINARY_FUNCTION(scalar, scalar, label, integerRoot)
99 BINARY_TYPE_FUNCTION_FS(scalar, scalar, label, integerRoot)
100 
101 BINARY_FUNCTION(scalar, scalar, scalar, atan2)
102 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 UNARY_FUNCTION(scalar, scalar, pow3)
108 UNARY_FUNCTION(scalar, scalar, pow4)
109 UNARY_FUNCTION(scalar, scalar, pow5)
110 UNARY_FUNCTION(scalar, scalar, pow6)
111 UNARY_FUNCTION(scalar, scalar, pow025)
112 UNARY_FUNCTION(scalar, scalar, sqrt)
113 UNARY_FUNCTION(scalar, scalar, cbrt)
114 UNARY_FUNCTION(scalar, scalar, sign)
115 UNARY_FUNCTION(scalar, scalar, pos)
116 UNARY_FUNCTION(scalar, scalar, pos0)
117 UNARY_FUNCTION(scalar, scalar, neg)
118 UNARY_FUNCTION(scalar, scalar, neg0)
119 UNARY_FUNCTION(scalar, scalar, posPart)
120 UNARY_FUNCTION(scalar, scalar, negPart)
121 UNARY_FUNCTION(scalar, scalar, exp)
122 UNARY_FUNCTION(scalar, scalar, log)
123 UNARY_FUNCTION(scalar, scalar, log10)
124 UNARY_FUNCTION(scalar, scalar, sin)
125 UNARY_FUNCTION(scalar, scalar, cos)
126 UNARY_FUNCTION(scalar, scalar, tan)
127 UNARY_FUNCTION(scalar, scalar, asin)
128 UNARY_FUNCTION(scalar, scalar, acos)
129 UNARY_FUNCTION(scalar, scalar, atan)
130 UNARY_FUNCTION(scalar, scalar, sinh)
131 UNARY_FUNCTION(scalar, scalar, cosh)
132 UNARY_FUNCTION(scalar, scalar, tanh)
133 UNARY_FUNCTION(scalar, scalar, asinh)
134 UNARY_FUNCTION(scalar, scalar, acosh)
135 UNARY_FUNCTION(scalar, scalar, atanh)
136 UNARY_FUNCTION(scalar, scalar, erf)
137 UNARY_FUNCTION(scalar, scalar, erfc)
138 UNARY_FUNCTION(scalar, scalar, lgamma)
139 UNARY_FUNCTION(scalar, scalar, j0)
140 UNARY_FUNCTION(scalar, scalar, j1)
141 UNARY_FUNCTION(scalar, scalar, y0)
142 UNARY_FUNCTION(scalar, scalar, y1)
143 
144 UNARY_FUNCTION(scalar, scalar, degToRad)
145 UNARY_FUNCTION(scalar, scalar, radToDeg)
146 UNARY_FUNCTION(scalar, scalar, atmToPa)
147 UNARY_FUNCTION(scalar, scalar, paToAtm)
148 
149 #define BesselFunc(func) \
150 void func(scalarField& Res, const int n, const UList<scalar>& sf); \
151 tmp<scalarField> func(const int n, const UList<scalar>&); \
152 tmp<scalarField> func(const int n, const tmp<scalarField>&);
153 
154 BesselFunc(jn)
155 BesselFunc(yn)
156 
157 #undef BesselFunc
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #include "undefFieldFunctionsM.H"
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 #endif
171 
172 // ************************************************************************* //
BINARY_FUNCTION
#define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:132
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:642
BINARY_TYPE_FUNCTION_FS
#define BINARY_TYPE_FUNCTION_FS(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:312
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:391
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:499
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:384
FieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
Foam::Field< scalar >::replace
void replace(const direction, const UList< cmptType > &)
Replace a component field of the field.
Definition: Field.C:467
Foam::Field< scalar >::component
tmp< Field< cmptType > > component(const direction) const
Return a component field of the field.
Definition: Field.C:455
sf
volScalarField sf(fieldObject, mesh)
s
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.name(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214
Foam::pow6
dimensionedScalar pow6(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:120
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:190
Foam::pow5
dimensionedScalar pow5(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:109
Foam::integerRoot
scalar integerRoot(const scalar x, const label e)
Compute the power of the number x to the reciprocal integer 1/e.
Definition: scalarI.H:55
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:290
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:280
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:274
Foam::tan
dimensionedScalar tan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:279
Foam::stabilise
tmp< DimensionedField< scalar, GeoMesh > > stabilise(const DimensionedField< scalar, GeoMesh > &dsf, const dimensioned< scalar > &ds)
Definition: DimensionedScalarField.C:40
Foam::pos0
dimensionedScalar pos0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:201
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:179
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::lgamma
dimensionedScalar lgamma(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:291
Foam::j1
dimensionedScalar j1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:293
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:87
Foam::y0
dimensionedScalar y0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:294
Foam::component
void component(FieldField< Field, typename FieldField< Field, Type >::cmptType > &sf, const FieldField< Field, Type > &f, const direction d)
Definition: FieldFieldFunctions.C:41
Foam::cosh
dimensionedScalar cosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:284
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::radToDeg
scalar radToDeg(const scalar rad)
Conversion from radians to degrees.
Definition: unitConversion.H:51
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:277
Foam::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:285
Foam::erf
dimensionedScalar erf(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:289
Foam::sinh
dimensionedScalar sinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:283
Foam::integerPow
scalar integerPow(const scalar x, const label e)
Compute the power of the number x to the integer e.
Definition: scalarI.H:30
Foam::log10
dimensionedScalar log10(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:276
Foam::UNARY_FUNCTION
UNARY_FUNCTION(Type, Type, cmptMag, cmptMag)
Foam::yn
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:319
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:48
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:275
Foam::divide
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:73
Foam::atan2
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:325
Foam::y1
dimensionedScalar y1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:295
Foam::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:245
Foam::acosh
dimensionedScalar acosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:287
Foam::sqrt
dimensionedScalar sqrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:142
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::sumProd
scalar sumProd(const UList< Type > &f1, const UList< Type > &f2)
Definition: FieldFunctions.C:416
Foam::pow4
dimensionedScalar pow4(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:98
Foam::jn
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:318
Foam::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:212
Foam::atanh
dimensionedScalar atanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:288
Foam::atmToPa
scalar atmToPa(const scalar atm)
Conversion from atm to Pa.
Definition: unitConversion.H:57
Foam::neg0
dimensionedScalar neg0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:223
Foam::cbrt
dimensionedScalar cbrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:153
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:282
Foam::paToAtm
scalar paToAtm(const scalar pa)
Conversion from atm to Pa.
Definition: unitConversion.H:63
Foam::multiply
void multiply(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:278
Foam::posPart
dimensionedScalar posPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:234
Foam::direction
uint8_t direction
Definition: direction.H:45
Foam::acos
dimensionedScalar acos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:281
Foam::j0
dimensionedScalar j0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:292
Foam::degToRad
scalar degToRad(const scalar deg)
Conversion from degrees to radians.
Definition: unitConversion.H:45
Foam::pow025
dimensionedScalar pow025(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:131
Foam::asinh
dimensionedScalar asinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:286
f
labelList f(nPoints)
BesselFunc
#define BesselFunc(func)
Definition: scalarField.H:149