FreeFOAM The Cross-Platform CFD Toolkit
channelIndex Class Reference

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


Detailed Description

List of all members.

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< TregionSum (const Field< T > &cellField) const
 Sum field per region.
template<class T >
Field< Tcollapse (const Field< T > &vsf, const bool asymmetric=false) const
 collapse a field to a line
const scalarFieldy () const
 return the field of Y locations from the cell centres

Constructor & Destructor Documentation

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.


Member Function Documentation

Field<T> regionSum ( const Field< T > &  cellField) const

Sum field per region.

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

collapse a field to a line

const scalarField& y ( ) const
inline

return the field of Y locations from the cell centres

Definition at line 135 of file channelIndex.H.


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