Chombo + EB  3.2
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Side Class Reference

Encapsulation of high or low side. More...

#include <LoHiSide.H>

Public Types

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

Public Member Functions

 Side ()
 
 ~Side ()
 

Static Public Member Functions

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

Friends

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

Detailed Description

Encapsulation of high or low side.

Encapsulation of high or low side.

Member Enumeration Documentation

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

Enumerator
Invalid 
Lo 
Hi 
NUMSIDES 

Constructor & Destructor Documentation

Side::Side ( )
inline

Constructor.

Side::~Side ( )
inline

Destructor.

Member Function Documentation

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

Friends And Related Function Documentation

Side::LoHiSide flip ( const Side::LoHiSide a_side)
friend

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

int sign ( const 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: