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...
 
Nodenode1_pt () const
 Access to the first vertex node. More...
 
Nodenode2_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

NodeNode1_pt
 First vertex node. More...
 
NodeNode2_pt
 Second vertex node. More...
 

Detailed Description

Edge class.

Definition at line 2401 of file mesh.h.

Constructor & Destructor Documentation

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

Constructor: Pass in the two vertex nodes.

Definition at line 2407 of file mesh.h.

References node1_pt(), Node1_pt, node2_pt(), and Node2_pt.

Member Function Documentation

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 2493 of file mesh.h.

References Node1_pt, and Node2_pt.

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 2485 of file mesh.h.

References oomph::Node::is_on_boundary(), Node1_pt, and Node2_pt.

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

Access to the first vertex node.

Definition at line 2437 of file mesh.h.

References Node1_pt.

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

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

Access to the second vertex node.

Definition at line 2440 of file mesh.h.

References Node2_pt.

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

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

Less-than operator.

Definition at line 2460 of file mesh.h.

References node1_pt(), Node1_pt, node2_pt(), and Node2_pt.

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

Comparison operator.

Definition at line 2443 of file mesh.h.

References node1_pt(), Node1_pt, node2_pt(), and Node2_pt.

Member Data Documentation

Node* oomph::Edge::Node1_pt
private

First vertex node.

Definition at line 2502 of file mesh.h.

Referenced by Edge(), is_boundary_edge(), is_on_boundary(), node1_pt(), operator<(), and operator==().

Node* oomph::Edge::Node2_pt
private

Second vertex node.

Definition at line 2505 of file mesh.h.

Referenced by Edge(), is_boundary_edge(), is_on_boundary(), node2_pt(), operator<(), and operator==().


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