applications/utilities/mesh/advanced/selectCells/edgeStats.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::edgeStats
  27
  28 Description
  29     Helper class to calculate minimum edge length on mesh.
  30
  31 SourceFiles
  32     edgeStats.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef edgeStats_H
  37 #define edgeStats_H
  38
  39 #include "direction.H"
  40 #include "scalar.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class polyMesh;
  49 class Ostream;
  50 class twoDPointCorrector;
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class edgeStats Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class edgeStats
  57 {
  58     // Private data
  59
  60         //- Reference to mesh.
  61         const polyMesh& mesh_;
  62
  63         //- Component (0,1,2) of normal direction or 3 if 3D case.
  64         direction normalDir_;
  65
  66     // Private Member Functions
  67
  68         //- If 2d get component of normal dir.
  69         direction getNormalDir(const twoDPointCorrector*) const;
  70
  71
  72         //- Disallow default bitwise copy construct
  73         edgeStats(const edgeStats&);
  74
  75         //- Disallow default bitwise assignment
  76         void operator=(const edgeStats&);
  77
  78
  79 public:
  80
  81     // Static data members
  82
  83         // Max (cos of) angle for edges to be considered aligned with axis.
  84         static const scalar edgeTol_;
  85
  86
  87     // Constructors
  88
  89         //- Construct from mesh
  90         edgeStats(const polyMesh& mesh);
  91
  92         //- Construct from mesh and corrector
  93         edgeStats(const polyMesh& mesh, const twoDPointCorrector* );
  94
  95
  96     // Member Functions
  97
  98         //- Calculate minimum edge length and print
  99         scalar minLen(Ostream& os) const;
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //