Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
extendedCellToFaceStencil Class Reference

Calculates/contains the extended cell-to-face stencil. More...

Inheritance diagram for extendedCellToFaceStencil:
Inheritance graph
[legend]
Collaboration diagram for extendedCellToFaceStencil:
Collaboration graph
[legend]

Public Member Functions

 ClassName ("extendedCellToFaceStencil")
 
 extendedCellToFaceStencil (const polyMesh &)
 Construct from mesh. More...
 
template<class Type >
void collectData (const distributionMap &map, const labelListList &stencil, const GeometricField< Type, fvPatchField, volMesh > &fld, List< List< Type >> &stencilFld)
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh > > weightedSum (const distributionMap &map, const labelListList &stencil, const GeometricField< Type, fvPatchField, volMesh > &fld, const List< List< scalar >> &stencilWeights)
 

Static Public Member Functions

template<class T >
static void collectData (const distributionMap &map, const labelListList &stencil, const GeometricField< T, fvPatchField, volMesh > &fld, List< List< T >> &stencilFld)
 Use map to get the data into stencil order. More...
 
template<class Type >
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > weightedSum (const distributionMap &map, const labelListList &stencil, const GeometricField< Type, fvPatchField, volMesh > &fld, const List< List< scalar >> &stencilWeights)
 Sum vol field contributions to create face values. More...
 

Static Protected Member Functions

static void writeStencilStats (Ostream &os, const labelListList &stencil, const distributionMap &map)
 Write some statistics about stencil. More...
 

Protected Attributes

const polyMesh & mesh_
 

Detailed Description

Calculates/contains the extended cell-to-face stencil.

The stencil is a list of indices into either cells or boundary faces in a compact way. (element 0 is owner, 1 is neighbour). The index numbering is

  • cells first
  • then all (non-empty patch) boundary faces

When used in evaluation is a two stage process:

  • collect the data (cell data and non-empty boundaries) into a single field
  • (parallel) distribute the field
  • sum the weights*field.
Source files

Definition at line 65 of file extendedCellToFaceStencil.H.

Constructor & Destructor Documentation

◆ extendedCellToFaceStencil()

extendedCellToFaceStencil ( const polyMesh &  mesh)
explicit

Construct from mesh.

Definition at line 100 of file extendedCellToFaceStencil.C.

References polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, patchIdentifier::name(), patches, patchi, coupledPolyPatch::transform(), and transformer::transformsPosition().

Here is the call graph for this function:

Member Function Documentation

◆ writeStencilStats()

void writeStencilStats ( Ostream &  os,
const labelListList &  stencil,
const distributionMap &  map 
)
staticprotected

Write some statistics about stencil.

Definition at line 42 of file extendedCellToFaceStencil.C.

References Foam::endl(), forAll, Foam::labelMax, Foam::labelMin, Foam::max(), Foam::min(), UPstream::myProcNo(), Foam::nl, Foam::reduce(), Foam::returnReduce(), List< T >::size(), and distributionMapBase::subMap().

Referenced by centredCECCellToFaceStencilObject::centredCECCellToFaceStencilObject(), centredCFCCellToFaceStencilObject::centredCFCCellToFaceStencilObject(), centredCPCCellToFaceStencilObject::centredCPCCellToFaceStencilObject(), centredFECCellToFaceStencilObject::centredFECCellToFaceStencilObject(), pureUpwindCFCCellToFaceStencilObject::pureUpwindCFCCellToFaceStencilObject(), upwindCECCellToFaceStencilObject::upwindCECCellToFaceStencilObject(), upwindCFCCellToFaceStencilObject::upwindCFCCellToFaceStencilObject(), upwindCPCCellToFaceStencilObject::upwindCPCCellToFaceStencilObject(), and upwindFECCellToFaceStencilObject::upwindFECCellToFaceStencilObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ClassName()

ClassName ( "extendedCellToFaceStencil"  )

◆ collectData() [1/2]

static void collectData ( const distributionMap &  map,
const labelListList &  stencil,
const GeometricField< T, fvPatchField, volMesh > &  fld,
List< List< T >> &  stencilFld 
)
static

Use map to get the data into stencil order.

Referenced by extendedCentredCellToFaceStencil::collectData(), extendedCentredCellToCellStencil::collectData(), and extendedUpwindCellToFaceStencil::extendedUpwindCellToFaceStencil().

Here is the caller graph for this function:

◆ weightedSum() [1/2]

static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > weightedSum ( const distributionMap &  map,
const labelListList &  stencil,
const GeometricField< Type, fvPatchField, volMesh > &  fld,
const List< List< scalar >> &  stencilWeights 
)
static

Sum vol field contributions to create face values.

Referenced by extendedCellToFaceStencil::collectData(), and extendedCentredCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

◆ collectData() [2/2]

void collectData ( const distributionMap &  map,
const labelListList &  stencil,
const GeometricField< Type, fvPatchField, volMesh > &  fld,
List< List< Type >> &  stencilFld 
)

Definition at line 32 of file extendedCellToFaceStencilTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), distributionMapBase::constructSize(), distributionMap::distribute(), forAll, DimensionedField< Type, GeoMesh >::mesh(), fvPatchField< Type >::patch(), patchi, List< T >::setSize(), List< T >::size(), extendedCellToFaceStencil::weightedSum(), and Foam::Zero.

Here is the call graph for this function:

◆ weightedSum() [2/2]

Foam::tmp<Foam::GeometricField<Type, Foam::fvsPatchField, Foam::surfaceMesh> > weightedSum ( const distributionMap &  map,
const labelListList &  stencil,
const GeometricField< Type, fvPatchField, volMesh > &  fld,
const List< List< scalar >> &  stencilWeights 
)

Definition at line 86 of file extendedCellToFaceStencilTemplates.C.

References fvsPatchField< Type >::coupled(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, mesh, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), primitiveMesh::nInternalFaces(), fvsPatchField< Type >::patch(), patchi, sf(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const polyMesh& mesh_
protected

Definition at line 71 of file extendedCellToFaceStencil.H.

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