src/dynamicMesh/dynamicFvMesh/dynamicTopoFvMesh/fieldMapping/topoCellMapper.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     topoCellMapper
  27
  28 Description
  29     This object provides mapping and fill-in information for internal
  30     cell data between the two meshes after topological changes.
  31     It is constructed from mapPolyMesh.
  32
  33 Author
  34     Sandeep Menon
  35     University of Massachusetts Amherst
  36     All rights reserved
  37
  38 SourceFiles
  39     topoCellMapper.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef topoCellMapper_H
  44 #define topoCellMapper_H
  45
  46 #include "topoMapper.H"
  47 #include "morphFieldMapper.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                         Class topoCellMapper Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class topoCellMapper
  59 :
  60     public morphFieldMapper
  61 {
  62     // Private data
  63
  64         //- Reference to polyMesh
  65         const polyMesh& mesh_;
  66
  67         //- Reference to mapPolyMesh
  68         const mapPolyMesh& mpm_;
  69
  70         //- Reference to the topoMapper
  71         const topoMapper& tMapper_;
  72
  73         //- Is the mapping direct
  74         bool direct_;
  75
  76         //- Size before mapping
  77         mutable label sizeBeforeMapping_;
  78
  79     // Demand-driven private data
  80
  81         //- Direct addressing
  82         mutable labelList* directAddrPtr_;
  83
  84         //- Interpolated addressing
  85         mutable labelListList* interpolationAddrPtr_;
  86
  87         //- Inverse-distance weights
  88         mutable scalarListList* weightsPtr_;
  89
  90         //- Inserted cells
  91         mutable labelList* insertedCellLabelsPtr_;
  92
  93         //- Interpolation volumes
  94         mutable List<scalarField>* volumesPtr_;
  95
  96         //- Interpolation centres
  97         mutable List<vectorField>* centresPtr_;
  98
  99     // Private Member Functions
 100
 101         //- Disallow default bitwise copy construct
 102         topoCellMapper(const topoCellMapper&);
 103
 104         //- Disallow default bitwise assignment
 105         void operator=(const topoCellMapper&);
 106
 107         //- Calculate addressing for interpolative mapping
 108         void calcAddressing() const;
 109
 110         //- Calculate inverse-distance weights for interpolative mapping
 111         void calcInverseDistanceWeights() const;
 112
 113         //- Calculate intersection weights for conservative mapping
 114         void calcIntersectionWeightsAndCentres() const;
 115
 116         //- Return intersection volume weights
 117         const List<scalarField>& intersectionWeights() const;
 118
 119         //- Return intersection volume centres
 120         const List<vectorField>& intersectionCentres() const;
 121
 122         //- Clear out local storage
 123         void clearOut();
 124
 125 public:
 126
 127     // Constructors
 128
 129         //- Construct from mapPolyMesh
 130         topoCellMapper
 131         (
 132             const mapPolyMesh& mpm,
 133             const topoMapper& mapper
 134         );
 135
 136     // Destructor
 137
 138         virtual ~topoCellMapper();
 139
 140     // Member Functions
 141
 142         //- Return size
 143         virtual label size() const;
 144
 145         //- Return size before mapping
 146         virtual label sizeBeforeMapping() const;
 147
 148         //- Is the mapping direct
 149         virtual bool direct() const;
 150
 151         //- Return direct addressing
 152         virtual const unallocLabelList& directAddressing() const;
 153
 154         //- Return interpolation addressing
 155         virtual const labelListList& addressing() const;
 156
 157         //- Return weights
 158         virtual const scalarListList& weights() const;
 159
 160         //- Are there any inserted cells
 161         virtual bool insertedObjects() const;
 162
 163         //- Return list of inserted cells
 164         virtual const labelList& insertedObjectLabels() const;
 165
 166         //- Conservatively map the internal field
 167         template <class Type, class gradType>
 168         void mapInternalField
 169         (
 170             const word& fieldName,
 171             const Field<gradType>& gF,
 172             Field<Type>& iF
 173         ) const;
 174 };
 175
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 } // End namespace Foam
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 #ifdef NoRepository
 184 #   include "topoCellMapperTemplates.C"
 185 #endif
 186
 187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 188
 189 #endif
 190
 191 // ************************************************************************* //