applications/test/IndirectList/IndirectList.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::IndirectList
  27
  28 Description
  29
  30 SourceFiles
  31     IndirectListI.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef IndirectList_H
  36 #define IndirectList_H
  37
  38 #include "List.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class IndirectList Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class T>
  50 class IndirectList
  51 {
  52     // Private data
  53
  54         const UList<T>& completeList_;
  55         List<label> addresses_;
  56
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise assignment
  61         void operator=(const IndirectList<T>&);
  62
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Construct given the complete list and the addressing array
  69         inline IndirectList(const UList<T>&, const List<label>&);
  70
  71
  72     // Member Functions
  73
  74         // Access
  75
  76             inline label size() const;
  77             inline const UList<T>& completeList() const;
  78             inline const List<label>& addresses() const;
  79
  80
  81         // Member Operators
  82
  83             //- Return const access to an element
  84             inline const T& operator[](const label) const;
  85 };
  86
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 } // End namespace Foam
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #include "IndirectListI.H"
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //