scalarFieldField.C
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-------------------------------------------------------------------------------
11License
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
27Description
28 Specialisation of FieldField<T> for scalar.
29
30\*---------------------------------------------------------------------------*/
31
32#include "scalarFieldField.H"
33
34#define TEMPLATE template<template<class> class Field>
35#include "FieldFieldFunctionsM.C"
36
37// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38
39namespace Foam
40{
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44template<template<class> class Field>
45void stabilise
46(
47 FieldField<Field, scalar>& f,
48 const FieldField<Field, scalar>& f1,
49 const scalar s
50)
51{
52 forAll(f, i)
53 {
54 stabilise(f[i], f1[i], s);
55 }
56}
57
58template<template<class> class Field>
59tmp<FieldField<Field, scalar>> stabilise
60(
61 const FieldField<Field, scalar>& f1,
62 const scalar s
63)
64{
65 tmp<FieldField<Field, scalar>> tf
66 (
67 FieldField<Field, scalar>::NewCalculatedType(f1)
68 );
69 stabilise(tf(), f1, s);
70 return tf;
71}
72
73template<template<class> class Field>
74tmp<FieldField<Field, scalar>> stabilise
75(
76 const tmp<FieldField<Field, scalar>>& tf1,
77 const scalar s
78)
79{
80 tmp<FieldField<Field, scalar>> tf(tf1.ptr());
81 stabilise(tf(), tf(), s);
82 return tf;
83}
84
85
86// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, add)
89BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, subtract)
90
91BINARY_OPERATOR(scalar, scalar, scalar, *, multiply)
92BINARY_OPERATOR(scalar, scalar, scalar, /, divide)
93
94BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, divide)
95
96BINARY_FUNCTION(scalar, scalar, scalar, pow)
97BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
98
99BINARY_FUNCTION(scalar, scalar, scalar, atan2)
100BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
101
102BINARY_FUNCTION(scalar, scalar, scalar, hypot)
103BINARY_TYPE_FUNCTION(scalar, scalar, scalar, hypot)
104
105
106// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108UNARY_FUNCTION(scalar, scalar, pow3)
109UNARY_FUNCTION(scalar, scalar, pow4)
110UNARY_FUNCTION(scalar, scalar, pow5)
111UNARY_FUNCTION(scalar, scalar, pow6)
112UNARY_FUNCTION(scalar, scalar, pow025)
113UNARY_FUNCTION(scalar, scalar, sqrt)
114UNARY_FUNCTION(scalar, scalar, cbrt)
115UNARY_FUNCTION(scalar, scalar, sign)
116UNARY_FUNCTION(scalar, scalar, pos)
117UNARY_FUNCTION(scalar, scalar, pos0)
118UNARY_FUNCTION(scalar, scalar, neg)
119UNARY_FUNCTION(scalar, scalar, neg0)
120UNARY_FUNCTION(scalar, scalar, posPart)
121UNARY_FUNCTION(scalar, scalar, negPart)
122UNARY_FUNCTION(scalar, scalar, exp)
123UNARY_FUNCTION(scalar, scalar, log)
124UNARY_FUNCTION(scalar, scalar, log10)
125UNARY_FUNCTION(scalar, scalar, sin)
126UNARY_FUNCTION(scalar, scalar, cos)
127UNARY_FUNCTION(scalar, scalar, tan)
128UNARY_FUNCTION(scalar, scalar, asin)
129UNARY_FUNCTION(scalar, scalar, acos)
130UNARY_FUNCTION(scalar, scalar, atan)
131UNARY_FUNCTION(scalar, scalar, sinh)
132UNARY_FUNCTION(scalar, scalar, cosh)
133UNARY_FUNCTION(scalar, scalar, tanh)
134UNARY_FUNCTION(scalar, scalar, asinh)
135UNARY_FUNCTION(scalar, scalar, acosh)
136UNARY_FUNCTION(scalar, scalar, atanh)
137UNARY_FUNCTION(scalar, scalar, erf)
138UNARY_FUNCTION(scalar, scalar, erfc)
139UNARY_FUNCTION(scalar, scalar, lgamma)
140UNARY_FUNCTION(scalar, scalar, j0)
141UNARY_FUNCTION(scalar, scalar, j1)
142UNARY_FUNCTION(scalar, scalar, y0)
143UNARY_FUNCTION(scalar, scalar, y1)
144
145
146#define BesselFunc(func) \
147 \
148template<template<class> class Field> \
149void func \
150( \
151 FieldField<Field, scalar>& res, \
152 const int n, \
153 const FieldField<Field, scalar>& sf \
154) \
155{ \
156 forAll(res, i) \
157 { \
158 func(res[i], n, sf[i]); \
159 } \
160} \
161 \
162template<template<class> class Field> \
163tmp<FieldField<Field, scalar>> func \
164( \
165 const int n, \
166 const FieldField<Field, scalar>& sf \
167) \
168{ \
169 tmp<FieldField<Field, scalar>> tRes \
170 ( \
171 FieldField<Field, scalar>::NewCalculatedType(sf) \
172 ); \
173 func(tRes(), n, sf); \
174 return tRes; \
175} \
176 \
177template<template<class> class Field> \
178tmp<FieldField<Field, scalar>> func \
179( \
180 const int n, \
181 const tmp<FieldField<Field, scalar>>& tsf \
182) \
183{ \
184 tmp<FieldField<Field, scalar>> tRes(New(tsf)); \
185 func(tRes(), n, tsf()); \
186 tsf.clear(); \
187 return tRes; \
188}
189
190BesselFunc(jn)
191BesselFunc(yn)
192
193#undef BesselFunc
194
195
196// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
197
198} // End namespace Foam
199
200// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
201
202#include "undefFieldFunctionsM.H"
203
204// ************************************************************************* //
BINARY_FUNCTION
#define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:141
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:674
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:412
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:522
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:33
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:405
BesselFunc
#define BesselFunc(func)
Definition: DimensionedScalarField.C:732
Foam::FieldField
A field of fields is a PtrList of fields with reference counting.
Definition: FieldField.H:80
Foam::tmp
A class for managing temporary objects.
Definition: tmp.H:65
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))
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:34
Foam::pow6
dimensionedScalar pow6(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:122
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:177
Foam::pow5
dimensionedScalar pow5(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:111
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:277
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:267
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:261
Foam::tan
dimensionedScalar tan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:266
Foam::pos0
dimensionedScalar pos0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:188
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:166
Foam::lgamma
dimensionedScalar lgamma(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:278
Foam::j1
dimensionedScalar j1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:280
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:89
Foam::y0
dimensionedScalar y0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:281
Foam::cosh
dimensionedScalar cosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:271
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:940
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:264
Foam::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:272
Foam::erf
dimensionedScalar erf(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:276
Foam::sinh
dimensionedScalar sinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:270
Foam::log10
dimensionedScalar log10(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:263
Foam::yn
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:306
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:262
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:75
Foam::atan2
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:312
Foam::y1
dimensionedScalar y1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:282
Foam::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:232
Foam::acosh
dimensionedScalar acosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:274
Foam::sqrt
dimensionedScalar sqrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:144
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:939
Foam::hypot
dimensionedScalar hypot(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:327
Foam::pow4
dimensionedScalar pow4(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:100
Foam::jn
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:305
Foam::multiply
void multiply(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:199
Foam::atanh
dimensionedScalar atanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:275
Foam::stabilise
dimensionedScalar stabilise(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:342
Foam::neg0
dimensionedScalar neg0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:210
Foam::cbrt
dimensionedScalar cbrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:155
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:269
Foam::divide
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:265
Foam::posPart
dimensionedScalar posPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:221
Foam::acos
dimensionedScalar acos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:268
Foam::j0
dimensionedScalar j0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:279
Foam::pow025
dimensionedScalar pow025(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:133
Foam::asinh
dimensionedScalar asinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:273
f
labelList f(nPoints)
scalarFieldField.H
Specialisation of FieldField<T> for scalar.
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:333