src/finiteVolume/fvMesh/fvMeshMapper/fvSurfaceMapper.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::fvSurfaceMapper
  27
  28 Description
  29     FV surface mapper.
  30
  31 SourceFiles
  32     fvSurfaceMapper.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fvSurfaceMapper_H
  37 #define fvSurfaceMapper_H
  38
  39 #include "morphFieldMapper.H"
  40 #include "fvMesh.H"
  41 #include "faceMapper.H"
  42 #include "HashSet.H"
  43 #include "mapPolyMesh.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of classes
  51
  52 /*---------------------------------------------------------------------------*\
  53                          Class fvSurfaceMapper Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class fvSurfaceMapper
  57 :
  58     public morphFieldMapper
  59 {
  60     // Private data
  61
  62         //- Reference to mesh
  63         const fvMesh& mesh_;
  64
  65         //- Reference to face mapper
  66         const faceMapper& faceMap_;
  67
  68
  69     // Demand-driven private data
  70
  71         //- Direct addressing (only one for of addressing is used)
  72         mutable labelList* directAddrPtr_;
  73
  74         //- Interpolated addressing (only one for of addressing is used)
  75         mutable labelListList* interpolationAddrPtr_;
  76
  77         //- Interpolation weights
  78         mutable scalarListList* weightsPtr_;
  79
  80         //- Inserted faces
  81         mutable labelList* insertedObjectLabelsPtr_;
  82
  83
  84
  85     // Private Member Functions
  86
  87         //- Disallow default bitwise copy construct
  88         fvSurfaceMapper(const fvSurfaceMapper&);
  89
  90         //- Disallow default bitwise assignment
  91         void operator=(const fvSurfaceMapper&);
  92
  93
  94         //- Calculate addressing
  95         void calcAddressing() const;
  96
  97         //- Clear out local storage
  98         void clearOut();
  99
 100
 101 public:
 102
 103     // Constructors
 104
 105         //- Construct from components
 106         fvSurfaceMapper
 107         (
 108             const fvMesh& mesh,
 109             const faceMapper& fMapper
 110         );
 111
 112
 113     // Destructor
 114
 115         virtual ~fvSurfaceMapper();
 116
 117
 118     // Member Functions
 119
 120         //- Return size
 121         virtual label size() const
 122         {
 123             return mesh_.nInternalFaces();
 124         }
 125
 126         //- Return size of field before mapping
 127         virtual label sizeBeforeMapping() const
 128         {
 129             return faceMap_.internalSizeBeforeMapping();
 130         }
 131
 132         //- Is the mapping direct
 133         virtual bool direct() const
 134         {
 135             return faceMap_.direct();
 136         }
 137
 138         //- Return direct addressing
 139         virtual const unallocLabelList& directAddressing() const;
 140
 141         //- Return interpolated addressing
 142         virtual const labelListList& addressing() const;
 143
 144         //- Return interpolaion weights
 145         virtual const scalarListList& weights() const;
 146
 147         //- Are there any inserted faces
 148         virtual bool insertedObjects() const
 149         {
 150             return faceMap_.insertedObjects();
 151         }
 152
 153         //- Return list of inserted faces
 154         virtual const labelList& insertedObjectLabels() const;
 155
 156         //- Return flux flip map
 157         const labelHashSet& flipFaceFlux() const
 158         {
 159             return faceMap_.flipFaceFlux();
 160         }
 161 };
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 } // End namespace Foam
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #endif
 171
 172 // ************************************************************************* //