Class for pyramid element definition. More...

#include <primal_grid_structure.hpp>

Inheritance diagram for CPyramid:

Public Member Functions
	CPyramid (unsigned long val_point_0, unsigned long val_point_1, unsigned long val_point_2, unsigned long val_point_3, unsigned long val_point_4)
	Constructor using the nodes and index. More...

	~CPyramid (void)
	Destructor of the class.

unsigned long	GetNode (unsigned short val_node)
	Get the nodes shared by the pyramid. More...

void	SetNode (unsigned short val_node, unsigned long val_point)
	Set the point associated at a node. More...

unsigned short	GetFaces (unsigned short val_face, unsigned short val_index)
	Get the face index of and element. More...

unsigned short	GetNeighbor_Nodes (unsigned short val_node, unsigned short val_index)
	Get the local index of the neighbors to a node (given the local index). More...

unsigned short	GetnNeighbor_Nodes (unsigned short val_node)
	Get the number of neighbors nodes of a node. More...

unsigned short	GetnNodesFace (unsigned short val_face)
	Get the number of nodes that composes a face of an element. More...

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

unsigned short	GetnFaces (void)
	Get the number of faces of an element. More...

unsigned short	GetMaxNodesFace (void)
	Get the Maximum number of nodes of a face of an element. More...

unsigned short	GetVTK_Type (void)
	Get the type of the element using VTK nomenclature. More...

unsigned short	GetnNeighbor_Elements (void)
	Get the number of element that are neighbor to this element. More...

void	Change_Orientation (void)
	Change the orientation of an element.

Public Member Functions inherited from CPrimalGrid
	CPrimalGrid (void)
	Constructor of the class.

	CPrimalGrid (unsigned short val_nNodes, unsigned short val_nFaces, unsigned short val_VTK_Type)

virtual	~CPrimalGrid (void)
	Destructor of the class.

long	GetNeighbor_Elements (unsigned short val_face)
	Get the elements that surround an element. More...

void	SetNeighbor_Elements (unsigned long val_elem, unsigned short val_face)
	Set the elements that surround an element. More...

void	SetCoord_CG (su2double **val_coord)
	Set the center of gravity of an element (including edges). More...

su2double	GetCG (unsigned short val_dim)
	Get the center of gravity of an element (including edges). More...

void	SetVolume (su2double val_volume)
	Set the center of gravity of an element (including edges). More...

su2double	GetVolume (void)
	Get the center of gravity of an element (including edges). More...

su2double	GetFaceCG (unsigned short val_face, unsigned short val_dim)
	Get the CG of a face of an element. More...

void	GetAllNeighbor_Elements (void)
	Get all the neighbors of an element. More...

void	SetDivide (bool val_divide)
	Set that an element must be divided in the adaptation stage. More...

bool	GetDivide (void)
	Get if an element must be divided in the adaptation stage. More...

unsigned long	GetGlobalIndex (void)
	Get the element global index in a parallel computation. More...

void	SetGlobalIndex (unsigned long val_globalindex)
	Set the global index for an element in a parallel computation. More...

virtual void	SetDomainElement (unsigned long val_domainelement)
	A virtual member. More...

virtual unsigned long	GetDomainElement (void)
	A virtual member. More...

virtual unsigned short	GetRotation_Type (void)
	A pure virtual member. More...

virtual void	SetRotation_Type (unsigned short val_rotation_type)
	A pure virtual member. More...

Additional Inherited Members
Protected Attributes inherited from CPrimalGrid
unsigned long *	Nodes
	Vector to store the global nodes of an element.

unsigned long	GlobalIndex
	The global index of an element.

long *	Neighbor_Elements
	Vector to store the elements surronding an element.

su2double *	Coord_CG
	Coordinates of the center-of-gravity of the element.

su2double **	Coord_FaceElems_CG
	Coordinates of the center-of-gravity of the face of the elements.

unsigned long	DomainElement
	Only for boundaries, in this variable the 3D elements which correspond with a boundary element is stored.

bool	Divide
	Marker used to know if we are going to divide this element in the adaptation proccess.

su2double	Volume
	Volume of the element.

Static Protected Attributes inherited from CPrimalGrid
static unsigned short	nDim
	Dimension of the element (2D or 3D) useful for triangles, quadrilateral and edges.

Detailed Description

Class for pyramid element definition.

Author: F. Palacios

Version: 5.0.0 "Raven"

Constructor & Destructor Documentation

§ CPyramid()

CPyramid::CPyramid	(	unsigned long	val_point_0,
		unsigned long	val_point_1,
		unsigned long	val_point_2,
		unsigned long	val_point_3,
		unsigned long	val_point_4
	)

Constructor using the nodes and index.

Parameters

[in]	val_point_0	- Index of the 1st point read from the grid file.
[in]	val_point_1	- Index of the 2nd point read from the grid file.
[in]	val_point_2	- Index of the 3th point read from the grid file.
[in]	val_point_3	- Index of the 4th point read from the grid file.
[in]	val_point_4	- Index of the 5th point read from the grid file.

Member Function Documentation

§ GetFaces()

unsigned short CPyramid::GetFaces	(	unsigned short	val_face,
		unsigned short	val_index
	)

inlinevirtual

Get the face index of and element.

Parameters

[in]	val_face	- Local index of the face.
[in]	val_index	- Local (to the face) index of the nodes that compose the face.

Returns: Local (to the element) index of the nodes that compose the face.

Implements CPrimalGrid.

§ GetMaxNodesFace()

unsigned short CPyramid::GetMaxNodesFace ( void )

inlinevirtual

Get the Maximum number of nodes of a face of an element.

Returns: Maximum number of nodes of a face of an element.

Implements CPrimalGrid.

§ GetNeighbor_Nodes()

unsigned short CPyramid::GetNeighbor_Nodes	(	unsigned short	val_node,
		unsigned short	val_index
	)

inlinevirtual

Get the local index of the neighbors to a node (given the local index).

Parameters

[in]	val_node	- Local (to the element) index of a node.
[in]	val_index	- Local (to the neighbor nodes of val_node) index of the nodes that are neighbor to val_node.

Returns: Local (to the element) index of the nodes that are neighbor to val_node.

Implements CPrimalGrid.

§ GetnFaces()

unsigned short CPyramid::GetnFaces ( void )

inlinevirtual

Get the number of faces of an element.

Returns: Number of faces of an element.

Implements CPrimalGrid.

§ GetnNeighbor_Elements()

unsigned short CPyramid::GetnNeighbor_Elements ( void )

inlinevirtual

Get the number of element that are neighbor to this element.

Returns: Number of neighbor elements.

Implements CPrimalGrid.

§ GetnNeighbor_Nodes()

unsigned short CPyramid::GetnNeighbor_Nodes ( unsigned short val_node )

inlinevirtual

Get the number of neighbors nodes of a node.

Parameters

[in] val_node - Local (to the element) index of a node.

Returns: Number if neighbors of a node val_node.

Implements CPrimalGrid.

§ GetnNodes()

unsigned short CPyramid::GetnNodes ( void )

inlinevirtual

Get the number of nodes of an element.

Returns: Number of nodes that composes an element.

Implements CPrimalGrid.

§ GetnNodesFace()

unsigned short CPyramid::GetnNodesFace ( unsigned short val_face )

inlinevirtual

Get the number of nodes that composes a face of an element.

Parameters

[in] val_face - Local index of the face.

Returns: Number of nodes that composes a face of an element.

Implements CPrimalGrid.

§ GetNode()

unsigned long CPyramid::GetNode ( unsigned short val_node )

inlinevirtual

Get the nodes shared by the pyramid.

Parameters

[in] val_node - Local (to the pyramid) index of the node (a pyramid has 3 nodes).

Returns: Global index of the pyramid node.

Implements CPrimalGrid.

§ GetVTK_Type()

unsigned short CPyramid::GetVTK_Type ( void )

inlinevirtual

Get the type of the element using VTK nomenclature.

Returns: Type of the element using VTK nomenclature.

Implements CPrimalGrid.

§ SetNode()

void CPyramid::SetNode	(	unsigned short	val_node,
		unsigned long	val_point
	)

inlinevirtual

Set the point associated at a node.

Parameters

[in]	val_node	- Local index of a node.
[in]	val_point	- Point associated to the node.

Reimplemented from CPrimalGrid.

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

Common/include/primal_grid_structure.hpp
Common/include/primal_grid_structure.inl
Common/src/primal_grid_structure.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ CPyramid()

Member Function Documentation

§ GetFaces()

§ GetMaxNodesFace()

§ GetNeighbor_Nodes()

§ GetnFaces()

§ GetnNeighbor_Elements()

§ GetnNeighbor_Nodes()

§ GetnNodes()

§ GetnNodesFace()

§ GetNode()

§ GetVTK_Type()

§ SetNode()