All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
directFieldMapper.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::directFieldMapper
26 
27 Description
28  Direct field mapper
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef directFieldMapper_H
33 #define directFieldMapper_H
34 
35 #include "fieldMapper.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class directFieldMapper 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 ~directFieldMapper()
70  {}
71 
72 
73  // Member Functions
74 
75  //- Are there unmapped values? I.e. do all size() elements get
76  // get value
77  virtual bool hasUnmapped() const = 0;
78 
79  //- Access to the direct map addressing
80  virtual const labelUList& addressing() const = 0;
81 
82 
83  // Member Operators
84 
85  virtual void operator()
86  (
88  const Field<scalar>& mapF
89  ) const;
90 
91  virtual void operator()
92  (
94  const Field<vector>& mapF
95  ) const;
96 
97  virtual void operator()
98  (
100  const Field<sphericalTensor>& mapF
101  ) const;
102 
103  virtual void operator()
104  (
106  const Field<symmTensor>& mapF
107  ) const;
108 
109  virtual void operator()
110  (
111  Field<tensor>& f,
112  const Field<tensor>& mapF
113  ) const;
114 
115 
116  virtual tmp<Field<scalar>> operator()
117  (
118  const Field<scalar>& mapF
119  ) const;
120 
121  virtual tmp<Field<vector>> operator()
122  (
123  const Field<vector>& mapF
124  ) const;
125 
126  virtual tmp<Field<sphericalTensor>> operator()
127  (
128  const Field<sphericalTensor>& mapF
129  ) const;
130 
131  virtual tmp<Field<symmTensor>> operator()
132  (
133  const Field<symmTensor>& mapF
134  ) const;
135 
136  virtual tmp<Field<tensor>> operator()
137  (
138  const Field<tensor>& mapF
139  ) const;
140 };
141 
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 } // End namespace Foam
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #ifdef NoRepository
151 #endif
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 #endif
156 
157 // ************************************************************************* //
Direct field mapper.
virtual const labelUList & addressing() const =0
Access to the direct map addressing.
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
virtual ~directFieldMapper()
Destructor.
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)
directFieldMapper()
Null constructor.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.