MeshGeoToolsLib::BoundaryElementsAlongPolyline Class Reference

Detailed Description

This class collects element edges located along a polyline. Note that internal edges are not collected in this class.

Definition at line 27 of file BoundaryElementsAlongPolyline.h.

#include <BoundaryElementsAlongPolyline.h>

Collaboration diagram for MeshGeoToolsLib::BoundaryElementsAlongPolyline:

Public Member Functions
	BoundaryElementsAlongPolyline (MeshLib::Mesh const &mesh, MeshNodeSearcher const &mshNodeSearcher, GeoLib::Polyline const &ply)
virtual	~BoundaryElementsAlongPolyline ()
	destructor
GeoLib::Polyline const &	getPolyline () const
std::vector< MeshLib::Element * > const &	getBoundaryElements () const

Private Attributes
GeoLib::Polyline const &	_ply
std::vector< MeshLib::Element * >	_boundary_elements

Constructor & Destructor Documentation

BoundaryElementsAlongPolyline()

MeshGeoToolsLib::BoundaryElementsAlongPolyline::BoundaryElementsAlongPolyline	(	MeshLib::Mesh const &	mesh,
		MeshNodeSearcher const &	mshNodeSearcher,
		GeoLib::Polyline const &	ply )

Constructor

Parameters

mesh	a mesh object
mshNodeSearcher	a MeshNodeSearcher object which is internally used to search mesh nodes
ply	a polyline object where edges are searched

Definition at line 98 of file BoundaryElementsAlongPolyline.cpp.

    : _ply(ply)
{
    // search nodes and elements located along the polyline
    auto node_ids_on_poly = mshNodeSearcher.getMeshNodeIDs(ply);
    MeshLib::ElementSearch es(mesh);
    es.searchByNodeIDs(node_ids_on_poly);
    auto const& ele_ids_near_ply = es.getSearchedElementIDs();
 
    // check all edges of the elements near the polyline
    for (auto ele_id : ele_ids_near_ply)
    {
        auto* e = mesh.getElement(ele_id);
        // skip line elements
        if (e->getDimension() == 1)
        {
            continue;
        }
        // skip internal elements
        if (!e->isBoundaryElement())
        {
            continue;
        }
        // find edges on the polyline
        for (unsigned i = 0; i < e->getNumberOfEdges(); i++)
        {
            auto* edge = e->getEdge(i);
            // check if all edge nodes are along the polyline (if yes, store a
            // distance)
            std::vector<std::size_t> edge_node_distances_along_ply;
            if (includesAllEdgeNodeIDs(node_ids_on_poly, *edge,
                                       edge_node_distances_along_ply))
            {
                auto* new_edge = modifyEdgeNodeOrdering(
                    *edge, ply, edge_node_distances_along_ply,
                    node_ids_on_poly);
                if (edge != new_edge)
                {
                    delete edge;
                }
                _boundary_elements.push_back(new_edge);
            }
            else
            {
                delete edge;
            }
        }
    }
 
    // The sort was necessary in OGS-5 for some reason. I'm not sure if it is
    // needed anymore in OGS-6.
    // sort picked edges according to a distance of their first node along the
    // polyline
    std::sort(begin(_boundary_elements), end(_boundary_elements),
              [&](MeshLib::Element* e1, MeshLib::Element* e2)
              {
                  std::size_t dist1 = std::distance(
                      node_ids_on_poly.begin(),
                      std::find(node_ids_on_poly.begin(),
                                node_ids_on_poly.end(), getNodeIndex(*e1, 0)));
                  std::size_t dist2 = std::distance(
                      node_ids_on_poly.begin(),
                      std::find(node_ids_on_poly.begin(),
                                node_ids_on_poly.end(), getNodeIndex(*e2, 0)));
                  return (dist1 < dist2);
              });
}

References _boundary_elements, _ply, MeshLib::Mesh::getElement(), MeshGeoToolsLib::MeshNodeSearcher::getMeshNodeIDs(), MeshLib::ElementSearch::getSearchedElementIDs(), and MeshLib::ElementSearch::searchByNodeIDs().

~BoundaryElementsAlongPolyline()

MeshGeoToolsLib::BoundaryElementsAlongPolyline::~BoundaryElementsAlongPolyline ( )

virtual

destructor

Definition at line 168 of file BoundaryElementsAlongPolyline.cpp.

{
    for (auto p : _boundary_elements)
    {
        delete p;
    }
}

References _boundary_elements.

Member Function Documentation

getBoundaryElements()

std::vector< MeshLib::Element * > const & MeshGeoToolsLib::BoundaryElementsAlongPolyline::getBoundaryElements ( ) const

inline

Return the vector of boundary elements (i.e. edges). The elements are sorted according to their distance to the starting point of the given polyline.

Definition at line 56 of file BoundaryElementsAlongPolyline.h.

    {
        return _boundary_elements;
    }

References _boundary_elements.

getPolyline()

GeoLib::Polyline const & MeshGeoToolsLib::BoundaryElementsAlongPolyline::getPolyline ( ) const

inline

Deploying this method the user can get access to the underlying GeoLib::Polyline.

Returns

the underlying GeoLib::Polyline

Definition at line 49 of file BoundaryElementsAlongPolyline.h.

{ return _ply; }

References _ply.

Referenced by MeshGeoToolsLib::BoundaryElementsSearcher::getBoundaryElements().

Member Data Documentation

_boundary_elements

std::vector<MeshLib::Element*> MeshGeoToolsLib::BoundaryElementsAlongPolyline::_boundary_elements

private

Definition at line 63 of file BoundaryElementsAlongPolyline.h.

Referenced by BoundaryElementsAlongPolyline(), ~BoundaryElementsAlongPolyline(), and getBoundaryElements().

_ply

GeoLib::Polyline const& MeshGeoToolsLib::BoundaryElementsAlongPolyline::_ply

private

Definition at line 62 of file BoundaryElementsAlongPolyline.h.

Referenced by BoundaryElementsAlongPolyline(), and getPolyline().

---

The documentation for this class was generated from the following files:

• BoundaryElementsAlongPolyline.h
• BoundaryElementsAlongPolyline.cpp