Public Types | Public Member Functions | Public Attributes | List of all members
Caching< DataType > Struct Template Reference

Bookkeeping for internal caching. More...

Inheritance diagram for Caching< DataType >:
[legend]

Public Types

typedef DataType dataType
 

Public Member Functions

uint64_t nPoints () const
 Number of points associated with the geometry. More...
 
void clearGeom ()
 Clear geometry and dataset. More...
 
vtkSmartPointer< dataType > getCopy () const
 Return a shallow copy of vtkgeom for manipulation. More...
 
void reuse ()
 Make a shallow copy of vtkgeom into dataset. More...
 
void set (vtkSmartPointer< dataType > geom)
 Set the geometry and make a shallow copy to dataset. More...
 
void PrintSelf (std::ostream &os) const
 Report basic information to output. More...
 

Public Attributes

vtkSmartPointer< dataType > vtkgeom
 The geometry, without any cell/point data. More...
 
vtkSmartPointer< dataType > dataset
 The shallow-copy of geometry, plus additional data. More...
 

Detailed Description

template<class DataType>
struct Foam::vtk::Caching< DataType >

Bookkeeping for internal caching.

Retain an original copy of the geometry as well as a shallow copy with the output fields. The original copy is reused for different timesteps etc.

Definition at line 87 of file foamVtkTools.H.

Member Typedef Documentation

◆ dataType

typedef DataType dataType

Definition at line 89 of file foamVtkTools.H.

Member Function Documentation

◆ nPoints()

uint64_t nPoints ( ) const
inline

Number of points associated with the geometry.

Definition at line 98 of file foamVtkTools.H.

◆ clearGeom()

void clearGeom ( )
inline

Clear geometry and dataset.

Definition at line 104 of file foamVtkTools.H.

◆ getCopy()

vtkSmartPointer<dataType> getCopy ( ) const
inline

Return a shallow copy of vtkgeom for manipulation.

Definition at line 111 of file foamVtkTools.H.

◆ reuse()

void reuse ( )
inline

Make a shallow copy of vtkgeom into dataset.

Definition at line 122 of file foamVtkTools.H.

Referenced by Caching< vtkUnstructuredGrid >::set().

Here is the caller graph for this function:

◆ set()

void set ( vtkSmartPointer< dataType >  geom)
inline

Set the geometry and make a shallow copy to dataset.

Definition at line 132 of file foamVtkTools.H.

◆ PrintSelf()

void PrintSelf ( std::ostream &  os) const
inline

Report basic information to output.

Definition at line 139 of file foamVtkTools.H.

Member Data Documentation

◆ vtkgeom

vtkSmartPointer<dataType> vtkgeom

The geometry, without any cell/point data.

Definition at line 92 of file foamVtkTools.H.

Referenced by Caching< vtkUnstructuredGrid >::clearGeom(), Caching< vtkUnstructuredGrid >::getCopy(), Caching< vtkUnstructuredGrid >::nPoints(), Caching< vtkUnstructuredGrid >::PrintSelf(), Caching< vtkUnstructuredGrid >::reuse(), and Caching< vtkUnstructuredGrid >::set().

◆ dataset

vtkSmartPointer<dataType> dataset

The shallow-copy of geometry, plus additional data.

Definition at line 95 of file foamVtkTools.H.

Referenced by Caching< vtkUnstructuredGrid >::clearGeom(), Caching< vtkUnstructuredGrid >::PrintSelf(), and Caching< vtkUnstructuredGrid >::reuse().

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