vtkPVFoam Class Reference

The backend for the vtkPVFoamReader reader module - providing a paraview reader interface for OpenFOAM meshes and fields. More...

Inheritance diagram for vtkPVFoam:

Collaboration diagram for vtkPVFoam:

Public Member Functions
	ClassName ("vtkPVFoam")
	Static data members. More...
	vtkPVFoam (const char *const FileName, vtkPVFoamReader *reader)
	Construct from components. More...
	~vtkPVFoam ()
	Destructor. More...
void	updateInfo ()
	Update. More...
void	Update (vtkMultiBlockDataSet *output, vtkMultiBlockDataSet *outputLagrangian)
void	UpdateFinalize ()
	Final part of Update(), after any last minute rendering. More...
void	renderPatchNames (vtkRenderer *renderer, const bool show)
	Add/remove patch names to/from the view. More...
std::vector< double >	findTimes (const bool skipZero=false) const
	Return a list of selected times. More...
int	setTime (const std::vector< double > &requestTimes)
	Set the runTime to the first plausible request time,. More...
int	timeIndex () const
	The current time index. More...
void	PrintSelf (ostream &, vtkIndent) const
	Debug information. More...
void	printInfo () const

Detailed Description

The backend for the vtkPVFoamReader reader module - providing a paraview reader interface for OpenFOAM meshes and fields.

Similar, and sometimes better, functionality may be provided by the native VTK OpenFOAM reader. OpenCFD has recently (2017) been working on improving the native VTK OpenFOAM reader for the benefit of everyone.

In some areas the reader module lacks compared to the native reader (notably the ability to work on decomosed datasets), but provides additional handling of sets,zones,groups. Some features have also since been adapted to the native reader. Additionally, the reader module provides a useful platform for testing new ideas.

Note

The reader module allows two levels of caching. The OpenFOAM fvMesh can be cached in memory, for faster loading of fields. Additionally, the translated VTK geometries are held in a local cache. The cached VTK geometries should incur no additional overhead since they use the VTK reference counting for their storage management.

Source files

• vtkPVFoam.H
• vtkPVFoam.C
• vtkPVFoamFields.C
• vtkPVFoamMesh.C
• vtkPVFoamMeshLagrangian.C
• vtkPVFoamMeshVolume.C
• vtkPVFoamTemplates.C
• vtkPVFoamUpdateInfo.C
• vtkPVFoamFieldTemplates.C
• vtkPVFoamUpdateTemplates.C

Needed by VTK: vtkDataArrayTemplateImplicit.txx

Definition at line 112 of file vtkPVFoam.H.

Constructor & Destructor Documentation

vtkPVFoam()

vtkPVFoam	(	const char *const	FileName,
		vtkPVFoamReader *	reader
	)

Construct from components.

~vtkPVFoam()

~vtkPVFoam

(

)

Destructor.

Member Function Documentation

ClassName()

ClassName

(

"vtkPVFoam"

)

Static data members.

updateInfo()

void updateInfo

(

)

Update.

Update()

void Update	(	vtkMultiBlockDataSet *	output,
		vtkMultiBlockDataSet *	outputLagrangian
	)

UpdateFinalize()

void UpdateFinalize

(

)

Final part of Update(), after any last minute rendering.

renderPatchNames()

void renderPatchNames	(	vtkRenderer *	renderer,
		const bool	show
	)

Add/remove patch names to/from the view.

findTimes()

std::vector<double> findTimes

(

const bool

skipZero = false

)

const

Return a list of selected times.

Use STL container since these values are used by the plugin

setTime()

int setTime

(

const std::vector< double > &

requestTimes

)

Set the runTime to the first plausible request time,.

returns the timeIndex sets to "constant" on error

timeIndex()

int timeIndex ( ) const

inline

The current time index.

Definition at line 479 of file vtkPVFoam.H.

PrintSelf()

void PrintSelf	(	ostream &	,
		vtkIndent
	)		const

Debug information.

printInfo()

void printInfo

(

)

const

---

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

• applications/utilities/postProcessing/graphics/PVReaders/foamReader/library/vtkPVFoam.H