Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

Side Class Reference

Encapsulation of high or low side. More...

#include <LoHiSide.H>

List of all members.

Public Types

enum  LoHiSide { Invalid = -1, Lo = 0, Hi, NUMSIDES }

Public Member Functions

 Side ()
 ~Side ()

Static Public Member Functions

static Side::LoHiSide flip (Side::LoHiSide a_side)

Friends

Side::LoHiSide flip (Side::LoHiSide a_side)
int sign (Side::LoHiSide a_side)


Detailed Description

Encapsulation of high or low side.

Encapsulation of high or low side.


Member Enumeration Documentation

enum Side::LoHiSide
 

Lo is the low side.
Hi is the high side.

Enumeration values:
Invalid 
Lo 
Hi 
NUMSIDES 


Constructor & Destructor Documentation

Side::Side  )  [inline]
 

Constructor.

Side::~Side  )  [inline]
 

Destructor.


Member Function Documentation

static Side::LoHiSide Side::flip Side::LoHiSide  a_side  )  [static]
 


Friends And Related Function Documentation

Side::LoHiSide flip Side::LoHiSide  a_side  )  [friend]
 

Returns the other side. That is, swap Hi for Lo and vice versa.

int sign Side::LoHiSide  a_side  )  [friend]
 

Returns -1 for Lo Side, +1 for Hi Side.


The documentation for this class was generated from the following file:
Generated on Wed Oct 5 14:02:19 2005 for Chombo&AMRSelfGravity by  doxygen 1.4.1