All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
channelIndex Class Reference

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

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...
 
 channelIndex (const channelIndex &)=delete
 Disallow default bitwise copy construction. More...
 
template<class T >
Field< TregionSum (const Field< T > &cellField) const
 Sum field per region. More...
 
template<class T >
Field< Tcollapse (const Field< T > &vsf, const bool asymmetric=false) const
 Collapse a field to a line. More...
 
const scalarFieldy () const
 Return the field of Y locations from the cell centres. More...
 
void operator= (const channelIndex &)
 Disallow default bitwise assignment. More...
 

Detailed Description

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

Source files

Definition at line 51 of file channelIndex.H.

Constructor & Destructor Documentation

◆ channelIndex() [1/3]

channelIndex ( const polyMesh ,
const dictionary  
)

Construct from dictionary.

◆ channelIndex() [2/3]

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

Construct from supplied starting faces.

◆ channelIndex() [3/3]

channelIndex ( const channelIndex )
delete

Disallow default bitwise copy construction.

Member Function Documentation

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

References channelIndex::operator=().

Here is the call graph for this function:

◆ operator=()

void operator= ( const channelIndex )

Disallow default bitwise assignment.

Referenced by channelIndex::y().

Here is the caller graph for this function:

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