src/dynamicMesh/dynamicTopoFvMesh/fieldMapping/topoCellMapper.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     topoCellMapper
  26
  27 Description
  28     This object provides mapping and fill-in information for internal
  29     cell data between the two meshes after topological changes.
  30     It is constructed from mapPolyMesh.
  31
  32 Author
  33     Sandeep Menon
  34     University of Massachusetts Amherst
  35     All rights reserved
  36
  37 SourceFiles
  38     topoCellMapper.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef topoCellMapper_H
  43 #define topoCellMapper_H
  44
  45 #include "topoMapper.H"
  46 #include "morphFieldMapper.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                         Class topoCellMapper Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class topoCellMapper
  58 :
  59     public morphFieldMapper
  60 {
  61     // Private data
  62
  63         //- Reference to polyMesh
  64         const polyMesh& mesh_;
  65
  66         //- Reference to mapPolyMesh
  67         const mapPolyMesh& mpm_;
  68
  69         //- Reference to the topoMapper
  70         const topoMapper& tMapper_;
  71
  72         //- Is the mapping direct
  73         bool direct_;
  74
  75         //- Size before mapping
  76         mutable label sizeBeforeMapping_;
  77
  78     // Demand-driven private data
  79
  80         //- Direct addressing
  81         mutable labelList* directAddrPtr_;
  82
  83         //- Interpolated addressing
  84         mutable labelListList* interpolationAddrPtr_;
  85
  86         //- Inverse-distance weights
  87         mutable scalarListList* weightsPtr_;
  88
  89         //- Inserted cells
  90         mutable labelList* insertedCellLabelsPtr_;
  91
  92         //- Interpolation volumes
  93         mutable List<scalarField>* volumesPtr_;
  94
  95         //- Interpolation centres
  96         mutable List<vectorField>* centresPtr_;
  97
  98     // Private Member Functions
  99
 100         //- Disallow default bitwise copy construct
 101         topoCellMapper(const topoCellMapper&);
 102
 103         //- Disallow default bitwise assignment
 104         void operator=(const topoCellMapper&);
 105
 106         //- Calculate addressing for interpolative mapping
 107         void calcAddressing() const;
 108
 109         //- Calculate inverse-distance weights for interpolative mapping
 110         void calcInverseDistanceWeights() const;
 111
 112         //- Calculate intersection weights for conservative mapping
 113         void calcIntersectionWeightsAndCentres() const;
 114
 115         //- Return intersection volume weights
 116         const List<scalarField>& intersectionWeights() const;
 117
 118         //- Return intersection volume centres
 119         const List<vectorField>& intersectionCentres() const;
 120
 121         //- Clear out local storage
 122         void clearOut();
 123
 124 public:
 125
 126     // Constructors
 127
 128         //- Construct from mapPolyMesh
 129         topoCellMapper
 130         (
 131             const mapPolyMesh& mpm,
 132             const topoMapper& mapper
 133         );
 134
 135     // Destructor
 136
 137         virtual ~topoCellMapper();
 138
 139     // Member Functions
 140
 141         //- Return size
 142         virtual label size() const;
 143
 144         //- Return size before mapping
 145         virtual label sizeBeforeMapping() const;
 146
 147         //- Is the mapping direct
 148         virtual bool direct() const;
 149
 150         //- Return direct addressing
 151         virtual const unallocLabelList& directAddressing() const;
 152
 153         //- Return interpolation addressing
 154         virtual const labelListList& addressing() const;
 155
 156         //- Return weights
 157         virtual const scalarListList& weights() const;
 158
 159         //- Are there any inserted cells
 160         virtual bool insertedObjects() const;
 161
 162         //- Return list of inserted cells
 163         virtual const labelList& insertedObjectLabels() const;
 164
 165         //- Conservatively map the internal field
 166         template <class Type, class gradType>
 167         void mapInternalField
 168         (
 169             const word& fieldName,
 170             const Field<gradType>& gF,
 171             Field<Type>& iF
 172         ) const;
 173 };
 174
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 } // End namespace Foam
 179
 180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 181
 182 #ifdef NoRepository
 183 #   include "topoCellMapperTemplates.C"
 184 #endif
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 #endif
 189
 190 // ************************************************************************* //