RINGMesh  Version 5.0.0
A programming library for geological model meshes
Public Member Functions | Private Attributes | List of all members
RINGMesh::GeoModelMeshWells< DIMENSION > Class Template Referencefinal

#include <geomodel_mesh.h>

Inheritance diagram for RINGMesh::GeoModelMeshWells< DIMENSION >:
RINGMesh::GeoModelMeshCommon< DIMENSION >

Public Member Functions

 GeoModelMeshWells (GeoModelMesh< DIMENSION > &gmm, GeoModel< DIMENSION > &gm, std::unique_ptr< LineMesh< DIMENSION > > &mesh)
 
GEO::AttributesManager & attribute_manager () const
 
bool is_initialized () const
 
void test_and_initialize () const
 
index_t nb_wells () const
 
index_t nb_edges () const
 
index_t nb_edges (index_t well) const
 
index_t vertex (index_t well, index_t edge, index_t vertex) const
 
void clear ()
 
void initialize ()
 
const LineAABBTree< DIMENSION > & aabb () const
 return the AABB tree for the edges of the mesh More...
 

Private Attributes

std::unique_ptr< LineMesh< DIMENSION > > & mesh_
 Attached Mesh. More...
 
std::vector< index_t > well_ptr_
 

Additional Inherited Members

- Protected Member Functions inherited from RINGMesh::GeoModelMeshCommon< DIMENSION >
 GeoModelMeshCommon (GeoModelMesh< DIMENSION > &gmm, GeoModel< DIMENSION > &geomodel)
 
virtual ~GeoModelMeshCommon ()=default
 
void set_mesh (MeshBase< DIMENSION > *mesh)
 
void save_mesh (const std::string &filename) const
 
- Protected Attributes inherited from RINGMesh::GeoModelMeshCommon< DIMENSION >
GeoModelMesh< DIMENSION > & gmm_
 Attached GeoModelMesh. More...
 
GeoModel< DIMENSION > & geomodel_
 Attached GeoModel. More...
 
MeshBase< DIMENSION > * mesh_base_
 Attached MeshBase. More...
 

Detailed Description

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

Definition at line 979 of file geomodel_mesh.h.

Constructor & Destructor Documentation

◆ GeoModelMeshWells()

template<index_t DIMENSION>
RINGMesh::GeoModelMeshWells< DIMENSION >::GeoModelMeshWells ( GeoModelMesh< DIMENSION > &  gmm,
GeoModel< DIMENSION > &  gm,
std::unique_ptr< LineMesh< DIMENSION > > &  mesh 
)
explicit

Definition at line 2575 of file geomodel_mesh.cpp.

Member Function Documentation

◆ aabb()

template<index_t DIMENSION>
const LineAABBTree< DIMENSION > & RINGMesh::GeoModelMeshWells< DIMENSION >::aabb ( ) const

return the AABB tree for the edges of the mesh

Definition at line 2697 of file geomodel_mesh.cpp.

◆ attribute_manager()

template<index_t DIMENSION>
GEO::AttributesManager& RINGMesh::GeoModelMeshWells< DIMENSION >::attribute_manager ( ) const
inline

Definition at line 987 of file geomodel_mesh.h.

◆ clear()

template<index_t DIMENSION>
void RINGMesh::GeoModelMeshWells< DIMENSION >::clear ( )

Clear the mesh edges

Definition at line 2615 of file geomodel_mesh.cpp.

◆ initialize()

template<index_t DIMENSION>
void RINGMesh::GeoModelMeshWells< DIMENSION >::initialize ( )

Initialize the mesh edges

Definition at line 2639 of file geomodel_mesh.cpp.

◆ is_initialized()

template<index_t DIMENSION>
bool RINGMesh::GeoModelMeshWells< DIMENSION >::is_initialized ( ) const

Test if the mesh edges are initialized

Definition at line 2624 of file geomodel_mesh.cpp.

◆ nb_edges() [1/2]

template<index_t DIMENSION>
index_t RINGMesh::GeoModelMeshWells< DIMENSION >::nb_edges ( ) const

Gets the number of edges in the MacroMesh

Returns
the corresponding number

Definition at line 2593 of file geomodel_mesh.cpp.

◆ nb_edges() [2/2]

template<index_t DIMENSION>
index_t RINGMesh::GeoModelMeshWells< DIMENSION >::nb_edges ( index_t  well) const

Gets the number of edges of a Well

Parameters
[in]wthe well index
Returns
the corresponding number

Definition at line 2600 of file geomodel_mesh.cpp.

◆ nb_wells()

template<index_t DIMENSION>
index_t RINGMesh::GeoModelMeshWells< DIMENSION >::nb_wells ( ) const

Gets the number of wells

Returns
the corresponding number

Definition at line 2585 of file geomodel_mesh.cpp.

◆ test_and_initialize()

template<index_t DIMENSION>
void RINGMesh::GeoModelMeshWells< DIMENSION >::test_and_initialize ( ) const

Tests if the mesh edges needs to be initialized and initialize it

Definition at line 2630 of file geomodel_mesh.cpp.

◆ vertex()

template<index_t DIMENSION>
index_t RINGMesh::GeoModelMeshWells< DIMENSION >::vertex ( index_t  well,
index_t  edge,
index_t  vertex 
) const

Gets the vertex index of the GeoModelMesh

Parameters
[in]wthe well index
[in]edgethe edge index in the well (from 0 to nb_edges in the well)
[in]vertexthe vertex index of the edge (0 or 1 )
Returns
the global vertex index

Definition at line 2607 of file geomodel_mesh.cpp.

Member Data Documentation

◆ mesh_

template<index_t DIMENSION>
std::unique_ptr< LineMesh< DIMENSION > >& RINGMesh::GeoModelMeshWells< DIMENSION >::mesh_
private

Attached Mesh.

Definition at line 1043 of file geomodel_mesh.h.

◆ well_ptr_

template<index_t DIMENSION>
std::vector< index_t > RINGMesh::GeoModelMeshWells< DIMENSION >::well_ptr_
private

Vector storing the index of the starting edge index for a given well

Definition at line 1049 of file geomodel_mesh.h.

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