CashOrthoFaceAccessor Class Reference

#include <cashorthofaceaccessor.h>

Collaboration diagram for CashOrthoFaceAccessor:

[legend]

List of all members.

Public Member Functions
	~CashOrthoFaceAccessor ()
bool	isValid () const
bool	at_boundary () const
void	getAdjCellIndices (unsigned &index1, unsigned &index2) const
void	getValidCellIndices (unsigned &index1, unsigned &index2)
double	normal_multiply (double *v) const
OrthoMesh::NORMAL_AXIS	getNormalOrientation () const
unsigned	getNormalNonZeroComponent () const
bool	hasPosCell () const
bool	hasNegCell () const
unsigned	getPosCell () const
unsigned	getNegCell () const
void	operator++ (int)
bool	operator!= (const CashOrthoFaceAccessor &face) const
unsigned	index () const
const OrthoMesh &	getMesh () const
double	area () const
double	areaPerCellVol () const
Private Member Functions
	CashOrthoFaceAccessor (const OrthoMesh &mesh, OrthoMesh::FaceCellsTbl_It m_cash)
Private Attributes
const OrthoMesh &	m_mesh
OrthoMesh::FaceCellsTbl_It	m_cash
unsigned	m_index
Friends
class	OrthoMesh

---

Detailed Description

CashOrthoFaceAccessor

Definition at line 9 of file cashorthofaceaccessor.h.

---

Constructor & Destructor Documentation

CashOrthoFaceAccessor::CashOrthoFaceAccessor	(	const OrthoMesh &	mesh,
		OrthoMesh::FaceCellsTbl_It	m_cash
	)			[private]

These constructors are private. The only way to construct a CashOrthoFaceAccessor is to use the copy constructor, making the variable to receive a value during its initialization like the code above

CashOrthoFace It = mesh.begin(); //Good
CashOrthoFAce It; //Error ,the default constructor is private.

Definition at line 4 of file cashorthofaceaccessor.cpp.

   :m_mesh(mesh),m_cash(cash)
{
   m_index = cash - mesh.m_vFCash.begin();
}

CashOrthoFaceAccessor::~CashOrthoFaceAccessor

(

)

[inline]

Definition at line 33 of file cashorthofaceaccessor.h.

{}

---

Member Function Documentation

double CashOrthoFaceAccessor::area

(

)

const [inline]

Definition at line 95 of file cashorthofaceaccessor.h.

  {
    assert(this->isValid());
    assert(m_index < m_mesh.numFaces());
    return m_mesh._faceArea[static_cast<unsigned>(m_cash->normal)];
  }

double CashOrthoFaceAccessor::areaPerCellVol

(

)

const [inline]

Definition at line 101 of file cashorthofaceaccessor.h.

  {
    assert(this->isValid());
    assert(m_index < m_mesh.numFaces());
    return m_mesh._faceAreaPerCellVol[static_cast<unsigned>(m_cash->normal)];
  }

bool CashOrthoFaceAccessor::at_boundary

(

)

const [inline]

Definition at line 37 of file cashorthofaceaccessor.h.

  {
    return m_cash->c1 == OrthoMesh::INVALID_INDEX || m_cash->c2 == OrthoMesh::INVALID_INDEX;
  }

void CashOrthoFaceAccessor::getAdjCellIndices	(	unsigned &	index1,
		unsigned &	index2
	)			const [inline]

Definition at line 41 of file cashorthofaceaccessor.h.

  {
    index1=m_cash->c1;index2=m_cash->c2;
  } 

const OrthoMesh& CashOrthoFaceAccessor::getMesh

(

)

const [inline]

Definition at line 93 of file cashorthofaceaccessor.h.

{return m_mesh;}

unsigned CashOrthoFaceAccessor::getNegCell

(

)

const [inline]

Definition at line 82 of file cashorthofaceaccessor.h.

  {
    return m_cash->c2;
  }

unsigned CashOrthoFaceAccessor::getNormalNonZeroComponent

(

)

const [inline]

Definition at line 66 of file cashorthofaceaccessor.h.

  {
    return m_cash->normal;
  }

OrthoMesh::NORMAL_AXIS CashOrthoFaceAccessor::getNormalOrientation

(

)

const [inline]

Definition at line 62 of file cashorthofaceaccessor.h.

  {
    return static_cast<OrthoMesh::NORMAL_AXIS>(m_cash->normal);
  }

unsigned CashOrthoFaceAccessor::getPosCell

(

)

const [inline]

Definition at line 78 of file cashorthofaceaccessor.h.

  {
    return m_cash->c1;
  }

void CashOrthoFaceAccessor::getValidCellIndices	(	unsigned &	index1,
		unsigned &	index2
	)			[inline]

Definition at line 45 of file cashorthofaceaccessor.h.

  {
    assert(isValid());
    index1=m_cash->c1;
    index2=m_cash->c2;
    if (index1 == OrthoMesh::INVALID_INDEX)
      index1=index2;
    if (index2 == OrthoMesh::INVALID_INDEX)
      index2=index1;
  }

bool CashOrthoFaceAccessor::hasNegCell

(

)

const [inline]

Definition at line 74 of file cashorthofaceaccessor.h.

  {
    return m_cash->c1!=OrthoMesh::INVALID_INDEX;
  }

bool CashOrthoFaceAccessor::hasPosCell

(

)

const [inline]

Definition at line 70 of file cashorthofaceaccessor.h.

  {
    return m_cash->c2!=OrthoMesh::INVALID_INDEX;
  }

unsigned CashOrthoFaceAccessor::index

(

)

const [inline]

Definition at line 92 of file cashorthofaceaccessor.h.

{return m_index;}

bool CashOrthoFaceAccessor::isValid

(

)

const

Definition at line 11 of file cashorthofaceaccessor.cpp.

{
  return (m_cash->c1 != OrthoMesh::INVALID_INDEX ||
          m_cash->c2 != OrthoMesh::INVALID_INDEX);
}

double CashOrthoFaceAccessor::normal_multiply

(

double *

v

)

const [inline]

Definition at line 58 of file cashorthofaceaccessor.h.

  {
    return v[static_cast<int>(m_cash->normal)];
  }

bool CashOrthoFaceAccessor::operator!=

(

const CashOrthoFaceAccessor &

face

)

const

Definition at line 21 of file cashorthofaceaccessor.cpp.

{
  assert(&m_mesh == &face.m_mesh);
  return m_cash != face.m_cash; 
}

void CashOrthoFaceAccessor::operator++

(

int

)

[inline]

Definition at line 86 of file cashorthofaceaccessor.h.

  {
    m_cash++;
    m_index++;
  }

---

Friends And Related Function Documentation

friend class OrthoMesh [friend]

Definition at line 14 of file cashorthofaceaccessor.h.

---

Member Data Documentation

OrthoMesh::FaceCellsTbl_It CashOrthoFaceAccessor::m_cash [private]

Definition at line 16 of file cashorthofaceaccessor.h.

unsigned CashOrthoFaceAccessor::m_index [private]

Definition at line 17 of file cashorthofaceaccessor.h.

const OrthoMesh& CashOrthoFaceAccessor::m_mesh [private]

Definition at line 15 of file cashorthofaceaccessor.h.

---

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

• cashorthofaceaccessor.h
• cashorthofaceaccessor.cpp