src/sampling/sampledSurface/thresholdCellFaces/thresholdCellFaces.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::thresholdCellFaces
  27
  28 Description
  29     Selects the mesh cell faces specified by a threshold value.
  30     Non-triangulated by default.
  31
  32 SourceFiles
  33     thresholdCellFaces.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef thresholdCellFaces_H
  38 #define thresholdCellFaces_H
  39
  40 #include "MeshedSurface.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class polyMesh;
  48
  49 /*---------------------------------------------------------------------------*\
  50                        Class thresholdCellFaces Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class thresholdCellFaces
  54 :
  55     public MeshedSurface<face>
  56 {
  57     //- Private typedefs for convenience
  58         typedef MeshedSurface<face> MeshStorage;
  59
  60         //- Reference to mesh
  61         const polyMesh& mesh_;
  62
  63         //- For every face the original cell in mesh
  64         labelList meshCells_;
  65
  66     // Private Member Functions
  67
  68         void calculate
  69         (
  70             const scalarField&,
  71             const scalar lowerThreshold,
  72             const scalar upperThreshold,
  73             const bool triangulate
  74         );
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("thresholdCellFaces");
  80
  81
  82     // Constructors
  83
  84         //- Construct from mesh, field and threshold value
  85         thresholdCellFaces
  86         (
  87             const polyMesh&,
  88             const scalarField&,
  89             const scalar lowerThreshold,
  90             const scalar upperThreshold,
  91             const bool triangulate = false
  92         );
  93
  94
  95     // Member Functions
  96
  97         //- For every face original cell in mesh
  98         labelList& meshCells()
  99         {
 100             return meshCells_;
 101         }
 102
 103         //- For every face original cell in mesh
 104         const labelList& meshCells() const
 105         {
 106             return meshCells_;
 107         }
 108
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #endif
 122
 123 // ************************************************************************* //