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