CMultiGridQueue Class Reference

Class for a multigrid queue system for the finite volume solver. More...

#include <CMultiGridQueue.hpp>

Public Member Functions
	CMultiGridQueue (unsigned long npoint)
	Constructor of the class.
	CMultiGridQueue ()=delete
	No default construction.
void	AddCV (unsigned long newPoint, short numberNeighbors)
	Add a new CV to the list.
void	RemoveCV (unsigned long removePoint)
	Remove a CV from the list.
void	MoveCV (unsigned long movePoint, short numberNeighbors)
	Change a CV from a list to a different list.
void	IncrPriorityCV (unsigned long incrPoint)
	Increase the priority of the CV.
void	RedPriorityCV (unsigned long redPoint)
	Reduce the priority of the CV.
void	VisualizeQueue (void) const
	Visualize the control volume queue.
void	VisualizePriority (void) const
	Visualize the priority list.
long	NextCV (void) const
	Find a new seed control volume.
bool	EmptyQueue (void) const
	Check if the queue is empty.
unsigned long	TotalCV (void) const
	Total number of control volume in the queue.
void	Update (unsigned long updatePoint, CGeometry *fineGrid)
	Update the queue with the new control volume (remove the CV and increase the priority of the neighbors).

Detailed Description

Class for a multigrid queue system for the finite volume solver.

Author

F. Palacios

Constructor & Destructor Documentation

CMultiGridQueue() [1/2]

CMultiGridQueue::CMultiGridQueue

(

unsigned long

npoint

)

Constructor of the class.

Parameters

[in]

npoint

- Number of control volumes.

CMultiGridQueue() [2/2]

CMultiGridQueue::CMultiGridQueue ( )

delete

No default construction.

Member Function Documentation

AddCV()

void CMultiGridQueue::AddCV	(	unsigned long	newPoint,
		short	numberNeighbors
	)

Add a new CV to the list.

Parameters

[in]	newPoint	- Index of the new point.
[in]	numberNeighbors	- Number of neighbors of the new point.

EmptyQueue()

bool CMultiGridQueue::EmptyQueue

(

void

)

const

Check if the queue is empty.

Returns

TRUE or FALSE depending if the queue is empty.

IncrPriorityCV()

void CMultiGridQueue::IncrPriorityCV

(

unsigned long

incrPoint

)

Increase the priority of the CV.

Parameters

[in]

incrPoint

- Index of the control volume.

MoveCV()

void CMultiGridQueue::MoveCV	(	unsigned long	movePoint,
		short	numberNeighbors
	)

Change a CV from a list to a different list.

Parameters

[in]	movePoint	- Index of the control volume to be moved.
[in]	numberNeighbors	- New number of neighbors of the control volume.

NextCV()

long CMultiGridQueue::NextCV ( void  ) const

inline

Find a new seed control volume.

Returns

Index of the new control volume.

RedPriorityCV()

void CMultiGridQueue::RedPriorityCV

(

unsigned long

redPoint

)

Reduce the priority of the CV.

Parameters

[in]

redPoint

- Index of the control volume.

RemoveCV()

void CMultiGridQueue::RemoveCV

(

unsigned long

removePoint

)

Remove a CV from the list.

Parameters

[in]

removePoint

- Index of the control volume to be removed.

TotalCV()

unsigned long CMultiGridQueue::TotalCV

(

void

)

const

Total number of control volume in the queue.

Returns

Total number of control points.

Update()

void CMultiGridQueue::Update	(	unsigned long	updatePoint,
		CGeometry *	fineGrid
	)

Update the queue with the new control volume (remove the CV and increase the priority of the neighbors).

Parameters

[in]	updatePoint	- Index of the new point.
[in]	fineGrid	- Fine grid geometry.

VisualizePriority()

void CMultiGridQueue::VisualizePriority

(

void

)

const

Visualize the priority list.

VisualizeQueue()

void CMultiGridQueue::VisualizeQueue

(

void

)

const

Visualize the control volume queue.

---

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

• Common/include/geometry/CMultiGridQueue.hpp
• Common/src/geometry/CMultiGridQueue.cpp