scalarField.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) 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 Typedef
25  Foam::scalarField
26 
27 Description
28  Specialisation of Field<T> for scalar.
29 
30 SourceFiles
31  scalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef scalarField_H
36 #define scalarField_H
37 
38 #include "Field.H"
39 #include "scalar.H"
40 
41 #define TEMPLATE
42 #include "FieldFunctionsM.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 typedef Field<scalar> scalarField;
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 template<>
54 tmp<scalarField> scalarField::component(const direction) const;
55 
56 void component
57 (
58  scalarField& sf,
59  const UList<scalar>& f,
60  const direction
61 );
62 
63 template<>
64 void scalarField::replace(const direction, const UList<scalar>& sf);
65 
66 template<>
67 void scalarField::replace(const direction, const scalar& s);
68 
69 
70 void stabilise(scalarField& Res, const UList<scalar>& sf, const scalar s);
71 tmp<scalarField> stabilise(const UList<scalar>&, const scalar s);
72 tmp<scalarField> stabilise(const tmp<scalarField>&, const scalar s);
73 
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 template<>
78 scalar sumProd(const UList<scalar>& f1, const UList<scalar>& f2);
79 
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, add)
84 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, subtract)
85 
86 BINARY_OPERATOR(scalar, scalar, scalar, *, multiply)
87 BINARY_OPERATOR(scalar, scalar, scalar, /, divide)
88 
89 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, divide)
90 
91 BINARY_FUNCTION(scalar, scalar, scalar, pow)
92 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, pow)
93 
94 BINARY_FUNCTION(scalar, scalar, scalar, atan2)
95 BINARY_TYPE_FUNCTION(scalar, scalar, scalar, atan2)
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 UNARY_FUNCTION(scalar, scalar, pow3)
101 UNARY_FUNCTION(scalar, scalar, pow4)
102 UNARY_FUNCTION(scalar, scalar, pow5)
103 UNARY_FUNCTION(scalar, scalar, pow6)
104 UNARY_FUNCTION(scalar, scalar, pow025)
105 UNARY_FUNCTION(scalar, scalar, sqrt)
106 UNARY_FUNCTION(scalar, scalar, cbrt)
107 UNARY_FUNCTION(scalar, scalar, sign)
108 UNARY_FUNCTION(scalar, scalar, pos)
109 UNARY_FUNCTION(scalar, scalar, neg)
110 UNARY_FUNCTION(scalar, scalar, posPart)
111 UNARY_FUNCTION(scalar, scalar, negPart)
112 UNARY_FUNCTION(scalar, scalar, exp)
113 UNARY_FUNCTION(scalar, scalar, log)
114 UNARY_FUNCTION(scalar, scalar, log10)
115 UNARY_FUNCTION(scalar, scalar, sin)
116 UNARY_FUNCTION(scalar, scalar, cos)
117 UNARY_FUNCTION(scalar, scalar, tan)
118 UNARY_FUNCTION(scalar, scalar, asin)
119 UNARY_FUNCTION(scalar, scalar, acos)
120 UNARY_FUNCTION(scalar, scalar, atan)
121 UNARY_FUNCTION(scalar, scalar, sinh)
122 UNARY_FUNCTION(scalar, scalar, cosh)
123 UNARY_FUNCTION(scalar, scalar, tanh)
124 UNARY_FUNCTION(scalar, scalar, asinh)
125 UNARY_FUNCTION(scalar, scalar, acosh)
126 UNARY_FUNCTION(scalar, scalar, atanh)
127 UNARY_FUNCTION(scalar, scalar, erf)
128 UNARY_FUNCTION(scalar, scalar, erfc)
129 UNARY_FUNCTION(scalar, scalar, lgamma)
130 UNARY_FUNCTION(scalar, scalar, j0)
131 UNARY_FUNCTION(scalar, scalar, j1)
132 UNARY_FUNCTION(scalar, scalar, y0)
133 UNARY_FUNCTION(scalar, scalar, y1)
134 
135 UNARY_FUNCTION(scalar, scalar, degToRad)
136 UNARY_FUNCTION(scalar, scalar, radToDeg)
137 UNARY_FUNCTION(scalar, scalar, atmToPa)
138 UNARY_FUNCTION(scalar, scalar, paToAtm)
139 
140 #define BesselFunc(func) \
141 void func(scalarField& Res, const int n, const UList<scalar>& sf); \
142 tmp<scalarField> func(const int n, const UList<scalar>&); \
143 tmp<scalarField> func(const int n, const tmp<scalarField>&);
144 
145 BesselFunc(jn)
146 BesselFunc(yn)
147 
148 #undef BesselFunc
149 
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 } // End namespace Foam
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #include "undefFieldFunctionsM.H"
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #endif
162 
163 // ************************************************************************* //
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:531
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:417
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:48
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:871
Foam::component
void component(FieldField< Field, typename FieldField< Field, Type >::cmptType > &sf, const FieldField< Field, Type > &f, const direction d)
Definition: FieldFieldFunctions.C:41
Foam::tan
dimensionedScalar tan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:257
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:30
Foam::cosh
dimensionedScalar cosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:262
Foam::y1
dimensionedScalar y1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:273
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:255
Foam::jn
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:296
Foam::posPart
dimensionedScalar posPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:212
Foam::atan2
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:303
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:684
undefFieldFunctionsM.H
Foam::paToAtm
scalar paToAtm(const scalar pa)
Conversion from atm to Pa.
Definition: unitConversion.H:63
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:252
BINARY_FUNCTION
#define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:142
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:179
Foam::erf
dimensionedScalar erf(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:267
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:131
Foam::atanh
dimensionedScalar atanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:266
Foam::lgamma
dimensionedScalar lgamma(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:269
Foam::pow4
dimensionedScalar pow4(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:98
Foam::pow6
dimensionedScalar pow6(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:120
Foam::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:263
FieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:87
Foam::stabilise
tmp< DimensionedField< scalar, GeoMesh > > stabilise(const DimensionedField< scalar, GeoMesh > &dsf, const dimensioned< scalar > &ds)
Definition: DimensionedScalarField.C:40
Foam::log10
dimensionedScalar log10(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:254
Foam::y0
dimensionedScalar y0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:272
Field.H
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:268
f1
scalar f1
Definition: createFields.H:28
Foam::Field::replace
void replace(const direction, const UList< cmptType > &)
Replace a component field of the field.
Foam::asinh
dimensionedScalar asinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:264
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:73
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:870
scalar.H
Foam::pow5
dimensionedScalar pow5(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:109
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:253
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
sf
volScalarField sf(fieldObject, mesh)
Foam::Field::component
tmp< Field< cmptType > > component(const direction) const
Return a component field of the field.
Definition: Field.C:644
s
gmvFile<< "tracers "<< particles.size()<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().x()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().y()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().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))
BINARY_TYPE_FUNCTION
#define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)
Definition: DimensionedFieldFunctionsM.C:410
Foam::yn
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:297
Foam::acosh
dimensionedScalar acosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:265
Foam::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:223
f
labelList f(nPoints)
Foam::sqrt
dimensionedScalar sqrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:142
Foam::j0
dimensionedScalar j0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:270
Foam::acos
dimensionedScalar acos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:259
Foam::direction
unsigned char direction
Definition: direction.H:43
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:260
Foam::radToDeg
scalar radToDeg(const scalar rad)
Conversion from radians to degrees.
Definition: unitConversion.H:51
BesselFunc
#define BesselFunc(func)
Definition: scalarField.H:140
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:153
Foam::j1
dimensionedScalar j1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:271
Foam::sumProd
scalar sumProd(const UList< Type > &f1, const UList< Type > &f2)
Definition: FieldFunctions.C:416
Foam::atmToPa
scalar atmToPa(const scalar atm)
Conversion from atm to Pa.
Definition: unitConversion.H:57
Foam::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:201
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:258
Foam::degToRad
scalar degToRad(const scalar deg)
Conversion from degrees to radians.
Definition: unitConversion.H:45
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:256
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:190
Foam::sinh
dimensionedScalar sinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:261

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17