Inheritance diagram for fieldVisualisationBase:

[legend]

Collaboration diagram for fieldVisualisationBase:

[legend]

Data Structures
struct	scalarBar

Public Types
enum	colourByType { cbColour, cbField }

enum	colourMapType { cmRainbow, cmBlueWhiteRed, cmFire, cmGreyscale }

Public Member Functions
	fieldVisualisationBase (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours)
	Construct from dictionary. More...

virtual	~fieldVisualisationBase ()
	Destructor. More...

const HashPtrTable< DataEntry< vector >, word > &	colours () const
	Return the colours. More...

const word &	fieldName () const
	Return the field name. More...

Static Public Attributes
static const NamedEnum< colourByType, 2 >	colourByTypeNames

static const NamedEnum< colourMapType, 4 >	colourMapTypeNames

Protected Member Functions
void	setColourMap (vtkLookupTable *lut) const
	Set the colour map. More...

void	addScalarBar (const scalar position, vtkRenderer renderer, vtkLookupTable lut) const
	Add scalar bar to renderer. More...

void	setField (const scalar position, const word &colourFieldName, vtkPolyDataMapper mapper, vtkRenderer renderer) const
	Set field/configure mapper, add scalar bar. More...

void	addGlyphs (const scalar position, const word &scaleFieldName, const word &colourFieldName, const scalar maxGlyphLength, vtkPolyData data, vtkActor actor, vtkRenderer *renderer) const
	Add glyphs. More...

Protected Attributes
const HashPtrTable< DataEntry< vector >, word > &	colours_
	Colours. More...

word	fieldName_
	Field name. More...

colourByType	colourBy_
	Colour by type. More...

colourMapType	colourMap_
	Colour map type. More...

Tuple2< scalar, scalar >	range_
	Range of values. More...

scalarBar	scalarBar_
	Scalar bar. More...

Private Member Functions
	fieldVisualisationBase (const fieldVisualisationBase &)
	Disallow default bitwise copy construct. More...

void	operator= (const fieldVisualisationBase &)
	Disallow default bitwise assignment. More...

Private Attributes
const runTimePostProcessing &	parent_
	Reference to the parent function object. More...

Detailed Description

Source files

Definition at line 65 of file fieldVisualisationBase.H.

Member Enumeration Documentation

◆ colourByType

enum colourByType

Enumerator
cbColour
cbField

Definition at line 71 of file fieldVisualisationBase.H.

◆ colourMapType

enum colourMapType

Enumerator
cmRainbow
cmBlueWhiteRed
cmFire
cmGreyscale

Definition at line 79 of file fieldVisualisationBase.H.

Constructor & Destructor Documentation

◆ fieldVisualisationBase() [1/2]

fieldVisualisationBase ( const fieldVisualisationBase & )

private

Disallow default bitwise copy construct.

◆ fieldVisualisationBase() [2/2]

fieldVisualisationBase	(	const runTimePostProcessing &	parent,
		const dictionary &	dict,
		const HashPtrTable< DataEntry< vector >, word > &	colours
	)

Construct from dictionary.

Definition at line 437 of file fieldVisualisationBase.C.

References dict, dictionary::found(), dictionary::lookup(), ITstream::read(), and dictionary::subDict().

Here is the call graph for this function:

◆ ~fieldVisualisationBase()

~fieldVisualisationBase ( )

virtual

Destructor.

Definition at line 486 of file fieldVisualisationBase.C.

Member Function Documentation

◆ operator=()

void operator= ( const fieldVisualisationBase & )

private

Disallow default bitwise assignment.

◆ setColourMap()

void setColourMap ( vtkLookupTable * lut ) const

protected

Set the colour map.

Definition at line 76 of file fieldVisualisationBase.C.

References Foam::constant::universal::c, fieldVisualisationBase::cmBlueWhiteRed, fieldVisualisationBase::cmFire, fieldVisualisationBase::cmGreyscale, fieldVisualisationBase::cmRainbow, fieldVisualisationBase::colourMap_, and Foam::compressible::New().

Here is the call graph for this function:

◆ addScalarBar()

void addScalarBar	(	const scalar	position,
		vtkRenderer *	renderer,
		vtkLookupTable *	lut
	)		const

protected

Add scalar bar to renderer.

Definition at line 133 of file fieldVisualisationBase.C.

References Foam::compressible::New().

Here is the call graph for this function:

◆ setField()

void setField	(	const scalar	position,
		const word &	colourFieldName,
		vtkPolyDataMapper *	mapper,
		vtkRenderer *	renderer
	)		const

protected

Set field/configure mapper, add scalar bar.

Definition at line 242 of file fieldVisualisationBase.C.

References Foam::compressible::New().

Here is the call graph for this function:

◆ addGlyphs()

void addGlyphs	(	const scalar	position,
		const word &	scaleFieldName,
		const word &	colourFieldName,
		const scalar	maxGlyphLength,
		vtkPolyData *	data,
		vtkActor *	actor,
		vtkRenderer *	renderer
	)		const

protected

Add glyphs.

Definition at line 287 of file fieldVisualisationBase.C.

References Foam::endl(), Foam::compressible::New(), range, setField(), and WarningInFunction.

Here is the call graph for this function:

◆ colours()

const Foam::HashPtrTable< Foam::DataEntry< Foam::vector >, Foam::word > & colours ( ) const

Return the colours.

Definition at line 493 of file fieldVisualisationBase.C.

◆ fieldName()

const Foam::word & fieldName ( ) const

Return the field name.

Definition at line 499 of file fieldVisualisationBase.C.

Field Documentation

◆ colourByTypeNames

const Foam::NamedEnum< Foam::fieldVisualisationBase::colourByType, 2 > colourByTypeNames

static

Definition at line 77 of file fieldVisualisationBase.H.

◆ colourMapTypeNames

const Foam::NamedEnum< Foam::fieldVisualisationBase::colourMapType, 4 > colourMapTypeNames

static

Definition at line 87 of file fieldVisualisationBase.H.

◆ parent_

const runTimePostProcessing& parent_

private

Reference to the parent function object.

Definition at line 95 of file fieldVisualisationBase.H.

◆ colours_

const HashPtrTable<DataEntry<vector>, word>& colours_

protected

Colours.

Definition at line 123 of file fieldVisualisationBase.H.

◆ fieldName_

word fieldName_

protected

Field name.

Definition at line 126 of file fieldVisualisationBase.H.

◆ colourBy_

colourByType colourBy_

protected

Colour by type.

Definition at line 129 of file fieldVisualisationBase.H.

◆ colourMap_

colourMapType colourMap_

protected

Colour map type.

Definition at line 132 of file fieldVisualisationBase.H.

Referenced by fieldVisualisationBase::setColourMap().

◆ range_

Tuple2<scalar, scalar> range_

protected

Range of values.

Definition at line 135 of file fieldVisualisationBase.H.

◆ scalarBar_

scalarBar scalarBar_

protected

Scalar bar.

Definition at line 138 of file fieldVisualisationBase.H.

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

src/postProcessing/functionObjects/graphics/runTimePostProcessing/fieldVisualisationBase.H
src/postProcessing/functionObjects/graphics/runTimePostProcessing/fieldVisualisationBase.C

Data Structures

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ colourByType

◆ colourMapType

Constructor & Destructor Documentation

◆ fieldVisualisationBase() [1/2]

◆ fieldVisualisationBase() [2/2]

◆ ~fieldVisualisationBase()

Member Function Documentation

◆ operator=()

◆ setColourMap()

◆ addScalarBar()

◆ setField()

◆ addGlyphs()

◆ colours()

◆ fieldName()

Field Documentation

◆ colourByTypeNames

◆ colourMapTypeNames

◆ parent_

◆ colours_

◆ fieldName_

◆ colourBy_

◆ colourMap_

◆ range_

◆ scalarBar_