OpenFOAM logo
Open Source CFD Toolkit

normalToFace.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     normalToFace
00027 
00028 Description
00029     TopoSetSource. Select faces based on normal.
00030 
00031 SourceFiles
00032     normalToFace.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef normalToFace_H
00037 #define normalToFace_H
00038 
00039 #include "topoSetSource.H"
00040 #include "NamedEnum.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class normalToFace Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class normalToFace
00052 :
00053     public topoSetSource
00054 {
00055 
00056 private:
00057 
00058         //- Add usage string
00059         static addToUsageTable usage_;
00060 
00061         //- (unit)vector to compare to
00062         vector normal_;
00063 
00064         //- Tolerance (i.e. cos of angle between normal_ and faceNormal)
00065         const scalar tol_;
00066 
00067 
00068     // Private Member Functions
00069 
00070         //- Normalize normal and check tolerance
00071         void setNormal();
00072 
00073 
00074 public:
00075 
00076     //- Runtime type information
00077     TypeName("normalToFace");
00078 
00079     // Constructors
00080 
00081         //- Construct from components
00082         normalToFace
00083         (
00084             const polyMesh& mesh,
00085             const vector& normal,
00086             const scalar tol
00087         );
00088 
00089         //- Construct from dictionary
00090         normalToFace(const polyMesh& mesh, const dictionary& dict);
00091 
00092         //- Construct from Istream
00093         normalToFace(const polyMesh& mesh, Istream&);
00094 
00095 
00096     // Destructor
00097 
00098         virtual ~normalToFace();
00099 
00100 
00101     // Member Functions
00102 
00103         virtual void applyToSet(const topoSetSource::setAction action, topoSet&)
00104          const;
00105 
00106 };
00107 
00108 
00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00110 
00111 } // End namespace Foam
00112 
00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00114 
00115 #endif
00116 
00117 // ************************************************************************* //
For further information go to www.openfoam.org