Traces points in an XmUGrid following a vector dataset. More...

Public Member Functions
virtual	~XmGridTrace ()
	Deconstruct XmGridTrace. More...

virtual double	GetVectorMultiplier () const =0
	Returns the vector multiplier. More...

virtual void	SetVectorMultiplier (const double a_vectorMultiplier)=0
	Sets the vector multiplier. More...

virtual double	GetMaxTracingTime () const =0
	Returns the Max Tracing Time. More...

virtual void	SetMaxTracingTime (const double a_maxTracingTime)=0
	Sets the max tracing time. More...

virtual double	GetMaxTracingDistance () const =0
	Returns the Max Tracing Distance. More...

virtual void	SetMaxTracingDistance (const double a_maxTracingDistance)=0
	Sets the max tracing distance. More...

virtual double	GetMinDeltaTime () const =0
	Returns the min delta time. More...

virtual void	SetMinDeltaTime (const double a_minDeltaTime)=0
	Sets the min delta time. More...

virtual double	GetMaxChangeDistance () const =0
	Returns the max change distance. More...

virtual void	SetMaxChangeDistance (const double a_maxChangeDistance)=0
	Sets the max change distance. More...

virtual double	GetMaxChangeVelocity () const =0
	Returns the max change in velcoity. More...

virtual void	SetMaxChangeVelocity (const double a_maxChangeVelocity)=0
	Sets the max change in velocity. More...

virtual double	GetMaxChangeDirectionInRadians () const =0
	Returns the max change in direction in radians. More...

virtual void	SetMaxChangeDirectionInRadians (const double a_maxChangeDirection)=0
	Sets the max change in direction in radians. More...

virtual void	AddGridScalarsAtTime (const VecPt3d &a_scalars, DataLocationEnum a_scalarLoc, xms::DynBitset &a_activity, DataLocationEnum a_activityLoc, double a_time)=0
	Assigns velocity vectors to each point or cell for a time step, keeping the previous step, and dropping the one before that for a maximum of two time steps. More...

virtual void	TracePoint (const Pt3d &a_pt, const double &a_ptTime, VecPt3d &a_outTrace, VecDbl &a_outTimes)=0
	Runs the Grid Trace for a point. More...

virtual std::string	GetExitMessage ()=0
	returns a message describing what caused trace to exit More...

Static Public Member Functions
static BSHP< XmGridTrace >	New (BSHP< XmUGrid > a_ugrid)
	Construct XmGridTrace for a UGrid. More...

Protected Member Functions
	XmGridTrace ()
	Empty constructer for abstract class.

Detailed Description

Traces points in an XmUGrid following a vector dataset.

Definition at line 39 of file XmGridTrace.h.

Constructor & Destructor Documentation

◆ ~XmGridTrace()

xms::XmGridTrace::~XmGridTrace ( )

virtual

Deconstruct XmGridTrace.

Empty destructer for abstract class.

Definition at line 575 of file XmGridTrace.cpp.

Member Function Documentation

◆ AddGridScalarsAtTime()

virtual void xms::XmGridTrace::AddGridScalarsAtTime	(	const VecPt3d &	a_scalars,
		DataLocationEnum	a_scalarLoc,
		xms::DynBitset &	a_activity,
		DataLocationEnum	a_activityLoc,
		double	a_time
	)

pure virtual

Assigns velocity vectors to each point or cell for a time step, keeping the previous step, and dropping the one before that for a maximum of two time steps.

Parameters

[in]	a_scalars	The velocity vectors
[in]	a_scalarLoc	Whether the vectors are assigned to cells or points
[in]	a_activity	Whether each cell or point is active
[in]	a_activityLoc	Whether the activities are assigned to cells or points
[in]	a_time	The time of the scalars

◆ GetExitMessage()

virtual std::string xms::XmGridTrace::GetExitMessage ( )

pure virtual

returns a message describing what caused trace to exit

Returns: the exit message of the last TracePoint operation

◆ GetMaxChangeDirectionInRadians()

virtual double xms::XmGridTrace::GetMaxChangeDirectionInRadians ( ) const

pure virtual

Returns the max change in direction in radians.

Returns: the maximum change in direction between trace steps

◆ GetMaxChangeDistance()

virtual double xms::XmGridTrace::GetMaxChangeDistance ( ) const

pure virtual

Returns the max change distance.

Returns: the maximum change in distance between trace steps

◆ GetMaxChangeVelocity()

virtual double xms::XmGridTrace::GetMaxChangeVelocity ( ) const

pure virtual

Returns the max change in velcoity.

Returns: the maximum change in velocity between trace steps

◆ GetMaxTracingDistance()

virtual double xms::XmGridTrace::GetMaxTracingDistance ( ) const

pure virtual

Returns the Max Tracing Distance.

Returns: the max tracing distance

◆ GetMaxTracingTime()

virtual double xms::XmGridTrace::GetMaxTracingTime ( ) const

pure virtual

Returns the Max Tracing Time.

Returns: the max tracing time

◆ GetMinDeltaTime()

virtual double xms::XmGridTrace::GetMinDeltaTime ( ) const

pure virtual

Returns the min delta time.

Returns: the minimum time between trace steps

◆ GetVectorMultiplier()

virtual double xms::XmGridTrace::GetVectorMultiplier ( ) const

pure virtual

Returns the vector multiplier.

Returns: the vector multiplier

◆ New()

BSHP< XmGridTrace > xms::XmGridTrace::New ( BSHP< XmUGrid > a_ugrid )

static

Construct XmGridTrace for a UGrid.

Construct from a new XmGridTrace using a UGrid.

Parameters

[in]	a_ugrid	a ugrid
[in]	a_ugrid	The UGrid to construct a grid trace for

Returns: a boost shared pointer to an XmGridTrace

Definition at line 583 of file XmGridTrace.cpp.

Referenced by XmGridTraceUnitTests::testTutorial().

◆ SetMaxChangeDirectionInRadians()

virtual void xms::XmGridTrace::SetMaxChangeDirectionInRadians ( const double a_maxChangeDirection )

pure virtual

Sets the max change in direction in radians.

Parameters

[in] a_maxChangeDirection the new max change in direction in radians

◆ SetMaxChangeDistance()

virtual void xms::XmGridTrace::SetMaxChangeDistance ( const double a_maxChangeDistance )

pure virtual

Sets the max change distance.

Parameters

[in] a_maxChangeDistance the new max change distance

◆ SetMaxChangeVelocity()

virtual void xms::XmGridTrace::SetMaxChangeVelocity ( const double a_maxChangeVelocity )

pure virtual

Sets the max change in velocity.

Parameters

[in] a_maxChangeVelocity the new max change in velocity

◆ SetMaxTracingDistance()

virtual void xms::XmGridTrace::SetMaxTracingDistance ( const double a_maxTracingDistance )

pure virtual

Sets the max tracing distance.

Parameters

[in] a_maxTracingDistance the new max tracing distance

◆ SetMaxTracingTime()

virtual void xms::XmGridTrace::SetMaxTracingTime ( const double a_maxTracingTime )

pure virtual

Sets the max tracing time.

Parameters

[in] a_maxTracingTime the new max tracing time

◆ SetMinDeltaTime()

virtual void xms::XmGridTrace::SetMinDeltaTime ( const double a_minDeltaTime )

pure virtual

Sets the min delta time.

Parameters

[in] a_minDeltaTime the new min delta time

◆ SetVectorMultiplier()

virtual void xms::XmGridTrace::SetVectorMultiplier ( const double a_vectorMultiplier )

pure virtual

Sets the vector multiplier.

Parameters

[in] a_vectorMultiplier the new vector multiplier

◆ TracePoint()

virtual void xms::XmGridTrace::TracePoint	(	const Pt3d &	a_pt,
		const double &	a_ptTime,
		VecPt3d &	a_outTrace,
		VecDbl &	a_outTimes
	)

pure virtual

Runs the Grid Trace for a point.

Parameters

[in]	a_pt	The starting point of the trace
[in]	a_ptTime	The starting time of the trace
[out]	a_outTrace	the resultant positions at each step
[out]	a_outTimes	the resultant times at each step

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

/home/conan/xmsgridtrace/gridtrace/XmGridTrace.h
/home/conan/xmsgridtrace/gridtrace/XmGridTrace.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~XmGridTrace()

Member Function Documentation

◆ AddGridScalarsAtTime()

◆ GetExitMessage()

◆ GetMaxChangeDirectionInRadians()

◆ GetMaxChangeDistance()

◆ GetMaxChangeVelocity()

◆ GetMaxTracingDistance()

◆ GetMaxTracingTime()

◆ GetMinDeltaTime()

◆ GetVectorMultiplier()

◆ New()

◆ SetMaxChangeDirectionInRadians()

◆ SetMaxChangeDistance()

◆ SetMaxChangeVelocity()

◆ SetMaxTracingDistance()

◆ SetMaxTracingTime()

◆ SetMinDeltaTime()

◆ SetVectorMultiplier()

◆ TracePoint()