scalarFieldField.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 InClass
28  Foam::scalarFieldField
29 
30 Description
31  Specialisation of FieldField<T> for scalar.
32 
33 SourceFiles
34  scalarFieldField.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef scalarFieldField_H
39 #define scalarFieldField_H
40 
41 #include "scalarField.H"
42 #include "FieldField.H"
43 
44 #define TEMPLATE template<template<class> class Field>
45 #include "FieldFieldFunctionsM.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 template<template<class> class Field>
55 void stabilise
56 (
57  FieldField<Field, scalar>& Res,
58  const FieldField<Field, scalar>& sf,
59  const scalar s
60 );
61 
62 
63 template<template<class> class Field>
64 tmp<FieldField<Field, scalar>> stabilise
65 (
66  const FieldField<Field, scalar>&,
67  const scalar s
68 );
69 
70 
71 template<template<class> class Field>
72 tmp<FieldField<Field, scalar>> stabilise
73 (
74  const tmp<FieldField<Field, scalar>>&,
75  const scalar s
76 );
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, add)
82 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, subtract)
83 
84 BINARY_OPERATOR(scalar, scalar, scalar, *, multiply)
85 BINARY_OPERATOR(scalar, scalar, scalar, /, divide)
86 
87 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, divide)
88 
89 BINARY_FUNCTION(scalar, scalar, scalar, pow)
90 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
91 
92 BINARY_FUNCTION(scalar, scalar, scalar, atan2)
93 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
94 
95 BINARY_FUNCTION(scalar, scalar, scalar, hypot)
96 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, hypot)
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 UNARY_FUNCTION(scalar, scalar, pow3)
102 UNARY_FUNCTION(scalar, scalar, pow4)
103 UNARY_FUNCTION(scalar, scalar, pow5)
104 UNARY_FUNCTION(scalar, scalar, pow6)
105 UNARY_FUNCTION(scalar, scalar, pow025)
106 UNARY_FUNCTION(scalar, scalar, sqrt)
107 UNARY_FUNCTION(scalar, scalar, cbrt)
108 UNARY_FUNCTION(scalar, scalar, sign)
109 UNARY_FUNCTION(scalar, scalar, pos)
110 UNARY_FUNCTION(scalar, scalar, pos0)
111 UNARY_FUNCTION(scalar, scalar, neg)
112 UNARY_FUNCTION(scalar, scalar, neg0)
113 UNARY_FUNCTION(scalar, scalar, posPart)
114 UNARY_FUNCTION(scalar, scalar, negPart)
115 UNARY_FUNCTION(scalar, scalar, exp)
116 UNARY_FUNCTION(scalar, scalar, log)
117 UNARY_FUNCTION(scalar, scalar, log10)
118 UNARY_FUNCTION(scalar, scalar, sin)
119 UNARY_FUNCTION(scalar, scalar, cos)
120 UNARY_FUNCTION(scalar, scalar, tan)
121 UNARY_FUNCTION(scalar, scalar, asin)
122 UNARY_FUNCTION(scalar, scalar, acos)
123 UNARY_FUNCTION(scalar, scalar, atan)
124 UNARY_FUNCTION(scalar, scalar, sinh)
125 UNARY_FUNCTION(scalar, scalar, cosh)
126 UNARY_FUNCTION(scalar, scalar, tanh)
127 UNARY_FUNCTION(scalar, scalar, asinh)
128 UNARY_FUNCTION(scalar, scalar, acosh)
129 UNARY_FUNCTION(scalar, scalar, atanh)
130 UNARY_FUNCTION(scalar, scalar, erf)
131 UNARY_FUNCTION(scalar, scalar, erfc)
132 UNARY_FUNCTION(scalar, scalar, lgamma)
133 UNARY_FUNCTION(scalar, scalar, j0)
134 UNARY_FUNCTION(scalar, scalar, j1)
135 UNARY_FUNCTION(scalar, scalar, y0)
136 UNARY_FUNCTION(scalar, scalar, y1)
137 
138 
139 #define BesselFunc(func) \
140 void func \
141 ( \
142  FieldField<Field, scalar>& Res, \
143  const int n, \
144  const FieldField<Field, scalar>& sf \
145 ); \
146 tmp<scalarField> func(const int n, const FieldField<Field, scalar>&); \
147 tmp<scalarField> func(const int n, const tmp<FieldField<Field, scalar>>&);
148 
149 BesselFunc(jn)
150 BesselFunc(yn)
151 
152 #undef BesselFunc
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #include "undefFieldFunctionsM.H"
162 
163 #ifdef NoRepository
164  #include "scalarFieldField.C"
165 #endif
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 #endif
170 
171 // ************************************************************************* //
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::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::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
FieldField.H
scalarField.H
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::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::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:265
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:82
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
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:270
BesselFunc
#define BesselFunc(func)
Definition: scalarFieldField.H:135
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
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
FieldFieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:398
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::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:225
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
scalarFieldField.C
Specialisation of FieldField<T> for scalar.
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:262
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