weightedFvPatchFieldMapper.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) 2015-2019 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 :
49 {
50  // Private Data
51 
52  const labelListList& addressing_;
53 
54  const scalarListList& weights_;
55 
56  bool hasUnmapped_;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct given addressing
65  (
67  const scalarListList& weights
68  )
69  :
70  addressing_(addressing),
71  weights_(weights),
72  hasUnmapped_(false)
73  {
74  forAll(addressing_, i)
75  {
76  if (addressing_[i].size() == 0)
77  {
78  hasUnmapped_ = true;
79  }
80  }
81  }
82 
83 
84  //- Destructor
86  {}
87 
88 
89  // Member Functions
90 
91  virtual bool direct() const
92  {
93  return false;
94  }
95 
96  virtual bool hasUnmapped() const
97  {
98  return hasUnmapped_;
99  }
101  virtual const labelListList& addressing() const
102  {
103  return addressing_;
104  }
106  virtual const scalarListList& weights() const
107  {
108  return weights_;
109  }
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
virtual bool hasUnmapped() const
Are there unmapped values? I.e. do all size() elements get.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
virtual const scalarListList & weights() const
FieldMapper with weighted mapping.
virtual const labelListList & addressing() const
weightedFvPatchFieldMapper(const labelListList &addressing, const scalarListList &weights)
Construct given addressing.
Namespace for OpenFOAM.