Overture: GridStatistics Class Reference

Overture Version 25

#include <GridStatistics.h>

Public Types
enum	MaskOptionEnum { ignoreMask, positiveMask, nonZeroMask }

Static Public Member Functions
static void	printGridStatistics (CompositeGrid &cg, FILE *file=stdout)

static void	printGridStatistics (GridCollection &gc, FILE *file=stdout)

static void	printGridStatistics (MappedGrid &mg, FILE file=stdout, int grid=0, int ipar=NULL, real *rpar=NULL)

static void	getGridSpacing (MappedGrid &mg, real dsMin[3], real dsAve[3], real dsMax[3], MaskOptionEnum maskOption=ignoreMask)

static void	getGridSpacingAndNumberOfPoints (MappedGrid &mg, real dsMin[3], real dsAve[3], real dsMax[3], int &numberOfPoints, MaskOptionEnum maskOption=ignoreMask)

static void	getNumberOfPoints (GridCollection &gc, int &totalNumberOfGridPoints, MaskOptionEnum maskOption=ignoreMask)

static void	getNumberOfPoints (MappedGrid &mg, int &numberOfPoints, MaskOptionEnum maskOption=ignoreMask)

Member Enumeration Documentation

enum GridStatistics::MaskOptionEnum

Enumerator
ignoreMask
positiveMask
nonZeroMask

Member Function Documentation

void GridStatistics::getGridSpacing	(	MappedGrid &	mg,
		real	dsMin[3],
		real	dsAve[3],
		real	dsMax[3],
		MaskOptionEnum	maskOption = `ignoreMask`
	)

static

void GridStatistics::getGridSpacingAndNumberOfPoints	(	MappedGrid &	mg,
		real	dsMin[3],
		real	dsAve[3],
		real	dsMax[3],
		int &	numberOfPoints,
		MaskOptionEnum	maskOption = `ignoreMask`
	)

static

References getGridSpacing(), and getNumberOfPoints().

void GridStatistics::getNumberOfPoints	(	GridCollection &	gc,
		int &	totalNumberOfGridPoints,
		MaskOptionEnum	maskOption = `ignoreMask`
	)

static

References dim, MappedGrid::dimension(), ignoreMask, GenericGridCollection::numberOfComponentGrids(), and printF().

Referenced by getGridSpacingAndNumberOfPoints(), and main().

void GridStatistics::getNumberOfPoints	(	MappedGrid &	mg,
		int &	numberOfPoints,
		MaskOptionEnum	maskOption = `ignoreMask`
	)

static

References printF().

void GridStatistics::printGridStatistics	(	CompositeGrid &	cg,
		FILE *	file = `stdout`
	)

static

Referenced by PlotIt::plotGrid(), and printGridStatistics().

void GridStatistics::printGridStatistics	(	GridCollection &	gc,
		FILE *	file = `stdout`
	)

static

References dim, MappedGrid::dimension(), fPrintF(), GridCollection::getClassName(), gid, MappedGrid::gridIndexRange(), max(), min(), GenericGridCollection::numberOfComponentGrids(), CompositeGrid::numberOfInterpolationPoints, printGridStatistics(), and REAL_MAX.

void GridStatistics::printGridStatistics	(	MappedGrid &	mg,
		FILE *	file = `stdout`,
		int	grid = `0`,
		int *	ipar = `NULL`,
		real *	rpar = `NULL`
	)

static

References MappedGrid::boundaryCondition(), MappedGrid::discretizationWidth(), MappedGrid::domainDimension(), dx, FOR_3D, fPrintF(), MappingRC::getClassName(), MappedGrid::getDeltaX(), getGridSpacing(), MappedGrid::getGridType(), getIndex(), ParallelUtility::getLocalArrayBounds(), getLocalArrayWithGhostBoundaries(), MappingRC::getMapping(), ParallelUtility::getMaxValue(), ParallelUtility::getMinValue(), MappedGrid::getName(), Mapping::getSignForJacobian(), ParallelUtility::getSum(), gid, MappedGrid::gridIndexRange(), i2, isPeriodic, MappedGrid::isPeriodic(), MappedGrid::isRectangular(), MappedGrid::mapping(), max(), min(), NULL, MappedGrid::numberOfGhostPoints(), printF(), MappedGrid::rangeDimension(), REAL_MAX, share, MappedGrid::sharedBoundaryFlag(), GenericGrid::structuredGrid, MappedGrid::THEvertex, MappedGrid::update(), MappedGrid::vertex(), and x.

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