src/triSurface/tools/labelledTri/sortLabelledTri.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::sortLabelledTri
  27
  28 Description
  29     Helper class which when constructed with a triSurface
  30     sorts the faces according to region number (or rather constructs a
  31     mapping).
  32
  33 SourceFiles
  34     sortLabelledTri.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef sortLabelledTri_H
  39 #define sortLabelledTri_H
  40
  41 #include "labelList.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class sortLabelledTri;
  49 class triSurface;
  50
  51 /*---------------------------------------------------------------------------*\
  52                          Class surfAndLabel Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 //- Hold surface and label
  56 class surfAndLabel
  57 {
  58     const triSurface* surfPtr_;
  59
  60     label index_;
  61
  62     // Private Classes
  63
  64         //- scalar comparison function used for sorting
  65         class less
  66         {
  67         public:
  68
  69             inline bool operator()
  70             (
  71                 const surfAndLabel& one,
  72                 const surfAndLabel& two
  73             ) const;
  74         };
  75
  76
  77 public:
  78
  79     friend class sortLabelledTri;
  80
  81     // Constructors
  82
  83         //- Construct null
  84         surfAndLabel()
  85         :
  86             surfPtr_(NULL),
  87             index_(-1)
  88         {}
  89
  90         //- Construct from surface and index
  91         surfAndLabel(const triSurface& surf, const label index)
  92         :
  93             surfPtr_(&surf),
  94             index_(index)
  95         {}
  96 };
  97
  98
  99 /*---------------------------------------------------------------------------*\
 100                            Class sortLabelledTri Declaration
 101 \*---------------------------------------------------------------------------*/
 102
 103 class sortLabelledTri
 104 :
 105     public List<surfAndLabel>
 106 {
 107
 108 public:
 109
 110     // Constructors
 111
 112         //- Construct from surface, sorting the faces according to patch
 113         sortLabelledTri(const triSurface&);
 114
 115
 116     // Member Functions
 117
 118         // Access
 119
 120             //- Set the labelList to those of sorted point indices
 121             void indices(labelList&) const;
 122
 123             //- Return the list of sorted point indices
 124             labelList indices() const;
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //