Sundance::PointData Class Reference

PointData is a utility class that helps create the Sundance objects required to include point measurements in an inversion problem. More...

List of all members.

Public Member Functions
	PointData (const Array< Point > &locations, const Array< double > &values, const double &pointComparisonTolerance)
	Create a point data object given a set of sensor locations and corresponding sensor readings.
	PointData (const Array< Point > &locations, const Expr &field, const double &pointComparisonTolerance)
	Create a point data object given a set of sensor locations and a field to probe at those points.
	PointData (const XMLObject &xml, const Mesh &mesh)
	Read point data from an XML file.
Expr	sensorValues () const
	Return an expr that, when called at one of the measurement locations, returns the value of the measurement there.
CellFilter	sensorLocations () const
	Return a cell filter that identifies the sensor points.
Static Public Member Functions
static Array< Point >	snapToMesh (const Mesh &mesh, const Array< Point > &locations)
	Adjust a set of points to the nearest vertices on a mesh.
static Point	nearestMeshPoint (const Mesh &mesh, const Point &x)
	Find the vertex nearest to a specified point.
Private Member Functions
void	init (const Array< Point > &locations, const Array< double > &values, const double &pointComparisonTolerance)
Private Attributes
Expr	sensorVals_
CellFilter	sensorLocations_

---

Detailed Description

PointData is a utility class that helps create the Sundance objects required to include point measurements in an inversion problem.

Definition at line 14 of file PDEOptPointData.hpp.

---

Constructor & Destructor Documentation

Sundance::PointData::PointData	(	const Array< Point > &	locations,
		const Array< double > &	values,
		const double &	pointComparisonTolerance
	)

Create a point data object given a set of sensor locations and corresponding sensor readings.

Definition at line 9 of file PDEOptPointData.cpp.

References init().

Sundance::PointData::PointData	(	const Array< Point > &	locations,
		const Expr &	field,
		const double &	pointComparisonTolerance
	)

Create a point data object given a set of sensor locations and a field to probe at those points.

Sundance::PointData::PointData	(	const XMLObject &	xml,
		const Mesh &	mesh
	)

Read point data from an XML file.

Definition at line 17 of file PDEOptPointData.cpp.

References init(), and snapToMesh().

---

Member Function Documentation

void Sundance::PointData::init	(	const Array< Point > &	locations,
		const Array< double > &	values,
		const double &	pointComparisonTolerance
	)			[private]

Definition at line 59 of file PDEOptPointData.cpp.

References Sundance::List(), sensorLocations_, sensorVals_, and Sundance::CellFilter::subset().

Referenced by PointData().

Point Sundance::PointData::nearestMeshPoint	(	const Mesh &	mesh,
		const Point &	x
	)			[static]

Find the vertex nearest to a specified point.

Definition at line 114 of file PDEOptPointData.cpp.

References Sundance::Mesh::nodePosition(), and Sundance::Mesh::numCells().

Referenced by snapToMesh().

CellFilter Sundance::PointData::sensorLocations

(

)

const [inline]

Return a cell filter that identifies the sensor points.

Definition at line 37 of file PDEOptPointData.hpp.

References sensorLocations_.

Expr Sundance::PointData::sensorValues

(

)

const [inline]

Return an expr that, when called at one of the measurement locations, returns the value of the measurement there.

Definition at line 34 of file PDEOptPointData.hpp.

References sensorVals_.

Array< Point > Sundance::PointData::snapToMesh	(	const Mesh &	mesh,
		const Array< Point > &	locations
	)			[static]

Adjust a set of points to the nearest vertices on a mesh.

Definition at line 102 of file PDEOptPointData.cpp.

References nearestMeshPoint().

Referenced by PointData().

---

Member Data Documentation

CellFilter Sundance::PointData::sensorLocations_ [private]

Definition at line 52 of file PDEOptPointData.hpp.

Referenced by init(), and sensorLocations().

Expr Sundance::PointData::sensorVals_ [private]

Definition at line 51 of file PDEOptPointData.hpp.

Referenced by init(), and sensorValues().