weightedFvPatchFieldMapper.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) 2015 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::weightedFvPatchFieldMapper
26 
27 Description
28  FieldMapper with weighted mapping.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef weightedFvPatchFieldMapper_H
33 #define weightedFvPatchFieldMapper_H
34 
35 #include "fvPatchFieldMapper.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class weightedFvPatchFieldMapper Declaration
44 \*---------------------------------------------------------------------------*/
45 
47 :
48  public fvPatchFieldMapper
49 {
50  const labelListList& addressing_;
51 
52  const scalarListList& weights_;
53 
54  bool hasUnmapped_;
55 
56 public:
57 
58  // Constructors
59 
60  //- Construct given addressing
62  (
64  const scalarListList& weights
65  )
66  :
67  addressing_(addressing),
68  weights_(weights),
69  hasUnmapped_(false)
70  {
71  forAll(addressing_, i)
72  {
73  if (addressing_[i].size() == 0)
74  {
75  hasUnmapped_ = true;
76  }
77  }
78  }
79 
80  //- Destructor
82  {}
83 
84 
85  // Member Functions
86 
87  virtual label size() const
88  {
89  return addressing().size();
90  }
91 
92  virtual bool direct() const
93  {
94  return false;
95  }
96 
97  virtual bool hasUnmapped() const
98  {
99  return hasUnmapped_;
100  }
102  virtual const labelListList& addressing() const
103  {
104  return addressing_;
105  }
107  virtual const scalarListList& weights() const
108  {
109  return weights_;
110  }
111 
112 };
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
virtual const scalarListList & weights() const
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:76
Foam::fvPatchFieldMapper.
Namespace for OpenFOAM.
FieldMapper with weighted mapping.
weightedFvPatchFieldMapper(const labelListList &addressing, const scalarListList &weights)
Construct given addressing.
#define forAll(list, i)
Definition: UList.H:421
virtual bool hasUnmapped() const
Are there unmapped values? I.e. do all size() elements get.
virtual const labelListList & addressing() const