ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator Class Reference

#include <ImmersedBoundaryMesh.hpp>

Collaboration diagram for ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator:

Public Member Functions
ImmersedBoundaryElement< ELEMENT_DIM - 1, SPACE_DIM > &	operator* ()
ImmersedBoundaryElement< ELEMENT_DIM - 1, SPACE_DIM > *	operator-> ()
bool	operator!= (const typename ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator &rOther)
ImmersedBoundaryLaminaIterator &	operator++ ()
	ImmersedBoundaryLaminaIterator (ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM > &rMesh, typename std::vector< ImmersedBoundaryElement< ELEMENT_DIM - 1, SPACE_DIM > * >::iterator laminaIter, bool skipDeletedLaminas=true)

Private Member Functions
bool	IsAtEnd ()
bool	IsAllowedLamina ()

Private Attributes
ImmersedBoundaryMesh &	mrMesh
std::vector< ImmersedBoundaryElement< ELEMENT_DIM-1, SPACE_DIM > * >::iterator	mLaminaIter
bool	mSkipDeletedLaminas

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator

A smart iterator over the laminas in the mesh.

Definition at line 848 of file ImmersedBoundaryMesh.hpp.

Constructor & Destructor Documentation

ImmersedBoundaryLaminaIterator()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::ImmersedBoundaryLaminaIterator	(	ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM > &	rMesh,
		typename std::vector< ImmersedBoundaryElement< ELEMENT_DIM - 1, SPACE_DIM > * >::iterator	laminaIter,
		bool	skipDeletedLaminas = true
	)

Constructor for a new iterator.

This should not be called directly by user code; use the mesh methods ImmersedBoundaryMesh::GetlaminaIteratorBegin and ImmersedBoundaryMesh::GetlaminaIteratorEnd instead.

Parameters

rMesh	the mesh to iterator over
laminaIter	where to start iterating
skipDeletedLaminas	whether to include deleted laminas

Definition at line 1051 of file ImmersedBoundaryMesh.hpp.

References ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::IsAllowedLamina(), ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::mLaminaIter, ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::mLaminas, and ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::mrMesh.

Member Function Documentation

IsAllowedLamina()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::IsAllowedLamina ( )

inlineprivate

Helper method to say if we're allowed to point at this lamina.

Returns

true if allowed

Definition at line 1081 of file ImmersedBoundaryMesh.hpp.

Referenced by ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::ImmersedBoundaryLaminaIterator().

IsAtEnd()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::IsAtEnd ( )

inlineprivate

Helper method to say when we're at the end.

Returns

true if at end

Definition at line 1075 of file ImmersedBoundaryMesh.hpp.

operator!=()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::operator!= ( const typename ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator &  rOther )

inline

Comparison not-equal-to.

Returns

true if not equal

Parameters

rOther

iterator with which comparison is made

Definition at line 1034 of file ImmersedBoundaryMesh.hpp.

References ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::mLaminaIter.

operator*()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

ImmersedBoundaryElement< ELEMENT_DIM - 1, SPACE_DIM > & ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::operator* ( )

inline

Dereference the iterator giving you a *reference* to the current lamina.

Returns

reference Make sure to use a reference for the result to avoid copying laminas unnecessarily.

Definition at line 1020 of file ImmersedBoundaryMesh.hpp.

operator++()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator & ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::operator++ ( )

inline

Prefix increment operator.

Returns

reference to incremented object

Definition at line 1040 of file ImmersedBoundaryMesh.hpp.

operator->()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

ImmersedBoundaryElement< ELEMENT_DIM - 1, SPACE_DIM > * ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::operator-> ( )

inline

Member access from a pointer.

Returns

pointer

Definition at line 1027 of file ImmersedBoundaryMesh.hpp.

Member Data Documentation

mLaminaIter

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::vector<ImmersedBoundaryElement<ELEMENT_DIM-1,SPACE_DIM>*>::iterator ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::mLaminaIter

private

The actual lamina iterator.

Definition at line 896 of file ImmersedBoundaryMesh.hpp.

Referenced by ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::ImmersedBoundaryLaminaIterator(), and ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::operator!=().

mrMesh

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

ImmersedBoundaryMesh& ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::mrMesh

private

The mesh we're iterating over.

Definition at line 893 of file ImmersedBoundaryMesh.hpp.

Referenced by ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::ImmersedBoundaryLaminaIterator().

mSkipDeletedLaminas

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::ImmersedBoundaryLaminaIterator::mSkipDeletedLaminas

private

Whether to skip deleted laminas.

Definition at line 899 of file ImmersedBoundaryMesh.hpp.

---

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

• mesh/src/immersed_boundary/ImmersedBoundaryMesh.hpp