gmCell.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_H_
#define _GEMA_CELL_H_


#include "gmCellGeometry.h"

class GmValueAccessor;
class GmIntegrationRule;

class  GmCellMesh;
struct lua_State;


enum GmCellFillMode
{
  GM_CELL_NODES,     
  GM_CELL_VERTICES,  
  GM_CELL_GHOST,     
  GM_CELL_ALL,       
};

enum GmCellGeometryMode
{
  GM_CELLGEOM_AUTO,    
  GM_CELLGEOM_ELEM,    
  GM_CELLGEOM_LINEAR,  
};


class GMC_API_EXPORT GmCell
{
public:

  virtual ~GmCell() {}

  virtual int cellId() const = 0;

  virtual GmCellMesh* mesh() const = 0;

  virtual bool active() const = 0;

  virtual void pushProxy(lua_State* L, const GmLogCategory& logger) = 0;

  virtual GmCellType type() const = 0;

  const char* typeStr() const { return typeToStr(type()); }

  virtual GmCellGeometry geometry() const { return GmCellGeometry(type()); }

  virtual int numNodes() const = 0;

  virtual int numGhostNodes() const { return 0; }

  virtual int totalNumNodes() const { return numNodes() + numGhostNodes(); }

  virtual int nodeIndex(int localIndex) const = 0;

  virtual void nodes(int* nodeList, bool ghost) const = 0;

  virtual int propertyIndex(int propertySet) const = 0;

  virtual void setActive(bool active) = 0;

  virtual bool setNodes(const int* nodeList)
  {
    Q_UNUSED(nodeList);
    return false;
  }

  virtual int addGhostNode(int globalIndex)
  {
    Q_UNUSED(globalIndex);
    return -1;
  }

  virtual void removeGhostNode(int localIndex)
  {
    Q_UNUSED(localIndex);
  }

  virtual bool setProperties(const int* propList, int nprop)
  {
    Q_UNUSED(propList); Q_UNUSED(nprop);
    return false;
  }

  GmCell* adjacentCell(int sideIndex, int* adjSideIndex = NULL) const;

  double length(const GmValueAccessor* coordAccessor, int edgeIndex = 0, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;
  double length(const GmMatrix& X,                    int edgeIndex = 0, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;

  double area(const GmValueAccessor* coordAccessor, int faceIndex = 0, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;
  double area(const GmMatrix& X,                    int faceIndex = 0, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;

  double volume(const GmValueAccessor* coordAccessor, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;
  double volume(const GmMatrix& X,                    GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;

  double characteristicLength(const GmValueAccessor* coordAccessor, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;
  double characteristicLength(const GmMatrix& X,                    GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;

  double characteristicDimension(const GmValueAccessor* coordAccessor, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;
  double characteristicDimension(const GmMatrix& X,                    GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;

  void centroidCartesian(const GmValueAccessor* coordAccessor, GmVector& coord, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;
  void centroidCartesian(const GmMatrix& X,                    GmVector& coord, GmCellGeometryMode linearMode = GM_CELLGEOM_AUTO) const;

  virtual bool isValid(const GmValueAccessor* nodeAccessor, double tol = 1e-5) const;

  virtual double quality(const GmValueAccessor* nodeAccessor, double tol = 1e-5) const;

  virtual bool contains(const GmValueAccessor* nodeAccessor, const GmVector& coord) const
  {
    GmMatrix X; fillNodeMatrix(nodeAccessor, X, true);
    return geometry().contains(X, coord);
  }

  // There once was a "projected" method that, given a coordinate of a point outside the 
  // cell, should return the coordinate of that point projected on the cell, together with 
  // their distances. Since that method was not used and was never really validated, it was 
  // removed from the cell API. The basic (unvalidated) method implementation core still 
  // remains in the GmGometryUtils namespace though.

  void fillNodeMatrix    (const GmValueAccessor* nodeAccessor, GmMatrix& m, bool transposed = false, GmCellFillMode mode = GM_CELL_NODES) const;
  void fillFaceNodeMatrix(const GmValueAccessor* nodeAccessor, GmMatrix& m, int faceIndex, bool transposed = false, GmCellFillMode mode = GM_CELL_NODES) const;
  void fillEdgeNodeMatrix(const GmValueAccessor* nodeAccessor, GmMatrix& m, int edgeIndex, bool transposed = false, GmCellFillMode mode = GM_CELL_NODES) const;

  void fillDeformedNodeMatrix    (const GmValueAccessor* nodeAccessor, const GmValueAccessor* uAccessor, GmMatrix& m, GmVector& u, bool transposed = false, GmCellFillMode mode = GM_CELL_NODES) const;
  void fillDeformedFaceNodeMatrix(const GmValueAccessor* nodeAccessor, const GmValueAccessor* uAccessor, GmMatrix& m, GmVector& u, int faceIndex, bool transposed = false, GmCellFillMode mode = GM_CELL_NODES) const;
  void fillDeformedEdgeNodeMatrix(const GmValueAccessor* nodeAccessor, const GmValueAccessor* uAccessor, GmMatrix& m, GmVector& u, int edgeIndex, bool transposed = false, GmCellFillMode mode = GM_CELL_NODES) const;

  static int         typeToNumNodes(GmCellType type);
  static const char* typeToStr(GmCellType type);
  static int         strToType(QString str);


  //-------------------------------------------------------------------
  // State dump helper functions. The following functions are added 
  // to help the implementation of mesh state dumping based on the 
  // standard mesh plugin. They really don't belong here, but can't be 
  // easily added to GmpCellBase (from the GemaMesh plugin) due to its 
  // template nature and the need for them to be called from a GmCell*
  // pointer (or any other non templated class). An alternative would
  // be to collect them in an auxiliary class and make GmpCellBase
  // to also inherit from that class. That works, but using multiple 
  // inheritance would add another virtual table pointer to the cell 
  // object, increasing its size.
  //-------------------------------------------------------------------

  virtual int meshId() const = 0;

  virtual void replaceCellId(int id, bool keepActiveFlag) { Q_UNUSED(id); Q_UNUSED(keepActiveFlag); }

  virtual void replaceGhostNodes(int* ghostNodes, int numNodes) { Q_UNUSED(ghostNodes); Q_UNUSED(numNodes); }
};


#endif