src/libengrid/operation.h

   1 //
   2 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   3 // +                                                                      +
   4 // + This file is part of enGrid.                                         +
   5 // +                                                                      +
   6 // + Copyright 2008-2013 enGits GmbH                                      +
   7 // +                                                                      +
   8 // + enGrid is free software: you can redistribute it and/or modify       +
   9 // + it under the terms of the GNU General Public License as published by +
  10 // + the Free Software Foundation, either version 3 of the License, or    +
  11 // + (at your option) any later version.                                  +
  12 // +                                                                      +
  13 // + enGrid is distributed in the hope that it will be useful,            +
  14 // + but WITHOUT ANY WARRANTY; without even the implied warranty of       +
  15 // + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        +
  16 // + GNU General Public License for more details.                         +
  17 // +                                                                      +
  18 // + You should have received a copy of the GNU General Public License    +
  19 // + along with enGrid. If not, see <http://www.gnu.org/licenses/>.       +
  20 // +                                                                      +
  21 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  22 //
  23 #ifndef operation_H
  24 #define operation_H
  25
  26 class Operation;
  27 class GuiMainWindow;
  28
  29 #include "egvtkobject.h"
  30 #include "vertexmeshdensity.h"
  31 #include "meshpartition.h"
  32 #include "timer.h"
  33
  34 #include <vtkUnstructuredGrid.h>
  35 #include <vtkCellType.h>
  36 #include <vtkSmartPointer.h>
  37 #include <vtkCellLocator.h>
  38
  39 #include <QThread>
  40 #include <QMutex>
  41 #include <QListWidget>
  42 #include <QTime>
  43
  44 #include <typeinfo>
  45
  46 #define EG_TYPENAME setTypeName(QString(typeid(*this).name()))
  47
  48 class OperationThread : public QThread
  49 {
  50
  51 private:
  52
  53   Operation *op;
  54
  55 protected:
  56
  57   virtual void run();
  58
  59 public:
  60
  61   void setOperation(Operation *an_op) { op = an_op; }
  62
  63 };
  64
  65 /**
  66  * This is the base class for all mesh operations.
  67  * Operations will typically be triggered by a Qt event; the MainWindow
  68  * object will call operator() with the current grid as parameter.
  69  */
  70 class Operation : public EgVtkObject
  71 {
  72
  73   friend class OperationThread;
  74   OperationThread thread;
  75
  76 private: // static attributes
  77
  78   static QSet<Operation*> garbage_operations;
  79
  80 private: // attributes
  81
  82   /// If true, attempts to lock the mutex when Operation::operator()() is called. If the lock was obtained, all other "lock_gui operations" will not work until the current "lock_gui opration" is done.
  83   bool               lock_gui;
  84
  85   bool               m_quicksave;             ///< save grid after operation finished?
  86   bool               m_resetoperationcounter; ///< reset operation counter after operation finished? (default is false)
  87   bool               autoset;
  88   Error             *err;
  89   QString            volume_name;
  90   QString            m_TypeName;              ///< typename retrieved from typeid(this).name()
  91   QTime              m_StartTime;             ///< start time for run-time information
  92
  93 private: // methods
  94
  95   void setStartTime() { m_StartTime = QTime::currentTime(); }
  96   int  elapsedTime() { return m_StartTime.secsTo(QTime::currentTime()); }
  97
  98 protected: // attributes
  99
 100   vtkUnstructuredGrid* m_Grid;     ///< The main grid the operation operates on.
 101   vtkUnstructuredGrid* m_RestGrid; ///< The remainder grid (not part of the selected volume)
 102   MeshPartition        m_Part;     ///< the partition containing the subset of cells and nodes
 103   Timer                m_Timer;    ///< Timer object for periodic output
 104   QString              m_MenuText; ///< The menu entry (mainly for plugins)
 105
 106 protected: // methods
 107
 108   void checkGrid();
 109   void updateActors();
 110   GuiMainWindow* mainWindow();
 111   virtual void operate() = 0;
 112   void setTypeName(QString name);
 113
 114   /**
 115    * Eliminate cells with identical node indices.
 116    * @param surf_only if set to false all cells will be checked, otherwise surface cells only.
 117    *                  Careful with eliminating volume cells -- this can be extremely slow.
 118    */
 119   void eliminateDuplicateCells(bool surf_only = true);
 120
 121   l2g_t getPartNodes()       { return m_Part.getNodes(); }
 122   l2g_t getPartCells() const { return m_Part.getCells(); }
 123   g2l_t getPartLocalNodes()  { return m_Part.getLocalNodes(); }
 124   g2l_t getPartLocalCells()  { return m_Part.getLocalCells(); }
 125   l2l_t getPartN2N()         { return m_Part.getN2N(); }
 126   l2l_t getPartN2C()         { return m_Part.getN2C(); }
 127   l2l_t getPartC2C()         { return m_Part.getC2C(); }
 128
 129 public: // methods
 130
 131   Operation();
 132   virtual ~Operation();
 133   void del();
 134
 135   void setGrid(vtkUnstructuredGrid *ug) { m_Grid = ug; }
 136   void setAllCells();
 137   void setAllVolumeCells();
 138   void setAllSurfaceCells();
 139   void setVolume(QString volume_name);
 140   template <class T> void setCells(const T &cls);
 141   void setMeshPartition(const MeshPartition &part);
 142
 143   void setLockGui() { lock_gui = true; }
 144   OperationThread& getThread() { return thread; }
 145   void enableAutoSet() { autoset = true; }
 146   void disableAutoSet() { autoset = false; }
 147   void setQuickSave(bool b) { m_quicksave = b; }
 148   void setResetOperationCounter(bool b) { m_resetoperationcounter=b; }
 149
 150   /**
 151    * Fill a QListWidget with all available boundary codes from a grid.
 152    * @param lw   The QListWidget to fill.
 153    * @param grid The grid to use.
 154    */
 155   void populateBoundaryCodes(QListWidget *lw);
 156
 157   /**
 158    * Fill a QListWidget with all available volumes from a grid.
 159    * @param lw   The QListWidget to fill.
 160    * @param grid The grid to use.
 161    */
 162   void populateVolumes(QListWidget *lw);
 163
 164   virtual void operator()();
 165
 166   static void collectGarbage();
 167
 168   QString getTypeName() { return m_TypeName; }
 169   QString getMenuText() { return m_MenuText; }
 170
 171 };
 172
 173 //End of class Operation
 174
 175 Q_DECLARE_INTERFACE(Operation, "eu.engits.enGrid.Operation/1.0")
 176
 177
 178 template <class T>
 179 void Operation::setCells(const T &cls)
 180 {
 181   m_Part.setGrid(m_Grid);
 182   m_Part.setCells(cls);
 183 }
 184
 185 #endif