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

faceToCellStencil.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::faceToCellStencil
00026 
00027 Description
00028     baseclass for extended cell centred addressing. Contains per cell a
00029     list of neighbouring faces in global addressing.
00030 
00031 SourceFiles
00032     faceToCellStencil.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef faceToCellStencil_H
00037 #define faceToCellStencil_H
00038 
00039 #include <OpenFOAM/globalIndex.H>
00040 #include <OpenFOAM/boolList.H>
00041 #include <OpenFOAM/HashSet.H>
00042 #include <OpenFOAM/indirectPrimitivePatch.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 class polyMesh;
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class faceToCellStencil Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class faceToCellStencil
00056 :
00057     public labelListList
00058 {
00059     // Private data
00060 
00061         const polyMesh& mesh_;
00062 
00063         //- Global numbering for faces
00064         const globalIndex globalNumbering_;
00065 
00066 
00067     // Private Member Functions
00068 
00069         //- Disallow default bitwise copy construct
00070         faceToCellStencil(const faceToCellStencil&);
00071 
00072         //- Disallow default bitwise assignment
00073         void operator=(const faceToCellStencil&);
00074 
00075 public:
00076 
00077     // Constructors
00078 
00079         //- Construct from mesh
00080         explicit faceToCellStencil(const polyMesh&);
00081 
00082 
00083     // Member Functions
00084 
00085         const polyMesh& mesh() const
00086         {
00087             return mesh_;
00088         }
00089 
00090         //- Global numbering for faces
00091         const globalIndex& globalNumbering() const
00092         {
00093             return globalNumbering_;
00094         }
00095 
00096         //- Work-around for C++ Standard Core Language Defect 391
00097         const faceToCellStencil& by_ref() const
00098         {
00099             return *this;
00100         }
00101 
00102 };
00103 
00104 
00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00106 
00107 } // End namespace Foam
00108 
00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00110 
00111 #endif
00112 
00113 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines