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

edgeStats.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::edgeStats
00026 
00027 Description
00028     Helper class to calculate minimum edge length on mesh.
00029 
00030 SourceFiles
00031     edgeStats.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef edgeStats_H
00036 #define edgeStats_H
00037 
00038 #include <OpenFOAM/direction.H>
00039 #include <OpenFOAM/scalar.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // Forward declaration of classes
00047 class polyMesh;
00048 class Ostream;
00049 class twoDPointCorrector;
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class edgeStats Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class edgeStats
00056 {
00057     // Private data
00058 
00059         //- Reference to mesh.
00060         const polyMesh& mesh_;
00061 
00062         //- Component (0,1,2) of normal direction or 3 if 3D case.
00063         direction normalDir_;
00064 
00065     // Private Member Functions
00066 
00067         //- If 2d get component of normal dir.
00068         direction getNormalDir(const twoDPointCorrector*) const;
00069         
00070 
00071         //- Disallow default bitwise copy construct
00072         edgeStats(const edgeStats&);
00073 
00074         //- Disallow default bitwise assignment
00075         void operator=(const edgeStats&);
00076 
00077 
00078 public:
00079 
00080     // Static data members
00081 
00082         // Max (cos of) angle for edges to be considered aligned with axis.
00083         static const scalar edgeTol_;
00084 
00085 
00086     // Constructors
00087 
00088         //- Construct from mesh
00089         edgeStats(const polyMesh& mesh);
00090 
00091         //- Construct from mesh and corrector
00092         edgeStats(const polyMesh& mesh, const twoDPointCorrector* );
00093 
00094 
00095     // Member Functions
00096 
00097         //- Calculate minimum edge length and print
00098         scalar minLen(Ostream& os) const;
00099 };
00100 
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 } // End namespace Foam
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 #endif
00109 
00110 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines