src/topoChangerFvMesh/topoChangerFvMesh/topoChangerFvMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::topoChangerFvMesh
  27
  28 Description
  29     Abstract base class for a topology changing fvMesh
  30
  31 SourceFiles
  32     topoChangerFvMesh.C
  33     newTopoFvMesh.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef topoChangerFvMesh_H
  38 #define topoChangerFvMesh_H
  39
  40 #include "dynamicFvMesh.H"
  41 #include "polyTopoChanger.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class topoChangerFvMesh Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class topoChangerFvMesh
  53 :
  54     public dynamicFvMesh
  55 {
  56     // Private Member Functions
  57
  58         //- Disallow default bitwise copy construct
  59         topoChangerFvMesh(const topoChangerFvMesh&);
  60
  61         //- Disallow default bitwise assignment
  62         void operator=(const topoChangerFvMesh&);
  63
  64
  65 protected:
  66
  67     // Protected Data
  68
  69         polyTopoChanger topoChanger_;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("topoChangerFvMesh");
  76
  77
  78     // Constructors
  79
  80         //- Construct from objectRegistry, and read/write options
  81         explicit topoChangerFvMesh(const IOobject& io);
  82
  83
  84     // Destructor
  85
  86         virtual ~topoChangerFvMesh();
  87
  88
  89     // Member Functions
  90
  91         //- Update the mesh for both mesh motion and topology change
  92         virtual bool update() = 0;
  93 };
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace Foam
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 #endif
 103
 104 // ************************************************************************* //