gmSpatialIndex.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2015 by Erwan Yann Renaut
** 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_SPATIAL_INDEX_H_
#define _GEMA_SPATIAL_INDEX_H_
 
#include "gmPluginObject.h"
#include "gmPluginCategory.h"
 
#include "gmVector.h"
#include <functional>
 
class GmMesh;
class GmCell;
class GmValueAccessor;
 
 
#define GMP_MAX_INDEX_DIM 3
 
struct GmpMmGaussData {
    int cellId;         //Cell Id
    int ip;             //Integration point Id
    double ccoord[GMP_MAX_INDEX_DIM];   // Cartesian coordinates of the point
 
    GmpMmGaussData() : cellId(-1), ip(-1)
    {
        memset(ccoord, 0, sizeof(double) * GMP_MAX_INDEX_DIM);
    }
 
    bool operator==(const GmpMmGaussData& other) const { 
        bool eq = cellId == other.cellId && ip == other.ip;
        //If cell/ip are equal the cached coord should also be, but we dont check it
        assert(!eq || !memcmp(ccoord, other.ccoord, sizeof(double) * GMP_MAX_INDEX_DIM));
        return eq;
    }
};
 
template<typename T>
struct GmpRefDist {
    T value;
    double distance;
};
 
class GMC_API_EXPORT GmSpatialIndex : public GmPluginObject
{
public:
  GmSpatialIndex(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmSpatialIndex();
 
  /*
    Extends GmSpatialIndex point search  with a 'point validator',
    which can be passed as argument to the methods.
    It takes the coordinates of the search and query points, and
    only include the search point if 'validator' returns true.
    It is not assumed to be symetric!!!
    Point are always passed in the order
    'validator(src, dst)'
    with 'src' being the query coordinate and 'dst' a point belonging to the spatial index.
  */
  using PointValidator = std::function<bool(const double*, const double*)>;
  static bool defaultPointValidator(const double*, const double*) { return true; }
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_SPATIALINDEX; }
 
  virtual bool hasCapability(QString capabilityName) const = 0;
 
  virtual GmMesh* mesh() const = 0;
 
  virtual int ndim() const = 0;
 
  virtual const GmValueAccessor* coordAccessor() const = 0;
 
  virtual bool activeOnly() const = 0;
 
  virtual int ruleSet() const = 0;
 
  virtual bool isOutsideOfDomain(const GmVector& crd) const = 0;
 
  virtual int numReferences() const = 0;
 
  virtual bool getClosestNode(const GmVector& crd, double& sqrDist, int& outNodeId, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestNodes(const GmVector& crd, int n, QVector <GmpRefDist<int>>& nodeList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestNodes(const GmVector& crd, double r, QVector <GmpRefDist<int>>& nodeList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestNodes(const GmVector& crd, int n, QVector<int>& nodeList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestNodes(const GmVector& crd, double r, QVector<int>& nodeList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual GmCell* getContainingCell(const GmVector& crd) const = 0;
 
  virtual bool getClosestGaussPoint(const GmVector& crd, double& sqrDist, GmpMmGaussData& outRef, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestGaussPoints(const GmVector& crd, int n, QVector<GmpRefDist<GmpMmGaussData> >& gpList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestGaussPoints(const GmVector& crd, double r, QVector<GmpRefDist<GmpMmGaussData> >& gpList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestGaussPoints(const GmVector& crd, int n, QVector<GmpMmGaussData>& gpList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void getClosestGaussPoints(const GmVector& crd, double r, QVector<GmpMmGaussData>& gpList, bool ordered, const PointValidator& pv = defaultPointValidator) const = 0;
 
  virtual void printParameters(const GmLogCategory& logger);
};
 
 
#endif // _GEMA_SPATIAL_INDEX_H_