GEOSX
Public Member Functions | List of all members
geos::vtk::CollocatedNodes Class Reference

Convenience wrapper around the raw vtk information. More...

#include <CollocatedNodes.hpp>

Public Member Functions

 CollocatedNodes (string const &faceBlockName, vtkSmartPointer< vtkDataSet > faceMesh, bool isParallel=true)
 Build a convenience wrapper around the raw vtk collocated nodes information. More...
 
const std::vector< vtkIdType > & operator[] (std::size_t i) const
 For node i of the face block, returns all the duplicated global node indices in the main 3d mesh. More...
 
std::size_t size () const
 Number of duplicated nodes buckets. Multiple nodes that are considered to be duplicated one of each other make one bucket. More...
 

Detailed Description

Convenience wrapper around the raw vtk information.

Definition at line 30 of file CollocatedNodes.hpp.

Constructor & Destructor Documentation

◆ CollocatedNodes()

geos::vtk::CollocatedNodes::CollocatedNodes ( string const &  faceBlockName,
vtkSmartPointer< vtkDataSet >  faceMesh,
bool  isParallel = true 
)

Build a convenience wrapper around the raw vtk collocated nodes information.

Parameters
faceBlockNameThe face block name.
faceMeshThe face mesh for which the collocated nodes structure will be fed.
isParallelEven if the global simulation is parallel, this structure can be built on one unique rank or on multiple ranks. When built on multiple ranks for the same face mesh, some additional extra checks are performed. Those checks are useless when the data is manipulated on one unique rank.

Member Function Documentation

◆ operator[]()

const std::vector< vtkIdType >& geos::vtk::CollocatedNodes::operator[] ( std::size_t  i) const
inline

For node i of the face block, returns all the duplicated global node indices in the main 3d mesh.

Parameters
ithe node in the face block (numbering is local to the face block).
Returns
The list of global node indices in the main 3d mesh.

Definition at line 51 of file CollocatedNodes.hpp.

◆ size()

std::size_t geos::vtk::CollocatedNodes::size ( ) const
inline

Number of duplicated nodes buckets. Multiple nodes that are considered to be duplicated one of each other make one bucket.

Returns
The number of duplicated nodes buckets.

Definition at line 61 of file CollocatedNodes.hpp.


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