Skip to content
Snippets Groups Projects
polyMeshTools.H 3.08 KiB
Newer Older
  • Learn to ignore specific revisions
  • /*---------------------------------------------------------------------------*\
      =========                 |
      \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
       \\    /   O peration     |
        \\  /    A nd           | Copyright (C) 2012 OpenFOAM Foundation
         \\/     M anipulation  |
    -------------------------------------------------------------------------------
    License
        This file is part of OpenFOAM.
    
        OpenFOAM is free software: you can redistribute it and/or modify it
        under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
    
        OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
        FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
        for more details.
    
        You should have received a copy of the GNU General Public License
        along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
    
    Namespace
        Foam::polyMeshTools
    
    Description
        Collection of static functions operating on polyMesh (mainly checks) so
        that need access to patch information.
    
    SourceFiles
        polyMeshTools.C
    
    \*---------------------------------------------------------------------------*/
    #ifndef polyMeshTools_H
    #define polyMeshTools_H
    
    #include "polyMesh.H"
    #include "primitiveMeshTools.H"
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    namespace Foam
    {
    
    /*---------------------------------------------------------------------------*\
                            Namespace polyMeshTools Declaration
    \*---------------------------------------------------------------------------*/
    
    class polyMeshTools
    :
        public primitiveMeshTools
    {
    
    public:
    
        //- Generate orthogonality field. (1 for fully orthogonal, < 1 for
        //  non-orthogonal)
        static tmp<scalarField> faceOrthogonality
        (
            const polyMesh& mesh,
            const vectorField& fAreas,
            const vectorField& cellCtrs
        );
    
    //    static tmp<scalarField> faceOrthogonality(const polyMesh& mesh)
    //    {
    //        return faceOrthogonality
    //        (
    //            mesh,
    //            mesh.faceAreas(),
    //            mesh.cellCentres()
    //        );
    //    }
    
        //- Generate skewness field
        static tmp<scalarField> faceSkewness
        (
            const polyMesh& mesh,
            const pointField& points,
            const vectorField& fCtrs,
            const vectorField& fAreas,
            const vectorField& cellCtrs
        );
    
    //    static tmp<scalarField> faceSkewness(const polyMesh& mesh)
    //    {
    //        return faceSkewness
    //        (
    //            mesh,
    //            mesh.points(),
    //            mesh.faceCentres(),
    //            mesh.faceAreas(),
    //            mesh.cellCentres()
    //        );
    //    }
    
    };
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    } // End namespace Foam
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    #endif
    
    // ************************************************************************* //