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 | 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 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, neg)
105 UNARY_FUNCTION(scalar, scalar, posPart)
106 UNARY_FUNCTION(scalar, scalar, negPart)
107 UNARY_FUNCTION(scalar, scalar, exp)
108 UNARY_FUNCTION(scalar, scalar, log)
109 UNARY_FUNCTION(scalar, scalar, log10)
110 UNARY_FUNCTION(scalar, scalar, sin)
111 UNARY_FUNCTION(scalar, scalar, cos)
112 UNARY_FUNCTION(scalar, scalar, tan)
113 UNARY_FUNCTION(scalar, scalar, asin)
114 UNARY_FUNCTION(scalar, scalar, acos)
115 UNARY_FUNCTION(scalar, scalar, atan)
116 UNARY_FUNCTION(scalar, scalar, sinh)
117 UNARY_FUNCTION(scalar, scalar, cosh)
118 UNARY_FUNCTION(scalar, scalar, tanh)
119 UNARY_FUNCTION(scalar, scalar, asinh)
120 UNARY_FUNCTION(scalar, scalar, acosh)
121 UNARY_FUNCTION(scalar, scalar, atanh)
122 UNARY_FUNCTION(scalar, scalar, erf)
123 UNARY_FUNCTION(scalar, scalar, erfc)
124 UNARY_FUNCTION(scalar, scalar, lgamma)
125 UNARY_FUNCTION(scalar, scalar, j0)
126 UNARY_FUNCTION(scalar, scalar, j1)
127 UNARY_FUNCTION(scalar, scalar, y0)
128 UNARY_FUNCTION(scalar, scalar, y1)
129 
130 
131 #define BesselFunc(func) \
132 void func \
133 ( \
134  FieldField<Field, scalar>& Res, \
135  const int n, \
136  const FieldField<Field, scalar>& sf \
137 ); \
138 tmp<scalarField> func(const int n, const FieldField<Field, scalar>&); \
139 tmp<scalarField> func(const int n, const tmp<FieldField<Field, scalar> >&);
140 
141 BesselFunc(jn)
142 BesselFunc(yn)
143 
144 #undef BesselFunc
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #include "undefFieldFunctionsM.H"
154 
155 #ifdef NoRepository
156 # include "scalarFieldField.C"
157 #endif
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::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::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
FieldField.H
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::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
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
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:268
BesselFunc
#define BesselFunc(func)
Definition: scalarFieldField.H:131
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
FieldFieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
sf
volScalarField sf(fieldObject, mesh)
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
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
scalarFieldField.C
Specialisation of FieldField<T> for scalar.
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:260
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::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:201
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:258
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