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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::faceMapper
  26
  27 Description
  28     This object provides mapping and fill-in information for face data
  29     between the two meshes after the topological change.  It is
  30     constructed from mapPolyMesh.
  31
  32 SourceFiles
  33     faceMapper.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef faceMapper_H
  38 #define faceMapper_H
  39
  40 #include "morphFieldMapper.H"
  41 #include "HashSet.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class polyMesh;
  50 class mapPolyMesh;
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class faceMapper Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class faceMapper
  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) faces
  69         bool insertedFaces_;
  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 faces
  87         mutable labelList* insertedFaceLabelsPtr_;
  88
  89
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         faceMapper(const faceMapper&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const faceMapper&);
  97
  98
  99         //- Calculate addressing for mapping with inserted faces
 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         faceMapper(const mapPolyMesh& mpm);
 114
 115
 116     //- Destructor
 117     virtual ~faceMapper();
 118
 119
 120     // Member Functions
 121
 122         //- Return size
 123         virtual label size() const;
 124
 125         //- Return size of field before mapping
 126         virtual label sizeBeforeMapping() const;
 127
 128         //- Return number of internal faces before mapping
 129         virtual label internalSizeBeforeMapping() const;
 130
 131         //- Is the mapping direct
 132         virtual bool direct() const
 133         {
 134             return direct_;
 135         }
 136
 137         //- Return direct addressing
 138         virtual const labelUList& directAddressing() const;
 139
 140         //- Return interpolated addressing
 141         virtual const labelListList& addressing() const;
 142
 143         //- Return interpolaion weights
 144         virtual const scalarListList& weights() const;
 145
 146         //- Return flux flip map
 147         virtual const labelHashSet& flipFaceFlux() const;
 148
 149         //- Return number of old internalFaces
 150         virtual label nOldInternalFaces() const;
 151
 152         //- Return old patch starts
 153         virtual const labelList& oldPatchStarts() const;
 154
 155         //- Return old patch sizes
 156         virtual const labelList& oldPatchSizes() const;
 157
 158         //- Are there any inserted faces
 159         virtual bool insertedObjects() const
 160         {
 161             return insertedFaces_;
 162         }
 163
 164         //- Return list of inserted faces
 165         virtual const labelList& insertedObjectLabels() const;
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #endif
 176
 177 // ************************************************************************* //