src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/mapDistributeLagrangian.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::mapDistributeLagrangian
  26
  27 Description
  28     Class containing mesh-to-mesh mapping information for particles
  29
  30 SourceFiles
  31     mapDistributeLagrangian.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef mapDistributeLagrangian_H
  36 #define mapDistributeLagrangian_H
  37
  38 #include "mapDistribute.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 class mapPolyMesh;
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class mapDistributeLagrangian Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class mapDistributeLagrangian
  52 {
  53     // Private data
  54
  55         //- Map to distribute particles
  56         const mapDistribute particleMap_;
  57
  58         //- Per element in subsetted mesh the cell label
  59         const labelListList constructCellLabels_;
  60
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct from components
  67         mapDistributeLagrangian
  68         (
  69             const label nNewParticles,
  70             const Xfer<labelListList>& subParticleMap,
  71             const Xfer<labelListList>& constructParticleMap,
  72             const Xfer<labelListList>& constructCellLabels
  73         )
  74         :
  75             particleMap_(nNewParticles, subParticleMap, constructParticleMap),
  76             constructCellLabels_(constructCellLabels)
  77         {}
  78
  79
  80     // Member Functions
  81
  82         // Access
  83
  84             //- Distribution map
  85             const mapDistribute& particleMap() const
  86             {
  87                 return particleMap_;
  88             }
  89
  90             //- Per received particle the destination cell label
  91             const labelListList& constructCellLabels() const
  92             {
  93                 return constructCellLabels_;
  94             }
  95
  96
  97         // Edit
  98
  99             //- distribute list of lagrangian data
 100             template<class T>
 101             void distributeLagrangianData(List<T>& lst) const
 102             {
 103                 particleMap_.distribute(lst);
 104             }
 105
 106             //- Correct for topo change.
 107             void updateMesh(const mapPolyMesh&)
 108             {
 109                 notImplemented
 110                 (
 111                     "mapDistributeLagrangian::updateMesh(const mapPolyMesh&)"
 112                 );
 113             }
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #endif
 124
 125 // ************************************************************************* //