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

Private Attributes
Node *	Node1_pt
	First vertex node.
Node *	Node2_pt
	Second vertex node.

Detailed Description

Edge class.

Definition at line 2699 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 2703 of file mesh.h.

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

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

References Node1_pt, and Node2_pt.

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

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

node1_pt()

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

inline

Access to the first vertex node.

Definition at line 2731 of file mesh.h.

References Node1_pt.

Referenced by Edge().

node2_pt()

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

inline

Access to the second vertex node.

Definition at line 2737 of file mesh.h.

References Node2_pt.

Referenced by Edge().

operator<()

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

inline

Less-than operator.

Definition at line 2758 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 2743 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 2799 of file mesh.h.

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

Node2_pt

Node* oomph::Edge::Node2_pt

private

Second vertex node.

Definition at line 2802 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:

• mesh.h