RINGMesh::StratigraphicUnit Class Reference

Representing Stratigraphic Units Each Unit has a name, two delimiting interfaces with two corresponding relations, a layer, a RockFeature, a minimum thickness and a maximum thickness. A StratigraphicColumn can be a StratigraphicUnit. More...

#include <stratigraphic_column.h>

Inheritance diagram for RINGMesh::StratigraphicUnit:

Public Member Functions
	StratigraphicUnit (std::string name, RockFeature rock)
	Complete Constructor of StratigraphicUnit. More...
virtual	~StratigraphicUnit ()=default
virtual const std::string &	get_name () const
void	set_rock_feature (const RockFeature &rock_feature)
const RockFeature &	get_rock_feature () const
virtual bool	is_conformable_base () const =0
virtual bool	is_conformable_top () const =0
virtual RELATION	get_relation_base () const =0
virtual RELATION	get_relation_top () const =0
virtual const Interface3D &	get_interface_base () const =0
virtual const Interface3D &	get_interface_top () const =0
virtual double	get_min_thick () const =0
virtual double	get_max_thick () const =0

Protected Member Functions
	StratigraphicUnit ()
	Constructor of StratigraphicUnit. More...

Protected Attributes
std::string	name_ {}
RockFeature	rock_

Private Member Functions
	ringmesh_disable_copy_and_move (StratigraphicUnit)

Detailed Description

Representing Stratigraphic Units Each Unit has a name, two delimiting interfaces with two corresponding relations, a layer, a RockFeature, a minimum thickness and a maximum thickness. A StratigraphicColumn can be a StratigraphicUnit.

Definition at line 139 of file stratigraphic_column.h.

Constructor & Destructor Documentation

StratigraphicUnit() [1/2]

RINGMesh::StratigraphicUnit::StratigraphicUnit	(	std::string	name,
		RockFeature	rock
	)

Complete Constructor of StratigraphicUnit.

Parameters

[in]	name	Name of the unit
[in]	interface_base	Interface delimiting the bottom of the unit
[in]	interface_top	Interface delimiting the top of the unit
[in]	layer	Layer delimiting the volume of the unit
[in]	relation_top	Relation characterizing the upper contact of the unit
[in]	relation_base	Relation characterizing the lower contact of the unit
[in]	rock	RockFeature characterizing among others the rock type associated with the unit
[in]	min_thick	Minimum thickness of the layer
[in]	max_thick	Maximum thickness of the layer

Definition at line 45 of file stratigraphic_column.cpp.

~StratigraphicUnit()

virtual RINGMesh::StratigraphicUnit::~StratigraphicUnit ( )

virtualdefault

StratigraphicUnit() [2/2]

RINGMesh::StratigraphicUnit::StratigraphicUnit ( )

protected

Constructor of StratigraphicUnit.

Definition at line 40 of file stratigraphic_column.cpp.

Member Function Documentation

get_interface_base()

virtual const Interface3D& RINGMesh::StratigraphicUnit::get_interface_base ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

get_interface_top()

virtual const Interface3D& RINGMesh::StratigraphicUnit::get_interface_top ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

get_max_thick()

virtual double RINGMesh::StratigraphicUnit::get_max_thick ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

get_min_thick()

virtual double RINGMesh::StratigraphicUnit::get_min_thick ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

get_name()

virtual const std::string& RINGMesh::StratigraphicUnit::get_name ( ) const

inlinevirtual

Definition at line 163 of file stratigraphic_column.h.

get_relation_base()

virtual RELATION RINGMesh::StratigraphicUnit::get_relation_base ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

get_relation_top()

virtual RELATION RINGMesh::StratigraphicUnit::get_relation_top ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

get_rock_feature()

const RockFeature& RINGMesh::StratigraphicUnit::get_rock_feature ( ) const

inline

Definition at line 179 of file stratigraphic_column.h.

is_conformable_base()

virtual bool RINGMesh::StratigraphicUnit::is_conformable_base ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

is_conformable_top()

virtual bool RINGMesh::StratigraphicUnit::is_conformable_top ( ) const

pure virtual

Implemented in RINGMesh::SubdividedStratigraphicUnit, and RINGMesh::UnsubdividedStratigraphicUnit.

ringmesh_disable_copy_and_move()

RINGMesh::StratigraphicUnit::ringmesh_disable_copy_and_move ( StratigraphicUnit  )

private

set_rock_feature()

void RINGMesh::StratigraphicUnit::set_rock_feature ( const RockFeature &  rock_feature )

inline

Parameters

[out]

out

RockFeature returned after modification in the function

Returns

the RockFeature of the unit,

if StratigraphicColumn, return a RockFeature with "multiple" rocktype

Definition at line 174 of file stratigraphic_column.h.

Member Data Documentation

name_

std::string RINGMesh::StratigraphicUnit::name_ {}

protected

Definition at line 200 of file stratigraphic_column.h.

rock_

RockFeature RINGMesh::StratigraphicUnit::rock_

protected

Definition at line 201 of file stratigraphic_column.h.

---

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

• D:/dev/RINGMesh/include/ringmesh/geomodel/stratigraphic_column.h
• D:/dev/RINGMesh/src/ringmesh/geomodel/stratigraphic_column.cpp