FreeFOAM The Cross-Platform CFD Toolkit
transformList.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
26 
27 Description
28  Spatial transformation functions for primitive fields.
29 
30 SourceFiles
31  transformList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef transformList_H
36 #define transformList_H
37 
38 #include <OpenFOAM/transform.H>
39 #include <OpenFOAM/List.H>
40 #include <OpenFOAM/Map.H>
41 #include <OpenFOAM/EdgeMap.H>
42 #include <OpenFOAM/tensorField.H>
43 
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 //- Extend transform to work on list.
53 template<class T>
54 List<T> transform
55 (
56  const tensor& rotTensor,
57  const UList<T>& field
58 );
59 
60 //- Apply transformation to list. Either single transformation tensor
61 // or one tensor per element.
62 template<class T>
63 void transformList(const tensorField&, UList<T>&);
64 
65 template<class T>
66 void transformList(const tensorField&, Map<T>&);
67 
68 template<class T>
69 void transformList(const tensorField&, EdgeMap<T>&);
70 
71 
72 template<>
73 inline void transformList(const tensorField&, UList<label>&)
74 {}
75 template<>
76 inline void transformList(const tensorField&, Map<label>&)
77 {}
78 template<>
80 {}
81 
82 
83 template<>
85 {}
86 template<>
87 inline void transformList(const tensorField&, Map<scalar>&)
88 {}
89 template<>
91 {}
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #ifdef NoRepository
101 # include <OpenFOAM/transformList.C>
102 #endif
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************ vim: set sw=4 sts=4 et: ************************ //