FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::normalToFace
00026 
00027 Description
00028     A topoSetSource to select faces based on normal.
00029 
00030 SourceFiles
00031     normalToFace.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef normalToFace_H
00036 #define normalToFace_H
00037 
00038 #include <meshTools/topoSetSource.H>
00039 #include <OpenFOAM/NamedEnum.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                        Class normalToFace Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class normalToFace
00051 :
00052     public topoSetSource
00053 {
00054 
00055 private:
00056 
00057         //- Add usage string
00058         static addToUsageTable usage_;
00059 
00060         //- (unit)vector to compare to
00061         vector normal_;
00062 
00063         //- Tolerance (i.e. cos of angle between normal_ and faceNormal)
00064         const scalar tol_;
00065 
00066 
00067     // Private Member Functions
00068 
00069         //- Normalize normal and check tolerance
00070         void setNormal();
00071 
00072 
00073 public:
00074 
00075     //- Runtime type information
00076     TypeName("normalToFace");
00077 
00078     // Constructors
00079 
00080         //- Construct from components
00081         normalToFace
00082         (
00083             const polyMesh& mesh,
00084             const vector& normal,
00085             const scalar tol
00086         );
00087 
00088         //- Construct from dictionary
00089         normalToFace(const polyMesh& mesh, const dictionary& dict);
00090 
00091         //- Construct from Istream
00092         normalToFace(const polyMesh& mesh, Istream&);
00093 
00094 
00095     // Destructor
00096 
00097         virtual ~normalToFace();
00098 
00099 
00100     // Member Functions
00101 
00102         virtual void applyToSet
00103         (
00104             const topoSetSource::setAction action,
00105             topoSet&
00106         ) const;
00107 
00108 };
00109 
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 } // End namespace Foam
00114 
00115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00116 
00117 #endif
00118 
00119 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines