CPoint Class Reference

Class for point definition (dual control volumes). More...

#include <CPoint.hpp>

Public Member Functions
	CPoint (unsigned long npoint, unsigned long ndim, unsigned short imesh, const CConfig *config)
	"Full" constructor of the class.
	CPoint (unsigned long npoint, unsigned long ndim)
	Minimal constructor, only allocates the structures required to read and partition a mesh file.
	CPoint ()=delete
	Default construction is not allowed.
void	FullAllocation (unsigned short imesh, const CConfig *config)
	Allocate the variables not covered by the minimal constructor.
su2double	GetCoord (unsigned long iPoint, unsigned long iDim) const
	Get the coordinates dor the control volume.
su2double *	GetCoord (unsigned long iPoint)
	Get the coordinates of the control volume.
const su2activematrix &	GetCoord () const
	Get the entire matrix of coordinates of the control volumes.
void	SetCoord (unsigned long iPoint, unsigned long iDim, su2double coord)
	Set the coordinates for the control volume.
void	AddCoord (unsigned long iPoint, unsigned long iDim, su2double coord)
	Set the coordinates for the control volume.
void	SetCoord (unsigned long iPoint, const su2double *coord)
	Set the point coordinates.
void	SetElems (const vector< vector< long > > &elemsMatrix)
	Set the elements that are connected to each point.
void	ResetElems ()
	Reset the elements of a control volume.
unsigned short	GetnElem (unsigned long iPoint) const
	Get the number of elements that compose the control volume.
unsigned long	GetElem (unsigned long iPoint, unsigned long nelem) const
	Get all the elements that compose the control volume.
CCompressedSparsePatternL::CInnerIter	GetElems (unsigned long iPoint) const
	Get inner iterator to loop over neighbor elements.
void	SetPoints (const vector< vector< unsigned long > > &pointsMatrix)
	Set the points that compose the control volume.
const CCompressedSparsePatternUL &	GetPoints () const
	Get the entire point adjacency information in compressed format (CSR).
void	ResetPoints ()
	Reset the points that compose the control volume.
unsigned short	GetnPoint (unsigned long iPoint) const
	Get the number of points that compose the control volume.
unsigned long	GetPoint (unsigned long iPoint, unsigned long npoint) const
	Get all the points that compose the control volume.
CCompressedSparsePatternUL::CInnerIter	GetPoints (unsigned long iPoint) const
	Get inner iterator to loop over neighbor points.
void	SetEdge (unsigned long iPoint, long iedge, unsigned long nedge)
	Set the edges that compose the control volume.
long	GetEdge (unsigned long iPoint, unsigned long nedge) const
	Get all the edges that compose the control volume.
CCompressedSparsePatternL::CInnerIter	GetEdges (unsigned long iPoint) const
	Get inner iterator to loop over neighbor edges.
void	SetVertex (unsigned long iPoint, long iVertex, unsigned long iMarker)
	Set the boundary vertex that compose the control volume.
long	GetVertex (unsigned long iPoint, unsigned long iMarker) const
	Get the vertex that compose the control volume for a marker.
void	SetBoundary (unsigned long iPoint, unsigned short nMarker)
	Set if a point belong to the boundary.
void	ResetBoundary (unsigned long iPoint)
	Reset the boundary of a control volume.
void	SetBoundary (unsigned long iPoint, bool boundary)
	Mark the point as boundary.
bool	GetBoundary (unsigned long iPoint) const
	Provides information about if a point belong to the boundaries.
void	SetPhysicalBoundary (unsigned long iPoint, bool boundary)
	Set if a point belong to the boundary.
bool	GetPhysicalBoundary (unsigned long iPoint) const
	Provides information about if a point belong to the physical boundaries (without MPI).
void	SetSolidBoundary (unsigned long iPoint, bool boundary)
	Set if a point belong to the solid wall boundary.
bool	GetSolidBoundary (unsigned long iPoint) const
	Provides information about if a point belong to the physical boundaries (without MPI).
void	SetViscousBoundary (unsigned long iPoint, bool boundary)
	Set if a point belong to the boundary.
bool	GetViscousBoundary (unsigned long iPoint) const
	Provides information about if a point belong to the physical boundaries (without MPI).
void	SetPeriodicBoundary (unsigned long iPoint, bool boundary)
	Set if a point belongs to a periodic boundary.
bool	GetPeriodicBoundary (unsigned long iPoint) const
	Provides information about if a point belongs to a periodic boundary (without MPI).
void	SetDomain (unsigned long iPoint, bool domain)
	For parallel computation, its indicates if a point must be computed or not.
bool	GetDomain (unsigned long iPoint) const
	For parallel computation, its indicates if a point must be computed or not.
void	SetColor (unsigned long iPoint, unsigned long color)
	Set a color to the point that comes from the grid partitioning.
unsigned long	GetColor (unsigned long iPoint) const
	Get the color of a point, the color indicates to which subdomain the point belong to.
void	SetGlobalIndex (unsigned long iPoint, unsigned long globalindex)
	Set the global index in a parallel computation.
unsigned long	GetGlobalIndex (unsigned long iPoint) const
	Get the global index in a parallel computation.
void	SetnNeighbor (unsigned long iPoint, unsigned short nneighbor)
	Set the number of neighbor (artificial dissipation).
unsigned short	GetnNeighbor (unsigned long iPoint) const
	Get the number of neighbor of a point.
void	SetWall_Distance (unsigned long iPoint, su2double distance, int rankID, unsigned short zoneID, unsigned short markerID, unsigned long elemID)
	Set the value of the distance to the nearest wall.
void	SetWall_Distance (unsigned long iPoint, su2double distance)
su2double &	GetWall_Distance (unsigned long iPoint)
	Get the value of the distance to the nearest wall.
const su2double &	GetWall_Distance (unsigned long iPoint) const
void	SetRoughnessHeight (unsigned long iPoint, su2double roughheight)
	Set the value of the distance to the nearest wall.
su2double	GetRoughnessHeight (unsigned long iPoint) const
	Get the value of the distance to the nearest wall.
void	SetSharpEdge_Distance (unsigned long iPoint, su2double distance)
	Set the value of the distance to a sharp edge.
su2double &	GetSharpEdge_Distance (unsigned long iPoint)
	Get the value of the distance to a sharp edge.
const su2double &	GetSharpEdge_Distance (unsigned long iPoint) const
void	SetCurvature (unsigned long iPoint, su2double curvature)
	Set the value of the curvature at a surface node.
su2double	GetCurvature (unsigned long iPoint) const
	Get the value of the curvature at a surface node.
void	SetMaxLength (unsigned long iPoint, su2double max_length)
	Set the max cell-center to cell-center length.
su2double	GetMaxLength (unsigned long iPoint) const
	Get the maximum cell-center to cell-center length.
su2double &	GetVolume (unsigned long iPoint)
	Get area or volume of the control volume.
const su2double &	GetVolume (unsigned long iPoint) const
void	SetVolume (unsigned long iPoint, su2double volume)
	Set the volume of the control volume.
void	AddVolume (unsigned long iPoint, su2double volume)
	Adds some area or volume of the CV.
su2double &	GetPeriodicVolume (unsigned long iPoint)
	Get the missing component of area or volume for a control volume on a periodic marker.
const su2double &	GetPeriodicVolume (unsigned long iPoint) const
void	SetPeriodicVolume (unsigned long iPoint, su2double volume)
	Set the missing component of area or volume for a control volume on a periodic marker.
su2double	GetVolume_n (unsigned long iPoint) const
	Get the volume of the control volume at time n.
su2double	GetVolume_nM1 (unsigned long iPoint) const
	Get the volume of the control volume at time n+1.
void	SetVolume_n ()
	Set the volume of the control volume at time n.
void	SetVolume_nM1 ()
	Set the volume of the control volume at time n-1.
void	SetVolume_n_from_OldnM1 ()
	Set the volume of the control volume at time n using n-1.
void	SetVolume_from_Oldn ()
	Set the volume of the control volume at current time using time n.
void	SetVolume_Old ()
	Set the Volume to Volume_Old.
void	SetVolume_n_Old ()
	Set the Volume_n to Volume_n_Old.
void	SetVolume_nM1_Old ()
	Set the Volume_nM1 to Volume_nM1_Old.
void	SetParent_CV (unsigned long iPoint, unsigned long parent_CV)
	Set the parent control volume of an agglomerated control volume.
void	SetChildren_CV (unsigned long iPoint, unsigned long nchildren_CV, unsigned long children_CV)
	Set the children control volumes of an agglomerated control volume.
void	SetChildren_CV (unsigned long iPoint, const vector< unsigned long > &children_CV)
	Set all the children control volumes of an agglomerated control volume at once.
unsigned long	GetParent_CV (unsigned long iPoint) const
	Get the parent control volume of an agglomerated control volume.
unsigned long	GetChildren_CV (unsigned long iPoint, unsigned short nchildren_CV) const
	Get the children control volume of an agglomerated control volume.
const vector< unsigned long > &	GetChildren_CV (unsigned long iPoint) const
	Get the children control volumes of an agglomerated control volume. Only the first GetnChildren_CV entries are meaningful, the storage may be longer.
bool	GetAgglomerate (unsigned long iPoint) const
	Get information about if a control volume has been agglomerated.
bool	GetAgglomerate_Indirect (unsigned long iPoint) const
	Get information about if the indirect neighbors can be agglomerated.
void	SetAgglomerate_Indirect (unsigned long iPoint, bool agglomerate)
	Set information about if the indirect neighbors can be agglomerated.
unsigned short	GetnChildren_CV (unsigned long iPoint) const
	Get the number of children of an agglomerated control volume.
void	SetnChildren_CV (unsigned long iPoint, unsigned short nchildren_CV)
	Set the number of children of an agglomerated control volume.
su2double *	GetCoord_n (unsigned long iPoint)
	Get the coordinates of the control volume at time n.
su2double *	GetCoord_n1 (unsigned long iPoint)
	Get the coordinates of the control volume at time n-1.
su2double *	GetCoord_p1 (unsigned long iPoint)
	Get the coordinates of the control volume at time n+1.
void	SetCoord_n ()
	Set the coordinates of the control volume at time n to the ones in Coord.
void	SetCoord_n1 ()
	Set the coordinates of the control volume at time n-1 to the ones in Coord_n.
void	SetCoord_n (unsigned long iPoint, const su2double *coord)
	Set the coordinates of the control volume at time n, for restart cases.
void	SetCoord_n1 (unsigned long iPoint, const su2double *coord)
	Set the coordinates of the control volume at time n-1, for restart cases.
void	SetCoord_p1 (unsigned long iPoint, const su2double *coord)
	Set the coordinates of the control volume at time n+1.
su2double *	GetCoord_Old (unsigned long iPoint)
	Get the value of the old coordinates.
void	SetCoord_Old (unsigned long iPoint, const su2double *coord_old)
	Set the value of the vector Coord_Old.
void	SetCoord_Old ()
	Set the value of the vector Coord_Old to Coord.
su2double *	GetGridVel (unsigned long iPoint)
	Get the value of the grid velocity at the point.
const su2activematrix &	GetGridVel () const
	Get the grid velocity matrix for the entire domain.
void	SetGridVel (unsigned long iPoint, unsigned long iDim, su2double gridvel)
	Set the value of the grid velocity at the point.
void	SetGridVel (unsigned long iPoint, const su2double *gridvel)
	Set the value of the grid velocity at the point.
CVectorOfMatrix &	GetGridVel_Grad ()
	Get the grid velocity gradients for the entire domain.
CMatrixView< const su2double >	GetGridVel_Grad (unsigned long iPoint) const
	Get the value of the grid velocity gradient at the point.
void	SetAdjointSolution (unsigned long iPoint, const su2double *adj_sol)
	Set the adjoint values of the (geometric) coordinates.
su2double	GetAdjointSolution (unsigned long iPoint, unsigned long iDim) const
	Get the adjoint values of the (geometric) coordinates.
void	RegisterCoordinates (unsigned long iPoint, bool input)
	Register coordinates of a point.
template<typename Roughness_type >
void	SetWallRoughness (Roughness_type const &roughness)
	Set wall roughnesses according to stored closest wall information.

Friends
class	CPhysicalGeometry

Detailed Description

Class for point definition (dual control volumes).

Author

F. Palacios

Constructor & Destructor Documentation

CPoint() [1/3]

CPoint::CPoint	(	unsigned long	npoint,
		unsigned long	ndim,
		unsigned short	imesh,
		const CConfig *	config
	)

"Full" constructor of the class.

Parameters

[in]	npoint	- Number of points (dual volumes) in the problem.
[in]	ndim	- Number of spatial dimensions of the problem.
[in]	imesh	- Index of the grid allocating the points.
[in]	config	- Definition of the particular problem.

CPoint() [2/3]

CPoint::CPoint	(	unsigned long	npoint,
		unsigned long	ndim
	)

Minimal constructor, only allocates the structures required to read and partition a mesh file.

Parameters

[in]	npoint	- Number of points (dual volumes) in the problem.
[in]	ndim	- Number of spatial dimensions of the problem.

CPoint() [3/3]

CPoint::CPoint ( )

delete

Default construction is not allowed.

Member Function Documentation

AddCoord()

void CPoint::AddCoord ( unsigned long  iPoint, unsigned long  iDim, su2double  coord  )

inline

Set the coordinates for the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	iDim	- Position to store the coordinate.
[in]	coord	- Coordinate for iDim.

AddVolume()

void CPoint::AddVolume ( unsigned long  iPoint, su2double  volume  )

inline

Adds some area or volume of the CV.

Parameters

[in]	iPoint	- Index of the point.
[in]	volume	- Local volume to be added to the total one.

FullAllocation()

void CPoint::FullAllocation	(	unsigned short	imesh,
		const CConfig *	config
	)

Allocate the variables not covered by the minimal constructor.

GetAdjointSolution()

su2double CPoint::GetAdjointSolution ( unsigned long  iPoint, unsigned long  iDim  ) const

inline

Get the adjoint values of the (geometric) coordinates.

Parameters

[in]	iPoint	- Index of the point.
[in]	iDim	- Dimension.

GetAgglomerate()

bool CPoint::GetAgglomerate ( unsigned long  iPoint ) const

inline

Get information about if a control volume has been agglomerated.

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the point has been agglomerated; otherwise FALSE.

GetAgglomerate_Indirect()

bool CPoint::GetAgglomerate_Indirect ( unsigned long  iPoint ) const

inline

Get information about if the indirect neighbors can be agglomerated.

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the indirect neigbors can be agglomerated; otherwise FALSE.

GetBoundary()

bool CPoint::GetBoundary ( unsigned long  iPoint ) const

inline

Provides information about if a point belong to the boundaries.

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the point belong to the boundary; otherwise FALSE.

GetChildren_CV() [1/2]

const vector< unsigned long > & CPoint::GetChildren_CV ( unsigned long  iPoint ) const

inline

Get the children control volumes of an agglomerated control volume. Only the first GetnChildren_CV entries are meaningful, the storage may be longer.

Parameters

[in]

iPoint

- Index of the point.

Returns

Indices of the children control volumes.

GetChildren_CV() [2/2]

unsigned long CPoint::GetChildren_CV ( unsigned long  iPoint, unsigned short  nchildren_CV  ) const

inline

Get the children control volume of an agglomerated control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	nchildren_CV	- Number of the children.

Returns

Index of the parent control volume.

GetColor()

unsigned long CPoint::GetColor ( unsigned long  iPoint ) const

inline

Get the color of a point, the color indicates to which subdomain the point belong to.

Parameters

[in]

iPoint

- Index of the point.

Returns

Color of the point.

GetCoord() [1/3]

const su2activematrix & CPoint::GetCoord ( ) const

inline

Get the entire matrix of coordinates of the control volumes.

GetCoord() [2/3]

su2double * CPoint::GetCoord ( unsigned long  iPoint )

inline

Get the coordinates of the control volume.

Parameters

[in]

iPoint

- Index of the point.

Returns

pointer to the coordinate of the point.

GetCoord() [3/3]

su2double CPoint::GetCoord ( unsigned long  iPoint, unsigned long  iDim  ) const

inline

Get the coordinates dor the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	iDim	- Number of dimensions of the problem.

Returns

Coordinate that correspond with iDim.

GetCoord_n()

su2double * CPoint::GetCoord_n ( unsigned long  iPoint )

inline

Get the coordinates of the control volume at time n.

Parameters

[in]

iPoint

- Index of the point.

Returns

Coordinates of the control volume at time n.

GetCoord_n1()

su2double * CPoint::GetCoord_n1 ( unsigned long  iPoint )

inline

Get the coordinates of the control volume at time n-1.

Parameters

[in]

iPoint

- Index of the point.

Returns

Volume of the control volume at time n-1

GetCoord_Old()

su2double * CPoint::GetCoord_Old ( unsigned long  iPoint )

inline

Get the value of the old coordinates.

Parameters

[in]

iPoint

- Index of the point.

Returns

Old coordinates at a point.

GetCoord_p1()

su2double * CPoint::GetCoord_p1 ( unsigned long  iPoint )

inline

Get the coordinates of the control volume at time n+1.

Parameters

[in]

iPoint

- Index of the point.

Returns

Volume of the control volume at time n+1

GetCurvature()

su2double CPoint::GetCurvature ( unsigned long  iPoint ) const

inline

Get the value of the curvature at a surface node.

Parameters

[in]

iPoint

- Index of the point.

Returns

Value of the curvature.

GetDomain()

bool CPoint::GetDomain ( unsigned long  iPoint ) const

inline

For parallel computation, its indicates if a point must be computed or not.

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the node belong to the physical domain; otherwise FALSE.

GetEdge()

long CPoint::GetEdge ( unsigned long  iPoint, unsigned long  nedge  ) const

inline

Get all the edges that compose the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	nedge	- Position where the edge is stored.

Returns

Index of the edge.

GetEdges()

CCompressedSparsePatternL::CInnerIter CPoint::GetEdges ( unsigned long  iPoint ) const

inline

Get inner iterator to loop over neighbor edges.

GetElem()

unsigned long CPoint::GetElem ( unsigned long  iPoint, unsigned long  nelem  ) const

inline

Get all the elements that compose the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	nelem	- Position where the element is stored.

Returns

Index of the element.

GetElems()

CCompressedSparsePatternL::CInnerIter CPoint::GetElems ( unsigned long  iPoint ) const

inline

Get inner iterator to loop over neighbor elements.

GetGlobalIndex()

unsigned long CPoint::GetGlobalIndex ( unsigned long  iPoint ) const

inline

Get the global index in a parallel computation.

Parameters

[in]

iPoint

- Index of the point.

Returns

Global index in a parallel computation.

GetGridVel() [1/2]

const su2activematrix & CPoint::GetGridVel ( ) const

inline

Get the grid velocity matrix for the entire domain.

GetGridVel() [2/2]

su2double * CPoint::GetGridVel ( unsigned long  iPoint )

inline

Get the value of the grid velocity at the point.

Parameters

[in]

iPoint

- Index of the point.

Returns

Grid velocity at the point.

GetGridVel_Grad() [1/2]

CVectorOfMatrix & CPoint::GetGridVel_Grad ( )

inline

Get the grid velocity gradients for the entire domain.

GetGridVel_Grad() [2/2]

CMatrixView< const su2double > CPoint::GetGridVel_Grad ( unsigned long  iPoint ) const

inline

Get the value of the grid velocity gradient at the point.

Parameters

[in]

iPoint

- Index of the point.

Returns

Grid velocity gradient at the point.

GetMaxLength()

su2double CPoint::GetMaxLength ( unsigned long  iPoint ) const

inline

Get the maximum cell-center to cell-center length.

Parameters

[in]

iPoint

- Index of the point.

Returns

The maximum cell-center to cell-center length.

GetnChildren_CV()

unsigned short CPoint::GetnChildren_CV ( unsigned long  iPoint ) const

inline

Get the number of children of an agglomerated control volume.

Parameters

[in]

iPoint

- Index of the point.

Returns

Number of children control volume.

GetnElem()

unsigned short CPoint::GetnElem ( unsigned long  iPoint ) const

inline

Get the number of elements that compose the control volume.

Parameters

[in]

iPoint

- Index of the point.

Returns

Number of elements that compose the control volume.

GetnNeighbor()

unsigned short CPoint::GetnNeighbor ( unsigned long  iPoint ) const

inline

Get the number of neighbor of a point.

Parameters

[in]

iPoint

- Index of the point.

Returns

Number of neighbors.

GetnPoint()

unsigned short CPoint::GetnPoint ( unsigned long  iPoint ) const

inline

Get the number of points that compose the control volume.

Parameters

[in]

iPoint

- Index of the point.

Returns

Number of points that compose the control volume.

GetParent_CV()

unsigned long CPoint::GetParent_CV ( unsigned long  iPoint ) const

inline

Get the parent control volume of an agglomerated control volume.

Parameters

[in]

iPoint

- Index of the point.

Returns

Index of the parent control volume.

GetPeriodicBoundary()

bool CPoint::GetPeriodicBoundary ( unsigned long  iPoint ) const

inline

Provides information about if a point belongs to a periodic boundary (without MPI).

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the point belongs to a periodic boundary; otherwise FALSE.

GetPeriodicVolume() [1/2]

su2double & CPoint::GetPeriodicVolume ( unsigned long  iPoint )

inline

Get the missing component of area or volume for a control volume on a periodic marker.

Parameters

[in]

iPoint

- Index of the point.

Returns

Periodic component of area or volume for a control volume on a periodic marker.

GetPeriodicVolume() [2/2]

const su2double & CPoint::GetPeriodicVolume ( unsigned long  iPoint ) const

inline

GetPhysicalBoundary()

bool CPoint::GetPhysicalBoundary ( unsigned long  iPoint ) const

inline

Provides information about if a point belong to the physical boundaries (without MPI).

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the point belong to the boundary; otherwise FALSE.

GetPoint()

unsigned long CPoint::GetPoint ( unsigned long  iPoint, unsigned long  npoint  ) const

inline

Get all the points that compose the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	point	- Position where the point is stored.

Returns

Index of the point.

GetPoints() [1/2]

const CCompressedSparsePatternUL & CPoint::GetPoints ( ) const

inline

Get the entire point adjacency information in compressed format (CSR).

GetPoints() [2/2]

CCompressedSparsePatternUL::CInnerIter CPoint::GetPoints ( unsigned long  iPoint ) const

inline

Get inner iterator to loop over neighbor points.

GetRoughnessHeight()

su2double CPoint::GetRoughnessHeight ( unsigned long  iPoint ) const

inline

Get the value of the distance to the nearest wall.

Parameters

[in]

iPoint

- Index of the point.

Returns

Value of the distance to the nearest wall.

GetSharpEdge_Distance() [1/2]

su2double & CPoint::GetSharpEdge_Distance ( unsigned long  iPoint )

inline

Get the value of the distance to a sharp edge.

Parameters

[in]

iPoint

- Index of the point.

Returns

Value of the distance to the nearest wall.

GetSharpEdge_Distance() [2/2]

const su2double & CPoint::GetSharpEdge_Distance ( unsigned long  iPoint ) const

inline

GetSolidBoundary()

bool CPoint::GetSolidBoundary ( unsigned long  iPoint ) const

inline

Provides information about if a point belong to the physical boundaries (without MPI).

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the point belong to the boundary; otherwise FALSE.

GetVertex()

long CPoint::GetVertex ( unsigned long  iPoint, unsigned long  iMarker  ) const

inline

Get the vertex that compose the control volume for a marker.

Parameters

[in]	iPoint	- Index of the point.
[in]	iMarker	- Position where the vertex is stored.

Returns

Index of the vertex.

GetViscousBoundary()

bool CPoint::GetViscousBoundary ( unsigned long  iPoint ) const

inline

Provides information about if a point belong to the physical boundaries (without MPI).

Parameters

[in]

iPoint

- Index of the point.

Returns

TRUE if the point belong to the boundary; otherwise FALSE.

GetVolume() [1/2]

su2double & CPoint::GetVolume ( unsigned long  iPoint )

inline

Get area or volume of the control volume.

Parameters

[in]

iPoint

- Index of the point.

Returns

Area or volume of the control volume.

GetVolume() [2/2]

const su2double & CPoint::GetVolume ( unsigned long  iPoint ) const

inline

GetVolume_n()

su2double CPoint::GetVolume_n ( unsigned long  iPoint ) const

inline

Get the volume of the control volume at time n.

Parameters

[in]

iPoint

- Index of the point.

Returns

Volume of the control volume at time n

GetVolume_nM1()

su2double CPoint::GetVolume_nM1 ( unsigned long  iPoint ) const

inline

Get the volume of the control volume at time n+1.

Parameters

[in]

iPoint

- Index of the point.

Returns

Volume of the control volume at time n+1

GetWall_Distance() [1/2]

su2double & CPoint::GetWall_Distance ( unsigned long  iPoint )

inline

Get the value of the distance to the nearest wall.

Parameters

[in]

iPoint

- Index of the point.

Returns

Value of the distance to the nearest wall.

GetWall_Distance() [2/2]

const su2double & CPoint::GetWall_Distance ( unsigned long  iPoint ) const

inline

RegisterCoordinates()

void CPoint::RegisterCoordinates ( unsigned long  iPoint, bool  input  )

inline

Register coordinates of a point.

Parameters

[in]	iPoint	- Index of the point.
[in]	input	- Register as input or output.

ResetBoundary()

void CPoint::ResetBoundary ( unsigned long  iPoint )

inline

Reset the boundary of a control volume.

Parameters

[in]

iPoint

- Index of the point.

ResetElems()

void CPoint::ResetElems ( )

inline

Reset the elements of a control volume.

ResetPoints()

void CPoint::ResetPoints ( )

inline

Reset the points that compose the control volume.

SetAdjointSolution()

void CPoint::SetAdjointSolution ( unsigned long  iPoint, const su2double *  adj_sol  )

inline

Set the adjoint values of the (geometric) coordinates.

Parameters

[in]	iPoint	- Index of the point.
[in]	adj_sol	- Adjoint values of the Coord variables.

SetAgglomerate_Indirect()

void CPoint::SetAgglomerate_Indirect ( unsigned long  iPoint, bool  agglomerate  )

inline

Set information about if the indirect neighbors can be agglomerated.

Parameters

[in]	iPoint	- Index of the point.
[in]	agglomerate	- The indirect neigbors can be agglomerated.

SetBoundary() [1/2]

void CPoint::SetBoundary ( unsigned long  iPoint, bool  boundary  )

inline

Mark the point as boundary.

Parameters

[in]	iPoint	- Index of the point.
[in]	boundary	- TRUE if the point belong to the boundary; otherwise FALSE.

SetBoundary() [2/2]

void CPoint::SetBoundary ( unsigned long  iPoint, unsigned short  nMarker  )

inline

Set if a point belong to the boundary.

Parameters

[in]

iPoint

- Index of the point.

Note

It also create the structure to store the vertex.

Parameters

[in]

nMarker

- Max number of marker.

SetChildren_CV() [1/2]

void CPoint::SetChildren_CV ( unsigned long  iPoint, const vector< unsigned long > &  children_CV  )

inline

Set all the children control volumes of an agglomerated control volume at once.

Parameters

[in]	iPoint	- Index of the point.
[in]	children_CV	- Indices of the children control volumes.

SetChildren_CV() [2/2]

void CPoint::SetChildren_CV ( unsigned long  iPoint, unsigned long  nchildren_CV, unsigned long  children_CV  )

inline

Set the children control volumes of an agglomerated control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	nchildren_CV	- Number of children.
[in]	children_CV	- Index of the children control volume.

SetColor()

void CPoint::SetColor ( unsigned long  iPoint, unsigned long  color  )

inline

Set a color to the point that comes from the grid partitioning.

Parameters

[in]

iPoint

- Index of the point.

Note

Each domain has a different color.

Parameters

[in]

color

- Color of the point.

SetCoord() [1/2]

void CPoint::SetCoord ( unsigned long  iPoint, const su2double *  coord  )

inline

Set the point coordinates.

Parameters

[in]	iPoint	- Index of the point.
[in]	coord	- Coordinate of the point.

SetCoord() [2/2]

void CPoint::SetCoord ( unsigned long  iPoint, unsigned long  iDim, su2double  coord  )

inline

Set the coordinates for the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	iDim	- Position to store the coordinate.
[in]	coord	- Coordinate for iDim.

SetCoord_n() [1/2]

void CPoint::SetCoord_n

(

)

Set the coordinates of the control volume at time n to the ones in Coord.

SetCoord_n() [2/2]

void CPoint::SetCoord_n ( unsigned long  iPoint, const su2double *  coord  )

inline

Set the coordinates of the control volume at time n, for restart cases.

Parameters

[in]	iPoint	- Index of the point.
[in]	coord	- Value of the grid coordinates at time n.

SetCoord_n1() [1/2]

void CPoint::SetCoord_n1

(

)

Set the coordinates of the control volume at time n-1 to the ones in Coord_n.

SetCoord_n1() [2/2]

void CPoint::SetCoord_n1 ( unsigned long  iPoint, const su2double *  coord  )

inline

Set the coordinates of the control volume at time n-1, for restart cases.

Parameters

[in]	iPoint	- Index of the point.
[in]	coord	- Value of the grid coordinates at time n-1.

SetCoord_Old() [1/2]

void CPoint::SetCoord_Old

(

)

Set the value of the vector Coord_Old to Coord.

SetCoord_Old() [2/2]

void CPoint::SetCoord_Old ( unsigned long  iPoint, const su2double *  coord_old  )

inline

Set the value of the vector Coord_Old.

Parameters

[in]	iPoint	- Index of the point.
[in]	coord_old	- Value of the coordinates.

SetCoord_p1()

void CPoint::SetCoord_p1 ( unsigned long  iPoint, const su2double *  coord  )

inline

Set the coordinates of the control volume at time n+1.

Parameters

[in]	iPoint	- Index of the point.
[in]	coord	- Value of the grid coordinates at time n+1.

SetCurvature()

void CPoint::SetCurvature ( unsigned long  iPoint, su2double  curvature  )

inline

Set the value of the curvature at a surface node.

Parameters

[in]	iPoint	- Index of the point.
[in]	curvature	- Value of the curvature.

SetDomain()

void CPoint::SetDomain ( unsigned long  iPoint, bool  domain  )

inline

For parallel computation, its indicates if a point must be computed or not.

Parameters

[in]	iPoint	- Index of the point.
[in]	domain	- TRUE if the point belong to the domain; otherwise FALSE.

SetEdge()

void CPoint::SetEdge ( unsigned long  iPoint, long  iedge, unsigned long  nedge  )

inline

Set the edges that compose the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	iedge	- Edge to be added.
[in]	nedge	- Position in which is going to be stored the edge for each control volume.

SetElems()

void CPoint::SetElems

(

const vector< vector< long > > &

elemsMatrix

)

Set the elements that are connected to each point.

Parameters

[in]

elemsMatrix

- List of lists with the neighbor points connected to each point.

SetGlobalIndex()

void CPoint::SetGlobalIndex ( unsigned long  iPoint, unsigned long  globalindex  )

inline

Set the global index in a parallel computation.

Parameters

[in]

iPoint

- Index of the point.

Returns

Global index in a parallel computation.

SetGridVel() [1/2]

void CPoint::SetGridVel ( unsigned long  iPoint, const su2double *  gridvel  )

inline

Set the value of the grid velocity at the point.

Parameters

[in]	iPoint	- Index of the point.
[in]	gridvel	- Value of the grid velocity.

SetGridVel() [2/2]

void CPoint::SetGridVel ( unsigned long  iPoint, unsigned long  iDim, su2double  gridvel  )

inline

Set the value of the grid velocity at the point.

Parameters

[in]	iPoint	- Index of the point.
[in]	iDim	- Index of the coordinate.
[in]	gridvel	- Value of the grid velocity.

SetMaxLength()

void CPoint::SetMaxLength ( unsigned long  iPoint, su2double  max_length  )

inline

Set the max cell-center to cell-center length.

Parameters

[in]	iPoint	- Index of the point.
[in]	max_length	- Value of the max length

SetnChildren_CV()

void CPoint::SetnChildren_CV ( unsigned long  iPoint, unsigned short  nchildren_CV  )

inline

Set the number of children of an agglomerated control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	nchildren_CV	- Number of children of the control volume.

SetnNeighbor()

void CPoint::SetnNeighbor ( unsigned long  iPoint, unsigned short  nneighbor  )

inline

Set the number of neighbor (artificial dissipation).

Parameters

[in]	iPoint	- Index of the point.
[in]	nneighbor	- Number of neighbors.

SetParent_CV()

void CPoint::SetParent_CV ( unsigned long  iPoint, unsigned long  parent_CV  )

inline

Set the parent control volume of an agglomerated control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	parent_CV	- Index of the parent control volume.

SetPeriodicBoundary()

void CPoint::SetPeriodicBoundary ( unsigned long  iPoint, bool  boundary  )

inline

Set if a point belongs to a periodic boundary.

Parameters

[in]	iPoint	- Index of the point.
[in]	boundary	- TRUE if the point belongs to a periodic boundary; otherwise FALSE.

SetPeriodicVolume()

void CPoint::SetPeriodicVolume ( unsigned long  iPoint, su2double  volume  )

inline

Set the missing component of area or volume for a control volume on a periodic marker.

Parameters

[in]	iPoint	- Index of the point.
[in]	volume	- Value of the volume from the missing components of the CV on the periodic marker.

SetPhysicalBoundary()

void CPoint::SetPhysicalBoundary ( unsigned long  iPoint, bool  boundary  )

inline

Set if a point belong to the boundary.

Parameters

[in]	iPoint	- Index of the point.
[in]	boundary	- TRUE if the point belong to the physical boundary; otherwise FALSE.

SetPoints()

void CPoint::SetPoints

(

const vector< vector< unsigned long > > &

pointsMatrix

)

Set the points that compose the control volume.

Parameters

[in]

pointsMatrix

- List of lists with the neighbor points connected to each point.

SetRoughnessHeight()

void CPoint::SetRoughnessHeight ( unsigned long  iPoint, su2double  roughheight  )

inline

Set the value of the distance to the nearest wall.

Parameters

[in]	iPoint	- Index of the point.
[in]	distance	- Value of the distance.

SetSharpEdge_Distance()

void CPoint::SetSharpEdge_Distance ( unsigned long  iPoint, su2double  distance  )

inline

Set the value of the distance to a sharp edge.

Parameters

[in]	iPoint	- Index of the point.
[in]	distance	- Value of the distance.

SetSolidBoundary()

void CPoint::SetSolidBoundary ( unsigned long  iPoint, bool  boundary  )

inline

Set if a point belong to the solid wall boundary.

Parameters

[in]	iPoint	- Index of the point.
[in]	boundary	- TRUE if the point belong to the physical boundary; otherwise FALSE.

SetVertex()

void CPoint::SetVertex ( unsigned long  iPoint, long  iVertex, unsigned long  iMarker  )

inline

Set the boundary vertex that compose the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	iVertex	- Vertex to be added.
[in]	iMarker	- Marker of the vertex to be added (position where is going to be stored).

SetViscousBoundary()

void CPoint::SetViscousBoundary ( unsigned long  iPoint, bool  boundary  )

inline

Set if a point belong to the boundary.

Parameters

[in]	iPoint	- Index of the point.
[in]	boundary	- TRUE if the point belong to the physical boundary; otherwise FALSE.

SetVolume()

void CPoint::SetVolume ( unsigned long  iPoint, su2double  volume  )

inline

Set the volume of the control volume.

Parameters

[in]	iPoint	- Index of the point.
[in]	volume	- Value of the volume.

SetVolume_from_Oldn()

void CPoint::SetVolume_from_Oldn

(

)

Set the volume of the control volume at current time using time n.

SetVolume_n()

void CPoint::SetVolume_n

(

)

Set the volume of the control volume at time n.

SetVolume_n_from_OldnM1()

void CPoint::SetVolume_n_from_OldnM1

(

)

Set the volume of the control volume at time n using n-1.

SetVolume_n_Old()

void CPoint::SetVolume_n_Old

(

)

Set the Volume_n to Volume_n_Old.

SetVolume_nM1()

void CPoint::SetVolume_nM1

(

)

Set the volume of the control volume at time n-1.

SetVolume_nM1_Old()

void CPoint::SetVolume_nM1_Old

(

)

Set the Volume_nM1 to Volume_nM1_Old.

SetVolume_Old()

void CPoint::SetVolume_Old

(

)

Set the Volume to Volume_Old.

SetWall_Distance() [1/2]

void CPoint::SetWall_Distance ( unsigned long  iPoint, su2double  distance  )

inline

SetWall_Distance() [2/2]

void CPoint::SetWall_Distance ( unsigned long  iPoint, su2double  distance, int  rankID, unsigned short  zoneID, unsigned short  markerID, unsigned long  elemID  )

inline

Set the value of the distance to the nearest wall.

Parameters

[in]	iPoint	- Index of the point.
[in]	distance	- Value of the distance.
[in]	rankID	- Rank of process holding the closest wall element.
[in]	zoneID	- Zone index of closest wall element.
[in]	markerID	- Marker index of closest wall element.
[in]	elemID	- Element index of closest wall element.

SetWallRoughness()

template<typename Roughness_type >

void CPoint::SetWallRoughness ( Roughness_type const &  roughness )

inline

Set wall roughnesses according to stored closest wall information.

Parameters

[in]

roughness

- Mapping [rank][zone][marker] -> roughness

Friends And Related Symbol Documentation

CPhysicalGeometry

friend class CPhysicalGeometry

friend

---

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

• Common/include/geometry/dual_grid/CPoint.hpp
• Common/src/geometry/dual_grid/CPoint.cpp