CVertex Class Reference

Class for vertex definition (equivalent to edges, but for the boundaries). More...

#include <dual_grid_structure.hpp>

Inheritance diagram for CVertex:

Public Member Functions
	CVertex (unsigned long val_point, unsigned short val_nDim)
	Number of points in Donor_Points; at least there will be one donor point (if the mesh is matching) More...
	~CVertex (void)
	Destructor of the class.
unsigned short	GetnNodes (void)
	Get the number of nodes of a vertex. More...
unsigned long	GetNode (void)
	Get the node of the vertex. More...
void	SetNodes_Coord (su2double *val_coord_Edge_CG, su2double *val_coord_FaceElem_CG, su2double *val_coord_Elem_CG)
	Set the face that correspond to a vertex. More...
void	SetNodes_Coord (su2double *val_coord_Edge_CG, su2double *val_coord_Elem_CG)
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 a vertex. More...
void	SetZeroValues (void)
	Initialize normal vector.
void	SetAuxVar (su2double val_auxvar)
	Set the value of an auxiliary variable for gradient computation. More...
su2double	GetAuxVar (void)
	Get the value of an auxiliary variable for gradient computation. More...
void	AddAuxVar (su2double val_auxvar)
	Add the value of an auxiliary variable for gradient computation. More...
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...
void	SetVarCoord (su2double *val_varcoord)
	Set the value of the coordinate variation due to a surface modification. More...
void	AddVarCoord (su2double *val_varcoord)
	Add the value of the coordinate variation due to a surface modification. More...
su2double *	GetVarCoord (void)
	Get the value of the coordinate variation due to a surface modification. More...
void	SetCoord (su2double *val_coord)
	Set the value of the cartesian coordinate for the vertex. More...
su2double *	GetCoord (void)
	Get the value of the cartesian coordinate for the vertex. More...
su2double	GetCoord (unsigned short val_dim)
	Get the value of the cartesian coordinate for the vertex. More...
void	SetRotation_Type (short val_rotation_type)
	Set the type of rotation associated to the vertex. More...
short	GetRotation_Type (void)
	Get the type of rotation associated to the vertex. More...
void	SetDonorPoint (long val_periodicpoint, long val_processor)
void	SetDonorPoint (long val_periodicpoint, long val_periodicglobalindex, long val_periodicvertex, long val_periodicmarker, long val_processor)
void	SetDonorPoint (long val_periodicpoint, long val_processor, long val_globalindex)
void	SetActDisk_Perimeter (bool val_actdisk_perimeter)
long	GetDonorPoint (void)
	Get the value of the periodic point of a vertex. More...
long	GetDonorMarker (void)
	Get the value of the periodic point of a vertex. More...
long	GetDonorVertex (void)
	Get the value of the periodic point of a vertex. More...
long	GetDonorGlobalIndex (void)
	Get the value of the periodic point of a vertex. More...
long	GetGlobalDonorPoint (void)
	Get the value of the periodic point of a vertex. More...
long	GetDonorProcessor (void)
	Get the value of the periodic point of a vertex. More...
long *	GetPeriodicPointDomain (void)
	Get the value of the periodic point of a vertex, and its somain. More...
bool	GetActDisk_Perimeter (void)
	Get the value of the periodic point of a vertex, and its somain. More...
void	SetDonorElem (long val_donorelem)
	Set the donor element of a vertex for interpolation across zones. More...
long	GetDonorElem (void)
	Get the donor element of a vertex for interpolation across zones. More...
void	SetDonorFace (unsigned short val_donorface)
	Set the donor face of a vertex for interpolation across zones. More...
unsigned short	GetDonorFace (void)
	Get the donor face of a vertex for interpolation across zones. More...
void	SetBasisFunction (unsigned short val_node, su2double val_basis)
	Set the finite element basis functions needed for interpolation. More...
su2double	GetBasisFunction (unsigned short val_node)
	Get the finite element basis functions needed for interpolation. More...
void	SetNormal_Neighbor (unsigned long val_Normal_Neighbor)
	Set the index of the closest neighbor to a point on the boundaries. More...
unsigned long	GetNormal_Neighbor (void)
	Get the value of the closest neighbor. More...
void	IncrementnDonor (void)
	Increment the number of donor points by 1.
void	SetnDonorPoints (unsigned short nDonor)
	Set the value of nDonor_Points. More...
unsigned short	GetnDonorPoints (void)
	Return the value of nDonor_Points. More...
void	SetDonorCoeff (unsigned short iDonor, su2double val)
	Set the coefficient value of a donor point. More...
su2double	GetDonorCoeff (unsigned short iDonor)
	Get the coefficient value of a donor point. More...
void	SetInterpDonorPoint (unsigned short val_donorindex, long val_donorpoint)
	Set the donor point of a vertex for interpolation across zones. More...
long	GetInterpDonorPoint (unsigned short val_donorpoint)
	Get the value of the donor point of a vertex (for interpolation). More...
void	SetInterpDonorProcessor (unsigned short val_donorindex, long val_rank)
	Set the donor point of a vertex for interpolation across zones. More...
long	GetInterpDonorProcessor (unsigned short val_donorindex)
	Get the value of the donor point of a vertex (for interpolation). More...
void	Allocate_DonorInfo (void)
	Allocate memory based on how many donor points need to be stored. Uses nDonor_Points.
su2double *	GetVarRot (void)
	Get the rotation variation. More...
void	SetVarRot (su2double *val)
	Set the rotation variation. More...
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 vertex definition (equivalent to edges, but for the boundaries).

Author

F. Palacios

Version

5.0.0 "Raven"

Constructor & Destructor Documentation

CVertex()

CVertex::CVertex	(	unsigned long	val_point,
		unsigned short	val_nDim
	)

Number of points in Donor_Points; at least there will be one donor point (if the mesh is matching)

Constructor of the class.

Parameters

[in]	val_point	- Node of the vertex.
[in]	val_nDim	- Number of dimensions of the problem.

Member Function Documentation

AddAuxVar()

void CVertex::AddAuxVar ( su2double  val_auxvar )

inline

Add the value of an auxiliary variable for gradient computation.

Parameters

[in]

val_auxvar

- Value of the auxiliar variable.

AddNormal()

void CVertex::AddNormal ( su2double *  val_face_normal )

virtual

Add a vector to the normal vector.

Parameters

[in]

val_face_normal

- Vector to add to the normal vector.

Implements CDualGrid.

AddVarCoord()

void CVertex::AddVarCoord ( su2double *  val_varcoord )

inline

Add the value of the coordinate variation due to a surface modification.

Parameters

[in]

val_varcoord

- Variation of the coordinate.

GetActDisk_Perimeter()

bool CVertex::GetActDisk_Perimeter ( void  )

inline

Get the value of the periodic point of a vertex, and its somain.

Returns

Value of the periodic point of a vertex, and the domain.

GetAuxVar()

su2double CVertex::GetAuxVar ( void  )

inline

Get the value of an auxiliary variable for gradient computation.

Returns

Value of the auxiliar variable.

GetBasisFunction()

su2double CVertex::GetBasisFunction ( unsigned short  val_node )

inline

Get the finite element basis functions needed for interpolation.

Parameters

[in]

val_node

- a node index of the owner element.

Returns

Value of the basis function for this node.

GetCoord() [1/2]

su2double * CVertex::GetCoord ( void  )

inlinevirtual

Get the value of the cartesian coordinate for the vertex.

Returns

Value of the cartesian coordinate of the vertex.

Implements CDualGrid.

GetCoord() [2/2]

su2double CVertex::GetCoord ( unsigned short  val_dim )

inline

Get the value of the cartesian coordinate for the vertex.

Parameters

[in]

val_dim

- Variable of the dimension.

Returns

Value of the cartesian coordinate of the vertex.

GetDonorCoeff()

su2double CVertex::GetDonorCoeff ( unsigned short  iDonor )

inline

Get the coefficient value of a donor point.

Parameters

[in]

iDonor

- Index of the donor point.

Returns

- Value of the coefficent for point iDonor.

GetDonorElem()

long CVertex::GetDonorElem ( void  )

inline

Get the donor element of a vertex for interpolation across zones.

Returns

Value of the donor element of a vertex.

GetDonorFace()

unsigned short CVertex::GetDonorFace ( void  )

inline

Get the donor face of a vertex for interpolation across zones.

Returns

Value of the donor face index (w/in donor elem).

GetDonorGlobalIndex()

long CVertex::GetDonorGlobalIndex ( void  )

inline

Get the value of the periodic point of a vertex.

Returns

Value of the periodic point of a vertex.

GetDonorMarker()

long CVertex::GetDonorMarker ( void  )

inline

Get the value of the periodic point of a vertex.

Returns

Value of the periodic point of a vertex.

GetDonorPoint()

long CVertex::GetDonorPoint ( void  )

inline

Get the value of the periodic point of a vertex.

Returns

Value of the periodic point of a vertex.

GetDonorProcessor()

long CVertex::GetDonorProcessor ( void  )

inline

Get the value of the periodic point of a vertex.

Returns

Value of the periodic point of a vertex.

GetDonorVertex()

long CVertex::GetDonorVertex ( void  )

inline

Get the value of the periodic point of a vertex.

Returns

Value of the periodic point of a vertex.

GetGlobalDonorPoint()

long CVertex::GetGlobalDonorPoint ( void  )

inline

Get the value of the periodic point of a vertex.

Returns

Value of the periodic point of a vertex.

GetInterpDonorPoint()

long CVertex::GetInterpDonorPoint ( unsigned short  val_donorpoint )

inline

Get the value of the donor point of a vertex (for interpolation).

Returns

Value of the donor point of a vertex.

GetInterpDonorProcessor()

long CVertex::GetInterpDonorProcessor ( unsigned short  val_donorindex )

inline

Get the value of the donor point of a vertex (for interpolation).

Returns

Value of the donor point of a vertex.

GetnDonorPoints()

unsigned short CVertex::GetnDonorPoints ( void  )

inline

Return the value of nDonor_Points.

Returns

nDonor - the number of donor points

GetnNodes()

unsigned short CVertex::GetnNodes ( void  )

inlinevirtual

Get the number of nodes of a vertex.

Returns

Number of nodes that set a vertex (1).

Implements CDualGrid.

GetNode()

unsigned long CVertex::GetNode ( void  )

inline

Get the node of the vertex.

Returns

Index of the node that compose the vertex.

GetNormal() [1/2]

void CVertex::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 * CVertex::GetNormal ( void  )

inlinevirtual

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

Returns

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

Implements CDualGrid.

GetNormal_Neighbor()

unsigned long CVertex::GetNormal_Neighbor ( void  )

inline

Get the value of the closest neighbor.

Returns

Index of the closest neighbor.

GetPeriodicPointDomain()

long * CVertex::GetPeriodicPointDomain ( void  )

inline

Get the value of the periodic point of a vertex, and its somain.

Returns

Value of the periodic point of a vertex, and the domain.

GetRotation_Type()

short CVertex::GetRotation_Type ( void  )

inline

Get the type of rotation associated to the vertex.

Returns

Value of the rotation that must be applied to the solution of the vertex

GetVarCoord()

su2double * CVertex::GetVarCoord ( void  )

inline

Get the value of the coordinate variation due to a surface modification.

Returns

Variation of the coordinate.

GetVarRot()

su2double * CVertex::GetVarRot ( void  )

inline

Get the rotation variation.

Returns

- pointer to the vector defining the rotation

SetActDisk_Perimeter()

void CVertex::SetActDisk_Perimeter ( bool  val_actdisk_perimeter )

inline

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_periodicpoint	- Value of periodic point of the vertex.
[in]	val_processor	- Processor where the point belong.

SetAuxVar()

void CVertex::SetAuxVar ( su2double  val_auxvar )

inline

Set the value of an auxiliary variable for gradient computation.

Parameters

[in]

val_auxvar

- Value of the auxiliar variable.

SetBasisFunction()

void CVertex::SetBasisFunction ( unsigned short  val_node, su2double  val_basis  )

inline

Set the finite element basis functions needed for interpolation.

Parameters

[in]	val_node	- a node index of the owner element.
[in]	val_basis	- basis function value for the node.

SetCoord()

void CVertex::SetCoord ( su2double *  val_coord )

inlinevirtual

Set the value of the cartesian coordinate for the vertex.

Parameters

[in]

val_coord

- Value of the cartesian coordinate.

Implements CDualGrid.

SetDonorCoeff()

void CVertex::SetDonorCoeff ( unsigned short  iDonor, su2double  val  )

inline

Set the coefficient value of a donor point.

Parameters

[in]	iDonor	- Index of the donor point.
[in]	val	- Value of the coefficent for point iDonor.

SetDonorElem()

void CVertex::SetDonorElem ( long  val_donorelem )

inline

Set the donor element of a vertex for interpolation across zones.

Parameters

[in]

val_donorelem

- donor element index.

SetDonorFace()

void CVertex::SetDonorFace ( unsigned short  val_donorface )

inline

Set the donor face of a vertex for interpolation across zones.

Parameters

[in]

val_donorface-

donor face index (w/in donor elem).

SetDonorPoint() [1/3]

void CVertex::SetDonorPoint ( long  val_periodicpoint, long  val_processor  )

inline

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_periodicpoint	- Value of periodic point of the vertex.
[in]	val_processor	- Processor where the point belong.

SetDonorPoint() [2/3]

void CVertex::SetDonorPoint ( long  val_periodicpoint, long  val_periodicglobalindex, long  val_periodicvertex, long  val_periodicmarker, long  val_processor  )

inline

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_periodicpoint	- Value of periodic point of the vertex.
[in]	val_processor	- Processor where the point belong.

SetDonorPoint() [3/3]

void CVertex::SetDonorPoint ( long  val_periodicpoint, long  val_processor, long  val_globalindex  )

inline

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_periodicpoint	- Value of periodic point of the vertex.
[in]	val_processor	- Processor where the point belong.
[in]	val_globalindex	- Global index of the donor point.

SetInterpDonorPoint()

void CVertex::SetInterpDonorPoint ( unsigned short  val_donorindex, long  val_donorpoint  )

inline

Set the donor point of a vertex for interpolation across zones.

Parameters

[in]

val_donorpoint-

donor face index (w/in donor elem).

SetInterpDonorProcessor()

void CVertex::SetInterpDonorProcessor ( unsigned short  val_donorindex, long  val_rank  )

inline

Set the donor point of a vertex for interpolation across zones.

Parameters

[in]

val_donorpoint-

donor face index (w/in donor elem).

SetnDonorPoints()

void CVertex::SetnDonorPoints ( unsigned short  nDonor )

inline

Set the value of nDonor_Points.

Parameters

[in]

nDonor

- the number of donor points

SetNodes_Coord() [1/2]

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

virtual

Set the face that correspond to a vertex.

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.

Returns

Compute the normal (dimensional) to the face that makes the vertex.

Implements CDualGrid.

SetNodes_Coord() [2/2]

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

virtual

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.

Returns

Compute the normal (dimensional) to the face that makes the vertex.

Implements CDualGrid.

SetNormal()

void CVertex::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.

SetNormal_Neighbor()

void CVertex::SetNormal_Neighbor ( unsigned long  val_Normal_Neighbor )

inline

Set the index of the closest neighbor to a point on the boundaries.

Parameters

[in]

val_Normal_Neighbor

- Index of the closest neighbor.

SetRotation_Type()

void CVertex::SetRotation_Type ( short  val_rotation_type )

inline

Set the type of rotation associated to the vertex.

Parameters

[in]

val_rotation_type

- Value of the rotation that will be applied to the solution at the vertex

SetVarCoord()

void CVertex::SetVarCoord ( su2double *  val_varcoord )

inline

Set the value of the coordinate variation due to a surface modification.

Parameters

[in]

val_varcoord

- Variation of the coordinate.

SetVarRot()

void CVertex::SetVarRot ( su2double *  val )

inline

Set the rotation variation.

Returns

- pointer to the vector defining the rotation

---

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

• Common/include/dual_grid_structure.hpp
• Common/include/dual_grid_structure.inl
• Common/src/dual_grid_structure.cpp