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 | Copyright (C) 2011-2015 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 Description
25  Specialisation of FieldField<T> for scalar.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "scalarFieldField.H"
30 
31 #define TEMPLATE template<template<class> class Field>
32 #include "FieldFieldFunctionsM.C"
33 
34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 template<template<class> class Field>
42 void stabilise
43 (
45  const FieldField<Field, scalar>& f1,
46  const scalar s
47 )
48 {
49  forAll(f, i)
50  {
51  stabilise(f[i], f1[i], s);
52  }
53 }
54 
55 template<template<class> class Field>
57 (
58  const FieldField<Field, scalar>& f1,
59  const scalar s
60 )
61 {
63  (
65  );
66  stabilise(tf(), f1, s);
67  return tf;
68 }
69 
70 template<template<class> class Field>
72 (
73  const tmp<FieldField<Field, scalar> >& tf1,
74  const scalar s
75 )
76 {
77  tmp<FieldField<Field, scalar> > tf(tf1.ptr());
78  stabilise(tf(), tf(), s);
79  return tf;
80 }
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, add)
86 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, subtract)
87 
88 BINARY_OPERATOR(scalar, scalar, scalar, *, multiply)
89 BINARY_OPERATOR(scalar, scalar, scalar, /, divide)
90 
91 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, divide)
92 
93 BINARY_FUNCTION(scalar, scalar, scalar, pow)
94 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
95 
96 BINARY_FUNCTION(scalar, scalar, scalar, atan2)
97 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 UNARY_FUNCTION(scalar, scalar, pow3)
103 UNARY_FUNCTION(scalar, scalar, pow4)
104 UNARY_FUNCTION(scalar, scalar, pow5)
105 UNARY_FUNCTION(scalar, scalar, pow6)
106 UNARY_FUNCTION(scalar, scalar, pow025)
107 UNARY_FUNCTION(scalar, scalar, sqrt)
108 UNARY_FUNCTION(scalar, scalar, cbrt)
109 UNARY_FUNCTION(scalar, scalar, sign)
110 UNARY_FUNCTION(scalar, scalar, pos)
111 UNARY_FUNCTION(scalar, scalar, neg)
112 UNARY_FUNCTION(scalar, scalar, posPart)
113 UNARY_FUNCTION(scalar, scalar, negPart)
114 UNARY_FUNCTION(scalar, scalar, exp)
115 UNARY_FUNCTION(scalar, scalar, log)
116 UNARY_FUNCTION(scalar, scalar, log10)
117 UNARY_FUNCTION(scalar, scalar, sin)
118 UNARY_FUNCTION(scalar, scalar, cos)
119 UNARY_FUNCTION(scalar, scalar, tan)
120 UNARY_FUNCTION(scalar, scalar, asin)
121 UNARY_FUNCTION(scalar, scalar, acos)
122 UNARY_FUNCTION(scalar, scalar, atan)
123 UNARY_FUNCTION(scalar, scalar, sinh)
124 UNARY_FUNCTION(scalar, scalar, cosh)
125 UNARY_FUNCTION(scalar, scalar, tanh)
126 UNARY_FUNCTION(scalar, scalar, asinh)
127 UNARY_FUNCTION(scalar, scalar, acosh)
128 UNARY_FUNCTION(scalar, scalar, atanh)
129 UNARY_FUNCTION(scalar, scalar, erf)
130 UNARY_FUNCTION(scalar, scalar, erfc)
131 UNARY_FUNCTION(scalar, scalar, lgamma)
132 UNARY_FUNCTION(scalar, scalar, j0)
133 UNARY_FUNCTION(scalar, scalar, j1)
134 UNARY_FUNCTION(scalar, scalar, y0)
135 UNARY_FUNCTION(scalar, scalar, y1)
136 
137 
138 #define BesselFunc(func) \
139  \
140 template<template<class> class Field> \
141 void func \
142 ( \
143  FieldField<Field, scalar>& res, \
144  const int n, \
145  const FieldField<Field, scalar>& sf \
146 ) \
147 { \
148  forAll(res, i) \
149  { \
150  func(res[i], n, sf[i]); \
151  } \
152 } \
153  \
154 template<template<class> class Field> \
155 tmp<FieldField<Field, scalar> > func \
156 ( \
157  const int n, \
158  const FieldField<Field, scalar>& sf \
159 ) \
160 { \
161  tmp<FieldField<Field, scalar> > tRes \
162  ( \
163  FieldField<Field, scalar>::NewCalculatedType(sf) \
164  ); \
165  func(tRes(), n, sf); \
166  return tRes; \
167 } \
168  \
169 template<template<class> class Field> \
170 tmp<FieldField<Field, scalar> > func \
171 ( \
172  const int n, \
173  const tmp<FieldField<Field, scalar> >& tsf \
174 ) \
175 { \
176  tmp<FieldField<Field, scalar> > tRes \
177  ( \
178  reuseTmpFieldField<Field, scalar, scalar>::New(tsf) \
179  ); \
180  func(tRes(), n, tsf()); \
181  reuseTmpFieldField<Field, scalar, scalar>::clear(tsf); \
182  return tRes; \
183 }
184 
187 
188 #undef BesselFunc
189 
190 
191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 
193 } // End namespace Foam
194 
195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
196 
197 #include "undefFieldFunctionsM.H"
198 
199 // ************************************************************************* //
dimensionedScalar sqrt(const dimensionedScalar &ds)
dimensionedScalar pow3(const dimensionedScalar &ds)
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
dimensionedScalar erfc(const dimensionedScalar &ds)
dimensionedScalar erf(const dimensionedScalar &ds)
Generic field type.
Definition: FieldField.H:51
dimensionedScalar j0(const dimensionedScalar &ds)
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
dimensionedScalar neg(const dimensionedScalar &ds)
dimensionedScalar y1(const dimensionedScalar &ds)
dimensionedScalar j1(const dimensionedScalar &ds)
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
dimensionedScalar posPart(const dimensionedScalar &ds)
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
dimensionedScalar cbrt(const dimensionedScalar &ds)
dimensionedScalar log10(const dimensionedScalar &ds)
dimensionedScalar exp(const dimensionedScalar &ds)
dimensionedScalar sign(const dimensionedScalar &ds)
dimensionedScalar y0(const dimensionedScalar &ds)
Namespace for OpenFOAM.
dimensionedScalar pow6(const dimensionedScalar &ds)
dimensionedScalar log(const dimensionedScalar &ds)
#define BesselFunc(func)
dimensionedScalar negPart(const dimensionedScalar &ds)
#define forAll(list, i)
Definition: UList.H:421
dimensionedScalar asinh(const dimensionedScalar &ds)
dimensionedScalar cos(const dimensionedScalar &ds)
dimensionedScalar pow025(const dimensionedScalar &ds)
dimensionedScalar acos(const dimensionedScalar &ds)
dimensionedScalar lgamma(const dimensionedScalar &ds)
Pre-declare SubField and related Field type.
Definition: Field.H:57
dimensionedScalar tanh(const dimensionedScalar &ds)
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
const tensorField & tf
dimensionedScalar tan(const dimensionedScalar &ds)
dimensionedScalar atan(const dimensionedScalar &ds)
void multiply(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
tmp< DimensionedField< scalar, GeoMesh > > stabilise(const DimensionedField< scalar, GeoMesh > &dsf, const dimensioned< scalar > &ds)
#define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)
dimensionedScalar pow4(const dimensionedScalar &ds)
dimensionedScalar pow5(const dimensionedScalar &ds)
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
void subtract(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Specialisation of FieldField<T> for scalar.
dimensionedScalar pos(const dimensionedScalar &ds)
dimensionedScalar acosh(const dimensionedScalar &ds)
dimensionedScalar cosh(const dimensionedScalar &ds)
dimensionedScalar asin(const dimensionedScalar &ds)
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
A class for managing temporary objects.
Definition: PtrList.H:118
dimensionedScalar atanh(const dimensionedScalar &ds)
dimensionedScalar sinh(const dimensionedScalar &ds)
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
dimensionedScalar sin(const dimensionedScalar &ds)