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

UIndirectList.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::UIndirectList
00026 
00027 Description
00028     A List with indirect addressing.
00029     Like IndirectList but does not store addressing.
00030 
00031 SourceFiles
00032     UIndirectListI.H
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef UIndirectList_H
00037 #define UIndirectList_H
00038 
00039 #include <OpenFOAM/List.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // Forward declaration of friend functions and operators
00047 template<class T> class UIndirectList;
00048 template<class T> Ostream& operator<<(Ostream&, const UIndirectList<T>&);
00049 
00050 /*---------------------------------------------------------------------------*\
00051                         Class UIndirectList Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 template<class T>
00055 class UIndirectList
00056 {
00057     // Private data
00058 
00059         UList<T>& completeList_;
00060         const UList<label>& addressing_;
00061 
00062 
00063 public:
00064 
00065     // Constructors
00066 
00067         //- Construct given the complete list and the addressing array
00068         inline UIndirectList(const UList<T>&, const UList<label>&);
00069 
00070 
00071     // Member Functions
00072 
00073         // Access
00074 
00075             inline label size() const;
00076             inline bool  empty() const;
00077 
00078             inline const UList<T>& completeList() const;
00079             inline const List<label>& addressing() const;
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     // Ostream operator
00101 
00102         //- Write UIndirectList to Ostream
00103         //  Binary output is currently still a bit of a problem
00104         friend Ostream& operator<< <T>
00105         (
00106             Ostream&,
00107             const UIndirectList<T>&
00108         );
00109 };
00110 
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 } // End namespace Foam
00115 
00116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00117 
00118 #include "UIndirectListI.H"
00119 
00120 #ifdef NoRepository
00121 #   include "UIndirectListIO.C"
00122 #endif
00123 
00124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00125 
00126 #endif
00127 
00128 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines