SU2
Public Member Functions | List of all members
su2_adtPointsOnlyClass Class Reference

Class for storing an ADT of only points in an arbitrary number of dimensions. More...

#include <adt_structure.hpp>

Inheritance diagram for su2_adtPointsOnlyClass:
su2_adtBaseClass

Public Member Functions

 su2_adtPointsOnlyClass (unsigned short nDim, unsigned long nPoints, const su2double *coor, const unsigned long *pointID)
 Constructor of the class. More...
 
 ~su2_adtPointsOnlyClass ()
 Destructor of the class. Nothing to be done.
 
void DetermineNearestNode (const su2double *coor, su2double &dist, unsigned long &pointID, int &rankID)
 Function, which determines the nearest node in the ADT for the given coordinate. More...
 
- Public Member Functions inherited from su2_adtBaseClass
bool IsEmpty (void) const
 Function, which returns whether or not the ADT is empty. More...
 

Additional Inherited Members

- Protected Member Functions inherited from su2_adtBaseClass
 su2_adtBaseClass ()
 Constructor of the class. Nothing to be done.
 
virtual ~su2_adtBaseClass ()
 Destructor of the class. Nothing to be done.
 
void BuildADT (unsigned short nDim, unsigned long nPoints, const su2double *coor)
 Function, which builds the ADT of the given coordinates. More...
 
- Protected Attributes inherited from su2_adtBaseClass
unsigned long nLeaves
 Number of leaves in the ADT.
 
unsigned short nDimADT
 Number of dimensions of the ADT.
 
bool isEmpty
 Whether or not the ADT is empty.
 
vector< su2_adtNodeClassleaves
 Vector, which contains all the leaves of the ADT.
 

Detailed Description

Class for storing an ADT of only points in an arbitrary number of dimensions.

Author
E. van der Weide
Version
4.1.3 "Cardinal"

Constructor & Destructor Documentation

§ su2_adtPointsOnlyClass()

su2_adtPointsOnlyClass::su2_adtPointsOnlyClass ( unsigned short  nDim,
unsigned long  nPoints,
const su2double *  coor,
const unsigned long *  pointID 
)

Constructor of the class.

Parameters
[in]nDimNumber of spatial dimensions of the problem.
[in]nPointsNumber of local points to be stored in the ADT.
[in]coorCoordinates of the local points.
[in]pointIDLocal point IDs of the local points.

Member Function Documentation

§ DetermineNearestNode()

void su2_adtPointsOnlyClass::DetermineNearestNode ( const su2double *  coor,
su2double &  dist,
unsigned long &  pointID,
int &  rankID 
)

Function, which determines the nearest node in the ADT for the given coordinate.

Parameters
[in]coorCoordinate for which the nearest node in the ADT must be determined.
[out]distDistance to the nearest node in the ADT.
[out]pointIDLocal point ID of the nearest node in the ADT.
[out]rankIDRank on which the nearest node in the ADT is stored.

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