Inheritance diagram for functionObjectSurface:

Collaboration diagram for functionObjectSurface:

[legend]

Public Member Functions
	TypeName ("functionObject")
	Run-time type information. More...

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

virtual	~functionObjectSurface ()
	Destructor. More...

virtual void	addGeometryToScene (const scalar position, vtkRenderer *renderer)
	Add surface(s) to scene. More...

Public Member Functions inherited from geometrySurface
	TypeName ("geometry")
	Run-time type information. More...

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

	geometrySurface (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours, const List< fileName > &fileNames)
	Construct from components. More...

virtual	~geometrySurface ()
	Destructor. More...

virtual void	updateActors (const scalar position)
	Update actors. More...

Public Member Functions inherited from surface
	TypeName ("surface")
	Run-time type information. More...

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

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

virtual	~surface ()
	Destructor. More...

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

virtual	~geometryBase ()
	Destructor. More...

const runTimePostProcessing &	parent () const
	Return the reference to the parent function object. More...

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

bool	visible () const
	Return the visible flag. More...

scalar	opacity (const scalar position) const
	Return the opacity. More...

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

Public Member Functions inherited from fieldVisualisationBase
	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...

Protected Attributes
word	functionObject_
	Name of function object result to render. More...

Protected Attributes inherited from geometrySurface
List< fileName >	fileNames_
	File names. More...

Protected Attributes inherited from surface
representationType	representation_
	Representation type. More...

bool	featureEdges_
	Activate feature edges. More...

autoPtr< DataEntry< vector > >	surfaceColour_
	Surface colour. More...

autoPtr< DataEntry< vector > >	edgeColour_
	Edge colour. More...

vtkSmartPointer< vtkActor >	surfaceActor_
	Surface actor. More...

vtkSmartPointer< vtkActor >	edgeActor_
	Edge actor. More...

scalar	maxGlyphLength_
	Max glyph length for representation type rtGlyph. More...

Protected Attributes inherited from geometryBase
const runTimePostProcessing &	parent_
	Reference to the parent function object. More...

word	name_
	Name. More...

bool	visible_
	Visible flag. More...

renderModeType	renderMode_
	Render mode. More...

autoPtr< DataEntry< scalar > >	opacity_
	Opacity. More...

const HashPtrTable< DataEntry< vector >, word > &	colours_
	Reference to the colours. More...

Protected Attributes inherited from fieldVisualisationBase
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
	functionObjectSurface (const functionObjectSurface &)
	Disallow default bitwise copy construct. More...

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

Additional Inherited Members
Public Types inherited from surface
enum	representationType { rtNone, rtWireframe, rtSurface, rtSurfaceWithEdges, rtGlyph }

Public Types inherited from geometryBase
enum	renderModeType { rmFlat, rmGouraud, rmPhong }

Public Types inherited from fieldVisualisationBase
enum	colourByType { cbColour, cbField }

enum	colourMapType { cmRainbow, cmBlueWhiteRed, cmFire, cmGreyscale }

Static Public Member Functions inherited from surface
static autoPtr< surface >	New (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours, const word &surfaceName)
	Return a reference to the selected RAS model. More...

Static Public Attributes inherited from surface
static const NamedEnum< representationType, 5 >	representationTypeNames

Static Public Attributes inherited from geometryBase
static const NamedEnum< renderModeType, 3 >	renderModeTypeNames

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

static const NamedEnum< colourMapType, 4 >	colourMapTypeNames

Protected Member Functions inherited from geometrySurface
void	addGeometryToScene (const scalar position, vtkRenderer *renderer, const fileName &fName) const
	Add surface (file) to scene. More...

Protected Member Functions inherited from surface
void	setRepresentation (vtkActor *actor) const
	Set the representation. More...

void	addFeatureEdges (vtkRenderer renderer, vtkPolyData data) const
	Add feature edges to scene. More...

Protected Member Functions inherited from geometryBase
void	initialiseActor (vtkActor *actor) const
	Initialse actor. More...

Protected Member Functions inherited from fieldVisualisationBase
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...

Detailed Description

Source files

Definition at line 48 of file functionObjectSurface.H.

Constructor & Destructor Documentation

◆ functionObjectSurface() [1/2]

functionObjectSurface ( const functionObjectSurface & )

private

Disallow default bitwise copy construct.

◆ functionObjectSurface() [2/2]

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

Construct from dictionary.

Definition at line 51 of file functionObjectSurface.C.

References dict.

◆ ~functionObjectSurface()

~functionObjectSurface ( )

virtual

Destructor.

Definition at line 70 of file functionObjectSurface.C.

Member Function Documentation

◆ operator=()

void operator= ( const functionObjectSurface & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "functionObject" )

Run-time type information.

◆ addGeometryToScene()

void addGeometryToScene	(	const scalar	position,
		vtkRenderer *	renderer
	)

virtual

Add surface(s) to scene.

Reimplemented from geometrySurface.

Definition at line 77 of file functionObjectSurface.C.

References geometrySurface::addGeometryToScene(), dict, Foam::endl(), fileName::ext(), functionObjectState::getObjectProperty(), Foam::compressible::New(), dictionary::null, geometryBase::parent_, dictionary::readIfPresent(), setField(), and WarningInFunction.

Here is the call graph for this function:

Field Documentation

◆ functionObject_

word functionObject_

protected

Name of function object result to render.

Definition at line 71 of file functionObjectSurface.H.

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members