src/OpenFOAM/containers/Lists/SubList/SubList.H

   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.
  10
  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.
  15
  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.
  20
  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
  24
  25 Class
  26     Foam::SubList
  27
  28 Description
  29     A List obtained as a section of another List.
  30
  31     Since the SubList is itself unallocated, no storage is allocated or
  32     de-allocated during its use.  To achieve this behaviour, SubList is
  33     derived from UList rather than List.
  34
  35 SourceFiles
  36     SubListI.H
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef SubList_H
  41 #define SubList_H
  42
  43 #include "List.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class SubList Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class T>
  55 class SubList
  56 :
  57     public UList<T>
  58 {
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct from UList and SubList size
  65         inline SubList
  66         (
  67             const UList<T>& list,
  68             const label subSize
  69         );
  70
  71         //- Construct from UList, start and end indices
  72         inline SubList
  73         (
  74             const UList<T>& list,
  75             const label subSize,
  76             const label startIndex
  77         );
  78
  79
  80     // Member functions
  81
  82         //- Return a null SubList
  83         static inline const SubList<T>& null();
  84
  85
  86     // Member operators
  87
  88         //- Allow cast to a const List<T>&
  89         inline operator const Foam::List<T>&() const;
  90 };
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace Foam
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 #include "SubListI.H"
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #endif
 104
 105 // ************************************************************************* //