gmCellGroupSet.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_CELL_GROUP_SET_H_
#define _GEMA_CELL_GROUP_SET_H_

#include "gmCell.h"
#include "gmCellMesh.h"

#include <QString>


class GMC_API_EXPORT GmCellGroupSet
{
public:
  virtual ~GmCellGroupSet() {}

  virtual int numCells() const = 0;

  // PS: We don't have a numActiveCells() function since that would require some type of 
  // synchronization to update our statistics when a cell active flag is changed.
  // An option would be making the mesh emit a signal when activeCellUpdated() is called
  // (GmMesh already inherits QObject). That would require that GmCellGroupSet becomes a 
  // QObjects itself.  Maybe not a bad idea after all. Would simplify the codes in 
  // GmFileFilter::fillCellData() and GmFilteredCellSetGaussIndex::init() if we also 
  // implement numCellTypes() and numActiveCellTypes()

  virtual GmCell* cell(int setIndex) const = 0;

  virtual bool ordered() const = 0;

  virtual int numNodes() const = 0;

  virtual int node(int setIndex) const = 0;

  virtual void clear() = 0;

  virtual const QList<int>& cellGroups() const = 0;

  QStringList cellGroupNames() const;

  virtual GmCellMesh* mesh() const = 0;

  static bool cellGroupIds(const GmCellMesh* mesh, const QStringList& groupNames, QList<int>& idList, QString& err);
};

class GMC_API_EXPORT GmCellMeshGroupSet : public GmCellGroupSet
{
public:
  GmCellMeshGroupSet(GmCellMesh* mesh) { assert(mesh); _mesh = mesh; }

  // See comments on the base class
  virtual int numCells() const { return _mesh->numCells(); }

  // See comments on the base class
  virtual GmCell* cell(int setIndex) const { return _mesh->cell(setIndex); }

  // See comments on the base class
  virtual bool ordered() const { return true; }

  // See comments on the base class
  virtual int numNodes() const { return _mesh->numNodes(); }

  // See comments on the base class
  virtual int node(int setIndex) const { return setIndex; }

  // See comments on the base class
  virtual void clear() {}

  // See comments on the base class
  virtual const QList<int>& cellGroups() const { static QList<int> emptyGroupList;  return emptyGroupList; }

  // See comments on the base class
  virtual GmCellMesh* mesh() const { return _mesh; }

private:
  Q_DISABLE_COPY(GmCellMeshGroupSet)

  GmCellMesh* _mesh;  
};

class GMC_API_EXPORT GmBaseCellGroupSet: public GmCellGroupSet
{
protected:
  typedef QPair<int, int*> NodeData;

public:
  virtual ~GmBaseCellGroupSet();

  // See comments on the base class
  virtual int numNodes() const { return nodeData()->first; }

  // See comments on the base class
  virtual int node(int setIndex) const 
  { 
    NodeData* d = nodeData();
    
    assert(setIndex >= 0 && setIndex < d->first); 
    return d->second[setIndex]; 
  }

  virtual void clear();

  // See comments on the base class
  virtual const QList<int>& cellGroups() const { return _groupList; }

  // See comments on the base class
  virtual GmCellMesh* mesh() const { return _mesh; }

protected:
  GmBaseCellGroupSet(GmCellMesh* mesh, const QList<int>& groups);

  NodeData* buildNodeList() const;
  NodeData* nodeData() const;

  GmCellMesh*  _mesh;       
  QList<int>   _groupList;  

  mutable QAtomicPointer<NodeData> _nodeData; 

  mutable QMutex _nodeDataMutex;  

private:
  Q_DISABLE_COPY(GmBaseCellGroupSet)
};



class GMC_API_EXPORT GmCellDisjointGroupSet : public GmBaseCellGroupSet
{
public:
  GmCellDisjointGroupSet(GmCellMesh* mesh, const QList<int>& groups);

  virtual int numCells() const;

  virtual GmCell* cell(int setIndex) const;

  // See comments on the base class
  virtual bool ordered() const { return false; }

  virtual void clear();

private:
  QMap<int, int> _groupMap;  
};

class GMC_API_EXPORT GmCellGenericGroupSet : public GmBaseCellGroupSet
{
public:
  GmCellGenericGroupSet(GmCellMesh* mesh, const QList<int>& groups);

  virtual ~GmCellGenericGroupSet();

  // See comments on the base class
  virtual int numCells() const { return _ncells; }

  // See comments on the base class
  virtual GmCell* cell(int setIndex) const { assert(setIndex >= 0 && setIndex < _ncells);  return _cells[setIndex]; }

  // See comments on the base class
  virtual bool ordered() const { return true; }

  virtual void clear();

private:
  int      _ncells; 
  GmCell** _cells;  
};

#define GmForeachActiveGroupCell(variable, gs) GmForeachCellHelper(variable, gs, GmCellGroupSet, GmCell, true)

#define GmForeachGroupCell(variable, gs, activeOnly) GmForeachCellHelper(variable, gs, GmCellGroupSet, GmCell, activeOnly) 

#define GmForeachActiveGroupElement(variable, gs) GmForeachCellHelper(variable, gs, GmCellGroupSet, GmElement, true)

#define GmForeachGroupElement(variable, gs, activeOnly) GmForeachCellHelper(variable, gs, GmCellGroupSet, GmElement, activeOnly) 


#endif