channelIndex Class Reference

Does averaging of fields over layers of cells. Assumes layered mesh. More...

Collaboration diagram for channelIndex:

Public Member Functions
	channelIndex (const polyMesh &, const dictionary &)
	Construct from dictionary. More...
	channelIndex (const polyMesh &mesh, const labelList &startFaces, const bool symmetric, const direction dir)
	Construct from supplied starting faces. More...
template<class T >
Field< T >	regionSum (const Field< T > &cellField) const
	Sum field per region. More...
template<class T >
Field< T >	collapse (const Field< T > &vsf, const bool asymmetric=false) const
	Collapse a field to a line. More...
const scalarField &	y () const
	Return the field of Y locations from the cell centres. More...

Private Member Functions
void	walkOppositeFaces (const polyMesh &mesh, const labelList &startFaces, boolList &blockedFace)
void	calcLayeredRegions (const polyMesh &mesh, const labelList &startFaces)
	channelIndex (const channelIndex &)
	Disallow default bitwise copy construct and assignment. More...
void	operator= (const channelIndex &)

Private Attributes
const bool	symmetric_
	Is mesh symmetric. More...
const direction	dir_
	Direction to sort. More...
autoPtr< regionSplit >	cellRegion_
	Per cell the global region. More...
scalarField	regionCount_
	Per global region the number of cells (scalarField so we can use. More...
labelList	sortMap_
	From sorted region back to unsorted global region. More...
scalarField	y_
	Sorted component of cell centres. More...

Static Private Attributes
static const NamedEnum< vector::components, 3 >	vectorComponentsNames_

Detailed Description

Does averaging of fields over layers of cells. Assumes layered mesh.

Source files

• channelIndex.H
• channelIndex.C

Definition at line 52 of file channelIndex.H.

Constructor & Destructor Documentation

channelIndex() [1/3]

channelIndex ( const channelIndex &  )

private

Disallow default bitwise copy construct and assignment.

channelIndex() [2/3]

channelIndex	(	const polyMesh &	,
		const dictionary &
	)

Construct from dictionary.

channelIndex() [3/3]

channelIndex	(	const polyMesh &	mesh,
		const labelList &	startFaces,
		const bool	symmetric,
		const direction	dir
	)

Construct from supplied starting faces.

Member Function Documentation

walkOppositeFaces()

void walkOppositeFaces ( const polyMesh &  mesh, const labelList &  startFaces, boolList &  blockedFace  )

private

calcLayeredRegions()

void calcLayeredRegions ( const polyMesh &  mesh, const labelList &  startFaces  )

private

operator=()

void operator= ( const channelIndex &  )

private

regionSum()

Field<T> regionSum

(

const Field< T > &

cellField

)

const

Sum field per region.

collapse()

Field<T> collapse	(	const Field< T > &	vsf,
		const bool	asymmetric = false
	)		const

Collapse a field to a line.

y()

const scalarField& y ( ) const

inline

Return the field of Y locations from the cell centres.

Definition at line 134 of file channelIndex.H.

References channelIndex::y_.

Field Documentation

vectorComponentsNames_

const NamedEnum<vector::components, 3> vectorComponentsNames_

staticprivate

Definition at line 57 of file channelIndex.H.

symmetric_

const bool symmetric_

private

Is mesh symmetric.

Definition at line 60 of file channelIndex.H.

dir_

const direction dir_

private

Direction to sort.

Definition at line 63 of file channelIndex.H.

cellRegion_

autoPtr<regionSplit> cellRegion_

private

Per cell the global region.

Definition at line 66 of file channelIndex.H.

regionCount_

scalarField regionCount_

private

Per global region the number of cells (scalarField so we can use.

field algebra)

Definition at line 70 of file channelIndex.H.

sortMap_

labelList sortMap_

private

From sorted region back to unsorted global region.

Definition at line 73 of file channelIndex.H.

y_

scalarField y_

private

Sorted component of cell centres.

Definition at line 76 of file channelIndex.H.

Referenced by channelIndex::y().

---

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

• applications/utilities/postProcessing/miscellaneous/postChannel/channelIndex.H