OpenFOAM logo
Open Source CFD Toolkit

SubList.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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     SubList
00027 
00028 Description
00029     SubList is a List obtained as a section of another List.  Thus it is
00030     itself unallocated so that no storage is allocated or de-allocated
00031     during it's use.  To achieve this behaviour, SubList is derived from
00032     UList rather than List.
00033 
00034 SourceFiles
00035     SubListI.H
00036 
00037 \*---------------------------------------------------------------------------*/
00038 
00039 #ifndef SubList_H
00040 #define SubList_H
00041 
00042 #include "List.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class SubList Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 template<class T>
00054 class SubList
00055 :
00056     public UList<T>
00057 {
00058     // Private member functions
00059 
00060         //- Dissalow non-const return subscript-checked element of SubList.
00061         T& operator[](const label);
00062 
00063 
00064 public:
00065 
00066     // Constructors
00067 
00068         //- Construct from UList and SubList size
00069         inline SubList
00070         (
00071             const UList<T>& list,
00072             const label subSize
00073         );
00074 
00075         //- Construct from UList, start and end indices
00076         inline SubList
00077         (
00078             const UList<T>& list,
00079             const label subSize,
00080             const label startIndex
00081         );
00082 
00083 
00084     // Member functions
00085 
00086         //- Return a null SubList
00087         static inline SubList<T>& null();
00088 
00089 
00090     // Member operators
00091 
00092         //- Return const subscript-checked element of SubList.
00093         const T& operator[](const label l) const
00094         {
00095             return UList<T>::operator[](l);
00096         }
00097 
00098         //- Allow cast to a const List<T>&
00099         inline operator const List<T>&() const;
00100 };
00101 
00102 
00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00104 
00105 } // End namespace Foam
00106 
00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00108 
00109 #include "SubListI.H"
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 #endif
00114 
00115 // ************************************************************************* //
For further information go to www.openfoam.org