ProbeInfo Class Reference

#include <ProbeInfo.h>

Collaboration diagram for ProbeInfo:

Public Types
enum	ProbeTypesEnum { probeAtGridPoint, probeAtLocation, probeBoundingBox, probeRegion }

Public Member Functions
	ProbeInfo (Parameters &par)
	: define a probe. A probe is a point or location in a grid where the solution is periodically saved to a file. A probe may also save the solution on a bounding-box. This bounding box info may be used on subsequent computations as boundary conditions for a computation on a smaller sub-domain.
	~ProbeInfo ()
	: destructor.
int	update (CompositeGrid &cg, GenericGraphicsInterface &gi)
	define the properties of the probe
int	buildRegionOptionsDialog (DialogData &dialog)
	Build the region options dialog.
int	getRegionOption (const aString &answer, DialogData &dialog)
	: Look for an region option in the string "answer"

Public Attributes
ProbeTypesEnum	probeType
int	grid
int	iv [3]
real	xv [3]
FILE *	file
aString	fileName
int	boundingBoxGrid
int	boundingBox [6]
int	numberOfLayers
GenericDataBase *	pdb
int	numberOfTimes
RealArray *	times
Parameters &	parameters
DataBase	dbase

Member Enumeration Documentation

enum ProbeInfo::ProbeTypesEnum

Enumerator
probeAtGridPoint
probeAtLocation
probeBoundingBox
probeRegion

Constructor & Destructor Documentation

ProbeInfo::ProbeInfo

(

Parameters &

par

)

: define a probe. A probe is a point or location in a grid where the solution is periodically saved to a file. A probe may also save the solution on a bounding-box. This bounding box info may be used on subsequent computations as boundary conditions for a computation on a smaller sub-domain.

The file generated with the probe results can be read by the matlab script plotProbes.m

References axis, bb, boundingBoxGrid, dbase, file, fileName, grid, iv, numberOfLayers, numberOfTimes, pdb, probeAtGridPoint, probeType, times, and xv.

ProbeInfo::~ProbeInfo

(

)

: destructor.

References assert(), file, numberOfTimes, pdb, printF(), and times.

Member Function Documentation

int ProbeInfo::buildRegionOptionsDialog

(

DialogData &

dialog

)

Build the region options dialog.

Parameters

dialog

(input) : graphics dialog to use.

References assert().

Referenced by update().

int ProbeInfo::getRegionOption	(	const aString &	answer,
		DialogData &	dialog
	)

: Look for an region option in the string "answer"

Parameters

answer

(input) : check this command

Returns

return 1 if the command was found, 0 otherwise.

References Parameters::dbase, dbase, forcingType, i, OV_ABORT(), parameters, printF(), probeRegion, and probeType.

Referenced by update().

int ProbeInfo::update	(	CompositeGrid &	cg,
		GenericGraphicsInterface &	gi
	)

define the properties of the probe

cg (input) : the probe will be a point on this grid

References addPrefix(), assert(), axis, bb, boundingBoxGrid, buildRegionOptionsDialog(), center, Parameters::dbase, dbase, fileName, getClosestGridPoint(), getRegionOption(), grid, i1, i2, i3, iv, numberOfLayers, parameters, printF(), probeAtGridPoint, probeAtLocation, probeBoundingBox, probeType, side, and x.

Referenced by DomainSolver::getOutputOption().

Member Data Documentation

int ProbeInfo::boundingBox[6]

Referenced by DomainSolver::outputProbes().

int ProbeInfo::boundingBoxGrid

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and update().

DataBase ProbeInfo::dbase

Referenced by getRegionOption(), DomainSolver::outputProbes(), ProbeInfo(), and update().

FILE* ProbeInfo::file

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and ~ProbeInfo().

aString ProbeInfo::fileName

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and update().

int ProbeInfo::grid

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and update().

int ProbeInfo::iv[3]

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and update().

int ProbeInfo::numberOfLayers

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and update().

int ProbeInfo::numberOfTimes

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and ~ProbeInfo().

Parameters& ProbeInfo::parameters

Referenced by getRegionOption(), and update().

GenericDataBase* ProbeInfo::pdb

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and ~ProbeInfo().

ProbeTypesEnum ProbeInfo::probeType

Referenced by getRegionOption(), DomainSolver::outputProbes(), ProbeInfo(), and update().

RealArray* ProbeInfo::times

Referenced by DomainSolver::outputProbes(), ProbeInfo(), and ~ProbeInfo().

real ProbeInfo::xv[3]

Referenced by ProbeInfo().

---

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

• ProbeInfo.h
• ProbeInfo.C