channelIndex Class Reference

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

#include <channelIndex.H>

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

Detailed Description

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

Source files

• channelIndex.H
• channelIndex.C

Definition at line 50 of file channelIndex.H.

Constructor & Destructor Documentation

channelIndex() [1/2]

channelIndex	(	const polyMesh &	,
		const dictionary &	)

Construct from dictionary.

channelIndex() [2/2]

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

Construct from supplied starting faces.

References mesh.

Member Function Documentation

regionSum()

template<class T>

Field< T > regionSum

(

const Field< T > &

cellField

)

const

Sum field per region.

collapse()

template<class T>

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 161 of file channelIndex.H.

---

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

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