Detailed Description

Element search class.

Definition at line 27 of file ElementSearch.h.

#include <ElementSearch.h>

Collaboration diagram for MeshLib::ElementSearch:

Public Member Functions
	ElementSearch (const MeshLib::Mesh &mesh)

const std::vector< std::size_t > &	getSearchedElementIDs () const
	return marked elements More...

template<typename PROPERTY_TYPE >
std::size_t	searchByPropertyValue (std::string const &property_name, PROPERTY_TYPE const property_value)

template<typename PROPERTY_TYPE >
std::size_t	searchByPropertyValueRange (std::string const &property_name, PROPERTY_TYPE const min_property_value, PROPERTY_TYPE const max_property_value, bool outside_of)

std::size_t	searchByElementType (MeshElemType eleType)
	Marks all elements of the given element type. More...

std::size_t	searchByContent (double eps=std::numeric_limits< double >::epsilon())
	Marks all elements with a volume smaller than eps. More...

std::size_t	searchByBoundingBox (GeoLib::AABB const &aabb)
	Marks all elements with at least one node outside the bounding box spanned by x1 and x2;. More...

std::size_t	searchByNodeIDs (const std::vector< std::size_t > &nodes)
	Marks all elements connecting to any of the given nodes. More...

Private Member Functions
void	updateUnion (const std::vector< std::size_t > &vec)
	Updates the vector of marked elements with values from vec. More...

Private Attributes
const MeshLib::Mesh &	_mesh
	The mesh from which elements should be removed. More...

std::vector< std::size_t >	_marked_elements
	The vector of element indices that should be removed. More...

Constructor & Destructor Documentation

◆ ElementSearch()

MeshLib::ElementSearch::ElementSearch ( const MeshLib::Mesh & mesh )

explicit

Definition at line 19 of file ElementSearch.cpp.

19 : _mesh(mesh) {}

MeshLib::ElementSearch::_mesh

const MeshLib::Mesh & _mesh

The mesh from which elements should be removed.

Definition: ElementSearch.h:136

Member Function Documentation

◆ getSearchedElementIDs()

const std::vector<std::size_t>& MeshLib::ElementSearch::getSearchedElementIDs ( ) const

inline

return marked elements

Definition at line 33 of file ElementSearch.h.

33 { return _marked_elements; }

MeshLib::ElementSearch::_marked_elements

std::vector< std::size_t > _marked_elements

The vector of element indices that should be removed.

Definition: ElementSearch.h:138

References _marked_elements.

Referenced by MeshGeoToolsLib::BoundaryElementsAlongPolyline::BoundaryElementsAlongPolyline(), MeshGeoToolsLib::BoundaryElementsOnSurface::BoundaryElementsOnSurface(), MeshElementRemovalDialog::accept(), MeshLib::RasterToMesh::convert(), LayeredVolume::createRasterLayers(), main(), MeshLib::removeNodes(), and removeUnusedGridCells().

◆ searchByBoundingBox()

std::size_t MeshLib::ElementSearch::searchByBoundingBox ( GeoLib::AABB const & aabb )

Marks all elements with at least one node outside the bounding box spanned by x1 and x2;.

Definition at line 55 of file ElementSearch.cpp.

 {
     auto matchedIDs =
         filter(_mesh.getElements(),
                [&aabb](MeshLib::Element* e)
                {
                    std::size_t const nElemNodes(e->getNumberOfBaseNodes());
                    for (std::size_t n = 0; n < nElemNodes; ++n)
                    {
                        if (aabb.containsPoint(*e->getNode(n), 0))
                        {
                            return true;  // any node of element is in aabb.
                        }
                    }
                    return false;  // no nodes of element are in aabb.
                });
  
     this->updateUnion(matchedIDs);
     return matchedIDs.size();
 }

References _mesh, MeshLib::filter(), and MeshLib::Mesh::getElements().

Referenced by MeshElementRemovalDialog::accept(), and main().

◆ searchByContent()

std::size_t MeshLib::ElementSearch::searchByContent ( double eps = std::numeric_limits<double>::epsilon() )

Marks all elements with a volume smaller than eps.

Definition at line 46 of file ElementSearch.cpp.

 {
     auto matchedIDs = filter(_mesh.getElements(), [&eps](MeshLib::Element* e)
                              { return e->getContent() < eps; });
  
     this->updateUnion(matchedIDs);
     return matchedIDs.size();
 }

References _mesh, MeshLib::filter(), MeshLib::Mesh::getElements(), and updateUnion().

Referenced by MeshElementRemovalDialog::accept(), and main().

◆ searchByElementType()

std::size_t MeshLib::ElementSearch::searchByElementType ( MeshElemType eleType )

Marks all elements of the given element type.

Definition at line 37 of file ElementSearch.cpp.

 {
     auto matchedIDs = filter(_mesh.getElements(), [&](MeshLib::Element* e)
                              { return e->getGeomType() == eleType; });
  
     this->updateUnion(matchedIDs);
     return matchedIDs.size();
 }

References _mesh, MeshLib::filter(), MeshLib::Mesh::getElements(), and updateUnion().

Referenced by MeshElementRemovalDialog::accept(), LayeredVolume::createRasterLayers(), and main().

◆ searchByNodeIDs()

std::size_t MeshLib::ElementSearch::searchByNodeIDs ( const std::vector< std::size_t > & nodes )

Marks all elements connecting to any of the given nodes.

Definition at line 76 of file ElementSearch.cpp.

 {
     std::vector<std::size_t> connected_elements;
     for (std::size_t node_id : nodes)
     {
         auto const& elements = _mesh.getElementsConnectedToNode(node_id);
         std::transform(begin(elements), end(elements),
                        back_inserter(connected_elements),
                        [](Element const* const e) { return e->getID(); });
     }
  
     BaseLib::makeVectorUnique(connected_elements);
  
     this->updateUnion(connected_elements);
     return connected_elements.size();
 }

References MeshLib::Element::getID(), and BaseLib::makeVectorUnique().

Referenced by MeshGeoToolsLib::BoundaryElementsAlongPolyline::BoundaryElementsAlongPolyline(), MeshGeoToolsLib::BoundaryElementsOnSurface::BoundaryElementsOnSurface(), and MeshLib::removeNodes().

◆ searchByPropertyValue()

template<typename PROPERTY_TYPE >

std::size_t MeshLib::ElementSearch::searchByPropertyValue	(	std::string const &	property_name,
		PROPERTY_TYPE const	property_value
	)

inline

Template Parameters

PROPERTY_TYPE type of the property Different properties can be assigned to the elements of the mesh. These properties can be accessed by the name of the property. The method marks all elements of the mesh for the property property_name with a property value equal to property_value.

Parameters

property_name	the name of the property the searching/marking is based on
property_value	value required for the element to be marked

Returns: The number of marked elements will be returned. The concrete element ids can be requested by getSearchedElementIDs().

Definition at line 46 of file ElementSearch.h.

     {
         return searchByPropertyValueRange<PROPERTY_TYPE>(
             property_name, property_value, property_value, false);
     }

Referenced by MeshLib::RasterToMesh::convert(), and searchByPropertyValue().

◆ searchByPropertyValueRange()

template<typename PROPERTY_TYPE >

std::size_t MeshLib::ElementSearch::searchByPropertyValueRange	(	std::string const &	property_name,
		PROPERTY_TYPE const	min_property_value,
		PROPERTY_TYPE const	max_property_value,
		bool	outside_of
	)

inline

Template Parameters

PROPERTY_TYPE type of the property Different properties can be assigned to the elements of the mesh. These properties can be accessed by the name of the property. The method marks all elements of the mesh for the property property_name with a property value outside of the interval [min_property_value, max_property_value].

Parameters

property_name	the name of the property the searching/marking is based on
min_property_value	minimum value of the given property for the element not to be marked
max_property_value	maximum value of the given property for the element not to be marked
outside_of	if true, all values outside of the given range are marked, if false, all values inside the given range are marked

Returns: The number of marked elements will be returned. The concrete element ids can be requested by getSearchedElementIDs().

Definition at line 70 of file ElementSearch.h.

     {
         MeshLib::PropertyVector<PROPERTY_TYPE> const* pv = nullptr;
         try
         {
             pv = _mesh.getProperties().getPropertyVector<PROPERTY_TYPE>(
                 property_name, MeshLib::MeshItemType::Cell, 1);
         }
         catch (std::runtime_error const& e)
         {
             ERR("{:s}", e.what());
             WARN(
                 "Value-based element removal currently only works for "
                 "scalars.");
             return 0;
         }
  
         std::vector<std::size_t> matchedIDs;
  
         if (outside_of)
         {
             for (std::size_t i(0); i < pv->getNumberOfTuples(); ++i)
             {
                 if ((*pv)[i] < min_property_value ||
                     (*pv)[i] > max_property_value)
                 {
                     matchedIDs.push_back(i);
                 }
             }
         }
         else
         {
             for (std::size_t i(0); i < pv->getNumberOfTuples(); ++i)
             {
                 if ((*pv)[i] >= min_property_value &&
                     (*pv)[i] <= max_property_value)
                 {
                     matchedIDs.push_back(i);
                 }
             }
         }
         updateUnion(matchedIDs);
         return matchedIDs.size();
     }

References _mesh, MeshLib::Cell, ERR(), MeshLib::PropertyVector< PROP_VAL_TYPE >::getNumberOfTuples(), MeshLib::Mesh::getProperties(), MeshLib::Properties::getPropertyVector(), updateUnion(), and WARN().

Referenced by MeshElementRemovalDialog::accept(), removeUnusedGridCells(), and searchByPropertyRange().

◆ updateUnion()

void MeshLib::ElementSearch::updateUnion ( const std::vector< std::size_t > & vec )

private

Updates the vector of marked elements with values from vec.

Definition at line 94 of file ElementSearch.cpp.

 {
     std::vector<std::size_t> vec_temp(vec.size() + _marked_elements.size());
     auto it = std::set_union(vec.begin(), vec.end(), _marked_elements.begin(),
                              _marked_elements.end(), vec_temp.begin());
     vec_temp.resize(it - vec_temp.begin());
     _marked_elements.assign(vec_temp.begin(), vec_temp.end());
 }

Referenced by searchByContent(), searchByElementType(), and searchByPropertyValueRange().

Member Data Documentation

◆ _marked_elements

std::vector<std::size_t> MeshLib::ElementSearch::_marked_elements

private

The vector of element indices that should be removed.

Definition at line 138 of file ElementSearch.h.

Referenced by getSearchedElementIDs().

◆ _mesh

const MeshLib::Mesh& MeshLib::ElementSearch::_mesh

private

The mesh from which elements should be removed.

Definition at line 136 of file ElementSearch.h.

Referenced by searchByBoundingBox(), searchByContent(), searchByElementType(), and searchByPropertyValueRange().

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

MeshLib/MeshSearch/ElementSearch.h
MeshLib/MeshSearch/ElementSearch.cpp

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ ElementSearch()

Member Function Documentation

◆ getSearchedElementIDs()

◆ searchByBoundingBox()

◆ searchByContent()

◆ searchByElementType()

◆ searchByNodeIDs()

◆ searchByPropertyValue()

◆ searchByPropertyValueRange()

◆ updateUnion()

Member Data Documentation

◆ _marked_elements

◆ _mesh