Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
containers
Lists
UIndirectList
UIndirectList.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::UIndirectList
26
27
Description
28
A List with indirect addressing.
29
Like IndirectList but does not store addressing.
30
31
SourceFiles
32
UIndirectListI.H
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef UIndirectList_H
37
#define UIndirectList_H
38
39
#include <
OpenFOAM/List.H
>
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
// Forward declaration of friend functions and operators
47
template
<
class
T>
class
UIndirectList;
48
template
<
class
T> Ostream& operator<<(Ostream&, const UIndirectList<T>&);
49
50
/*---------------------------------------------------------------------------*\
51
Class UIndirectList Declaration
52
\*---------------------------------------------------------------------------*/
53
54
template
<
class
T>
55
class
UIndirectList
56
{
57
// Private data
58
59
UList<T>
& completeList_;
60
const
UList<label>
& addressing_;
61
62
63
public
:
64
65
// Constructors
66
67
//- Construct given the complete list and the addressing array
68
inline
UIndirectList
(
const
UList<T>
&,
const
UList<label>
&);
69
70
71
// Member Functions
72
73
// Access
74
75
inline
label
size
()
const
;
76
inline
bool
empty
()
const
;
77
78
inline
const
UList<T>
&
completeList
()
const
;
79
inline
const
List<label>
&
addressing
()
const
;
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
// Ostream operator
101
102
//- Write UIndirectList to Ostream
103
// Binary output is currently still a bit of a problem
104
friend
Ostream
& operator<< <T>
105
(
106
Ostream
&,
107
const
UIndirectList<T>
&
108
);
109
};
110
111
112
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114
}
// End namespace Foam
115
116
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117
118
#include "
UIndirectListI.H
"
119
120
#ifdef NoRepository
121
# include "
UIndirectListIO.C
"
122
#endif
123
124
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126
#endif
127
128
// ************************ vim: set sw=4 sts=4 et: ************************ //