gmMesh.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_MESH_H_
#define _GEMA_MESH_H_
 
#include "gmPluginObject.h"
#include "gmPluginCategory.h"
#include "gmStateDumpItem.h"
#include "gmPrintUtils.h"
#include "gmPCR.h"
 
#include "gmValueSetGroup.h"
 
class  GmStateVar;
class  GmNodeSet;
class  GmPCR;
class  GmPhysicsUserFunctions;
 
class  Unit;
struct lua_State;
 
#define GM_GHOSTNODE_MASK (~(~0u >> 1))
 
class GMC_API_EXPORT GmMesh : public QObject, public GmPluginObject, public GmGroupDumpItem
{
Q_OBJECT
 
public:
  GmMesh(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmMesh();
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_MESH; }
 
  virtual bool hasCapability(QString capabilityName) const = 0;
 
  virtual bool useDualVectors() const = 0;
 
  virtual void pushProxy(lua_State* L, const GmLogCategory& logger) = 0;
 
  virtual GmValueInfo* nodeCoordInfo() const = 0;
 
  virtual GmValueAccessor* nodeCoordAccessor(Unit desiredUnit, const GmLogCategory& logger) const = 0;
 
  virtual int numNodes() const = 0;
 
  virtual int numGhostNodes() const { return 0; }
 
  int totalNumNodes() const { return numNodes() + numGhostNodes(); }
 
  virtual int numGlobalNodes() const { return pcrObject()->numGlobalNodes(); }
 
  virtual int numGlobalGhostNodes() const { return pcrObject()->numGlobalGhostNodes(); }
 
  int totalNumGlobalNodes() const { return numGlobalNodes() + numGlobalGhostNodes(); }
 
 
  static bool isGhostNode(int nodeIndex) { return nodeIndex & GM_GHOSTNODE_MASK; }
 
  static int setGhostFlag(int nodeIndex) { return nodeIndex | GM_GHOSTNODE_MASK; }
 
  static int clearGhostFlag(int nodeIndex) { return nodeIndex & (~GM_GHOSTNODE_MASK); }
 
  int toLinearGhostIndex(int nodeIndex) const { return isGhostNode(nodeIndex) ? clearGhostFlag(nodeIndex) + numNodes() : nodeIndex; }
 
  int toLocalGhostIndex(int nodeIndex) const { return nodeIndex - numNodes(); }
 
  virtual const QMap<QString, GmNodeSet*>& nodeSets() const = 0;
 
  QStringList nodeValueIds(int filter = -1) const;
 
  virtual GmValueInfo*     nodeValueInfo(QString id, int filter = -1) const;
  virtual GmValueAccessor* nodeValueAccessor(QString id, Unit desiredUnit, const GmLogCategory& logger) const;
  virtual GmValueAccessor* nodeValueAccessor(QString id, int snum, bool locked, Unit desiredUnit, const GmLogCategory& logger) const;
 
  virtual GmValueAccessor* nodeStateVarAccessorFromDof(int dof, Unit desiredUnit, GmStateVar** stateVar) const;
 
  virtual bool addNodeValueSet(GmValueInfo* info);
  virtual void removeNodeValueSet(QString id);
  virtual bool initNodeValueSets();
  virtual void beginAddingNodeAttributeSets();
  virtual bool endAddingNodeAttributeSets();
  virtual void clearNodeValueSets();
  virtual void clearNodeValueSetsData();
 
  virtual bool    saveState            (GmValueSet::SaveStateMode mode, const GmLogCategory& logger);
  virtual bool    saveNodeValueState   (QString id, GmValueSet::SaveStateMode mode, const GmLogCategory& logger);
  virtual int     numNodeValueStates   (QString id) const;
  virtual QString nodeValueStateTag    (QString id, int snum) const;
  virtual double  nodeValueStateTime   (QString id, int snum) const;
  virtual void    setNodeValueStateTag (QString id, int snum, QString tag);
  virtual void    setNodeValueStateTime(QString id, int snum, double time);
 
 
  virtual int addNodes(int numNodes) { Q_UNUSED(numNodes);  return -1; }
 
  virtual int addGhostNodes(int numNodes) { Q_UNUSED(numNodes);  return numNodes == 0 ? -2 : -1; }
 
  virtual void clear() {}
 
  QMap<QString, GmPhysicsUserFunctions*>& userFunctionsObjMap() const { return _cUserFuncObjMap; }
 
  virtual void printParameters(const GmLogCategory& logger);
  virtual void printValues    (const GmLogCategory& logger, int options = GM_PRINT_DEFAULT);
 
  virtual size_t nodeMemory() const = 0;
 
  virtual size_t nodeSetsMemory() const = 0;
  
  virtual GmPCR* pcrObject() const = 0;
 
  GmValueSetGroup* nodeValueSetGroup() const { return _nodeValuesGroup; }
 
  GmValueSet* nodeValueSet(QString id) const { return _nodeValuesGroup->valueSet(id); }
 
 
  GmValueSetGroup* ghostNodeValueSetGroup() const { return _ghostNodeValuesGroup; }
 
  GmValueSet* ghostNodeValueSet(QString id) const { return _ghostNodeValuesGroup->valueSet(id); }
 
  virtual void emitMeshChanged() { emit meshChanged(); }
 
signals:
  void meshChanged();
 
protected:
 
  GmValueSet* anyVsFromId(QString id) const
  { 
    GmValueSet* vs = nodeValueSet(id);
    if(!vs)
      vs = ghostNodeValueSet(id);
    return vs;
  }
 
  void printValueInfo(const GmLogCategory& logger, QString title, const QStringList& idList);
 
  virtual bool addStateItemsToGroup(GmStateDump* state, int groupId);
 
  virtual int controlMapStateItemType() { return GM_MESH_DUMP_ITEM; }
 
  virtual bool addStateGeometryData(GmStateDump* state, int groupId) { Q_UNUSED(state); Q_UNUSED(groupId); return true; }
 
  virtual bool addStateAccessorData(GmStateDump* state, int groupId);
 
  virtual bool fillDumpControlMapData  (QVariantMap* map, const GmLogCategory& logger);
  virtual bool dumpControlMapDataLoaded(QVariantMap* map, const GmLogCategory& logger);
 
  int _stateDumpControlMapItem; 
 
private:
  Q_DISABLE_COPY(GmMesh)
 
  GmValueSetGroup* _nodeValuesGroup;       
  GmValueSetGroup* _ghostNodeValuesGroup;  
 
  mutable QMap<QString, GmPhysicsUserFunctions*> _cUserFuncObjMap;
 
  QVariantMap _stateDumpControlMap; 
};
 
#endif