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