src/dynamicMesh/polyTopoChange/attachPolyTopoChanger/attachPolyTopoChanger.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::attachPolyTopoChanger
  26
  27 Description
  28     This class is derived from polyMesh and serves as a tool for
  29     statically connecting pieces of a mesh by executing the mesh
  30     modifiers and cleaning the mesh.
  31
  32     The idea is that a mesh can be built from pieces and put together
  33     using various mesh modifiers (mainly sliding interfaces) which are
  34     not needed during the run.  Therefore, once the mesh is assembled
  35     and mesh modification triggered, the newly created point, face and
  36     cell zones can be cleared together with the mesh modifiers thus
  37     creating a singly connected static mesh.
  38
  39     Note:
  40     All point, face and cell zoning will be lost!  Do it after
  41     attaching the parts of the mesh, as the point, face and cell
  42     numbering changes.
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef attachPolyTopoChanger_H
  47 #define attachPolyTopoChanger_H
  48
  49 #include "polyTopoChanger.H"
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 namespace Foam
  54 {
  55
  56 /*---------------------------------------------------------------------------*\
  57                            Class attachPolyTopoChanger Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class attachPolyTopoChanger
  61 :
  62     public polyTopoChanger
  63 {
  64     // Private data
  65
  66     // Private Member Functions
  67
  68         //- Disallow default bitwise copy construct
  69         attachPolyTopoChanger(const attachPolyTopoChanger&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const attachPolyTopoChanger&);
  73
  74
  75 public:
  76
  77     // Constructors
  78
  79         //- Read constructor from IOobject and a polyMesh
  80         attachPolyTopoChanger(const IOobject& io, polyMesh&);
  81
  82         //- Read constructor for given polyMesh
  83         explicit attachPolyTopoChanger(polyMesh&);
  84
  85
  86     //- Destructor
  87     virtual ~attachPolyTopoChanger()
  88     {}
  89
  90
  91     // Member Functions
  92
  93         //- Attach mesh. By default filter out empty patches.
  94         void attach(const bool removeEmptyPatches = true);
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //