src/OpenFOAM/meshes/polyMesh/mapPolyMesh/cellMapper/cellMapper.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::cellMapper
  27
  28 Description
  29     This object provides mapping and fill-in information for cell data
  30     between the two meshes after the topological change.  It is
  31     constructed from mapPolyMesh.
  32
  33 SourceFiles
  34     cellMapper.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef cellMapper_H
  39 #define cellMapper_H
  40
  41 #include "morphFieldMapper.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class polyMesh;
  50 class mapPolyMesh;
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class cellMapper Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class cellMapper
  57 :
  58     public morphFieldMapper
  59 {
  60     // Private data
  61
  62         //- Reference to polyMesh
  63         const polyMesh& mesh_;
  64
  65         //- Reference to mapPolyMesh
  66         const mapPolyMesh& mpm_;
  67
  68         //- Are there any inserted (unmapped) cells
  69         bool insertedCells_;
  70
  71         //- Is the mapping direct
  72         bool direct_;
  73
  74
  75     // Demand-driven private data
  76
  77         //- Direct addressing (only one for of addressing is used)
  78         mutable labelList* directAddrPtr_;
  79
  80         //- Interpolated addressing (only one for of addressing is used)
  81         mutable labelListList* interpolationAddrPtr_;
  82
  83         //- Interpolation weights
  84         mutable scalarListList* weightsPtr_;
  85
  86         //- Inserted cells
  87         mutable labelList* insertedCellLabelsPtr_;
  88
  89
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         cellMapper(const cellMapper&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const cellMapper&);
  97
  98
  99         //- Calculate addressing for mapping with inserted cells
 100         void calcAddressing() const;
 101
 102         //- Clear out local storage
 103         void clearOut();
 104
 105
 106 public:
 107
 108     // Static data members
 109
 110     // Constructors
 111
 112         //- Construct from mapPolyMesh
 113         cellMapper(const mapPolyMesh& mpm);
 114
 115
 116     // Destructor
 117
 118         virtual ~cellMapper();
 119
 120
 121     // Member Functions
 122
 123         //- Return size
 124         virtual label size() const;
 125
 126         //- Return size before mapping
 127         virtual label sizeBeforeMapping() const;
 128
 129         //- Is the mapping direct
 130         virtual bool direct() const
 131         {
 132             return direct_;
 133         }
 134
 135         //- Return direct addressing
 136         virtual const unallocLabelList& directAddressing() const;
 137
 138         //- Return interpolated addressing
 139         virtual const labelListList& addressing() const;
 140
 141         //- Return interpolaion weights
 142         virtual const scalarListList& weights() const;
 143
 144         //- Are there any inserted cells
 145         bool insertedObjects() const
 146         {
 147             return insertedCells_;
 148         }
 149
 150         //- Return list of inserted cells
 151         const labelList& insertedObjectLabels() const;
 152 };
 153
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 } // End namespace Foam
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 #endif
 162
 163 // ************************************************************************* //