Loading...
Searching...
No Matches
Caching< DataType > Struct Template Reference

Bookkeeping for internal caching. More...

#include <foamVtkTools.H>

Inheritance diagram for Caching< DataType >:
Inheritance graph
[legend]

Public Types

typedef DataType dataType
 The VTK geometry data type.

Public Member Functions

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

Public Attributes

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

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 85 of file foamVtkTools.H.

Member Typedef Documentation

◆ dataType

template<class DataType>
typedef DataType dataType

The VTK geometry data type.

Definition at line 90 of file foamVtkTools.H.

Member Function Documentation

◆ nPoints()

template<class DataType>
uint64_t nPoints ( ) const
inline

Number of points associated with the geometry.

Definition at line 105 of file foamVtkTools.H.

References vtkgeom.

◆ clearGeom()

template<class DataType>
void clearGeom ( )
inline

Clear geometry and dataset.

Definition at line 113 of file foamVtkTools.H.

References dataset, and vtkgeom.

◆ getCopy()

template<class DataType>
vtkSmartPointer< dataType > getCopy ( ) const
inline

Return a shallow copy of vtkgeom for manipulation.

Definition at line 122 of file foamVtkTools.H.

References vtkgeom.

◆ reuse()

template<class DataType>
void reuse ( )
inline

Make a shallow copy of vtkgeom into dataset.

Definition at line 135 of file foamVtkTools.H.

References dataset, and vtkgeom.

Referenced by set().

Here is the caller graph for this function:

◆ set()

template<class DataType>
void set ( vtkSmartPointer< dataType > geom)
inline

Set the geometry and make a shallow copy to dataset.

Definition at line 147 of file foamVtkTools.H.

References reuse(), and vtkgeom.

Here is the call graph for this function:

◆ PrintSelf()

template<class DataType>
void PrintSelf ( std::ostream & os) const
inline

Report basic information to output.

Definition at line 156 of file foamVtkTools.H.

References dataset, Foam::nl, os(), and vtkgeom.

Here is the call graph for this function:

Member Data Documentation

◆ vtkgeom

template<class DataType>
vtkSmartPointer<dataType> vtkgeom

The geometry, without any cell/point data.

Definition at line 95 of file foamVtkTools.H.

Referenced by clearGeom(), getCopy(), nPoints(), PrintSelf(), reuse(), and set().

◆ dataset

template<class DataType>
vtkSmartPointer<dataType> dataset

The shallow-copy of geometry, plus additional data.

Definition at line 100 of file foamVtkTools.H.

Referenced by clearGeom(), PrintSelf(), and reuse().

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