src/finiteVolume/fvMesh/fvMeshMapper/fvMeshMapper.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::fvMeshMapper
  27
  28 Description
  29     Class holds all the necessary information for mapping fields associated
  30     with fvMesh.
  31 SourceFiles
  32     fvMeshMapper.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fvMeshMapper_H
  37 #define fvMeshMapper_H
  38
  39 #include "faceMapper.H"
  40 #include "cellMapper.H"
  41 #include "fvSurfaceMapper.H"
  42 #include "fvBoundaryMeshMapper.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50 class fvMesh;
  51 class mapPolyMesh;
  52
  53 /*---------------------------------------------------------------------------*\
  54                         Class fvMeshMapper Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class fvMeshMapper
  58 {
  59     // Private data
  60
  61         //- Reference to mesh
  62         const fvMesh& mesh_;
  63
  64         //- Face mapper
  65         faceMapper faceMap_;
  66
  67         //- Cell mapper
  68         cellMapper cellMap_;
  69
  70         //- Surface mapper (needs to be shortened for internal faces only)
  71         fvSurfaceMapper surfaceMap_;
  72
  73         //- Boundary mapper
  74         fvBoundaryMeshMapper boundaryMap_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         fvMeshMapper(const fvMeshMapper&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const fvMeshMapper&);
  84
  85
  86 public:
  87
  88     // Constructors
  89
  90         //- Construct from fvMesh
  91         fvMeshMapper(const fvMesh& mesh, const mapPolyMesh& mpm)
  92         :
  93             mesh_(mesh),
  94             faceMap_(mpm),
  95             cellMap_(mpm),
  96             surfaceMap_(mesh, faceMap_),
  97             boundaryMap_(mesh, faceMap_)
  98         {}
  99
 100
 101     // Member Functions
 102
 103         //- Return reference to mesh
 104         const fvMesh& mesh() const
 105         {
 106             return mesh_;
 107         }
 108
 109         //- Return reference to objectRegistry storing fields. Can be
 110         //  removed once fields stored on pointMesh.
 111         const objectRegistry& thisDb() const
 112         {
 113             return mesh_;
 114         }
 115
 116         //- Return volume mapper
 117         const morphFieldMapper& volMap() const
 118         {
 119             return cellMap_;
 120         }
 121
 122         //- Return surface mapper
 123         const fvSurfaceMapper& surfaceMap() const
 124         {
 125             return surfaceMap_;
 126         }
 127
 128         //- Return boundary mapper
 129         const fvBoundaryMeshMapper& boundaryMap() const
 130         {
 131             return boundaryMap_;
 132         }
 133 };
 134
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 } // End namespace Foam
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #endif
 143
 144 // ************************************************************************* //