All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
generalFieldMapper.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2019-2020 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 Class
25  Foam::generalFieldMapper
26 
27 Description
28  General field mapper supporting both direct and weighted mapping.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef generalFieldMapper_H
33 #define generalFieldMapper_H
34 
35 #include "fieldMapper.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class generalFieldMapper Declaration
44 \*---------------------------------------------------------------------------*/
45 
47 :
48  virtual public fieldMapper
49 {
50  // Private Member Functions
51 
52  template<class Type>
53  void map(Field<Type>& f, const Field<Type>& mapF) const;
54 
55  template<class Type>
56  tmp<Field<Type>> map(const Field<Type>& f) const;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Null constructor
65  {}
66 
67 
68  //- Destructor
69  virtual ~generalFieldMapper()
70  {}
71 
72 
73  // Member Functions
74 
75  virtual bool direct() const = 0;
76 
77  //- Are there unmapped values? I.e. do all size() elements get
78  // get value
79  virtual bool hasUnmapped() const = 0;
80 
81  virtual const labelUList& directAddressing() const;
82 
83  virtual const labelListList& addressing() const;
84 
85  virtual const scalarListList& weights() const;
86 
87 
88  // Member Operators
89 
90  virtual void operator()
91  (
93  const Field<scalar>& mapF
94  ) const;
95 
96  virtual void operator()
97  (
99  const Field<vector>& mapF
100  ) const;
101 
102  virtual void operator()
103  (
105  const Field<sphericalTensor>& mapF
106  ) const;
107 
108  virtual void operator()
109  (
111  const Field<symmTensor>& mapF
112  ) const;
113 
114  virtual void operator()
115  (
116  Field<tensor>& f,
117  const Field<tensor>& mapF
118  ) const;
119 
120 
121  virtual tmp<Field<scalar>> operator()
122  (
123  const Field<scalar>& mapF
124  ) const;
125 
126  virtual tmp<Field<vector>> operator()
127  (
128  const Field<vector>& mapF
129  ) const;
130 
131  virtual tmp<Field<sphericalTensor>> operator()
132  (
133  const Field<sphericalTensor>& mapF
134  ) const;
135 
136  virtual tmp<Field<symmTensor>> operator()
137  (
138  const Field<symmTensor>& mapF
139  ) const;
140 
141  virtual tmp<Field<tensor>> operator()
142  (
143  const Field<tensor>& mapF
144  ) const;
145 };
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #ifdef NoRepository
156 #endif
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #endif
161 
162 // ************************************************************************* //
virtual const labelListList & addressing() const
virtual bool direct() const =0
virtual ~generalFieldMapper()
Destructor.
virtual const labelUList & directAddressing() const
Pre-declare SubField and related Field type.
Definition: Field.H:56
virtual bool hasUnmapped() const =0
Are there unmapped values? I.e. do all size() elements get.
Abstract base class for field mapping.
Definition: fieldMapper.H:46
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:60
labelList f(nPoints)
generalFieldMapper()
Null constructor.
virtual const scalarListList & weights() const
A class for managing temporary objects.
Definition: PtrList.H:53
General field mapper supporting both direct and weighted mapping.
Namespace for OpenFOAM.