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

Edge class. More...

#include <mesh.h>

Public Member Functions

 Edge (Node *node1_pt, Node *node2_pt)
 Constructor: Pass in the two vertex nodes. More...
 
Node * node1_pt () const
 Access to the first vertex node. More...
 
Node * node2_pt () const
 Access to the second vertex node. More...
 
bool operator== (const Edge &other) const
 Comparison operator. More...
 
bool operator< (const Edge &other) const
 Less-than operator. More...
 
bool is_on_boundary () const
 Test whether the Edge lies on a boundary. Relatively simple test, based on both vertices lying on (some) boundary. More...
 
bool is_boundary_edge () const
 Test whether the Edge is a boundary edge, i.e. does it connnect two boundary nodes? More...
 

Private Attributes

Node * Node1_pt
 First vertex node. More...
 
Node * Node2_pt
 Second vertex node. More...
 

Detailed Description

Edge class.

Definition at line 2362 of file mesh.h.

Constructor & Destructor Documentation

◆ Edge()

oomph::Edge::Edge ( Node *  node1_pt,
Node *  node2_pt 
)
inline

Constructor: Pass in the two vertex nodes.

Definition at line 2368 of file mesh.h.

Member Function Documentation

◆ is_boundary_edge()

bool oomph::Edge::is_boundary_edge ( ) const
inline

Test whether the Edge is a boundary edge, i.e. does it connnect two boundary nodes?

Definition at line 2454 of file mesh.h.

◆ is_on_boundary()

bool oomph::Edge::is_on_boundary ( ) const
inline

Test whether the Edge lies on a boundary. Relatively simple test, based on both vertices lying on (some) boundary.

Definition at line 2446 of file mesh.h.

◆ node1_pt()

Node* oomph::Edge::node1_pt ( ) const
inline

Access to the first vertex node.

Definition at line 2398 of file mesh.h.

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

◆ node2_pt()

Node* oomph::Edge::node2_pt ( ) const
inline

Access to the second vertex node.

Definition at line 2401 of file mesh.h.

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

◆ operator<()

bool oomph::Edge::operator< ( const Edge &  other) const
inline

Less-than operator.

Definition at line 2421 of file mesh.h.

References node1_pt(), and node2_pt().

◆ operator==()

bool oomph::Edge::operator== ( const Edge &  other) const
inline

Comparison operator.

Definition at line 2404 of file mesh.h.

References node1_pt(), and node2_pt().

Member Data Documentation

◆ Node1_pt

Node* oomph::Edge::Node1_pt
private

First vertex node.

Definition at line 2463 of file mesh.h.

◆ Node2_pt

Node* oomph::Edge::Node2_pt
private

Second vertex node.

Definition at line 2466 of file mesh.h.

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