spatiallocalizer.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef spatiallocalizer_h
#define spatiallocalizer_h
 
#include "oofemenv.h"
#include "interface.h"
#include "logger.h"
#include "error.h"
#include "set.h"
 
#include <set>
#include <list>
 
namespace oofem {
class Domain;
class Element;
class TimeStep;
class GaussPoint;
class FloatArray;
class IntArray;
class Node;

class OOFEM_EXPORT SpatialLocalizerInterface : public Interface
{
private:
    Element *element;
 
public:
    SpatialLocalizerInterface(Element *element) : Interface(), element(element) { }


    virtual int SpatialLocalizerI_containsPoint(const FloatArray &coords);
    int SpatialLocalizerI_BBoxContainsPoint(const FloatArray &coords);
    virtual void SpatialLocalizerI_giveBBox(FloatArray &bb0, FloatArray &bb1);

    virtual double SpatialLocalizerI_giveClosestPoint(FloatArray &lcoords, FloatArray &closest, const FloatArray &gcoords);
};
 

class OOFEM_EXPORT SpatialLocalizer
{
protected:
    Domain *domain;
 
public:
    typedef IntArray elementContainerType;
    typedef std :: list< int > nodeContainerType;

    SpatialLocalizer(Domain * d) : domain(d) { }
 
    virtual ~SpatialLocalizer() { }

    Domain *giveDomain() { return domain; }

    virtual Element *giveElementContainingPoint(const FloatArray &coords, const IntArray *regionList=nullptr) = 0;
    virtual Element *giveElementContainingPoint(const FloatArray &coords, const Set &eset) = 0;
    virtual Element *giveElementClosestToPoint(FloatArray &lcoords, FloatArray &closest,
                                               const FloatArray &coords, int region = 0) = 0;
    virtual GaussPoint *giveClosestIP(const FloatArray &coords, int region, bool iCohesiveZoneGP = false) = 0;
    virtual GaussPoint *giveClosestIP(const FloatArray &coords, Set &elemSet, bool iCohesiveZoneGP = false) = 0;

    virtual void giveAllElementsWithIpWithinBox(elementContainerType &elemSet, const FloatArray &coords,
                                                 const double radius) = 0;
 
    virtual void giveAllElementsWithIpWithinBox_EvenIfEmpty(elementContainerType &elemSet, const FloatArray &coords,
                                                 const double radius) = 0;
    virtual void giveAllElementsWithNodesWithinBox(elementContainerType &elemSet, const FloatArray &coords,
                                                   const double radius);

    virtual void giveAllNodesWithinBox(nodeContainerType &nodeList, const FloatArray &coords, const double radius) = 0;

    virtual Node *giveNodeClosestToPoint(const FloatArray &coords, double maxDist) = 0;

    virtual int init(bool force = false) { return 1; }
 
    virtual const char *giveClassName() const = 0;
    std :: string errorInfo(const char *func) const { return std :: string(giveClassName()) + func; }
};
} // end namespace oofem
#endif // spatiallocalizer_h