src/meshTools/sets/faceSources/normalToFace/normalToFace.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::normalToFace
  27
  28 Description
  29     A topoSetSource to select faces based on normal.
  30
  31 SourceFiles
  32     normalToFace.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef normalToFace_H
  37 #define normalToFace_H
  38
  39 #include "topoSetSource.H"
  40 #include "NamedEnum.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class normalToFace Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class normalToFace
  52 :
  53     public topoSetSource
  54 {
  55
  56 private:
  57
  58         //- Add usage string
  59         static addToUsageTable usage_;
  60
  61         //- (unit)vector to compare to
  62         vector normal_;
  63
  64         //- Tolerance (i.e. cos of angle between normal_ and faceNormal)
  65         const scalar tol_;
  66
  67
  68     // Private Member Functions
  69
  70         //- Normalize normal and check tolerance
  71         void setNormal();
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("normalToFace");
  78
  79     // Constructors
  80
  81         //- Construct from components
  82         normalToFace
  83         (
  84             const polyMesh& mesh,
  85             const vector& normal,
  86             const scalar tol
  87         );
  88
  89         //- Construct from dictionary
  90         normalToFace(const polyMesh& mesh, const dictionary& dict);
  91
  92         //- Construct from Istream
  93         normalToFace(const polyMesh& mesh, Istream&);
  94
  95
  96     // Destructor
  97
  98         virtual ~normalToFace();
  99
 100
 101     // Member Functions
 102
 103         virtual void applyToSet
 104         (
 105             const topoSetSource::setAction action,
 106             topoSet&
 107         ) const;
 108
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //