CMultiGridQueue Struct Reference

Class for a multigrid queue system. More...

#include <geometry_structure.hpp>

Public Member Functions
	CMultiGridQueue (unsigned long val_npoint)
	Constructor of the class. More...
	~CMultiGridQueue (void)
	Destructor of the class.
void	AddCV (unsigned long val_new_point, unsigned short val_number_neighbors)
	Add a new CV to the list. More...
void	RemoveCV (unsigned long val_remove_point)
	Remove a CV from the list. More...
void	MoveCV (unsigned long val_move_point, short val_number_neighbors)
	Change a CV from a list to a different list. More...
void	IncrPriorityCV (unsigned long val_incr_point)
	Increase the priority of the CV. More...
void	RedPriorityCV (unsigned long val_red_point)
	Increase the priority of the CV. More...
void	VisualizeQueue (void)
	Visualize the control volume queue.
void	VisualizePriority (void)
	Visualize the priority list.
long	NextCV (void)
	Find a new seed control volume. More...
bool	EmptyQueue (void)
	Check if the queue is empty. More...
unsigned long	TotalCV (void)
	Total number of control volume in the queue. More...
void	Update (unsigned long val_update_point, CGeometry *fine_grid)
	Update the queue with the new control volume (remove the CV and increase the priority of the neighbors). More...

Detailed Description

Class for a multigrid queue system.

Author

F. Palacios

Version

5.0.0 "Raven"

Date

Aug 12, 2012

Constructor & Destructor Documentation

CMultiGridQueue()

CMultiGridQueue::CMultiGridQueue

(

unsigned long

val_npoint

)

Constructor of the class.

Parameters

[in]

val_npoint

- Number of control volumes.

Member Function Documentation

AddCV()

void CMultiGridQueue::AddCV	(	unsigned long	val_new_point,
		unsigned short	val_number_neighbors
	)

Add a new CV to the list.

Parameters

[in]	val_new_point	- Index of the new point.
[in]	val_number_neighbors	- Number of neighbors of the new point.

EmptyQueue()

bool CMultiGridQueue::EmptyQueue

(

void

)

Check if the queue is empty.

Returns

TRUE or FALSE depending if the queue is empty.

IncrPriorityCV()

void CMultiGridQueue::IncrPriorityCV

(

unsigned long

val_incr_point

)

Increase the priority of the CV.

Parameters

[in]

val_incr_point

- Index of the control volume.

MoveCV()

void CMultiGridQueue::MoveCV	(	unsigned long	val_move_point,
		short	val_number_neighbors
	)

Change a CV from a list to a different list.

Parameters

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

NextCV()

long CMultiGridQueue::NextCV

(

void

)

Find a new seed control volume.

Returns

Index of the new control volume.

RedPriorityCV()

void CMultiGridQueue::RedPriorityCV

(

unsigned long

val_red_point

)

Increase the priority of the CV.

Parameters

[in]

val_red_point

- Index of the control volume.

RemoveCV()

void CMultiGridQueue::RemoveCV

(

unsigned long

val_remove_point

)

Remove a CV from the list.

Parameters

[in]

val_remove_point

- Index of the control volume to be removed.

TotalCV()

unsigned long CMultiGridQueue::TotalCV

(

void

)

Total number of control volume in the queue.

Returns

Total number of control points.

Update()

void CMultiGridQueue::Update	(	unsigned long	val_update_point,
		CGeometry *	fine_grid
	)

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

Parameters

[in]	val_update_point	- Index of the new point.
[in]	fine_grid	- Fine grid geometry.

---

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

• Common/include/geometry_structure.hpp
• Common/src/geometry_structure.cpp