A stratigraphic column is composed of several stratigraphic units. More...

#include <stratigraphic_column.h>

Public Member Functions
	StratigraphicColumn (std::string name, const std::vector< const StratigraphicUnit * > &units, STRATIGRAPHIC_PARADIGM type)
	Complete constructor of StratigraphicColumn. More...

	StratigraphicColumn (std::string name, const STRATIGRAPHIC_PARADIGM type)
	Simple Constructor of StratigraphicColumn. More...

Stratigraphic Column edition
void	insert_unit_below (const StratigraphicUnit &above, const StratigraphicUnit &unit_to_add)

void	insert_top_unit (const StratigraphicUnit &to_add)

void	insert_base_unit (const StratigraphicUnit &to_add)

void	remove_unit (const StratigraphicUnit &unit)

Get column units
const StratigraphicUnit *	get_top_unit () const

const StratigraphicUnit *	get_base_unit () const

const StratigraphicUnit *	get_unit_above (const StratigraphicUnit &unit) const

const StratigraphicUnit *	get_unit_below (const StratigraphicUnit &unit) const

const StratigraphicUnit *	get_unit (const index_t index) const

const StratigraphicUnit *	get_unit (const std::string &name) const

const std::vector< const StratigraphicUnit *> &	get_all_units () const

Others
STRATIGRAPHIC_PARADIGM	get_paradigm () const

bool	is_conformable_base () const
	is_conformable_base for the Stratigraphic Column More...

bool	is_conformable_top () const
	is_conformable_top for the Stratigraphic Column More...

RELATION	get_relation_base ()
	get_relation_base for the Stratigraphic Column More...

RELATION	get_relation_top ()
	get_relation_top for the Stratigraphic Column More...

const Interface3D &	get_interface_base () const
	get_interface_base for the Stratigraphic Column More...

const Interface3D &	get_interface_top () const
	get_interface_top for the Stratigraphic Column More...

double	get_column_min_thick () const

double	get_column_max_thick () const

const std::string &	get_name () const

Private Member Functions
index_t	get_index (const std::string &unit_name) const

Private Attributes
std::string	name_ {}

std::vector< const StratigraphicUnit *>	units_ {}

STRATIGRAPHIC_PARADIGM	type_ { STRATIGRAPHIC_PARADIGM::UNSPECIFIED }

Detailed Description

A stratigraphic column is composed of several stratigraphic units.

Definition at line 343 of file stratigraphic_column.h.

Constructor & Destructor Documentation

◆ StratigraphicColumn() [1/2]

RINGMesh::StratigraphicColumn::StratigraphicColumn	(	std::string	name,
		const std::vector< const StratigraphicUnit * > &	units,
		STRATIGRAPHIC_PARADIGM	type
	)

inline

Complete constructor of StratigraphicColumn.

Parameters

[in]	name	Name of the stratigraphic column
[in]	layers	Vector of the StratigraphicUnit constituting the StratigraphicColumn
[in]	type	Chronostratigraphic, Lithostratigraphic or Biostratigraphic

Definition at line 354 of file stratigraphic_column.h.

◆ StratigraphicColumn() [2/2]

RINGMesh::StratigraphicColumn::StratigraphicColumn	(	std::string	name,
		const STRATIGRAPHIC_PARADIGM	type
	)

inline

Simple Constructor of StratigraphicColumn.

Parameters

[in] name Name of the unit

Definition at line 365 of file stratigraphic_column.h.

Member Function Documentation

◆ get_all_units()

const std::vector< const StratigraphicUnit* >& RINGMesh::StratigraphicColumn::get_all_units ( ) const

inline

Returns: a vector of all the units of the column

Definition at line 441 of file stratigraphic_column.h.

◆ get_base_unit()

const StratigraphicUnit* RINGMesh::StratigraphicColumn::get_base_unit ( ) const

inline

Returns: the bottom unit of the column

Definition at line 409 of file stratigraphic_column.h.

◆ get_column_max_thick()

double RINGMesh::StratigraphicColumn::get_column_max_thick ( ) const

Returns: the maximum thickness for the whole Column (i.e sum on units)

Definition at line 136 of file stratigraphic_column.cpp.

◆ get_column_min_thick()

double RINGMesh::StratigraphicColumn::get_column_min_thick ( ) const

Returns: the minimum thickness for the whole Column (i.e sum on units)

Definition at line 126 of file stratigraphic_column.cpp.

◆ get_index()

index_t RINGMesh::StratigraphicColumn::get_index ( const std::string & unit_name ) const

private

Parameters

[in] unit_name of the unit to find

Returns: the position of a unit in the stratigraphic column

Definition at line 146 of file stratigraphic_column.cpp.

◆ get_interface_base()

const Interface3D& RINGMesh::StratigraphicColumn::get_interface_base ( ) const

inline

get_interface_base for the Stratigraphic Column

Returns: the base interface of the last unit in the Stratigraphic Column

Definition at line 499 of file stratigraphic_column.h.

◆ get_interface_top()

const Interface3D& RINGMesh::StratigraphicColumn::get_interface_top ( ) const

inline

get_interface_top for the Stratigraphic Column

Returns: the top interface of the first unit in the Stratigraphic Column

Definition at line 508 of file stratigraphic_column.h.

◆ get_name()

const std::string& RINGMesh::StratigraphicColumn::get_name ( ) const

inline

Definition at line 522 of file stratigraphic_column.h.

◆ get_paradigm()

STRATIGRAPHIC_PARADIGM RINGMesh::StratigraphicColumn::get_paradigm ( ) const

inline

Definition at line 451 of file stratigraphic_column.h.

◆ get_relation_base()

RELATION RINGMesh::StratigraphicColumn::get_relation_base ( )

inline

get_relation_base for the Stratigraphic Column

Returns: the relation of the base of the first unit of the StratigraphicColumn

Definition at line 480 of file stratigraphic_column.h.

◆ get_relation_top()

RELATION RINGMesh::StratigraphicColumn::get_relation_top ( )

inline

get_relation_top for the Stratigraphic Column

Returns: the relation of the top of the first unit of the StratigraphicColumn

Definition at line 489 of file stratigraphic_column.h.

◆ get_top_unit()

const StratigraphicUnit* RINGMesh::StratigraphicColumn::get_top_unit ( ) const

inline

Returns: the top unit of the column

Definition at line 401 of file stratigraphic_column.h.

◆ get_unit() [1/2]

const StratigraphicUnit* RINGMesh::StratigraphicColumn::get_unit ( const index_t index ) const

inline

Definition at line 431 of file stratigraphic_column.h.

◆ get_unit() [2/2]

const StratigraphicUnit * RINGMesh::StratigraphicColumn::get_unit ( const std::string & name ) const

Definition at line 118 of file stratigraphic_column.cpp.

◆ get_unit_above()

const StratigraphicUnit * RINGMesh::StratigraphicColumn::get_unit_above ( const StratigraphicUnit & unit ) const

Parameters

[in] unit Reference unit

Returns: the StratigraphicUnit which position in the StratigraphicColumn is just above the reference unit

Definition at line 102 of file stratigraphic_column.cpp.

◆ get_unit_below()

const StratigraphicUnit * RINGMesh::StratigraphicColumn::get_unit_below ( const StratigraphicUnit & unit ) const

Parameters

[in] unit Reference unit

Returns: the StratigraphicUnit which position in the StratigraphicColumn is just below the reference unit

Definition at line 110 of file stratigraphic_column.cpp.

◆ insert_base_unit()

void RINGMesh::StratigraphicColumn::insert_base_unit ( const StratigraphicUnit & to_add )

Parameters

[in] to_add Unit to add at the bottom of the column

Definition at line 88 of file stratigraphic_column.cpp.

◆ insert_top_unit()

void RINGMesh::StratigraphicColumn::insert_top_unit ( const StratigraphicUnit & to_add )

Parameters

[in] to_add Unit to add at the top of the column

Definition at line 82 of file stratigraphic_column.cpp.

◆ insert_unit_below()

void RINGMesh::StratigraphicColumn::insert_unit_below	(	const StratigraphicUnit &	above,
		const StratigraphicUnit &	unit_to_add
	)

Parameters

[in]	above	Reference unit, the new unit will be added below it
[in]	unit_to_add	Unit you want to add to the column

Definition at line 73 of file stratigraphic_column.cpp.

◆ is_conformable_base()

bool RINGMesh::StratigraphicColumn::is_conformable_base ( ) const

inline

is_conformable_base for the Stratigraphic Column

Returns: true if the base of the last unit of the Stratigraphic Column is conformable

Definition at line 461 of file stratigraphic_column.h.

◆ is_conformable_top()

bool RINGMesh::StratigraphicColumn::is_conformable_top ( ) const

inline

is_conformable_top for the Stratigraphic Column

Returns: true if the top of the first unit of the Stratigraphic Column is conformable

Definition at line 470 of file stratigraphic_column.h.

◆ remove_unit()

void RINGMesh::StratigraphicColumn::remove_unit ( const StratigraphicUnit & unit )

Definition at line 95 of file stratigraphic_column.cpp.

Member Data Documentation

◆ name_

std::string RINGMesh::StratigraphicColumn::name_ {}

private

Definition at line 537 of file stratigraphic_column.h.

◆ type_

STRATIGRAPHIC_PARADIGM RINGMesh::StratigraphicColumn::type_ { STRATIGRAPHIC_PARADIGM::UNSPECIFIED }

private

Definition at line 539 of file stratigraphic_column.h.

◆ units_

std::vector< const StratigraphicUnit* > RINGMesh::StratigraphicColumn::units_ {}

private

Definition at line 538 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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StratigraphicColumn() [1/2]

◆ StratigraphicColumn() [2/2]

Member Function Documentation

◆ get_all_units()

◆ get_base_unit()

◆ get_column_max_thick()

◆ get_column_min_thick()

◆ get_index()

◆ get_interface_base()

◆ get_interface_top()

◆ get_name()

◆ get_paradigm()

◆ get_relation_base()

◆ get_relation_top()

◆ get_top_unit()

◆ get_unit() [1/2]

◆ get_unit() [2/2]

◆ get_unit_above()

◆ get_unit_below()

◆ insert_base_unit()

◆ insert_top_unit()

◆ insert_unit_below()

◆ is_conformable_base()

◆ is_conformable_top()

◆ remove_unit()

Member Data Documentation

◆ name_

◆ type_

◆ units_