src/dynamicMesh/polyMeshModifiers/polyMeshModifier/polyMeshModifier.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     Foam::polyMeshModifier
  27
  28 Description
  29     Virtual base class for mesh modifiers.
  30
  31 SourceFiles
  32     polyMeshModifier.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef polyMeshModifier_H
  37 #define polyMeshModifier_H
  38
  39 #include "label.H"
  40 #include "word.H"
  41 #include "Switch.H"
  42 #include "typeInfo.H"
  43 #include "runTimeSelectionTables.H"
  44 #include "autoPtr.H"
  45 #include "pointField.H"
  46 #include "faceList.H"
  47 #include "cellList.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 // Forward declaration of classes
  55 class polyTopoChanger;
  56 class polyTopoChange;
  57 class mapPolyMesh;
  58
  59 /*---------------------------------------------------------------------------*\
  60                        Class polyMeshModifier Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 class polyMeshModifier
  64 {
  65     // Private data
  66
  67         //- Name of zone
  68         word name_;
  69
  70         //- Index of zone
  71         label index_;
  72
  73         //- Reference to morph engine
  74         const polyTopoChanger& topoChanger_;
  75
  76         //- Activation switch
  77         mutable Switch active_;
  78
  79
  80     // Private Member Functions
  81
  82         //- Disallow default bitwise copy construct
  83         polyMeshModifier(const polyMeshModifier&);
  84
  85         //- Disallow default bitwise assignment
  86         void operator=(const polyMeshModifier&);
  87
  88
  89 public:
  90
  91     // Static data members
  92
  93         //- Runtime type information
  94         TypeName("meshModifier");
  95
  96
  97     // Declare run-time constructor selection tables
  98
  99         declareRunTimeSelectionTable
 100         (
 101             autoPtr,
 102             polyMeshModifier,
 103             dictionary,
 104             (
 105                 const word& name,
 106                 const dictionary& dict,
 107                 const label index,
 108                 const polyTopoChanger& mme
 109             ),
 110             (name, dict, index, mme)
 111         );
 112
 113
 114     // Constructors
 115
 116         //- Construct from components
 117         polyMeshModifier
 118         (
 119             const word& name,
 120             const label index,
 121             const polyTopoChanger& mme,
 122             const bool act
 123         );
 124
 125
 126     // Selectors
 127
 128         //- Select constructed from dictionary
 129         static autoPtr<polyMeshModifier> New
 130         (
 131             const word& name,
 132             const dictionary& dict,
 133             const label index,
 134             const polyTopoChanger& mme
 135         );
 136
 137
 138     // Destructor
 139
 140         virtual ~polyMeshModifier();
 141
 142
 143     // Member Functions
 144
 145         //- Return name
 146         const word& name() const
 147         {
 148             return name_;
 149         }
 150
 151         //- Return the index of this patch in the boundaryMesh
 152         label index() const
 153         {
 154             return index_;
 155         }
 156
 157         //- Return reference to morph engine
 158         const polyTopoChanger& topoChanger() const;
 159
 160         //- Check for topology change
 161         virtual bool changeTopology() const = 0;
 162
 163         //- Insert the topological change instructions
 164         virtual void setRefinement(polyTopoChange&) const = 0;
 165
 166         //- Modify motion points to comply with the topological change
 167         virtual void modifyMotionPoints(pointField& motionPoints) const = 0;
 168
 169         //- Force recalculation of locally stored data on topological change
 170         virtual void updateMesh(const mapPolyMesh&) = 0;
 171
 172
 173         // Activation and deactivation
 174
 175             const Switch& active() const
 176             {
 177                 return active_;
 178             }
 179
 180             //- Activate mesh modifier
 181             void enable() const
 182             {
 183                 active_ = true;
 184             }
 185
 186             //- Activate mesh modifier
 187             void disable() const
 188             {
 189                 active_ = false;
 190             }
 191
 192
 193         //- Write
 194         virtual void write(Ostream&) const = 0;
 195
 196         //- Write dictionary
 197         virtual void writeDict(Ostream&) const = 0;
 198
 199
 200     // Ostream Operator
 201
 202         friend Ostream& operator<<(Ostream&, const polyMeshModifier&);
 203 };
 204
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 } // End namespace Foam
 209
 210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 211
 212 #endif
 213
 214 // ************************************************************************* //