GeoMesh.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011 OpenFOAM Foundation
-------------------------------------------------------------------------------
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/>.
 
Class
    Foam::GeoMesh
 
Description
    Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
 
    Derived classes are typically expected to implement the static methods
    size() and boundary_size().
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_GeoMesh_H
#define Foam_GeoMesh_H
 
#include "objectRegistry.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                           Class GeoMesh Declaration
\*---------------------------------------------------------------------------*/
 
template<class MESH>
class GeoMesh
{
protected:
 
    // Protected Data
 
        //- Reference to Mesh
        const MESH& mesh_;
 
 
public:
 
    // Public Typedefs
 
        typedef MESH Mesh;
        typedef typename MESH::BoundaryMesh BoundaryMesh;
 
 
    // Constructors
 
        //- Construct from mesh reference
        explicit GeoMesh(const MESH& mesh)
        :
            mesh_(mesh)
        {}
 
 
    // Member Functions
 
        //- Return true if thisDb() is a valid DB - here = false
        bool hasDb() const
        {
            return true;
        }
 
        //- Return the object registry
        const objectRegistry& thisDb() const
        {
            return mesh_;
        }
 
 
    // Member Operators
 
        //- Return reference to the underlying mesh
        const MESH& operator()() const
        {
            return mesh_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //