gmpRegularGridMesh.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_PLUGIN_REGULAR_GRID_MESH_H_
#define _GEMA_PLUGIN_REGULAR_GRID_MESH_H_
 
#include <gmRegularGridMesh.h>
#include <gmLuaMesh.h>
 
#include "gmpRegularGridMeshConfig.h"
 
 
class GMP_REGULARGRIDMESH_API_EXPORT GmpRegularGridMesh: public GmRegularGridMesh
{
public:
  GmpRegularGridMesh(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmpRegularGridMesh();
 
  // Comments on the base class
  virtual const char* pluginName() const { return "RegularGridMesh"; }
 
  // Comments on the base class
  virtual const char* pluginType() const { return "grid"; }
 
  virtual bool loadPrivateData(LuaTable& table);
 
  // Comments on the base class
  virtual bool hasCapability(QString capabilityName) const { return false; }
 
  // Comments on the base class
  virtual bool useDualVectors() const { return false; }
 
  // Comments on the base class
  virtual void pushProxy(lua_State* L, const GmLogCategory& logger) { LuaProxy::pushObject(L, new GmLuaRegularGridMesh(this, logger)); }
 
  // Comments on the base class
  virtual GmValueInfo* nodeCoordInfo() const { return _coordInfo; }
 
  // Comments on the base class
  virtual GmValueAccessor* nodeCoordAccessor(Unit desiredUnit, const GmLogCategory& logger) const;
 
  // See comments on the base interface class
  virtual int numNodes() const { return _nnodes; }
 
  // See comments on the base interface class
  virtual double nodeSpacing(int dim) const { assert(dim >= 0 && dim < _ndim);  return _spacing[dim]; }
 
  // See comments on the base interface class
  virtual int nodeCount(int dim) const { assert(dim >= 0 && dim < _ndim);  return _count[dim]; }
 
  // See comments on the base interface class
  virtual bool nodeWrap(int dim) const { assert(dim >= 0 && dim < _ndim);  return _wrap[dim]; }
 
  virtual int nodeFromIndex(int x, int y = -1, int z = -1) const;
 
  virtual void indexFromNode(int node, int* x, int* y = NULL, int* z = NULL) const;
 
  virtual int neighbor(int node, int xoffset, int yoffset = 0, int zoffset = 0) const;
 
  // Comments on the base class
  virtual const QMap<QString, GmNodeSet*>& nodeSets() const { return _nodeSets; }
 
  virtual void printParameters(const GmLogCategory& logger);
 
  // See comments on the base interface class
  virtual size_t nodeMemory() const { return 0.0; } // No storage is needed per node
 
  virtual size_t nodeSetsMemory() const;
 
  virtual GmPCR* pcrObject() const { return _pcr; }
 
private: 
  friend class GmpRegularGridMeshCoordAccessor;
 
  int           _ndim;      
  int           _nnodes;    
  GmValueInfo*  _coordInfo; 
  GmVector      _origin;    
  GmVector      _spacing;   
  QVector<int>  _count;     
  QVector<bool> _wrap;      
  GmPCR*        _pcr;       
  
  QMap<QString, GmNodeSet*> _nodeSets;
};
 
 
#endif