src/dynamicMesh/dynamicTopoFvMesh/fieldMapping/topoMapper.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     topoMapper
  26
  27 Description
  28     Class holds all necessary information for mapping fields associated with
  29     dynamicTopoFvMesh and fvMesh.
  30
  31 Author
  32     Sandeep Menon
  33     University of Massachusetts Amherst
  34     All rights reserved
  35
  36 SourceFiles
  37     topoMapper.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef topoMapper_H
  42 #define topoMapper_H
  43
  44 #include "Tuple2.H"
  45 #include "autoPtr.H"
  46 #include "PtrList.H"
  47 #include "IOmanip.H"
  48 #include "volFields.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 // Class forward declarations
  56 class fluxCorrector;
  57 class topoCellMapper;
  58 class topoSurfaceMapper;
  59 class topoBoundaryMeshMapper;
  60
  61 /*---------------------------------------------------------------------------*\
  62                          Class topoMapper Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 class topoMapper
  66 {
  67     // Private typedefs
  68
  69         typedef Tuple2<word, label> GradientMap;
  70         typedef HashTable<GradientMap> GradientTable;
  71
  72     // Private data
  73
  74         //- Reference to fvMesh
  75         const fvMesh& mesh_;
  76
  77         //- Reference to the options dictionary
  78         const dictionary& dict_;
  79
  80     // Demand-driven private data
  81
  82         //- Cell mapper
  83         mutable autoPtr<topoCellMapper> cellMap_;
  84
  85         //- Surface mapper
  86         mutable autoPtr<topoSurfaceMapper> surfaceMap_;
  87
  88         //- Boundary mapper
  89         mutable autoPtr<topoBoundaryMeshMapper> boundaryMap_;
  90
  91         //- Flux corrector
  92         mutable autoPtr<fluxCorrector> fluxCorrector_;
  93
  94         // Index map for gradients
  95         mutable GradientTable gradTable_;
  96
  97         // Stored gradients for mapping
  98         mutable PtrList<volVectorField> sGradPtrs_;
  99         mutable PtrList<volTensorField> vGradPtrs_;
 100
 101         //- Geometric information on the old mesh
 102         mutable scalarField* cellVolumesPtr_;
 103         mutable volVectorField* cellCentresPtr_;
 104
 105         //- Intersection weights
 106         mutable List<scalarField> faceWeights_;
 107         mutable List<scalarField> cellWeights_;
 108
 109         //- Intersection centres
 110         mutable List<vectorField> faceCentres_;
 111         mutable List<vectorField> cellCentres_;
 112
 113         //- Sizes / starts for mapping
 114         mutable labelList cellSizes_;
 115         mutable labelList cellStarts_;
 116         mutable labelList faceSizes_;
 117         mutable labelList faceStarts_;
 118         mutable labelListList patchSizes_;
 119         mutable labelListList patchStarts_;
 120
 121     // Private Member Functions
 122
 123         //- Disallow default bitwise copy construct
 124         topoMapper(const topoMapper&);
 125
 126         //- Disallow default bitwise assignment
 127         void operator=(const topoMapper&);
 128
 129         // Store gradients of volFields on the mesh
 130         // prior to topology changes
 131         template <class Type, class gradType>
 132         void storeGradients
 133         (
 134             GradientTable& gradTable,
 135             PtrList<gradType>& gradList
 136         ) const;
 137
 138         //- Store gradients prior to mesh reset
 139         void storeGradients() const;
 140
 141         //- Set geometric information
 142         void storeGeometry() const;
 143
 144 public:
 145
 146     // Constructors
 147
 148         //- Construct from mesh and dictionary
 149         topoMapper(const fvMesh& mesh, const dictionary& dict);
 150
 151     // Destructor
 152
 153         ~topoMapper();
 154
 155     // Member Functions
 156
 157         //- Return reference to the mesh
 158         const fvMesh& mesh() const;
 159
 160         //- Return reference to objectRegistry storing fields.
 161         const objectRegistry& thisDb() const;
 162
 163         //- Set mapping information
 164         void setMapper(const mapPolyMesh& mpm) const;
 165
 166         //- Set face weighting information
 167         void setFaceWeights
 168         (
 169             const Xfer<List<scalarField> >& weights,
 170             const Xfer<List<vectorField> >& centres
 171         ) const;
 172
 173         //- Set cell weighting information
 174         void setCellWeights
 175         (
 176             const Xfer<List<scalarField> >& weights,
 177             const Xfer<List<vectorField> >& centres
 178         ) const;
 179
 180         //- Set cell / patch offset information
 181         void setOffsets
 182         (
 183             const labelList& cellSizes,
 184             const labelList& cellStarts,
 185             const labelList& faceSizes,
 186             const labelList& faceStarts,
 187             const labelListList& patchSizes,
 188             const labelListList& patchStarts
 189         ) const;
 190
 191         //- Fetch face weights
 192         const List<scalarField>& faceWeights() const;
 193
 194         //- Fetch cell weights
 195         const List<scalarField>& cellWeights() const;
 196
 197         //- Fetch face centres
 198         const List<vectorField>& faceCentres() const;
 199
 200         //- Fetch cell centres
 201         const List<vectorField>& cellCentres() const;
 202
 203         //- Fetch cell sizes
 204         const labelList& cellSizes() const;
 205
 206         //- Fetch face sizes
 207         const labelList& faceSizes() const;
 208
 209         //- Fetch patch sizes
 210         const labelListList& patchSizes() const;
 211
 212         //- Fetch cell starts
 213         const labelList& cellStarts() const;
 214
 215         //- Fetch face starts
 216         const labelList& faceStarts() const;
 217
 218         //- Fetch patch starts
 219         const labelListList& patchStarts() const;
 220
 221         //- Store mesh information for the mapping stage
 222         void storeMeshInformation() const;
 223
 224         //- Deregister gradient fields and centres,
 225         //  but retain for mapping
 226         void deregisterMeshInformation() const;
 227
 228         //- Return non-const access to cell centres
 229         volVectorField& volCentres() const;
 230
 231         //- Return non-const access to cell volumes
 232         scalarField& internalVolumes() const;
 233
 234         //- Return stored cell centre information
 235         const vectorField& internalCentres() const;
 236
 237         //- Return stored patch centre information
 238         const vectorField& patchCentres(const label i) const;
 239
 240         //- Return names of stored gradients
 241         const wordList gradientTable() const;
 242
 243         //- Fetch the gradient field
 244         template <class Type>
 245         Type& gradient(const word& name) const;
 246
 247         //- Correct fluxes after topology change
 248         void correctFluxes() const;
 249
 250         //- Return volume mapper
 251         const topoCellMapper& volMap() const;
 252
 253         //- Return surface mapper
 254         const topoSurfaceMapper& surfaceMap() const;
 255
 256         //- Return boundary mapper
 257         const topoBoundaryMeshMapper& boundaryMap() const;
 258
 259         //- Return flux-corrector
 260         const fluxCorrector& surfaceFluxCorrector() const;
 261
 262         //- Clear out member data
 263         void clear() const;
 264 };
 265
 266
 267 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 268
 269 } // End namespace Foam
 270
 271 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 272
 273 #ifdef NoRepository
 274 #   include "topoMapperTemplates.C"
 275 #endif
 276
 277 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 278
 279 #endif
 280
 281 // ************************************************************************* //