src/OpenFOAM/meshes/pointMesh/pointMeshMapper/pointMeshMapper.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::pointMeshMapper
  27
  28 Description
  29     Class holds all the necessary information for mapping fields associated
  30     with pointMesh.
  31
  32 SourceFiles
  33     pointMeshMapper.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef pointMeshMapper_H
  38 #define pointMeshMapper_H
  39
  40 #include "pointMapper.H"
  41 #include "pointBoundaryMeshMapper.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class pointMesh;
  50 class mapPolyMesh;
  51
  52 /*---------------------------------------------------------------------------*\
  53                         Class pointMeshMapper Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class pointMeshMapper
  57 {
  58     // Private data
  59
  60         //- Reference to mesh
  61         const pointMesh& mesh_;
  62
  63         //- Point mapper
  64         pointMapper pointMap_;
  65
  66         //- Boundary mapper
  67         pointBoundaryMeshMapper boundaryMap_;
  68
  69
  70     // Private Member Functions
  71
  72         //- Disallow default bitwise copy construct
  73         pointMeshMapper(const pointMeshMapper&);
  74
  75         //- Disallow default bitwise assignment
  76         void operator=(const pointMeshMapper&);
  77
  78
  79 public:
  80
  81     // Constructors
  82
  83         //- Construct from pointMesh
  84         pointMeshMapper(const pointMesh& mesh, const mapPolyMesh& mpm)
  85         :
  86             mesh_(mesh),
  87             pointMap_(mpm),
  88             boundaryMap_(mesh, pointMap_, mpm)
  89         {}
  90
  91
  92     // Member Functions
  93
  94
  95         //- Return reference to mesh fields belong to
  96         const pointMesh& mesh() const
  97         {
  98             return mesh_;
  99         }
 100
 101         //- Return reference to objectRegistry storing fields. Can be
 102         //  removed once fields stored on pointMesh.
 103         const objectRegistry& thisDb() const
 104         {
 105             return mesh_();
 106         }
 107
 108         //- Return point mapper
 109         const morphFieldMapper& pointMap() const
 110         {
 111             return pointMap_;
 112         }
 113
 114         //- Return boundary mapper
 115         const pointBoundaryMeshMapper& boundaryMap() const
 116         {
 117             return boundaryMap_;
 118         }
 119 };
 120
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 } // End namespace Foam
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //