VolumeSide Class Reference

#include <VolumeSide.h>

Public Types
typedef SurfaceOrientation::GlobalFace	GlobalFace
typedef SurfaceOrientation::Side	Side
typedef ReferenceCountingPointer< Surface >	SurfacePointer

Public Member Functions
GlobalFace	globalFace () const
Surface &	mutableSurface () const
const Surface &	surface () const
Side	surfaceSide () const
	VolumeSide (Surface *surf, GlobalFace gSide, Side sSide)
	VolumeSide (SurfacePointer surf, GlobalFace gSide, Side sSide)

Private Attributes
GlobalFace	theGlobalFace
SurfacePointer	theSurface
Side	theSurfaceSide

Detailed Description

Class for delimiding surface of a volume. The additional information with respect to Surface that is needed to define the volume is
a) which side of the Surface the volume is (enumerator Surface::Side)
b) which face of the volume this surface represents (enumerator GlobalFace). Only 6 possible values for volume face are defined.

Definition at line 15 of file VolumeSide.h.

Member Typedef Documentation

GlobalFace

typedef SurfaceOrientation::GlobalFace VolumeSide::GlobalFace

Definition at line 17 of file VolumeSide.h.

Side

typedef SurfaceOrientation::Side VolumeSide::Side

Definition at line 18 of file VolumeSide.h.

SurfacePointer

typedef ReferenceCountingPointer<Surface> VolumeSide::SurfacePointer

Definition at line 20 of file VolumeSide.h.

Constructor & Destructor Documentation

VolumeSide() [1/2]

VolumeSide::VolumeSide ( Surface *  surf, GlobalFace  gSide, Side  sSide  )

inline

Definition at line 22 of file VolumeSide.h.

      : theSurface(surf), theGlobalFace(gSide), theSurfaceSide(sSide) {}

VolumeSide() [2/2]

VolumeSide::VolumeSide ( SurfacePointer  surf, GlobalFace  gSide, Side  sSide  )

inline

Definition at line 25 of file VolumeSide.h.

      : theSurface(surf), theGlobalFace(gSide), theSurfaceSide(sSide) {}

Member Function Documentation

globalFace()

GlobalFace VolumeSide::globalFace ( ) const

inline

Definition at line 32 of file VolumeSide.h.

References theGlobalFace.

{ return theGlobalFace; }

mutableSurface()

Surface& VolumeSide::mutableSurface ( ) const

inline

Definition at line 28 of file VolumeSide.h.

References theSurface.

{ return *theSurface; }

surface()

const Surface& VolumeSide::surface ( ) const

inline

Definition at line 30 of file VolumeSide.h.

References theSurface.

{ return *theSurface; }

surfaceSide()

Side VolumeSide::surfaceSide ( ) const

inline

Definition at line 34 of file VolumeSide.h.

References theSurfaceSide.

{ return theSurfaceSide; }

Member Data Documentation

theGlobalFace

GlobalFace VolumeSide::theGlobalFace

private

Definition at line 38 of file VolumeSide.h.

Referenced by globalFace().

theSurface

SurfacePointer VolumeSide::theSurface

private

Definition at line 37 of file VolumeSide.h.

Referenced by mutableSurface(), and surface().

theSurfaceSide

Side VolumeSide::theSurfaceSide

private

Definition at line 39 of file VolumeSide.h.

Referenced by surfaceSide().