GeometricTensorField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2013 OpenFOAM Foundation
9  Copyright (C) 2019-2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "GeometricTensorField.H"
30 #include "tensorFieldField.H"
31 
32 #define TEMPLATE template<template<class> class PatchField, class GeoMesh>
34 
35 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
36 
37 template<class Cmpt, template<class> class PatchField, class GeoMesh>
38 void Foam::zip
39 (
40  GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& result,
50 )
51 {
52  Foam::zip
53  (
54  result.primitiveFieldRef(),
58  );
59 
60  Foam::zip
61  (
62  result.boundaryFieldRef(),
63  xx.boundaryField(), xy.boundaryField(), xz.boundaryField(),
64  yx.boundaryField(), yy.boundaryField(), yz.boundaryField(),
66  );
67 }
68 
69 
70 template<class Cmpt, template<class> class PatchField, class GeoMesh>
71 void Foam::unzip
72 (
73  const GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& input,
83 )
84 {
86  (
87  input.primitiveField(),
91  );
92 
94  (
95  input.boundaryField(),
99  );
100 }
101 
102 
103 template<class Cmpt, template<class> class PatchField, class GeoMesh>
104 void Foam::zipRows
105 (
106  GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& result,
107  const GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& x,
108  const GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& y,
109  const GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& z
110 )
111 {
113  (
114  result.primitiveFieldRef(),
115  x.primitiveField(),
116  y.primitiveField(),
117  z.primitiveField()
118  );
119 
121  (
122  result.boundaryFieldRef(),
123  x.boundaryField(),
124  y.boundaryField(),
125  z.boundaryField()
126  );
127 }
128 
129 
130 template<class Cmpt, template<class> class PatchField, class GeoMesh>
131 void Foam::zipCols
132 (
133  GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& result,
134  const GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& x,
135  const GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& y,
136  const GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& z
137 )
138 {
140  (
141  result.primitiveFieldRef(),
142  x.primitiveField(),
143  y.primitiveField(),
144  z.primitiveField()
145  );
146 
148  (
149  result.boundaryFieldRef(),
150  x.boundaryField(),
151  y.boundaryField(),
152  z.boundaryField()
153  );
154 }
155 
156 
157 template<class Cmpt, template<class> class PatchField, class GeoMesh>
158 void Foam::unzipRows
159 (
160  const GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& input,
161  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& x,
162  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& y,
163  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& z
164 )
165 {
167  (
168  input.primitiveField(),
169  x.primitiveFieldRef(),
170  y.primitiveFieldRef(),
171  z.primitiveFieldRef()
172  );
173 
175  (
176  input.boundaryField(),
177  x.boundaryFieldRef(),
178  y.boundaryFieldRef(),
179  z.boundaryFieldRef()
180  );
181 }
182 
183 
184 template<class Cmpt, template<class> class PatchField, class GeoMesh>
185 void Foam::unzipCols
186 (
187  const GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& input,
188  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& x,
189  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& y,
190  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& z
191 )
192 {
194  (
195  input.primitiveField(),
196  x.primitiveFieldRef(),
197  y.primitiveFieldRef(),
198  z.primitiveFieldRef()
199  );
200 
202  (
203  input.boundaryField(),
204  x.boundaryFieldRef(),
205  y.boundaryFieldRef(),
206  z.boundaryFieldRef()
207  );
208 }
209 
210 
211 template<class Cmpt, template<class> class PatchField, class GeoMesh>
212 void Foam::unzipRow
213 (
214  const GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& input,
215  const vector::components cmpt,
216  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& result
217 )
218 {
219  Foam::unzipRow(input.primitiveField(), cmpt, result.primitiveFieldRef());
220 
221  Foam::unzipRow(input.boundaryField(), cmpt, result.boundaryFieldRef());
222 }
223 
224 
225 template<class Cmpt, template<class> class PatchField, class GeoMesh>
226 void Foam::unzipCol
227 (
228  const GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& input,
229  const vector::components cmpt,
230  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& result
231 )
232 {
233  Foam::unzipCol(input.primitiveField(), cmpt, result.primitiveFieldRef());
234 
235  Foam::unzipCol(input.boundaryField(), cmpt, result.boundaryFieldRef());
236 }
237 
238 
239 template<class Cmpt, template<class> class PatchField, class GeoMesh>
240 void Foam::unzipDiag
241 (
242  const GeometricField<Tensor<Cmpt>, PatchField, GeoMesh>& input,
243  GeometricField<Vector<Cmpt>, PatchField, GeoMesh>& result
244 )
245 {
246  Foam::unzipDiag(input.primitiveField(), result.primitiveFieldRef());
247 
248  Foam::unzipDiag(input.boundaryField(), result.boundaryFieldRef());
249 }
250 
251 
252 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
253 
254 namespace Foam
255 {
256 
257 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
258 
267 UNARY_FUNCTION(scalar, tensor, det, pow3)
270 
273 
274 
275 // * * * * * * * * * * * * * * * Global Operators * * * * * * * * * * * * * //
276 
279 
282 
283 
284 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
285 
286 } // End namespace Foam
287 
288 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
289 
290 #include "undefFieldFunctionsM.H"
291 
292 // ************************************************************************* //
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:412
Foam::Tensor
A templated (3 x 3) tensor of objects of <T> derived from MatrixSpace.
Definition: complexI.H:275
Foam::symm
dimensionedSymmTensor symm(const dimensionedSymmTensor &dt)
Definition: dimensionedSymmTensor.C:84
Foam::sphericalTensor
SphericalTensor< scalar > sphericalTensor
SphericalTensor of scalars, i.e. SphericalTensor<scalar>.
Definition: sphericalTensor.H:54
Foam::zipCols
void zipCols(FieldField< Field, Tensor< Cmpt >> &result, const FieldField< Field, Vector< Cmpt >> &x, const FieldField< Field, Vector< Cmpt >> &y, const FieldField< Field, Vector< Cmpt >> &z)
Zip together tensor field from column components.
Definition: tensorFieldField.C:113
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:33
Foam::unzipRows
void unzipRows(const FieldField< Field, Tensor< Cmpt >> &input, FieldField< Field, Vector< Cmpt >> &x, FieldField< Field, Vector< Cmpt >> &y, FieldField< Field, Vector< Cmpt >> &z)
Extract tensor field field rows.
Definition: tensorFieldField.C:129
Foam::unzip
void unzip(const FieldField< Field, SphericalTensor< Cmpt >> &input, FieldField< Field, Cmpt > &ii)
Unzip sphericalTensor field field into components.
Definition: sphericalTensorFieldField.C:55
Foam::skew
dimensionedTensor skew(const dimensionedTensor &dt)
Definition: dimensionedTensor.C:138
Foam::pow2
dimensionSet pow2(const dimensionSet &ds)
Definition: dimensionSet.C:367
GeometricTensorField.H
Tensor specific part of the implementation of GeometricField.
Foam::eigenValues
dimensionedVector eigenValues(const dimensionedSymmTensor &dt)
Definition: dimensionedTensor.C:149
Foam::GeometricField::primitiveField
const Internal::FieldType & primitiveField() const
Return a const-reference to the internal field.
Definition: GeometricFieldI.H:53
Foam::eigenVectors
dimensionedTensor eigenVectors(const dimensionedSymmTensor &dt)
Definition: dimensionedTensor.C:160
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:674
undefFieldFunctionsM.H
tensorFieldField.H
Specialisation of FieldField<T> for tensor.
Foam::unzipRow
void unzipRow(const FieldField< Field, Tensor< Cmpt >> &input, const vector::components cmpt, FieldField< Field, Vector< Cmpt >> &result)
Extract a tensor field field row (x,y,z) == (0,1,2)
Definition: tensorFieldField.C:161
Foam::zipRows
void zipRows(FieldField< Field, Tensor< Cmpt >> &result, const FieldField< Field, Vector< Cmpt >> &x, const FieldField< Field, Vector< Cmpt >> &y, const FieldField< Field, Vector< Cmpt >> &z)
Zip together tensor field field from row components.
Definition: tensorFieldField.C:97
Foam::unzipCols
void unzipCols(const FieldField< Field, Tensor< Cmpt >> &input, FieldField< Field, Vector< Cmpt >> &x, FieldField< Field, Vector< Cmpt >> &y, FieldField< Field, Vector< Cmpt >> &z)
Extract tensor field field columns.
Definition: tensorFieldField.C:145
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:166
Foam::transform
dimensionSet transform(const dimensionSet &ds)
Return the argument; transformations do not change the dimensions.
Definition: dimensionSet.C:519
Foam::dev2
dimensionedSymmTensor dev2(const dimensionedSymmTensor &dt)
Definition: dimensionedSymmTensor.C:117
Foam::divide
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:89
Foam::inv
dimensionedSphericalTensor inv(const dimensionedSphericalTensor &dt)
Definition: dimensionedSphericalTensor.C:73
GeometricFieldFunctionsM.C
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:58
Foam::symmTensor
SymmTensor< scalar > symmTensor
SymmTensor of scalars, i.e. SymmTensor<scalar>.
Definition: symmTensor.H:59
Foam::sph
SphericalTensor< Cmpt > sph(const DiagTensor< Cmpt > &dt)
Return the spherical part of a DiagTensor as a SphericalTensor.
Definition: DiagTensorI.H:130
Foam::GeoMesh
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:48
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::cof
dimensionedSymmTensor cof(const dimensionedSymmTensor &dt)
Definition: dimensionedSymmTensor.C:139
Foam::vector
Vector< scalar > vector
A scalar version of the templated Vector.
Definition: vector.H:51
Foam::GeometricField::primitiveFieldRef
Internal::FieldType & primitiveFieldRef(const bool updateAccessTime=true)
Return a reference to the internal field.
Definition: GeometricField.C:766
Foam::unzipCol
void unzipCol(const FieldField< Field, Tensor< Cmpt >> &input, const vector::components cmpt, FieldField< Field, Vector< Cmpt >> &result)
Extract a tensor field field column (x,y,z) == (0,1,2)
Definition: tensorFieldField.C:176
UNARY_OPERATOR
#define UNARY_OPERATOR(ReturnType, Type1, Op, OpFunc, Dfunc)
Definition: DimensionedFieldFunctionsM.C:87
Foam::GeometricField::boundaryFieldRef
Boundary & boundaryFieldRef(const bool updateAccessTime=true)
Return a reference to the boundary field.
Definition: GeometricField.C:783
Foam::Vector
Templated 3D Vector derived from VectorSpace adding construction from 3 components,...
Definition: Vector.H:62
Foam::input
static Istream & input(Istream &is, IntRange< T > &range)
Definition: IntRanges.C:55
x
x
Definition: LISASMDCalcMethod2.H:52
Foam::zip
void zip(FieldField< Field, SphericalTensor< Cmpt >> &result, const FieldField< Field, Cmpt > &ii)
Zip together sphericalTensor field field from components.
Definition: sphericalTensorFieldField.C:41
Foam::unzipDiag
void unzipDiag(const FieldField< Field, SymmTensor< Cmpt >> &input, FieldField< Field, Vector< Cmpt >> &result)
Extract a symmTensor field field diagonal.
Definition: symmTensorFieldField.C:91
Foam::tr
dimensionedScalar tr(const dimensionedSphericalTensor &dt)
Definition: dimensionedSphericalTensor.C:51
Foam::det
dimensionedScalar det(const dimensionedSphericalTensor &dt)
Definition: dimensionedSphericalTensor.C:62
Foam::hdual
void hdual(pointPatchField< vector > &, const pointPatchField< tensor > &)
Definition: pointPatchFieldFunctions.H:273
Foam::GeometricField
Generic GeometricField class.
Definition: areaFieldsFwd.H:53
Foam::twoSymm
dimensionedSymmTensor twoSymm(const dimensionedSymmTensor &dt)
Definition: dimensionedSymmTensor.C:95
Foam::tensor
Tensor< scalar > tensor
Tensor of scalars, i.e. Tensor<scalar>.
Definition: symmTensor.H:61
Foam::GeometricField::boundaryField
const Boundary & boundaryField() const
Return const-reference to the boundary field.
Definition: GeometricFieldI.H:62
y
scalar y
Definition: LISASMDCalcMethod1.H:14
Foam::dev
dimensionedSymmTensor dev(const dimensionedSymmTensor &dt)
Definition: dimensionedSymmTensor.C:106