Class for defining an edge. More...

#include <dual_grid_structure.hpp>

Inheritance diagram for CEdge:

Public Member Functions
	CEdge (unsigned long val_iPoint, unsigned long val_jPoint, unsigned short val_nDim)
	Constructor of the class. More...

	~CEdge (void)
	Destructor of the class.

void	SetCoord_CG (su2double **val_coord)
	Set the center of gravity of the edge. More...

su2double	GetCG (unsigned short val_dim)
	Obtain the centre of gravity of the edge. More...

unsigned long	GetNode (unsigned short val_node)
	Get the nodes of the edge. More...

unsigned short	GetnNodes (void)
	Get the number of nodes of an element. More...

su2double	GetVolume (su2double val_coord_Edge_CG, su2double val_coord_FaceElem_CG, su2double val_coord_Elem_CG, su2double val_coord_Point)
	Compute Volume associated to each edge. More...

su2double	GetVolume (su2double val_coord_Edge_CG, su2double val_coord_Elem_CG, su2double *val_coord_Point)

void	SetNodes_Coord (su2double val_coord_Edge_CG, su2double val_coord_FaceElem_CG, su2double *val_coord_Elem_CG)
	Set the face that correspond to an edge. More...

void	SetNodes_Coord (su2double val_coord_Edge_CG, su2double val_coord_Elem_CG)
	Set the face that correspond to an edge. More...

void	GetNormal (su2double *val_normal)
	Copy the the normal vector of a face. More...

su2double *	GetNormal (void)
	Get the normal to a face of the control volume asociated with an edge. More...

void	SetZeroValues (void)
	Initialize normal vector.

void	SetNormal (su2double *val_face_normal)
	Set the normal vector. More...

void	AddNormal (su2double *val_face_normal)
	Add a vector to the normal vector. More...

su2double *	GetCoord (void)
	This function does nothing (it comes from a pure virtual function, that implies the definition of the function in all the derived classes).

void	SetCoord (su2double *val_coord)
	This function does nothing (it comes from a pure virtual function, that implies the definition of the function in all the derived classes).

Public Member Functions inherited from CDualGrid
	CDualGrid (unsigned short val_nDim)
	Constructor of the class. More...

virtual	~CDualGrid (void)
	Destructor of the class.

Additional Inherited Members
Static Protected Attributes inherited from CDualGrid
static unsigned short	nDim = 0
	Number of dimensions of the problem.

Detailed Description

Class for defining an edge.

Author: F. Palacios

Version: 5.0.0 "Raven"

Constructor & Destructor Documentation

§ CEdge()

CEdge::CEdge	(	unsigned long	val_iPoint,
		unsigned long	val_jPoint,
		unsigned short	val_nDim
	)

Constructor of the class.

Parameters

[in]	val_iPoint	- First node of the edge.
[in]	val_jPoint	- Second node of the edge.
[in]	val_nDim	- Number of dimensions of the problem.

Member Function Documentation

§ AddNormal()

void CEdge::AddNormal ( su2double * val_face_normal )

inlinevirtual

Add a vector to the normal vector.

Parameters

[in] val_face_normal - Vector to add to the normal vector.

Implements CDualGrid.

§ GetCG()

su2double CEdge::GetCG ( unsigned short val_dim )

inline

Obtain the centre of gravity of the edge.

Parameters

[in] val_dim - Position to read the coordinate.

Returns: Coordinate val_dim of the centre of gravity.

§ GetnNodes()

unsigned short CEdge::GetnNodes ( void )

inlinevirtual

Get the number of nodes of an element.

Returns: Number of nodes that set an edge (2).

Implements CDualGrid.

§ GetNode()

unsigned long CEdge::GetNode ( unsigned short val_node )

inline

Get the nodes of the edge.

Parameters

[in] val_node - Position of the node that makes the edge.

Returns: Index of the node that compose the edge.

§ GetNormal() [1/2]

void CEdge::GetNormal ( su2double * val_normal )

inlinevirtual

Copy the the normal vector of a face.

Parameters

[in] val_normal - Vector where the subroutine is goint to copy the normal (dimensional).

Implements CDualGrid.

§ GetNormal() [2/2]

su2double * CEdge::GetNormal ( void )

inlinevirtual

Get the normal to a face of the control volume asociated with an edge.

Returns: Dimensional normal vector, the modulus is the area of the face.

Implements CDualGrid.

§ GetVolume() [1/2]

su2double CEdge::GetVolume	(	su2double *	val_coord_Edge_CG,
		su2double *	val_coord_FaceElem_CG,
		su2double *	val_coord_Elem_CG,
		su2double *	val_coord_Point
	)

Compute Volume associated to each edge.

Parameters

[in]	val_coord_Edge_CG	- Coordinates of the centre of gravity of the edge.
[in]	val_coord_FaceElem_CG	- Coordinates of the centre of gravity of the face of an element.
[in]	val_coord_Elem_CG	- Coordinates of the centre of gravity of the element.
[in]	val_coord_Point	- Coordinates of the point that form the control volume.

Returns: Local volume associated to the edge.

§ GetVolume() [2/2]

su2double CEdge::GetVolume	(	su2double *	val_coord_Edge_CG,
		su2double *	val_coord_Elem_CG,
		su2double *	val_coord_Point
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

[in]	val_coord_Edge_CG	- Coordinates of the centre of gravity of the edge.
[in]	val_coord_Elem_CG	- Coordinates of the centre of gravity of the element.
[in]	val_coord_Point	- Coordinates of the point that form the control volume.

Returns: Local volume associated to the edge.

§ SetCoord_CG()

void CEdge::SetCoord_CG ( su2double ** val_coord )

Set the center of gravity of the edge.

Parameters

[in] val_coord - Coordinates of all the nodes needed for computing the centre of gravity of an edge.

§ SetNodes_Coord() [1/2]

void CEdge::SetNodes_Coord	(	su2double *	val_coord_Edge_CG,
		su2double *	val_coord_FaceElem_CG,
		su2double *	val_coord_Elem_CG
	)

virtual

Set the face that correspond to an edge.

Parameters

[in]	val_coord_Edge_CG	- Coordinates of the centre of gravity of the edge.
[in]	val_coord_FaceElem_CG	- Coordinates of the centre of gravity of the face of an element.
[in]	val_coord_Elem_CG	- Coordinates of the centre of gravity of the element.
[in]	config	- Definition of the particular problem.

Returns: Compute the normal (dimensional) to the face that makes the control volume boundaries.

Implements CDualGrid.

§ SetNodes_Coord() [2/2]

void CEdge::SetNodes_Coord	(	su2double *	val_coord_Edge_CG,
		su2double *	val_coord_Elem_CG
	)

virtual

Set the face that correspond to an edge.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

[in]	val_coord_Edge_CG	- Coordinates of the centre of gravity of the edge.
[in]	val_coord_Elem_CG	- Coordinates of the centre of gravity of the element.
[in]	config	- Definition of the particular problem.

Returns: Compute the normal (dimensional) to the face that makes the contorl volume boundaries.

Implements CDualGrid.

§ SetNormal()

void CEdge::SetNormal ( su2double * val_face_normal )

inlinevirtual

Set the normal vector.

Parameters

[in] val_face_normal - Vector to initialize the normal vector.

Returns: Value of the normal vector.

Implements CDualGrid.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ CEdge()

Member Function Documentation

§ AddNormal()

§ GetCG()

§ GetnNodes()

§ GetNode()

§ GetNormal() [1/2]

§ GetNormal() [2/2]

§ GetVolume() [1/2]

§ GetVolume() [2/2]

§ SetCoord_CG()

§ SetNodes_Coord() [1/2]

§ SetNodes_Coord() [2/2]

§ SetNormal()