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::SubList 00026 00027 Description 00028 A List obtained as a section of another List. 00029 00030 Since the SubList is itself unallocated, no storage is allocated or 00031 de-allocated during its use. To achieve this behaviour, SubList is 00032 derived from UList rather than List. 00033 00034 SourceFiles 00035 SubListI.H 00036 00037 \*---------------------------------------------------------------------------*/ 00038 00039 #ifndef SubList_H 00040 #define SubList_H 00041 00042 #include <OpenFOAM/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 00059 public: 00060 00061 // Static Member Functions 00062 00063 //- Return a null SubList 00064 inline static const SubList<T>& null(); 00065 00066 00067 // Constructors 00068 00069 //- Construct from UList and sub-list size 00070 inline SubList 00071 ( 00072 const UList<T>& list, 00073 const label subSize 00074 ); 00075 00076 //- Construct from UList, sub-list size and start index 00077 inline SubList 00078 ( 00079 const UList<T>& list, 00080 const label subSize, 00081 const label startIndex 00082 ); 00083 00084 00085 // Member operators 00086 00087 //- Allow cast to a const List<T>& 00088 inline operator const Foam::List<T>&() const; 00089 00090 //- Assignment of all entries to the given value 00091 inline void operator=(const T&); 00092 }; 00093 00094 00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00096 00097 } // End namespace Foam 00098 00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00100 00101 #include <OpenFOAM/SubListI.H> 00102 00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00104 00105 #endif 00106 00107 // ************************ vim: set sw=4 sts=4 et: ************************ //
