gmCellMesh.h File Reference

Declaration of the GmCellMesh interface class. More...

#include "gmMesh.h"
#include "gmCell.h"
#include <assert.h>
#include <float.h>
#include "gmPCR.h"

Include dependency graph for gmCellMesh.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GmCellMesh
	Base interface class for CellMesh type plugins. More...
struct	GmCellMesh::GmCellEdgeStatistics
struct	GmCellMesh::GmCellBboxStatistics
class	GmForeachCellHelperClassBase< T >
	Base helper class for the GmForeachXxxx() family of macros. More...
class	GmForeachCellHelperClass< T, C >
	Helper class for the GmForeachActiveXxxx() family of macros. More...
class	GmForeachOrderedCellHelperClass< T, C >
	Helper class for the GmForeachOrderedActiveXxxx() family of macros. More...

Macros
#define	GmForeachCellHelper(variable, container, contType, cellType, activeOnly)
	Helper macro used to traverse all the (active) cells in a generic container. Should NOT be used in user code.
#define	GmForeachOrderedCellHelper(variable, container, contType, cellType, activeOnly, pcr)
#define	GmForeachActiveCell(variable, mesh)
	Macro used to traverse all the active cells in a mesh.
#define	GmForeachCell(variable, mesh, activeOnly)
	Similar to GmForeachActiveCell but with a flag (activeOnly) controlling if all cells will be traversed or only the active ones.
#define	GmForeachOrderedCell(variable, mesh, activeOnly, modelOrder)
	Similar to GmForeachCell but with an added parameter (modelOrder) to control if the mesh should be traversed in the original cell model order or not.

Detailed Description

Declaration of the GmCellMesh interface class.

Author

Carlos Augusto Teixeira Mendes

Date

may, 2015

Macro Definition Documentation

GmForeachActiveCell

#define GmForeachActiveCell	(		variable,
			mesh )

Value:

GmForeachCellHelper(variable, mesh, GmCellMesh, GmCell, true)

Macro used to traverse all the active cells in a mesh.

Can be used as:

GmForeachActiveCell(const GmCell* c, _mesh)
{
  printf("%d\n", c->id());
}
 
GmForeachActiveCell(GmCell* c, _mesh)
{
  printf("%d\n", c->id());
}

GmForeachCell

#define GmForeachCell	(		variable,
			mesh,
			activeOnly )

Value:

GmForeachCellHelper(variable, mesh, GmCellMesh, GmCell, activeOnly)

Similar to GmForeachActiveCell but with a flag (activeOnly) controlling if all cells will be traversed or only the active ones.

GmForeachCellHelper

#define GmForeachCellHelper	(		variable,
			container,
			contType,
			cellType,
			activeOnly )

Value:

for(GmForeachCellHelperClass<contType, cellType> it(container, activeOnly); it._control && it._index<it._n; it.inc(), it._control ^= 1) \
  for(variable = it.cell(); it._control; it._control = 0)

Helper macro used to traverse all the (active) cells in a generic container. Should NOT be used in user code.

The implementation is largely inspired by the implementation of the Qt foreach macro, so it can include break. The container parameter should be a pointer.
From the documentation of the Q_FOREACH macro:

Explanation of the control word:

• it's initialized to 1
• that means both the inner and outer loops start
• if there were no breaks, at the end of the inner loop, it's set to 0, which causes it to exit (the inner loop is run exactly once)
• at the end of the outer loop, it's inverted, so it becomes 1 again, allowing the outer loop to continue executing
• if there was a break inside the inner loop, it will exit with control still set to 1; in that case, the outer loop will invert it to 0 and will exit too

GmForeachOrderedCell

#define GmForeachOrderedCell	(		variable,
			mesh,
			activeOnly,
			modelOrder )

Value:

GmForeachOrderedCellHelper(variable, mesh, GmCellMesh, GmCell, activeOnly, modelOrder ? (mesh)->pcrObject() : NULL)

Similar to GmForeachCell but with an added parameter (modelOrder) to control if the mesh should be traversed in the original cell model order or not.

GmForeachOrderedCellHelper

#define GmForeachOrderedCellHelper	(		variable,
			container,
			contType,
			cellType,
			activeOnly,
			pcr )

Value:

for(GmForeachOrderedCellHelperClass<contType, cellType> it(container, activeOnly, pcr); it._control && it._index<it._n; it.inc(), it._control ^= 1) \
  for(variable = it.cell(); it._control; it._control = 0)