src/foam/meshes/MeshObject/meshObjectBase.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     meshObjectBase
  26
  27 Description
  28     Abstract base-class for dynamic mesh objects used to automate
  29     their allocation to the mesh database and mesh-related updates
  30
  31 SourceFiles
  32     meshObjectBase.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef meshObjectBase_H
  37 #define meshObjectBase_H
  38
  39 #include "typeInfo.H"
  40 #include "HashTable.H"
  41 #include "objectRegistry.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Class forward declarations
  49 class mapPolyMesh;
  50
  51 /*---------------------------------------------------------------------------*\
  52                          Class meshObjectBase Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class meshObjectBase
  56 {
  57 public:
  58
  59     //- Runtime type information
  60     TypeName("meshObject");
  61
  62
  63     // Static functions
  64
  65         //- Update topology on all mesh objects
  66         template<class Mesh>
  67         static void allUpdateTopology(const Mesh& mesh, const mapPolyMesh& mpm)
  68         {
  69             HashTable<const meshObjectBase*> tbl =
  70                 mesh.objectRegistry::template lookupClass<meshObjectBase>();
  71
  72             if (Mesh::debug)
  73             {
  74                 InfoIn
  75                 (
  76                     "static void meshObjectBase::"
  77                     "allUpdateTopology(const Mesh& mesh, "
  78                     "const mapPolyMesh& mpm)"
  79                 )   << "Mesh objects to update: " << tbl.toc() << endl;
  80             }
  81
  82             for
  83             (
  84                 HashTable<const meshObjectBase*>::iterator iter =
  85                     tbl.begin();
  86                 iter != tbl.end();
  87                 ++iter
  88             )
  89             {
  90                 const meshObjectBase& obj = *(iter());
  91
  92                 if (Mesh::debug)
  93                 {
  94                     Info << "Updating object " << obj.type() << endl;
  95                 }
  96
  97                 obj.updateMesh(mpm);
  98             }
  99
 100             if (Mesh::debug)
 101             {
 102                 Info << "Done update topology" << endl;
 103             }
 104         }
 105
 106
 107         //- Move points on all mesh objects
 108         template<class Mesh>
 109         static void allMovePoints(const Mesh& mesh)
 110         {
 111             if (mesh.moving())
 112             {
 113                 HashTable<const meshObjectBase*> tbl =
 114                     mesh.objectRegistry::template lookupClass<meshObjectBase>();
 115
 116                 if (Mesh::debug)
 117                 {
 118                     InfoIn
 119                     (
 120                         "static void meshObjectBase::"
 121                         "allMovePoints(const Mesh& mesh)"
 122                     )   << "Mesh objects to move: " << tbl.toc() << endl;
 123                 }
 124
 125                 for
 126                 (
 127                     HashTable<const meshObjectBase*>::iterator iter =
 128                         tbl.begin();
 129                     iter != tbl.end();
 130                     ++iter
 131                 )
 132                 {
 133                     const meshObjectBase& obj = *(iter());
 134
 135                     if (Mesh::debug)
 136                     {
 137                         Info<< "Moving object "
 138                             << " of type " << obj.type() << endl;
 139                     }
 140
 141                     obj.movePoints();
 142                 }
 143
 144                 if (Mesh::debug)
 145                 {
 146                     Info << "Done moving" << endl;
 147                 }
 148             }
 149         }
 150
 151         //- Move points on all mesh objects
 152         template<class Mesh>
 153         static void allDelete(const Mesh& mesh)
 154         {
 155             HashTable<const meshObjectBase*> tbl =
 156                 mesh.objectRegistry::template lookupClass<meshObjectBase>();
 157
 158             for
 159             (
 160                 HashTable<const meshObjectBase*>::iterator iter =
 161                     tbl.begin();
 162                 iter != tbl.end();
 163                 ++iter
 164             )
 165             {
 166                 const meshObjectBase& obj = *(iter());
 167
 168                 if (Mesh::debug)
 169                 {
 170                     Info << "Deleting object " << obj.type() << endl;
 171
 172                     obj.deleteObject();
 173                 }
 174             }
 175         }
 176
 177
 178     // Destructor
 179
 180         virtual ~meshObjectBase()
 181         {}
 182
 183
 184     // Member Functions
 185
 186         //- Update after mesh motion
 187         virtual bool movePoints() const = 0;
 188
 189         //- Update after topology change
 190         virtual bool updateMesh(const mapPolyMesh&) const = 0;
 191
 192         //- Delete object from database
 193         virtual bool deleteObject() const = 0;
 194 };
 195
 196
 197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 198
 199 } // End namespace Foam
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 #endif
 204
 205 // ************************************************************************* //