gmPCR.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2015 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_PCR_H_
#define _GEMA_PCR_H_
 
#include "gmPluginObject.h"
#include "gmPluginCategory.h"
#include "gmCell.h"
 
class GmMesh;
class GmCellGroupSet;
class GmValueAccessor;
class GmStateDump;
 
#define GM_PCR_REMOTE_BIT 0x01
 
#define GM_PCR_HALO_BIT   0x02
 
#define GM_PCR_MASK 0x03
 
#define GM_PCR_NUM_MASK_BITS 2
 
#define GM_PCR_NUM_CLASSES (1 << GM_PCR_NUM_MASK_BITS)
 
 
class GMC_API_EXPORT GmPCR : public GmPluginObject
{
public:
  GmPCR(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmPCR();
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_PCR; }
 
  virtual bool hasCapability(QString capabilityName) const = 0;
 
  virtual GmMesh* mesh() const = 0;
 
  virtual bool setMesh(GmMesh* mesh) = 0; 
 
  virtual void printParameters(const GmLogCategory& logger);
 
  virtual size_t printMemoryStatistics(const GmLogCategory& logger, GmLogLevel level) const = 0;
 
  virtual size_t usedMemory() const = 0;
 
  // --------------------------------------------------------------------------
  //  The public API used at the simulation execution by processes, etc
  // --------------------------------------------------------------------------
 
  // -- Partition --------------------------
 
  virtual int numPartitions() const = 0;
 
  virtual int partition() const = 0;
 
  virtual int numGlobalNodes() const = 0;
 
  virtual int numGlobalGhostNodes() const = 0;
 
  virtual int numGlobalCells() const = 0;
 
  enum CellClass {
    MY_CELL          = 0,                                    
    MY_HALO_CELL     = GM_PCR_HALO_BIT,                      
    REMOTE_HALO_CELL = GM_PCR_REMOTE_BIT | GM_PCR_HALO_BIT,  
  };
 
  enum NodeClass {
    MY_NODE          = 0,                                    
    REMOTE_NODE      = GM_PCR_REMOTE_BIT,                    
    MY_HALO_NODE     = GM_PCR_HALO_BIT,                      
    REMOTE_HALO_NODE = GM_PCR_REMOTE_BIT | GM_PCR_HALO_BIT,  
  };
 
  virtual CellClass cellClass(int cellId) const = 0;
 
  virtual int cellClassData(int cellId) const = 0;
 
  virtual int numCellsInClass(CellClass cellClass) const = 0;
 
  virtual NodeClass nodeClass(int nodeId) const = 0;
 
  virtual int nodeClassData(int nodeId) const = 0;
 
  virtual int numNodesInClass(NodeClass nodeClass, GmCellFillMode mode = GM_CELL_NODES) const = 0;
 
  virtual int numRemoteRanks(int templateIndex) const = 0;
 
  virtual const int* remoteRanks(int templateIndex) const = 0;
 
  virtual bool skipRemote() const = 0;
 
  virtual bool addPartitionInfoAsMeshAttributes(QString cellAttrPrefix, QString nodeAttrPrefix) = 0;
 
  virtual bool addDebugPartitionInfoAsMeshAttributes(QString cellAttrPrefix, QString nodeAttrPrefix) = 0;
 
  virtual void printPartitionRankTemplateData(const GmLogCategory& logger) const = 0;
 
  virtual void printPartitionClassStatistics(const GmLogCategory& logger) const = 0;
 
  // -- Coloring --------------------------
 
  enum ColorType {
    NO_COLORING,   
    FEM_COLORING,  
    FVM_COLORING,  
  };
 
  virtual ColorType coloringType() const = 0;
 
  enum ColorState {
    COLORED,            
    COLORED_WITH_HALO,  
    NOT_COLORED,        
    NOT_SET,            
  };
 
  virtual ColorState coloringState(const GmCellGroupSet* gs) = 0;
 
  virtual const QVector<GmCellGroupSet*>& coloredSets(const GmCellGroupSet* gs) = 0;
 
  virtual const GmCellGroupSet* sequentialSet(const GmCellGroupSet* gs) = 0;
 
  virtual const QVector<GmCellGroupSet*>& coloredHaloSets(const GmCellGroupSet* gs) = 0;
 
  virtual const GmCellGroupSet* sequentialHaloSet(const GmCellGroupSet* gs) = 0;
 
  virtual bool addColoringAsMeshAttribute(const GmCellGroupSet* gs, QString attrName) = 0;
 
  virtual bool addColoringAsMeshAttribute(const QVector<const GmCellGroupSet*>& gsets, QString attrName) = 0;
 
  virtual void printColoringStatistics(const GmLogCategory& logger) const = 0;
 
  // -- Renumbering --------------------------
 
  virtual bool nodesRenumbered() const = 0;
 
  virtual bool cellsRenumbered() const = 0;
 
  virtual int originalToLocalOrderNode(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderGeomNode(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderGhostNodeHighSet(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderGhostNodeHighClear(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderCell(int originalCellId) const = 0;
 
  virtual int originalToLocalOrderNodeSR(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderGeomNodeSR(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderGhostNodeHighSetSR(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderGhostNodeHighClearSR(int originalNodeId) const = 0;
 
  virtual int originalToLocalOrderCellSR(int originalCellId) const = 0;
 
 
  virtual int localOrderToOriginalNode(int nodeId) const = 0;
 
  virtual int localOrderToOriginalGeomNode(int nodeId) const = 0;
 
  virtual int localOrderToOriginalGhostNodeHighSet(int nodeId) const = 0;
 
  virtual int localOrderToOriginalGhostNodeHighClear(int nodeId) const = 0;
 
  virtual int localOrderToOriginalCell(int cellId) const = 0;
 
  virtual int originalNodeTraversalOrder(int i) const = 0;
 
  virtual int originalCellTraversalOrder(int i) const = 0;
 
  // --------------------------------------------------------------------------
  //  The "private" API used by the mesh plugin when creating the mesh.
  //  NOT for general use. Should be used only at model loading for adjusting 
  //  the mesh.
  // --------------------------------------------------------------------------
 
  virtual bool initPartitions(int numPartitions, int partition) = 0;
 
  virtual bool initNodeMapping(GmValueAccessor* ac, bool ghost, bool* renumbered,
                               QMap<int, int>& partOrigToLocOrder) = 0;
 
  virtual bool initCellMapping(bool* renumbered, QMap<int, int>& partOrigToLocOrder,
                               QVector<int>& partLocToOrigOrder) = 0;
 
  virtual QStringList cellMappingRequiredGroups() = 0;
 
  virtual bool addNodes(int numNodes) = 0;
 
  virtual bool addGhostNodes(int numGhostNodes) = 0;
 
  virtual bool addCells(int numCells) = 0;
 
  virtual void clear() = 0;
 
  //---------------------------------------
  // State dump control functions: Since the PCR object is always tied to 
  // the mesh, we are going to persist it together with the mesh. To do so,
  // the PCR object follows the same interface defined by GmMesh to add 
  // data to its state.
  //---------------------------------------
 
  // See comments on the base GmMesh class
  virtual bool addStateGeometryData    (GmStateDump* state, int groupId) = 0;
  virtual bool fillDumpControlMapData  (QVariantMap* map, const GmLogCategory& logger) = 0;
  virtual bool dumpControlMapDataLoaded(QVariantMap* map, const GmLogCategory& logger) = 0;
};
 
#endif // _GEMA_PCR_H_