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