src/dynamicMesh/meshCut/refineCell/refineCell.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::refineCell
  27
  28 Description
  29     Container with cells to refine. Refinement given as single direction.
  30
  31 SourceFiles
  32     refineCell.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef refineCell_H
  37 #define refineCell_H
  38
  39 #include "label.H"
  40 #include "vector.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class Istream;
  48 class Ostream;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class refineCell Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class refineCell
  55 {
  56     // Private data
  57
  58     //- Cell label
  59     label cellNo_;
  60
  61     //- Preferred refinement direction (always normalized).
  62     vector direction_;
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Null
  69         refineCell();
  70
  71         //- from components. Vector will be normalized upon construction.
  72         refineCell(const label, const vector&);
  73
  74         //- from Istream. Vector will be normalized upon construction.
  75         refineCell(Istream& is);
  76
  77
  78     // Member Functions
  79
  80         label cellNo() const
  81         {
  82             return cellNo_;
  83         }
  84
  85         const vector& direction() const
  86         {
  87             return direction_;
  88         }
  89
  90
  91     // Friend Operators
  92
  93         inline friend bool operator==
  94         (
  95             const refineCell& rc1,
  96             const refineCell& rc2
  97         )
  98         {
  99             return (rc1.cellNo() == rc2.cellNo());
 100         }
 101
 102         inline friend bool operator!=
 103         (
 104             const refineCell& rc1,
 105             const refineCell& rc2
 106         )
 107         {
 108             return !(rc1 == rc2);
 109         }
 110
 111
 112     // IOstream Operators
 113
 114         friend Ostream& operator<<(Ostream&, const refineCell&);
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //
 127