src/dynamicMesh/dynamicTopoFvMesh/convexSetAlgorithm/convexSetAlgorithm.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     convexSetAlgorithm
  26
  27 Description
  28     Base class for convexSetAlgorithms
  29
  30 Author
  31     Sandeep Menon
  32     University of Massachusetts Amherst
  33     All rights reserved
  34
  35 SourceFiles
  36     convexSetAlgorithm.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef convexSetAlgorithm_H
  41 #define convexSetAlgorithm_H
  42
  43 #include "Map.H"
  44 #include "label.H"
  45 #include "edgeList.H"
  46 #include "faceList.H"
  47 #include "cellList.H"
  48 #include "boundBox.H"
  49 #include "objectMap.H"
  50 #include "vectorField.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 class polyMesh;
  58
  59 /*---------------------------------------------------------------------------*\
  60                     Class convexSetAlgorithm Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 class convexSetAlgorithm
  64 {
  65
  66 protected:
  67
  68     // Protected data
  69
  70         const label nOldPoints_;
  71
  72         //- References to old-level connectivity
  73         //  [Before topo-changes, at old point-positions]
  74         const polyMesh& mesh_;
  75
  76         //- References to new-level connectivity
  77         //  [After topo-changes, at old point-positions]
  78         const pointField& newPoints_;
  79         const UList<edge>& newEdges_;
  80         const UList<face>& newFaces_;
  81         const UList<cell>& newCells_;
  82         const UList<label>& newOwner_;
  83         const UList<label>& newNeighbour_;
  84
  85         //- Entity parents
  86         mutable labelList parents_;
  87
  88         //- Internal data members
  89         mutable boundBox box_;
  90         mutable vector refNorm_;
  91         mutable scalar normFactor_;
  92         mutable vectorField centres_;
  93         mutable scalarField weights_;
  94
  95 public:
  96
  97     //- Constructor
  98
  99         // Construct from components
 100         convexSetAlgorithm
 101         (
 102             const polyMesh& mesh,
 103             const pointField& newPoints,
 104             const UList<edge>& newEdges,
 105             const UList<face>& newFaces,
 106             const UList<cell>& newCells,
 107             const UList<label>& newOwner,
 108             const UList<label>& newNeighbour
 109         );
 110
 111     //- Destructor
 112
 113         virtual ~convexSetAlgorithm()
 114         {}
 115
 116     //- Member functions
 117
 118         // Dimensions of the algorithm
 119         virtual label dimension() const = 0;
 120
 121         // Return true if accumulated weights are consistent
 122         virtual bool consistent(const scalar tolerance) const;
 123
 124         // Return the normFactor
 125         virtual scalar normFactor() const;
 126
 127         // Normalize stored weights
 128         virtual void normalize(bool normSum) const;
 129
 130         // Check whether the bounding box contains the entity
 131         virtual bool contains(const label index) const = 0;
 132
 133         // Extract weights and centres to lists
 134         virtual void populateLists
 135         (
 136             labelList& parents,
 137             vectorField& centres,
 138             scalarField& weights
 139         ) const;
 140
 141         // Compute normFactor
 142         virtual void computeNormFactor(const label index) const = 0;
 143
 144         // Compute intersections
 145         virtual bool computeIntersection
 146         (
 147             const label newIndex,
 148             const label oldIndex,
 149             const label offset,
 150             bool output
 151         ) const = 0;
 152
 153         // Obtain map weighting factors
 154         virtual void computeWeights
 155         (
 156             const label index,
 157             const label offset,
 158             const labelList& mapCandidates,
 159             const labelListList& oldNeighbourList,
 160             labelList& parents,
 161             scalarField& weights,
 162             vectorField& centres,
 163             bool output = false
 164         );
 165
 166         // Write out connectivity information to disk
 167         bool write() const;
 168
 169         // Output an entity as a VTK file
 170         void writeVTK
 171         (
 172             const word& name,
 173             const label entity,
 174             const label primitiveType = 3,
 175             const bool useOldConnectivity = false
 176         ) const;
 177
 178         // Output a list of entities as a VTK file
 179         void writeVTK
 180         (
 181             const word& name,
 182             const labelList& cList,
 183             const label primitiveType = 3,
 184             const bool useOldConnectivity = false
 185         ) const;
 186 };
 187
 188
 189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 190
 191 } // End namespace Foam
 192
 193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 194
 195 #endif
 196
 197 // ************************************************************************* //