vectorFieldTemplates.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) 2019 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "vectorField.H"
29 
30 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
31 
32 template<class Cmpt>
33 void Foam::zip
34 (
35  Field<Vector<Cmpt>>& result,
36  const UList<Cmpt>& x,
37  const UList<Cmpt>& y,
38  const UList<Cmpt>& z
39 )
40 {
41  typedef Vector<Cmpt> value_type;
42 
43  const label len = result.size();
44 
45  #ifdef FULLDEBUG
46  if (len != x.size() || len != y.size() || len != z.size())
47  {
49  << "Components sizes do not match: " << len << " ("
50  << x.size() << ' ' << y.size() << ' ' << z.size() << ')'
51  << nl
52  << abort(FatalError);
53  }
54  #endif
55 
56  for (label i=0; i < len; ++i)
57  {
58  result[i] = value_type(x[i], y[i], z[i]);
59  }
60 }
61 
62 
63 template<class Cmpt>
65 (
66  const Field<Cmpt>& x,
67  const Field<Cmpt>& y,
68  const Field<Cmpt>& z
69 )
70 {
71  auto tresult = tmp<Field<Vector<Cmpt>>>::New(x.size());
72 
73  Foam::zip(tresult.ref(), x, y, z);
74 
75  return tresult;
76 }
77 
78 
79 template<class Cmpt>
80 void Foam::unzip
81 (
82  const UList<Vector<Cmpt>>& input,
83  Field<Cmpt>& x,
84  Field<Cmpt>& y,
85  Field<Cmpt>& z
86 )
87 {
88  const label len = input.size();
89 
90  #ifdef FULLDEBUG
91  if (len != x.size() || len != y.size() || len != z.size())
92  {
94  << "Components sizes do not match: " << len << " ("
95  << x.size() << ' ' << y.size() << ' ' << z.size() << ')'
96  << nl
97  << abort(FatalError);
98  }
99  #endif
100 
101  for (label i=0; i < len; ++i)
102  {
103  x[i] = input[i].x();
104  y[i] = input[i].y();
105  z[i] = input[i].z();
106  }
107 }
108 
109 
110 // ************************************************************************* //
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::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:381
Foam::nl
constexpr char nl
Definition: Ostream.H:385
Foam::Vector
Templated 3D Vector derived from VectorSpace adding construction from 3 components,...
Definition: Vector.H:62
vectorField.H
Foam::UList
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:103
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::UList::size
void size(const label n) noexcept
Override size to be inconsistent with allocated storage.
Definition: UListI.H:360
Foam::VectorSpace::size
static constexpr direction size() noexcept
The number of elements in the VectorSpace = Ncmpts.
Definition: VectorSpace.H:176
y
scalar y
Definition: LISASMDCalcMethod1.H:14