src/operation.h

   1 //
   2 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   3 // +                                                                      +
   4 // + This file is part of enGrid.                                         +
   5 // +                                                                      +
   6 // + Copyright 2008,2009 Oliver Gloth                                     +
   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
  33 #include <vtkUnstructuredGrid.h>
  34 #include <vtkCellType.h>
  35 #include <vtkSmartPointer.h>
  36 #include <vtkCellLocator.h>
  37
  38 #include <QThread>
  39 #include <QMutex>
  40 #include <QListWidget>
  41 #include <QTime>
  42
  43 #include <typeinfo>
  44
  45 #define EG_TYPENAME setTypeName(QString(typeid(*this).name()))
  46
  47 class OperationThread : public QThread
  48 {
  49
  50 private:
  51
  52   Operation *op;
  53
  54 protected:
  55
  56   virtual void run();
  57
  58 public:
  59
  60   void setOperation(Operation *an_op) { op = an_op; }
  61
  62 };
  63
  64 /**
  65  * This is the base class for all mesh operations.
  66  * Operations will typically be triggered by a Qt event; the MainWindow
  67  * object will call operator() with the current grid as parameter.
  68  */
  69 class Operation : public EgVtkObject
  70 {
  71
  72   friend class OperationThread;
  73   OperationThread thread;
  74
  75 private: // static attributes
  76
  77   static QSet<Operation*> garbage_operations;
  78
  79 private: // attributes
  80
  81   bool               gui;
  82   bool               m_quicksave;             ///< save grid after operation finished?
  83   bool               m_resetoperationcounter; ///< reset operation counter after operation finished? (default is false)
  84   bool               autoset;
  85   Error             *err;
  86   QString            volume_name;
  87   QString            m_TypeName;              ///< typename retrieved from typeid(this).name()
  88   QTime              m_StartTime;             ///< start time for run-time information
  89
  90 private: // methods
  91
  92   void setStartTime() { m_StartTime = QTime::currentTime(); }
  93   int  elapsedTime() { return m_StartTime.secsTo(QTime::currentTime()); }
  94
  95 protected: // attributes
  96
  97   vtkUnstructuredGrid    *grid;   ///< The main grid the operation operates on.
  98   MeshPartition           m_Part; ///< the partition containing the subset of cells and nodes
  99
 100 protected: // methods
 101
 102   void checkGrid();
 103   void updateActors();
 104   GuiMainWindow* mainWindow();
 105   virtual void operate() = 0;
 106   void setTypeName(QString name);
 107
 108   l2g_t getPartNodes()       { return m_Part.getNodes(); }
 109   l2g_t getPartCells() const { return m_Part.getCells(); }
 110   g2l_t getPartLocalNodes()  { return m_Part.getLocalNodes(); }
 111   g2l_t getPartLocalCells()  { return m_Part.getLocalCells(); }
 112   l2l_t getPartN2N()         { return m_Part.getN2N(); }
 113   l2l_t getPartN2C()         { return m_Part.getN2C(); }
 114   l2l_t getPartC2C()         { return m_Part.getC2C(); }
 115
 116 public: // methods
 117
 118   Operation();
 119   virtual ~Operation();
 120   void del();
 121
 122   void setGrid(vtkUnstructuredGrid *ug) { grid = ug; }
 123   void setAllCells();
 124   void setAllVolumeCells();
 125   void setAllSurfaceCells();
 126   void setVolume(QString volume_name);
 127   template <class T> void setCells(const T &cls);
 128   void setMeshPartition(const MeshPartition &part);
 129
 130   void setGui() { gui = true; }
 131   OperationThread& getThread() { return thread; }
 132   void enableAutoSet() { autoset = true; }
 133   void disableAutoSet() { autoset = false; }
 134   void setQuickSave(bool b) { m_quicksave = b; }
 135   void setResetOperationCounter(bool b) { m_resetoperationcounter=b; }
 136
 137   /**
 138    * Fill a QListWidget with all available boundary codes from a grid.
 139    * @param lw   The QListWidget to fill.
 140    * @param grid The grid to use.
 141    */
 142   void populateBoundaryCodes(QListWidget *lw);
 143
 144   /**
 145    * Fill a QListWidget with all available volumes from a grid.
 146    * @param lw   The QListWidget to fill.
 147    * @param grid The grid to use.
 148    */
 149   void populateVolumes(QListWidget *lw);
 150
 151   virtual void operator()();
 152
 153   static void collectGarbage();
 154
 155   QString getTypeName() { return m_TypeName; }
 156
 157 };
 158
 159 //End of class Operation
 160
 161
 162
 163
 164 template <class T>
 165 void Operation::setCells(const T &cls)
 166 {
 167   m_Part.setGrid(grid);
 168   m_Part.setCells(cls);
 169 }
 170
 171 #endif