FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

IndirectList.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::IndirectList
00026 
00027 Description
00028     A List with indirect addressing
00029 
00030 SourceFiles
00031     IndirectListI.H
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef IndirectList_H
00036 #define IndirectList_H
00037 
00038 #include <OpenFOAM/List.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class IndirectList Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class T>
00050 class IndirectList
00051 {
00052     // Private data
00053 
00054         UList<T>& completeList_;
00055         List<label> addressing_;
00056 
00057 
00058 public:
00059 
00060     // Constructors
00061 
00062         //- Construct given the complete list and the addressing array
00063         inline IndirectList(const UList<T>&, const UList<label>&);
00064 
00065 
00066     // Member Functions
00067 
00068         // Access
00069 
00070             inline label size() const;
00071             inline bool  empty() const;
00072 
00073             inline const UList<T>& completeList() const;
00074             inline const List<label>& addressing() const;
00075 
00076         // Edit
00077 
00078             //- Reset addressing
00079             void resetAddressing(const UList<label>&);
00080 
00081 
00082         // Member Operators
00083 
00084             //- Return the addressed elements as a List
00085             inline List<T> operator()() const;
00086 
00087             //- Return non-const access to an element
00088             inline T& operator[](const label);
00089 
00090             //- Return const access to an element
00091             inline const T& operator[](const label) const;
00092 
00093             //- Assignment from UList of addressed elements
00094             inline void operator=(const UList<T>&);
00095 
00096             //- Assignment of all entries to the given value
00097             inline void operator=(const T&);
00098 };
00099 
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 } // End namespace Foam
00104 
00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00106 
00107 #include <OpenFOAM/IndirectListI.H>
00108 
00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00110 
00111 #endif
00112 
00113 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines