Detailed Description

template<typename field_t>
class walberla::gui::ScalarField3DisplayAdaptor< field_t >

Class for drawing slices of vector fields.

#include <ScalarField3DisplayAdaptor.h>

Inheritance diagram for walberla::gui::ScalarField3DisplayAdaptor< field_t >:

Public Types
typedef field_t::value_type	T

typedef FieldDisplayAdaptor< field_t >	base_t

typedef real_t	length_t

Public Member Functions
	ScalarField3DisplayAdaptor (ConstBlockDataID vectorFieldID)

	~ScalarField3DisplayAdaptor ()

virtual void	addConfigurationItem (QTreeWidgetItem *parentItem)
	Optionally adds a QTreeWidgetItem to a tree, containing configuration options. More...

virtual void	draw (QVector< QVector< CellView * > > &grid, int nrOfGhostLayers)
	Draws data structure represented by this Adaptor to a grid of cells Block has to be set first! More...

void	configure (const IBlock *block, int sliceDim, cell_idx_t sliceValue, Vector3< uint_t > &innerSize, cell_idx_t &ghostLayers)
	Configures the DisplayAdaptor by passing in a block and slice information. More...

Public Member Functions inherited from walberla::gui::FieldDisplayAdaptor< field_t >
	FieldDisplayAdaptor (ConstBlockDataID fieldId)

Protected Member Functions
void	drawVectorFieldNumeric (CellView *cell, const typename field_t::const_iterator &it)

void	drawVectorFieldColormap (CellView *cell, const typename field_t::const_iterator &it, length_t min, length_t max)

void	drawVectorFieldArrow (CellView *cell, const typename field_t::const_iterator &it, length_t max)

Protected Member Functions inherited from walberla::gui::FieldDisplayAdaptor< field_t >
Cell	permuteCoordAccordingToSlice (Cell input, int sliceCoord)

void	getFieldSizeInfo (CellInterval &ciOut, cell_idx_t &ghostLayerOut)

Protected Attributes
DisplayPropertiesItem *	displayProperties_

ConstBlockDataID	blockDataId_

cell_idx_t	sliceDim_

CellInterval	sliceInterval_

const field_t *	field_

Protected Attributes inherited from walberla::gui::FieldDisplayAdaptor< field_t >
const field_t *	field_

CellInterval	sliceInterval_

cell_idx_t	sliceDim_

ConstBlockDataID	blockDataId_

Additional Inherited Members
Signals inherited from walberla::gui::DisplayAdaptor
void	requestRedraw ()
	This signal requests a redraw, for example after a configuration change. More...

Member Typedef Documentation

◆ base_t

template<typename field_t >

typedef FieldDisplayAdaptor< field_t > walberla::gui::ScalarField3DisplayAdaptor< field_t >::base_t

◆ length_t

template<typename field_t >

typedef real_t walberla::gui::ScalarField3DisplayAdaptor< field_t >::length_t

◆ T

template<typename field_t >

typedef field_t::value_type walberla::gui::ScalarField3DisplayAdaptor< field_t >::T

Constructor & Destructor Documentation

◆ ScalarField3DisplayAdaptor()

template<typename field_t >

walberla::gui::ScalarField3DisplayAdaptor< field_t >::ScalarField3DisplayAdaptor ( ConstBlockDataID vectorFieldID )

◆ ~ScalarField3DisplayAdaptor()

template<typename field_t >

walberla::gui::ScalarField3DisplayAdaptor< field_t >::~ScalarField3DisplayAdaptor

Member Function Documentation

◆ addConfigurationItem()

template<typename field_t >

void walberla::gui::ScalarField3DisplayAdaptor< field_t >::addConfigurationItem ( QTreeWidgetItem * )

virtual

Optionally adds a QTreeWidgetItem to a tree, containing configuration options.

Reimplemented from walberla::gui::DisplayAdaptor.

◆ configure()

template<typename field_t >

void walberla::gui::ScalarField3DisplayAdaptor< field_t >::configure	(	const IBlock *	block,
		int	sliceDim,
		cell_idx_t	sliceValue,
		Vector3< uint_t > &	innerSize,
		cell_idx_t &	ghostLayers
	)

virtual

Configures the DisplayAdaptor by passing in a block and slice information.

Parameters

[in]	block	the block that should be displayed
[in]	sliceDim	The coordinate value of this dimension is kept constant. Defines the slice direction 0 means x, 1 means y, 2 means z
[in]	sliceValue	The fixed value of the sliceDim coordinate. If the value is not in the allowed range nothing is displayed
[out]	innerSize	size of the field, without ghost layer. innerSize[0] is the horizontal extent and will be the first coordinate in the grid array of draw() innerSize[1] is the vertical extend and will be the second coordinate in the grid array innerSize[2] is used for limiting the allowed sliceValues
[out]	ghostLayers	number of ghost layers for all three dimensions of innerSize

Reimplemented from walberla::gui::FieldDisplayAdaptor< field_t >.

◆ draw()

template<typename field_t >

void walberla::gui::ScalarField3DisplayAdaptor< field_t >::draw	(	QVector< QVector< CellView * > > &	grid,
		int	nrOfGhostLayers
	)

virtual

Draws data structure represented by this Adaptor to a grid of cells Block has to be set first!

Parameters

[in,out]	grid	Grid of cells. Use functions of CellView to draw The Grid has dimension of innerSize + ghostLayers
[in]	nrOfGhostLayers	the number of ghost layers in each direction. This value may be bigger than the returned value of configure() since other fields might have more ghost layers. The cell at grid[0][0] lies at the outermost ghost layer

Implements walberla::gui::DisplayAdaptor.

◆ drawVectorFieldArrow()

template<typename field_t >

void walberla::gui::ScalarField3DisplayAdaptor< field_t >::drawVectorFieldArrow	(	CellView *	cell,
		const typename field_t::const_iterator &	it,
		length_t	max
	)

protected

◆ drawVectorFieldColormap()

template<typename field_t >

void walberla::gui::ScalarField3DisplayAdaptor< field_t >::drawVectorFieldColormap	(	CellView *	cell,
		const typename field_t::const_iterator &	it,
		length_t	min,
		length_t	max
	)

protected

◆ drawVectorFieldNumeric()

template<typename field_t >

void walberla::gui::ScalarField3DisplayAdaptor< field_t >::drawVectorFieldNumeric	(	CellView *	cell,
		const typename field_t::const_iterator &	it
	)

protected

Member Data Documentation

◆ blockDataId_

template<typename field_t >

ConstBlockDataID walberla::gui::FieldDisplayAdaptor< field_t >::blockDataId_

protected

◆ displayProperties_

template<typename field_t >

DisplayPropertiesItem* walberla::gui::ScalarField3DisplayAdaptor< field_t >::displayProperties_

protected

◆ field_

template<typename field_t >

const field_t* walberla::gui::FieldDisplayAdaptor< field_t >::field_

protected

◆ sliceDim_

template<typename field_t >

cell_idx_t walberla::gui::FieldDisplayAdaptor< field_t >::sliceDim_

protected

◆ sliceInterval_

template<typename field_t >

CellInterval walberla::gui::FieldDisplayAdaptor< field_t >::sliceInterval_

protected

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

/builds/administration/walberla-website/walberla/src/gui/BlockSliceView/ScalarField3DisplayAdaptor.h
/builds/administration/walberla-website/walberla/src/gui/BlockSliceView/ScalarField3DisplayAdaptor.impl.h

Detailed Description

template<typename field_t> class walberla::gui::ScalarField3DisplayAdaptor< field_t >

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ base_t

◆ length_t

◆ T

Constructor & Destructor Documentation

◆ ScalarField3DisplayAdaptor()

◆ ~ScalarField3DisplayAdaptor()

Member Function Documentation

◆ addConfigurationItem()

◆ configure()

◆ draw()

◆ drawVectorFieldArrow()

◆ drawVectorFieldColormap()

◆ drawVectorFieldNumeric()

Member Data Documentation

◆ blockDataId_

◆ displayProperties_

◆ field_

◆ sliceDim_

◆ sliceInterval_

template<typename field_t>
class walberla::gui::ScalarField3DisplayAdaptor< field_t >