FreeFOAM The Cross-Platform CFD Toolkit
DimensionedScalarField.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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::DimensionedScalarField
26 
27 Description
28  Scalar specific part of the implementation of DimensionedField.
29 
30 SourceFiles
31  DimensionedScalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef DimensionedScalarField_H
36 #define DimensionedScalarField_H
37 
39 #include <OpenFOAM/scalar.H>
40 
41 #define TEMPLATE template<class GeoMesh>
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 template<class GeoMesh>
52 tmp<DimensionedField<scalar, GeoMesh> > stabilise
53 (
54  const DimensionedField<scalar, GeoMesh>&,
55  const dimensioned<scalar>&
56 );
57 
58 template<class GeoMesh>
59 tmp<DimensionedField<scalar, GeoMesh> > stabilise
60 (
61  const tmp<DimensionedField<scalar, GeoMesh> >&,
62  const dimensioned<scalar>&
63 );
64 
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, '+', add)
69 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, '-', subtract)
70 
71 BINARY_OPERATOR(scalar, scalar, scalar, *, '*', multiply)
72 BINARY_OPERATOR(scalar, scalar, scalar, /, '|', divide)
73 
74 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, '|', divide)
75 
76 BINARY_FUNCTION(scalar, scalar, scalar, pow)
77 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 UNARY_FUNCTION(scalar, scalar, pow3, pow3)
83 UNARY_FUNCTION(scalar, scalar, pow4, pow4)
84 UNARY_FUNCTION(scalar, scalar, pow5, pow5)
85 UNARY_FUNCTION(scalar, scalar, pow6, pow6)
86 UNARY_FUNCTION(scalar, scalar, sqrt, sqrt)
87 UNARY_FUNCTION(scalar, scalar, sign, sign)
88 UNARY_FUNCTION(scalar, scalar, pos, pos)
89 UNARY_FUNCTION(scalar, scalar, neg, neg)
90 
91 UNARY_FUNCTION(scalar, scalar, exp, trans)
92 UNARY_FUNCTION(scalar, scalar, log, trans)
93 UNARY_FUNCTION(scalar, scalar, log10, trans)
94 UNARY_FUNCTION(scalar, scalar, sin, trans)
95 UNARY_FUNCTION(scalar, scalar, cos, trans)
96 UNARY_FUNCTION(scalar, scalar, tan, trans)
97 UNARY_FUNCTION(scalar, scalar, asin, trans)
98 UNARY_FUNCTION(scalar, scalar, acos, trans)
99 UNARY_FUNCTION(scalar, scalar, atan, trans)
100 UNARY_FUNCTION(scalar, scalar, sinh, trans)
101 UNARY_FUNCTION(scalar, scalar, cosh, trans)
102 UNARY_FUNCTION(scalar, scalar, tanh, trans)
103 UNARY_FUNCTION(scalar, scalar, asinh, trans)
104 UNARY_FUNCTION(scalar, scalar, acosh, trans)
105 UNARY_FUNCTION(scalar, scalar, atanh, trans)
106 UNARY_FUNCTION(scalar, scalar, erf, trans)
107 UNARY_FUNCTION(scalar, scalar, erfc, trans)
108 UNARY_FUNCTION(scalar, scalar, lgamma, trans)
109 UNARY_FUNCTION(scalar, scalar, j0, trans)
110 UNARY_FUNCTION(scalar, scalar, j1, trans)
111 UNARY_FUNCTION(scalar, scalar, y0, trans)
112 UNARY_FUNCTION(scalar, scalar, y1, trans)
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #define BesselFunc(func) \
118  \
119 template<class GeoMesh> \
120 tmp<DimensionedField<scalar, GeoMesh> > func \
121 ( \
122  const int n, \
123  const DimensionedField<scalar, GeoMesh>& \
124 ); \
125  \
126 template<class GeoMesh> \
127 tmp<DimensionedField<scalar, GeoMesh> > func \
128 ( \
129  const int n, \
130  const tmp<DimensionedField<scalar, GeoMesh> >& \
131 );
132 
133 BesselFunc(jn)
134 BesselFunc(yn)
135 
136 #undef BesselFunc
137 
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
146 
147 #ifdef NoRepository
149 #endif
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************ vim: set sw=4 sts=4 et: ************************ //