Proto  3.2
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Proto::Side Class Reference

Side. More...

#include <Proto_Face.H>

Public Types

enum  LoHiSide { Invalid =-1, Lo =0, Hi, NUMSIDES }
 Side Enum. More...
 

Public Member Functions

 Side ()
 Constructor. More...
 
 ~Side ()
 Destructor. More...
 

Static Public Member Functions

static SideIterator begin ()
 Get Begin Iterator. More...
 
static SideIterator end ()
 Get End Iterator. More...
 

Detailed Description

Side.

Abstraction for high / low side of a grid cell.

Member Enumeration Documentation

◆ LoHiSide

Side Enum.

Enumerator
Invalid 

Invalid.

Lo 

Low side; normal is in negative coordinate direction.

Hi 

High side; normal is in the positive coordinate direction.

NUMSIDES 

Number of sides.

Constructor & Destructor Documentation

◆ Side()

Proto::Side::Side ( )
inline

Constructor.

◆ ~Side()

Proto::Side::~Side ( )
inline

Destructor.

References begin(), and end().

Member Function Documentation

◆ begin()

SideIterator Proto::Side::begin ( )
inlinestatic

Get Begin Iterator.

Referenced by ~Side().

◆ end()

SideIterator Proto::Side::end ( )
inlinestatic

Get End Iterator.

Referenced by ~Side().


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