src/mesh/cfMesh/utilities/triSurfaceTools/triSurfaceMetaData/triSurfaceMetaData.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     cfMesh 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 cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     triSurfaceMetaData
  26
  27 Description
  28     Generates meta data of the surface mesh. It contains:
  29     The number of points
  30     The number of triangles
  31     The number of patches
  32     The number of feature edges
  33     The number of subsets, names, and the number of elements in each subset
  34
  35 SourceFiles
  36     triSurfaceMetaData.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef triSurfaceMetaData_H
  41 #define triSurfaceMetaData_H
  42
  43 #include "triSurf.H"
  44 #include "dictionary.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                 Class triSurfaceMetaData Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class triSurfaceMetaData
  56 {
  57     // Private data
  58         //- const reference to triSurf
  59         const triSurf& surf_;
  60
  61         //- patches/subsets for removal
  62         dictionary metaDict_;
  63
  64     // Private member functions
  65         //- create dictionary with meta data
  66         void createMetaData();
  67
  68         //- Disallow default bitwise copy construct
  69         triSurfaceMetaData(const triSurfaceMetaData&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const triSurfaceMetaData&);
  73
  74 public:
  75
  76     // Constructors
  77
  78         //- Construct from triSurf
  79         triSurfaceMetaData(const triSurf& surface);
  80
  81     // Destructor
  82
  83         ~triSurfaceMetaData();
  84
  85
  86     // Member Functions
  87
  88         //- return a constant reference to meta data
  89         const dictionary& metaData() const
  90         {
  91             return metaDict_;
  92         }
  93 };
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //