fieldVisualisationBase::fieldSummary Struct Reference

General field characteristics. More...

Collaboration diagram for fieldVisualisationBase::fieldSummary:

Public Member Functions
	fieldSummary ()
	Construct null. More...
void	reduce ()
	Parallel reduction. A no-op if Pstream::parRun() is false. More...
bool	isScalar () const
	True if nComponents_ == 1. More...
bool	isVector () const
	True if nComponents_ == 3. More...
bool	exists () const
	True if association_ is non-zero. More...
bool	hasPointData () const
	True if there is a POINT_DATA association. More...
InfoProxy< fieldSummary >	info () const

Public Attributes
int	nComponents_
unsigned	association_
scalarMinMax	range_

Detailed Description

General field characteristics.

For convenience, the interface is exposed but external use is highly discouraged.

Definition at line 172 of file fieldVisualisationBase.H.

Constructor & Destructor Documentation

fieldSummary()

fieldSummary ( )

inline

Construct null.

Definition at line 179 of file fieldVisualisationBase.H.

Member Function Documentation

reduce()

void reduce

(

)

Parallel reduction. A no-op if Pstream::parRun() is false.

Definition at line 363 of file fieldVisualisationBase.C.

References UPstream::parRun(), fieldVisualisationBase::range_, and Foam::reduce().

Referenced by contourFilter::addGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

isScalar()

bool isScalar ( ) const

inline

True if nComponents_ == 1.

Definition at line 190 of file fieldVisualisationBase.H.

References fieldVisualisationBase::fieldSummary::nComponents_.

Referenced by fieldVisualisationBase::addGlyphs().

Here is the caller graph for this function:

isVector()

bool isVector ( ) const

inline

True if nComponents_ == 3.

Definition at line 196 of file fieldVisualisationBase.H.

References fieldVisualisationBase::fieldSummary::nComponents_.

Referenced by fieldVisualisationBase::addGlyphs().

Here is the caller graph for this function:

exists()

bool exists ( ) const

inline

True if association_ is non-zero.

Definition at line 202 of file fieldVisualisationBase.H.

References fieldVisualisationBase::fieldSummary::association_.

Referenced by fieldVisualisationBase::addGlyphs().

Here is the caller graph for this function:

hasPointData()

bool hasPointData ( ) const

inline

True if there is a POINT_DATA association.

Definition at line 208 of file fieldVisualisationBase.H.

References fieldVisualisationBase::fieldSummary::association_, and Foam::expressions::patchExpr::POINT_DATA.

Referenced by contourFilter::addGeometry(), and fieldVisualisationBase::addGlyphs().

Here is the caller graph for this function:

info()

InfoProxy<fieldSummary> info ( ) const

inline

Definition at line 213 of file fieldVisualisationBase.H.

Referenced by contourFilter::addGeometry(), and functionObjectCloud::addGeometryFromFile().

Here is the caller graph for this function:

Member Data Documentation

nComponents_

int nComponents_

Definition at line 174 of file fieldVisualisationBase.H.

Referenced by fieldVisualisationBase::addGlyphs(), fieldVisualisationBase::fieldSummary::isScalar(), fieldVisualisationBase::fieldSummary::isVector(), and fieldVisualisationBase::queryFieldSummary().

association_

unsigned association_

Definition at line 175 of file fieldVisualisationBase.H.

Referenced by fieldVisualisationBase::fieldSummary::exists(), fieldVisualisationBase::fieldSummary::hasPointData(), and fieldVisualisationBase::queryFieldSummary().

range_

scalarMinMax range_

Definition at line 176 of file fieldVisualisationBase.H.

Referenced by fieldVisualisationBase::addGlyphs(), and fieldVisualisationBase::queryFieldSummary().

---

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

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