Added more documentation.
[OpenFOAM-1.5.x.git] / applications / test / IndirectList / IndirectListI.H
blob8ab6547d66ac84254a49b18ea7d579482af41a65
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Description
27 \*---------------------------------------------------------------------------*/
29 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
31 //- Construct given size
32 template<class T>
33 inline Foam::IndirectList<T>::IndirectList
35     const Foam::UList<T>& completeList,
36     const Foam::List<label>& addresses
39     completeList_(completeList),
40     addresses_(addresses)
44 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
46 template<class T>
47 inline Foam::label Foam::IndirectList<T>::size() const
49     return addresses_.size();
53 template<class T>
54 inline const Foam::UList<T>& Foam::IndirectList<T>::
55 completeList() const
57     return completeList_;
61 template<class T>
62 inline const Foam::List<Foam::label>& Foam::IndirectList<T>::addresses() const
64     return addresses_;
68 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
70 template<class T>
71 inline const T& Foam::IndirectList<T>::operator[](const Foam::label i) const
73     return completeList_[addresses_[i]];
77 // ************************************************************************* //