FreeFOAM The Cross-Platform CFD Toolkit
BiIndirectList.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 Class
25  Foam::BiIndirectList
26 
27 Description
28  Indexes into negList (negative index) or posList (zero or positive index).
29 
30 SourceFiles
31  BiIndirectListI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef BiIndirectList_H
36 #define BiIndirectList_H
37 
38 #include <OpenFOAM/List.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class BiIndirectList Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class T>
51 {
52  // Private data
53 
54  UList<T>& posList_;
55  UList<T>& negList_;
56  List<label> addressing_;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct given the complete lists and the addressing array
64  inline BiIndirectList
65  (
66  const UList<T>& posList,
67  const UList<T>& negList,
68  const UList<label>&
69  );
70 
71 
72  // Member Functions
73 
74  // Access
75 
76  inline label size() const;
77  inline bool empty() const;
78 
79  inline const UList<T>& posList() const;
80  inline const UList<T>& negList() const;
81  inline const List<label>& addressing() const;
82  inline List<label>& addressing();
83 
84  //- Calculate index given whether index is into posList or negList
85  inline static label posIndex(const label);
86  inline static label negIndex(const label);
87 
88 
89  // Member Operators
90 
91  //- Return the addressed elements as a List
92  inline List<T> operator()() const;
93 
94  //- Return non-const access to an element
95  inline T& operator[](const label);
96 
97  //- Return const access to an element
98  inline const T& operator[](const label) const;
99 
100  //- Assignment from UList of addressed elements
101  inline void operator=(const UList<T>&);
102 
103  //- Assignment of all entries to the given value
104  inline void operator=(const T&);
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************ vim: set sw=4 sts=4 et: ************************ //