src/mesh/extrudeModel/wedge/wedge.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::extrudeModels::wedge
  26
  27 Description
  28     Extrudes by rotating a surface around an axis
  29     - extrusion is opposite the surface/patch normal so inwards the source
  30       mesh
  31     - axis direction has to be consistent with this.
  32     - use -mergeFaces option if doing full 360 and want to merge front and back
  33     - note direction of axis. This should be consistent with rotating against
  34       the patch normal direction. If you get it wrong you'll see all cells
  35       with extreme aspect ratio and internal faces wrong way around in
  36       checkMesh
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef wedge_H
  41 #define wedge_H
  42
  43 #include "extrudeModel.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49 namespace extrudeModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                          Class wedge Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class wedge
  57 :
  58     public extrudeModel
  59 {
  60     // Private data
  61
  62         //- Point on axis
  63         const point axisPt_;
  64
  65         //- Normalized direction of axis
  66         const vector axis_;
  67
  68         //- Overall angle (radians)
  69         const scalar angle_;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("wedge");
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         wedge(const dictionary& dict);
  81
  82
  83     //- Destrcuctor
  84     ~wedge();
  85
  86
  87     // Member Operators
  88
  89         point operator()
  90         (
  91             const point& surfacePoint,
  92             const vector& surfaceNormal,
  93             const label layer
  94         ) const;
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace extrudeModels
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //