Detailed Description

Base class for creation of 3D subsurface meshes based on raster data.

Definition at line 37 of file LayeredMeshGenerator.h.

#include <LayeredMeshGenerator.h>

Inheritance diagram for LayeredMeshGenerator:

Public Member Functions
virtual bool	createLayers (MeshLib::Mesh const &mesh, std::vector< GeoLib::Raster const * > const &rasters, double minimum_thickness, double noDataReplacementValue=0.0) final

virtual bool	createRasterLayers (MeshLib::Mesh const &mesh, std::vector< GeoLib::Raster const * > const &rasters, double minimum_thickness, double noDataReplacementValue)=0

std::unique_ptr< MeshLib::Mesh >	getMesh (std::string const &mesh_name) const
	Returns a mesh of the subsurface representation.

Protected Member Functions
	LayeredMeshGenerator ()=default

virtual	~LayeredMeshGenerator ()=default

virtual void	addLayerToMesh (MeshLib::Mesh const &mesh_layer, unsigned layer_id, GeoLib::Raster const &raster)=0
	Adds another layer to the subsurface mesh.

MeshLib::Node *	getNewLayerNode (MeshLib::Node const &dem_node, MeshLib::Node const &last_layer_node, GeoLib::Raster const &raster, std::size_t new_node_id) const

Static Protected Member Functions
static double	calcEpsilon (GeoLib::Raster const &low, GeoLib::Raster const &high)
	Calculates a data-dependent epsilon value.

Protected Attributes
double	_elevation_epsilon {0.0001}

double	_minimum_thickness {std::numeric_limits<float>::epsilon()}

std::vector< int >	_materials

std::vector< MeshLib::Node * >	_nodes

std::vector< MeshLib::Element * >	_elements

Constructor & Destructor Documentation

◆ LayeredMeshGenerator()

LayeredMeshGenerator::LayeredMeshGenerator ( )

protecteddefault

◆ ~LayeredMeshGenerator()

virtual LayeredMeshGenerator::~LayeredMeshGenerator ( )

protectedvirtualdefault

Member Function Documentation

◆ addLayerToMesh()

virtual void LayeredMeshGenerator::addLayerToMesh	(	MeshLib::Mesh const &	mesh_layer,
		unsigned	layer_id,
		GeoLib::Raster const &	raster )

protectedpure virtual

Adds another layer to the subsurface mesh.

Implemented in LayeredVolume, and MeshToolsLib::MeshLayerMapper.

◆ calcEpsilon()

double LayeredMeshGenerator::calcEpsilon	(	GeoLib::Raster const &	low,
		GeoLib::Raster const &	high )

staticprotected

Calculates a data-dependent epsilon value.

Definition at line 107 of file LayeredMeshGenerator.cpp.

{
    const double max(*std::max_element(high.begin(), high.end()));
    const double min(*std::min_element(low.begin(), low.end()));
    return ((max - min) * 1e-07);
}

References GeoLib::Raster::begin(), and GeoLib::Raster::end().

Referenced by LayeredVolume::createRasterLayers().

◆ createLayers()

bool LayeredMeshGenerator::createLayers	(	MeshLib::Mesh const &	mesh,
		std::vector< GeoLib::Raster const * > const &	rasters,
		double	minimum_thickness,
		double	noDataReplacementValue = 0.0 )

finalvirtual

Returns a subsurface representation of a region represented by a 2D mesh by reading raster files and calling the appropriate construction method.

Parameters

mesh	The 2D surface mesh that is used as a basis for the subsurface mesh
rasters	Containing all the rasters for the subsurface layers from bottom to top (starting with the bottom of the oldest layer and ending with the DEM)
minimum_thickness	Minimum thickness of each of the newly created layers (i.e. nodes with a vertical distance smaller than this will be collapsed)
noDataReplacementValue	Default z-coordinate if there are mesh nodes not located on the DEM raster (i.e. raster_paths[0])

Returns: true if the subsurface representation has been created, false if there was an error

Definition at line 31 of file LayeredMeshGenerator.cpp.

{
    if (mesh.getDimension() != 2)
    {
        return false;
    }
 
    auto const elem_count =
        MeshToolsLib::MeshInformation::getNumberOfElementTypes(mesh);
    if (elem_count.find(MeshLib::MeshElemType::QUAD) != elem_count.end())
    {
        ERR("Input mesh contains QUAD-elements. Please use input mesh "
            "containing LINE and TRIANGLE elements only.");
        return false;
    }
 
    bool result = createRasterLayers(
        mesh, rasters, minimum_thickness, noDataReplacementValue);
    std::for_each(rasters.begin(),
                  rasters.end(),
                  [](GeoLib::Raster const* const raster) { delete raster; });
    return result;
}

References createRasterLayers(), ERR(), MeshLib::Mesh::getDimension(), MeshToolsLib::MeshInformation::getNumberOfElementTypes(), and MeshLib::QUAD.

Referenced by MeshLayerEditDialog::createPrismMesh(), MeshLayerEditDialog::createTetMesh(), and main().

◆ createRasterLayers()

virtual bool LayeredMeshGenerator::createRasterLayers	(	MeshLib::Mesh const &	mesh,
		std::vector< GeoLib::Raster const * > const &	rasters,
		double	minimum_thickness,
		double	noDataReplacementValue )

pure virtual

Constructs a subsurface representation based on a 2D mesh and a number of rasters representing subsurface layer boundaries.

Parameters

mesh	The 2D surface mesh that is used as a basis for the subsurface mesh
rasters	Containing all the raster-data for the subsurface layers from bottom to top (starting with the bottom of the oldest layer and ending with the DEM)
minimum_thickness	Minimum thickness of each of the newly created layers (i.e. nodes with a vertical distance smaller than this will be collapsed)
noDataReplacementValue	Default z-coordinate if there are mesh nodes not located on the DEM raster (i.e. raster_paths[0])

Returns: true if the subsurface representation has been created, false if there was an error

Implemented in LayeredVolume, and MeshToolsLib::MeshLayerMapper.

Referenced by createLayers().

◆ getMesh()

std::unique_ptr< MeshLib::Mesh > LayeredMeshGenerator::getMesh ( std::string const & mesh_name ) const

Returns a mesh of the subsurface representation.

Definition at line 59 of file LayeredMeshGenerator.cpp.

{
    if (_nodes.empty())
    {
        WARN("LayeredMeshGenerator has not created any nodes.");
        return nullptr;
    }
    if (_elements.empty())
    {
        WARN("LayeredMeshGenerator has not created any elements.");
        return nullptr;
    }
 
    MeshLib::Properties properties;
    if (_materials.size() == _elements.size())
    {
        auto* const materials = properties.createNewPropertyVector<int>(
            "MaterialIDs", MeshLib::MeshItemType::Cell);
        assert(materials != nullptr);
        materials->reserve(_materials.size());
        std::copy(_materials.cbegin(),
                  _materials.cend(),
                  std::back_inserter(*materials));
    }
    else
    {
        WARN(
            "Skipping MaterialID information, number of entries does not match "
            "element number");
    }
 
    std::unique_ptr<MeshLib::Mesh> result(
        new MeshLib::Mesh(mesh_name,
                          _nodes,
                          _elements,
                          true /* compute_element_neighbors */,
                          properties));
    MeshLib::NodeSearch ns(*result);
    if (ns.searchUnused() > 0)
    {
        std::unique_ptr<MeshLib::Mesh> new_mesh(MeshToolsLib::removeNodes(
            *result, ns.getSearchedNodeIDs(), mesh_name));
        return new_mesh;
    }
    return result;
}

References _elements, _materials, _nodes, MeshLib::Cell, MeshLib::Properties::createNewPropertyVector(), MeshLib::NodeSearch::getSearchedNodeIDs(), MeshToolsLib::removeNodes(), MeshLib::NodeSearch::searchUnused(), and WARN().

Referenced by MeshLayerEditDialog::createPrismMesh(), MeshLayerEditDialog::createTetMesh(), and main().

◆ getNewLayerNode()

MeshLib::Node * LayeredMeshGenerator::getNewLayerNode	(	MeshLib::Node const &	dem_node,
		MeshLib::Node const &	last_layer_node,
		GeoLib::Raster const &	raster,
		std::size_t	new_node_id ) const

protected

Calculates the node Position of a subsurface node based on the given raster but also constrained by the DEM layer as an upper bound and the the layer located below as a lower bound (i.e. older stratigraphic layers are favored and nodes cannot be located above surface).

Parameters

dem_node	The node at this xy-location on the DEM
last_layer_node	The node at this xy-location on the layer below
raster	The raster file for the current layer
new_node_id	Node ID to be used if there is a meaningful node position to be found

Returns: A new node at the given xy position.

Definition at line 115 of file LayeredMeshGenerator.cpp.

{
    double const elevation =
        std::min(raster.interpolateValueAtPoint(dem_node), dem_node[2]);
 
    if ((std::abs(elevation - raster.getHeader().no_data) <
         std::numeric_limits<double>::epsilon()) ||
        (elevation - last_layer_node[2] < _minimum_thickness))
    {
        return new MeshLib::Node(last_layer_node);
    }
 
    return new MeshLib::Node(dem_node[0], dem_node[1], elevation, new_node_id);
}

References _minimum_thickness, GeoLib::Raster::getHeader(), GeoLib::Raster::interpolateValueAtPoint(), GeoLib::RasterHeader::no_data, and MeshLib::Node.

Referenced by LayeredVolume::addLayerToMesh(), and MeshToolsLib::MeshLayerMapper::addLayerToMesh().

Member Data Documentation

◆ _elements

std::vector<MeshLib::Element*> LayeredMeshGenerator::_elements

protected

Definition at line 120 of file LayeredMeshGenerator.h.

Referenced by LayeredVolume::addLayerBoundaries(), LayeredVolume::addLayerToMesh(), MeshToolsLib::MeshLayerMapper::addLayerToMesh(), LayeredVolume::createRasterLayers(), MeshToolsLib::MeshLayerMapper::createRasterLayers(), getMesh(), and LayeredVolume::removeCongruentElements().

◆ _elevation_epsilon

double LayeredMeshGenerator::_elevation_epsilon {0.0001}

protected

Definition at line 116 of file LayeredMeshGenerator.h.

116{0.0001};

Referenced by LayeredVolume::createRasterLayers().

◆ _materials

std::vector<int> LayeredMeshGenerator::_materials

protected

Definition at line 118 of file LayeredMeshGenerator.h.

Referenced by LayeredVolume::addLayerBoundaries(), LayeredVolume::addLayerToMesh(), MeshToolsLib::MeshLayerMapper::addLayerToMesh(), LayeredVolume::createRasterLayers(), MeshToolsLib::MeshLayerMapper::createRasterLayers(), getMesh(), and LayeredVolume::removeCongruentElements().

◆ _minimum_thickness

double LayeredMeshGenerator::_minimum_thickness {std::numeric_limits<float>::epsilon()}

protected

Definition at line 117 of file LayeredMeshGenerator.h.

117{std::numeric_limits<float>::epsilon()};

Referenced by LayeredVolume::createRasterLayers(), MeshToolsLib::MeshLayerMapper::createRasterLayers(), and getNewLayerNode().

◆ _nodes

std::vector<MeshLib::Node*> LayeredMeshGenerator::_nodes

protected

Definition at line 119 of file LayeredMeshGenerator.h.

Referenced by LayeredVolume::addLayerBoundaries(), LayeredVolume::addLayerToMesh(), MeshToolsLib::MeshLayerMapper::addLayerToMesh(), LayeredVolume::createRasterLayers(), MeshToolsLib::MeshLayerMapper::createRasterLayers(), getMesh(), and LayeredVolume::removeCongruentElements().

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

MeshToolsLib/MeshGenerators/LayeredMeshGenerator.h
MeshToolsLib/MeshGenerators/LayeredMeshGenerator.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ LayeredMeshGenerator()

◆ ~LayeredMeshGenerator()

Member Function Documentation

◆ addLayerToMesh()

◆ calcEpsilon()

◆ createLayers()

◆ createRasterLayers()

◆ getMesh()

◆ getNewLayerNode()

Member Data Documentation

◆ _elements

◆ _elevation_epsilon

◆ _materials

◆ _minimum_thickness

◆ _nodes