#include <geomodel_geological_entity.h>

Inheritance diagram for RINGMesh::GeoModelGeologicalEntity< DIMENSION >:

Public Types
enum	GEOL_FEATURE { GEOL_FEATURE::ALL_GEOL, GEOL_FEATURE::NO_GEOL, GEOL_FEATURE::STRATI, GEOL_FEATURE::UNCONFORMITY, GEOL_FEATURE::NORMAL_FAULT, GEOL_FEATURE::REVERSE_FAULT, GEOL_FEATURE::FAULT, GEOL_FEATURE::VOI }
	Geological feature types for GeoModelEntity. More...

Public Member Functions
bool	has_geological_feature () const

GEOL_FEATURE	geological_feature () const

gmge_id	gmge () const

GeologicalEntityType	entity_type () const

virtual MeshEntityType	child_type_name () const =0

virtual bool	is_on_voi () const

virtual bool	is_connectivity_valid () const

virtual bool	is_valid () const

virtual GeologicalEntityType	type_name () const

index_t	nb_children () const

const gmme_id &	child_gmme (index_t x) const

const GeoModelMeshEntity< DIMENSION > &	child (index_t x) const

virtual bool	is_identification_valid () const

template<>
void	initialize ()

template<>
void	initialize ()

Public Member Functions inherited from RINGMesh::GeoModelEntity< DIMENSION >
virtual	~GeoModelEntity ()=default

const GeoModel< DIMENSION > &	geomodel () const

const std::string &	name () const

index_t	index () const

Static Public Member Functions
static GEOL_FEATURE	determine_geological_type (const std::string &in)
	Map the name of a geological type with a value of GEOL_FEATURE. More...

static std::string	geol_name (GEOL_FEATURE feature)

static bool	is_fault (GEOL_FEATURE feature)

static bool	is_stratigraphic_limit (GEOL_FEATURE feature)

static void	initialize ()

static GeologicalEntityType	type_name_static ()

Protected Member Functions
	GeoModelGeologicalEntity (const GeoModel< DIMENSION > &geomodel)

virtual bool	is_index_valid () const

Protected Member Functions inherited from RINGMesh::GeoModelEntity< DIMENSION >
	GeoModelEntity (const GeoModel< DIMENSION > &geomodel, index_t id)

void	copy_name (const GeoModelEntity< DIMENSION > &from)

Protected Attributes
std::vector< index_t >	children_ {}
	Children relations of this entity. More...

GEOL_FEATURE	geol_feature_ { GEOL_FEATURE::NO_GEOL }
	Geological feature of this object - default is NO_GEOL. More...

Protected Attributes inherited from RINGMesh::GeoModelEntity< DIMENSION >
const GeoModel< DIMENSION > &	geomodel_
	Reference to the GeoModel owning this entity. More...

std::string	name_ = std::string{ "Unnamed" }
	Name of the entity - default is "Unnamed". More...

index_t	id_ { NO_ID }
	Index of the entity. More...

Private Member Functions
void	copy_geological_entity (const GeoModelGeologicalEntity< DIMENSION > &from)

Friends
class	GeoModelGeologicalEntityAccess< DIMENSION >

Detailed Description

template<index_t DIMENSION>
class RINGMesh::GeoModelGeologicalEntity< DIMENSION >

Definition at line 66 of file geomodel_geological_entity.h.

Member Enumeration Documentation

◆ GEOL_FEATURE

template<index_t DIMENSION>

enum RINGMesh::GeoModelGeologicalEntity::GEOL_FEATURE

strong

Geological feature types for GeoModelEntity.

Enumerator
ALL_GEOL	All geological features.
NO_GEOL	Default value - No geological feature defined.
STRATI	Stratigraphic surface - an horizon.
UNCONFORMITY	Unconformity.
NORMAL_FAULT	A normal fault.
REVERSE_FAULT	A reverse fault.
FAULT	An unspecified fault.
VOI	Volume Of Interest.

Definition at line 75 of file geomodel_geological_entity.h.

Constructor & Destructor Documentation

◆ GeoModelGeologicalEntity()

template<index_t DIMENSION>

RINGMesh::GeoModelGeologicalEntity< DIMENSION >::GeoModelGeologicalEntity ( const GeoModel< DIMENSION > & geomodel )

inlineexplicitprotected

Definition at line 169 of file geomodel_geological_entity.h.

Member Function Documentation

◆ child()

template<index_t DIMENSION>

const GeoModelMeshEntity< DIMENSION > & RINGMesh::GeoModelGeologicalEntity< DIMENSION >::child ( index_t x ) const

Definition at line 162 of file geomodel_geological_entity.cpp.

◆ child_gmme()

template<index_t DIMENSION>

const gmme_id & RINGMesh::GeoModelGeologicalEntity< DIMENSION >::child_gmme ( index_t x ) const

Definition at line 151 of file geomodel_geological_entity.cpp.

◆ child_type_name()

template<index_t DIMENSION>

virtual MeshEntityType RINGMesh::GeoModelGeologicalEntity< DIMENSION >::child_type_name ( ) const

pure virtual

Implemented in RINGMesh::Layer< DIMENSION >, RINGMesh::Interface< DIMENSION >, RINGMesh::Contact< DIMENSION >, RINGMesh::Layer< DIMENSION >, RINGMesh::Interface< DIMENSION >, RINGMesh::Contact< DIMENSION >, RINGMesh::Layer< DIMENSION >, RINGMesh::Interface< DIMENSION >, and RINGMesh::Contact< DIMENSION >.

◆ copy_geological_entity()

template<index_t DIMENSION>

void RINGMesh::GeoModelGeologicalEntity< DIMENSION >::copy_geological_entity ( const GeoModelGeologicalEntity< DIMENSION > & from )

inlineprivate

Definition at line 178 of file geomodel_geological_entity.h.

◆ determine_geological_type()

template<index_t DIMENSION>

GeoModelGeologicalEntity< DIMENSION >::GEOL_FEATURE RINGMesh::GeoModelGeologicalEntity< DIMENSION >::determine_geological_type ( const std::string & in )

static

Map the name of a geological type with a value of GEOL_FEATURE.

Parameters

[in]

in

Name of the feature. Can be

"reverse_fault"
"normal_fault"
"fault"
"top"
"none"
"topographic"
"unconformity"
"boundary" Other strings will end up in NO_GEOL

Returns: The geological feature index

Definition at line 67 of file geomodel_geological_entity.cpp.

◆ entity_type()

template<index_t DIMENSION>

GeologicalEntityType RINGMesh::GeoModelGeologicalEntity< DIMENSION >::entity_type ( ) const

inline

Definition at line 142 of file geomodel_geological_entity.h.

◆ geol_name()

template<index_t DIMENSION>

std::string RINGMesh::GeoModelGeologicalEntity< DIMENSION >::geol_name ( GEOL_FEATURE feature )

static

Returns: the (lowercase) string associated to a GeoModelELement::GEOL_FEATURE

Definition at line 116 of file geomodel_geological_entity.cpp.

◆ geological_feature()

template<index_t DIMENSION>

GEOL_FEATURE RINGMesh::GeoModelGeologicalEntity< DIMENSION >::geological_feature ( ) const

inline

Definition at line 130 of file geomodel_geological_entity.h.

◆ gmge()

template<index_t DIMENSION>

gmge_id RINGMesh::GeoModelGeologicalEntity< DIMENSION >::gmge ( ) const

inline

Definition at line 137 of file geomodel_geological_entity.h.

◆ has_geological_feature()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::has_geological_feature ( ) const

inline

Definition at line 125 of file geomodel_geological_entity.h.

◆ initialize() [1/3]

template<index_t DIMENSION>

static void RINGMesh::GeoModelGeologicalEntity< DIMENSION >::initialize ( )

static

◆ initialize() [2/3]

template<>

void RINGMesh::GeoModelGeologicalEntity< 2 >::initialize ( )

Definition at line 247 of file geomodel_geological_entity.cpp.

◆ initialize() [3/3]

template<>

void RINGMesh::GeoModelGeologicalEntity< 3 >::initialize ( )

Definition at line 258 of file geomodel_geological_entity.cpp.

◆ is_connectivity_valid()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_connectivity_valid ( ) const

virtual

Definition at line 188 of file geomodel_geological_entity.cpp.

◆ is_fault()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_fault ( GEOL_FEATURE feature )

static

Definition at line 142 of file geomodel_geological_entity.cpp.

◆ is_identification_valid()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_identification_valid ( ) const

virtual

Definition at line 217 of file geomodel_geological_entity.cpp.

◆ is_index_valid()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_index_valid ( ) const

protectedvirtual

Implements RINGMesh::GeoModelEntity< DIMENSION >.

Definition at line 181 of file geomodel_geological_entity.cpp.

◆ is_on_voi()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_on_voi ( ) const

virtual

Implements RINGMesh::GeoModelEntity< DIMENSION >.

Definition at line 168 of file geomodel_geological_entity.cpp.

◆ is_stratigraphic_limit()

template<index_t DIMENSION>

static bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_stratigraphic_limit ( GEOL_FEATURE feature )

inlinestatic

Definition at line 119 of file geomodel_geological_entity.h.

◆ is_valid()

template<index_t DIMENSION>

bool RINGMesh::GeoModelGeologicalEntity< DIMENSION >::is_valid ( ) const

virtual

Implements RINGMesh::GeoModelEntity< DIMENSION >.

Definition at line 241 of file geomodel_geological_entity.cpp.

◆ nb_children()

template<index_t DIMENSION>

index_t RINGMesh::GeoModelGeologicalEntity< DIMENSION >::nb_children ( ) const

inline

Definition at line 159 of file geomodel_geological_entity.h.

◆ type_name()

template<index_t DIMENSION>

virtual GeologicalEntityType RINGMesh::GeoModelGeologicalEntity< DIMENSION >::type_name ( ) const

inlinevirtual

Reimplemented in RINGMesh::Layer< DIMENSION >, RINGMesh::Interface< DIMENSION >, and RINGMesh::Contact< DIMENSION >.

Definition at line 155 of file geomodel_geological_entity.h.

◆ type_name_static()

template<index_t DIMENSION>

static GeologicalEntityType RINGMesh::GeoModelGeologicalEntity< DIMENSION >::type_name_static ( )

inlinestatic

Definition at line 151 of file geomodel_geological_entity.h.

Friends And Related Function Documentation

◆ GeoModelGeologicalEntityAccess< DIMENSION >

template<index_t DIMENSION>

friend class GeoModelGeologicalEntityAccess< DIMENSION >

friend

Definition at line 70 of file geomodel_geological_entity.h.

Member Data Documentation

◆ children_

template<index_t DIMENSION>

std::vector< index_t > RINGMesh::GeoModelGeologicalEntity< DIMENSION >::children_ {}

protected

Children relations of this entity.

Definition at line 188 of file geomodel_geological_entity.h.

◆ geol_feature_

template<index_t DIMENSION>

GEOL_FEATURE RINGMesh::GeoModelGeologicalEntity< DIMENSION >::geol_feature_ { GEOL_FEATURE::NO_GEOL }

protected

Geological feature of this object - default is NO_GEOL.

Definition at line 191 of file geomodel_geological_entity.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

template<index_t DIMENSION> class RINGMesh::GeoModelGeologicalEntity< DIMENSION >

Member Enumeration Documentation

◆ GEOL_FEATURE

Constructor & Destructor Documentation

◆ GeoModelGeologicalEntity()

Member Function Documentation

◆ child()

◆ child_gmme()

◆ child_type_name()

◆ copy_geological_entity()

◆ determine_geological_type()

◆ entity_type()

◆ geol_name()

◆ geological_feature()

◆ gmge()

◆ has_geological_feature()

◆ initialize() [1/3]

◆ initialize() [2/3]

◆ initialize() [3/3]

◆ is_connectivity_valid()

◆ is_fault()

◆ is_identification_valid()

◆ is_index_valid()

◆ is_on_voi()

◆ is_stratigraphic_limit()

◆ is_valid()

◆ nb_children()

◆ type_name()

◆ type_name_static()

Friends And Related Function Documentation

◆ GeoModelGeologicalEntityAccess< DIMENSION >

Member Data Documentation

◆ children_

◆ geol_feature_

template<index_t DIMENSION>
class RINGMesh::GeoModelGeologicalEntity< DIMENSION >