Public Member Functions | Private Attributes | List of all members
oomph::TetEdge Class Reference

////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////// More...

#include <gmsh_tet_mesh.template.h>

Public Member Functions

 TetEdge (const unsigned &vertex1, const unsigned &vertex2)
 Constructor: Pass two vertices, identified by their indices Edge "direction" is from lower vertex to higher vertex id so can compare if we're dealing with the same one... More...
 
unsigned first_vertex_id () const
 First vertex id. More...
 
unsigned second_vertex_id () const
 Second vertex id. More...
 
bool is_reversed () const
 Edge is reversed in the sense that vertex1 actually has a higher id than vertex2 (when specified in the constructor) More...
 
bool operator== (const TetEdge &tet_edge) const
 Comparison operator: Edges are identical if their sorted (and therefore possibly reversed) vertex ids agree. More...
 
bool operator< (const TetEdge &tet_edge) const
 Comparison operator. Lexicographic comparison based on vertex ids. More...
 

Private Attributes

std::pair< unsigned, unsigned > Vertex_pair
 The vertices (sorted by vertex ids) More...
 
bool Reversed
 Is it reversed? I.e. is the first input vertex stored after the second one? More...
 

Detailed Description

////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////

Helper class to keep track of edges in tet mesh generation

Definition at line 265 of file gmsh_tet_mesh.template.h.

Constructor & Destructor Documentation

◆ TetEdge()

oomph::TetEdge::TetEdge ( const unsigned &  vertex1,
const unsigned &  vertex2 
)
inline

Constructor: Pass two vertices, identified by their indices Edge "direction" is from lower vertex to higher vertex id so can compare if we're dealing with the same one...

Definition at line 271 of file gmsh_tet_mesh.template.h.

References Reversed, and Vertex_pair.

Member Function Documentation

◆ first_vertex_id()

unsigned oomph::TetEdge::first_vertex_id ( ) const
inline

First vertex id.

Definition at line 294 of file gmsh_tet_mesh.template.h.

References Vertex_pair.

Referenced by operator<(), and operator==().

◆ is_reversed()

bool oomph::TetEdge::is_reversed ( ) const
inline

Edge is reversed in the sense that vertex1 actually has a higher id than vertex2 (when specified in the constructor)

Definition at line 308 of file gmsh_tet_mesh.template.h.

References Reversed.

Referenced by oomph::GmshTetScaffoldMesh::write_geo_file().

◆ operator<()

bool oomph::TetEdge::operator< ( const TetEdge &  tet_edge) const
inline

Comparison operator. Lexicographic comparison based on vertex ids.

Definition at line 323 of file gmsh_tet_mesh.template.h.

References first_vertex_id(), second_vertex_id(), and Vertex_pair.

◆ operator==()

bool oomph::TetEdge::operator== ( const TetEdge &  tet_edge) const
inline

Comparison operator: Edges are identical if their sorted (and therefore possibly reversed) vertex ids agree.

Definition at line 315 of file gmsh_tet_mesh.template.h.

References first_vertex_id(), second_vertex_id(), and Vertex_pair.

◆ second_vertex_id()

unsigned oomph::TetEdge::second_vertex_id ( ) const
inline

Second vertex id.

Definition at line 300 of file gmsh_tet_mesh.template.h.

References Vertex_pair.

Referenced by operator<(), and operator==().

Member Data Documentation

◆ Reversed

bool oomph::TetEdge::Reversed
private

Is it reversed? I.e. is the first input vertex stored after the second one?

Definition at line 350 of file gmsh_tet_mesh.template.h.

Referenced by is_reversed(), and TetEdge().

◆ Vertex_pair

std::pair<unsigned, unsigned> oomph::TetEdge::Vertex_pair
private

The vertices (sorted by vertex ids)

Definition at line 346 of file gmsh_tet_mesh.template.h.

Referenced by first_vertex_id(), operator<(), operator==(), second_vertex_id(), and TetEdge().

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