AF2Point3D Class Reference

#include <AF2Point3D.hpp>

List of all members.

Public Member Functions
	AF2Point3D (unsigned long pntId, double xVal, double yVal, double zVal)
	Standard constructor.
unsigned int	getDistanceToBoundary () const
	Get this points current distance to the boundary based on the advancement of the advancing front.
moab::EntityHandle	getVertexHandle () const
	Get the value of the handle to the vertex in the mesh.
unsigned long	getLocalId () const
	Get the number that uniquely identifies this point within the context of the current execution of the AF2Algorithm.
double	getX () const
	Get the value of the x coordinate.
double	getY () const
	Get the value of the y coordinate.
double	getZ () const
	Get the value of the z coordinate.
bool	isCommitted () const
	Determine whether this point has been committed to the mesh.
void	limitDistanceToBoundary (unsigned int upperBound)
	If the current distance to the boundary is greater than the specified upper bound, reduce the distance to the boundary to the specified upper bound.
void	setCommittedHandle (const moab::EntityHandle &vertexHandleArg)
	Set the value of the vertex handle in the mesh that corresponds to this point.
Private Attributes
unsigned long	localId
double	x
double	y
double	z
unsigned int	distToBndry
bool	committed
moab::EntityHandle	vertexHandle

---

Detailed Description

Definition at line 15 of file AF2Point3D.hpp.

---

Constructor & Destructor Documentation

AF2Point3D	(	unsigned long	pntId,
		double	xVal,
		double	yVal,
		double	zVal
	)

Standard constructor.

Construct a point at the specified coordinates.

Parameters:

pntId	a number that uniquely identifies this point within the (local) context of a single execution of the AF2Algorithm
xVal	the x coordinate of the point
yVal	the y coordinate of the point
zVal	the z coordinate of the point

Definition at line 9 of file AF2Point3D.cpp.

---

Member Function Documentation

unsigned int getDistanceToBoundary

(

)

const

Get this points current distance to the boundary based on the advancement of the advancing front.

Definition at line 20 of file AF2Point3D.cpp.

unsigned long getLocalId

(

)

const

Get the number that uniquely identifies this point within the context of the current execution of the AF2Algorithm.

Definition at line 25 of file AF2Point3D.cpp.

moab::EntityHandle getVertexHandle

(

)

const

Get the value of the handle to the vertex in the mesh.

This will throw an exception if the point has not been committed. Users can check whether the point has been committed using the isCommitted() method.

Definition at line 30 of file AF2Point3D.cpp.

double getX

(

)

const

Get the value of the x coordinate.

Definition at line 41 of file AF2Point3D.cpp.

double getY

(

)

const

Get the value of the y coordinate.

Definition at line 46 of file AF2Point3D.cpp.

double getZ

(

)

const

Get the value of the z coordinate.

Definition at line 51 of file AF2Point3D.cpp.

bool isCommitted

(

)

const

Determine whether this point has been committed to the mesh.

Definition at line 56 of file AF2Point3D.cpp.

void limitDistanceToBoundary

(

unsigned int

upperBound

)

If the current distance to the boundary is greater than the specified upper bound, reduce the distance to the boundary to the specified upper bound.

Definition at line 61 of file AF2Point3D.cpp.

void setCommittedHandle

(

const moab::EntityHandle &

vertexHandleArg

)

Set the value of the vertex handle in the mesh that corresponds to this point.

This method should be called at most once. If this method has already been called, then the point is already noted as committed to the mesh, and calling the method again will throw an exception.

Definition at line 69 of file AF2Point3D.cpp.

---

Member Data Documentation

bool committed [private]

Definition at line 22 of file AF2Point3D.hpp.

unsigned int distToBndry [private]

Definition at line 21 of file AF2Point3D.hpp.

unsigned long localId [private]

Definition at line 19 of file AF2Point3D.hpp.

moab::EntityHandle vertexHandle [private]

Definition at line 23 of file AF2Point3D.hpp.

double x [private]

Definition at line 20 of file AF2Point3D.hpp.

double y [private]

Definition at line 20 of file AF2Point3D.hpp.

double z [private]

Definition at line 20 of file AF2Point3D.hpp.

---

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

• AF2Point3D.hpp
• AF2Point3D.cpp