VTK  9.4.20241124
Public Member Functions | Public Attributes | Friends | List of all members
vtkDGCell::Source Struct Reference

Records describing the source arrays for cells or cell-sides. More...

#include <vtkDGCell.h>

Collaboration diagram for vtkDGCell::Source:
[legend]

Public Member Functions

 Source ()=default
 
 Source (const Source &)=default
 
 Source (vtkDataArray *conn, vtkIdType off, bool blank, Shape shape, int sideType)
 
 Source (vtkDataArray *conn, vtkIdType off, bool blank, Shape shape, int sideType, int selnType, vtkDataArray *nodalGhostMarks)
 
Sourceoperator= (const Source &)=default
 
virtual ~Source ()=default
 Override the destructor to de-reference Connectivity, NodalGhostMarks.
 

Public Attributes

vtkDataArrayConnectivity { nullptr }
 An array holding cell connectivity or (cell-id, side-id) tuples.
 
vtkDataArrayNodalGhostMarks { nullptr }
 An array holding per-point "ghost" information (or null).
 
vtkIdType Offset { 0 }
 Offset (start ID; used for picking) of the first cell or side in Connectivity.
 
bool Blanked { false }
 True when the cells/sides should be omitted from processing.
 
Shape SourceShape { Shape::None }
 The shape of this type of cell/side.
 
int SideType { -1 }
 The type of the side (for calling GetSideRangeForType).
 
int SelectionType { -1 }
 If SideType >= 0, this determines what should be selected.
 

Friends

ostream & operator<< (ostream &os, const Source &source)
 

Detailed Description

Records describing the source arrays for cells or cell-sides.

Definition at line 89 of file vtkDGCell.h.

Constructor & Destructor Documentation

◆ Source() [1/4]

vtkDGCell::Source::Source ( )
default

◆ Source() [2/4]

vtkDGCell::Source::Source ( const Source )
default

◆ Source() [3/4]

vtkDGCell::Source::Source ( vtkDataArray conn,
vtkIdType  off,
bool  blank,
Shape  shape,
int  sideType 
)

◆ Source() [4/4]

vtkDGCell::Source::Source ( vtkDataArray conn,
vtkIdType  off,
bool  blank,
Shape  shape,
int  sideType,
int  selnType,
vtkDataArray nodalGhostMarks 
)

◆ ~Source()

virtual vtkDGCell::Source::~Source ( )
virtualdefault

Override the destructor to de-reference Connectivity, NodalGhostMarks.

Member Function Documentation

◆ operator=()

Source & vtkDGCell::Source::operator= ( const Source )
default

Friends And Related Symbol Documentation

◆ operator<<

ostream & operator<< ( ostream &  os,
const Source source 
)
friend

Definition at line 100 of file vtkDGCell.h.

Member Data Documentation

◆ Connectivity

vtkDataArray* vtkDGCell::Source::Connectivity { nullptr }

An array holding cell connectivity or (cell-id, side-id) tuples.

If the array is cell connectivity, then each component is a point ID and the number of components matches the number of corners for each cell. If the array is side connectivity, then each tuple consists of a cell ID for component 0 and a side ID for component 1.

Definition at line 120 of file vtkDGCell.h.

◆ NodalGhostMarks

vtkDataArray* vtkDGCell::Source::NodalGhostMarks { nullptr }

An array holding per-point "ghost" information (or null).

If this array is non-null, then the mesh is distributed across multiple vtkCellGrid instances and this array has a mark for each point that is either 0 or from vtkDataSetAttributes::PointGhostTypes.

Definition at line 127 of file vtkDGCell.h.

◆ Offset

vtkIdType vtkDGCell::Source::Offset { 0 }

Offset (start ID; used for picking) of the first cell or side in Connectivity.

Definition at line 130 of file vtkDGCell.h.

◆ Blanked

bool vtkDGCell::Source::Blanked { false }

True when the cells/sides should be omitted from processing.

Definition at line 133 of file vtkDGCell.h.

◆ SourceShape

Shape vtkDGCell::Source::SourceShape { Shape::None }

The shape of this type of cell/side.

Definition at line 136 of file vtkDGCell.h.

◆ SideType

int vtkDGCell::Source::SideType { -1 }

The type of the side (for calling GetSideRangeForType).

The default of -1 indicates the that the source is the cell-type itself, not any side.

Definition at line 140 of file vtkDGCell.h.

◆ SelectionType

int vtkDGCell::Source::SelectionType { -1 }

If SideType >= 0, this determines what should be selected.

A value of -1 indicates the parent cell (whatever its dimension) should be chosen when a side in this Source is selected. Other values indicate a side should be extracted, but for now this should be -1 or SideType.

Definition at line 147 of file vtkDGCell.h.


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