src/dynamicMesh/layerAdditionRemoval/layerAdditionRemoval.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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     Foam::layerAdditionRemoval
  27
  28 Description
  29     Cell layer addition mesh modifier
  30
  31 SourceFiles
  32     layerAdditionRemoval.C
  33     addCellLayer.C
  34     removeCellLayer.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef layerAdditionRemoval_H
  39 #define layerAdditionRemoval_H
  40
  41 #include "polyMeshModifier.H"
  42 #include "primitiveFacePatch.H"
  43 #include "ZoneIDs.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                      Class layerAdditionRemoval Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class layerAdditionRemoval
  55 :
  56     public polyMeshModifier
  57 {
  58     // Private data
  59
  60         //- Master face zone ID
  61         faceZoneID faceZoneID_;
  62
  63         //- Min thickness of extrusion layer.  Triggers layer removal
  64         mutable scalar minLayerThickness_;
  65
  66         //- Max thickness of extrusion layer.  Triggers layer addition
  67         mutable scalar maxLayerThickness_;
  68
  69         //- Layer thickness from previous step
  70         //  Used to decide whether to add or remove layers
  71         mutable scalar oldLayerThickness_;
  72
  73         //- Point pairing
  74         mutable labelList* pointsPairingPtr_;
  75
  76         //- Face pairing
  77         mutable labelList* facesPairingPtr_;
  78
  79         //- Layer removal trigger time index
  80         mutable label triggerRemoval_;
  81
  82         //- Layer addition trigger  time index
  83         mutable label triggerAddition_;
  84
  85
  86     // Private Member Functions
  87
  88         //- Disallow default bitwise copy construct
  89         layerAdditionRemoval(const layerAdditionRemoval&);
  90
  91         //- Disallow default bitwise assignment
  92         void operator=(const layerAdditionRemoval&);
  93
  94         //- Check validity of construction data
  95         void checkDefinition();
  96
  97
  98         // Topological changes
  99
 100             //- Check for valid layer
 101             bool validCollapse() const;
 102
 103             //- Set layer pairing.  Return true if a valid layer exists
 104             bool setLayerPairing() const;
 105
 106             //- Return points pairing in a layer (not automatic!)
 107             const labelList& pointsPairing() const;
 108
 109             //- Return faces pairing in a layer (not automatic!)
 110             const labelList& facesPairing() const;
 111
 112             //- Calculate the offset to the next layer
 113             tmp<vectorField> extrusionDir() const;
 114
 115             //- Add a layer of cells
 116             void addCellLayer(polyTopoChange&) const;
 117
 118             //- Remove a layer of cells
 119             void removeCellLayer(polyTopoChange&) const;
 120
 121             //- Clear addressing
 122             void clearAddressing() const;
 123
 124         // Helpers
 125
 126             //- Optionally read old thickness
 127             static scalar readOldThickness(const dictionary&);
 128
 129
 130     // Static data members
 131
 132         //- Thickness insertion fraction for the pre-motion
 133         static const scalar addDelta_;
 134
 135         //- Thickness removal fraction for the cell collapse
 136         //  Note: the cell will be collapsed to this relative
 137         //  thickness before the layer is removed.
 138         static const scalar removeDelta_;
 139
 140 public:
 141
 142     //- Runtime type information
 143     TypeName("layerAdditionRemoval");
 144
 145
 146     // Constructors
 147
 148         //- Construct from components
 149         layerAdditionRemoval
 150         (
 151             const word& name,
 152             const label index,
 153             const polyTopoChanger& mme,
 154             const word& zoneName,
 155             const scalar minThickness,
 156             const scalar maxThickness
 157         );
 158
 159         //- Construct from dictionary
 160         layerAdditionRemoval
 161         (
 162             const word& name,
 163             const dictionary& dict,
 164             const label index,
 165             const polyTopoChanger& mme
 166         );
 167
 168
 169     // Destructor
 170
 171         virtual ~layerAdditionRemoval();
 172
 173
 174     // Member Functions
 175
 176         //- Check for topology change
 177         virtual bool changeTopology() const;
 178
 179         //- Insert the layer addition/removal instructions
 180         //  into the topological change
 181         virtual void setRefinement(polyTopoChange&) const;
 182
 183         //- Modify motion points to comply with the topological change
 184         virtual void modifyMotionPoints(pointField& motionPoints) const;
 185
 186         //- Force recalculation of locally stored data on topological change
 187         virtual void updateMesh(const mapPolyMesh&);
 188
 189
 190         // Edit
 191
 192             //- Return min layer thickness which triggers removal
 193             scalar minLayerThickness() const
 194             {
 195                 return minLayerThickness_;
 196             }
 197
 198             //- Set min layer thickness which triggers removal
 199            void setMinLayerThickness(const scalar t) const;
 200
 201             //- Return max layer thickness which triggers removal
 202             scalar maxLayerThickness() const
 203             {
 204                 return maxLayerThickness_;
 205             }
 206
 207             //- Set max layer thickness which triggers removal
 208            void setMaxLayerThickness(const scalar t) const;
 209
 210
 211         //- Write
 212         virtual void write(Ostream&) const;
 213
 214         //- Write dictionary
 215         virtual void writeDict(Ostream&) const;
 216 };
 217
 218
 219 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 220
 221 } // End namespace Foam
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 #endif
 226
 227 // ************************************************************************* //