FreeFOAM The Cross-Platform CFD Toolkit
extendedUpwindCellToFaceStencil Class Reference

Creates upwind stencil by shifting a centred stencil to upwind and downwind faces and optionally removing all non-(up/down)wind faces ('pureUpwind'). More...

#include <finiteVolume/extendedUpwindCellToFaceStencil.H>


Detailed Description

Creates upwind stencil by shifting a centred stencil to upwind and downwind faces and optionally removing all non-(up/down)wind faces ('pureUpwind').

Note: the minOpposedness parameter is to decide which upwind and downwind faces to combine the stencils from. If myArea is the local area and upwindArea the area of the possible upwind candidate it will be included if (upwindArea & myArea)/magSqr(myArea) > minOpposedness so this includes both cosine and area. WIP.

Source files

Definition at line 60 of file extendedUpwindCellToFaceStencil.H.

+ Inheritance diagram for extendedUpwindCellToFaceStencil:
+ Collaboration diagram for extendedUpwindCellToFaceStencil:

List of all members.

Public Member Functions

 extendedUpwindCellToFaceStencil (const cellToFaceStencil &, const bool pureUpwind, const scalar minOpposedness)
 Construct from mesh and uncompacted centred face stencil.
 extendedUpwindCellToFaceStencil (const cellToFaceStencil &)
 Construct from mesh and uncompacted centred face stencil. Splits.
bool pureUpwind () const
const mapDistributeownMap () const
 Return reference to the parallel distribution map.
const mapDistributeneiMap () const
 Return reference to the parallel distribution map.
const labelListListownStencil () const
 Return reference to the stencil.
const labelListListneiStencil () const
 Return reference to the stencil.
template<class Type >
tmp< GeometricField< Type,
fvsPatchField, surfaceMesh > > 
weightedSum (const surfaceScalarField &phi, const GeometricField< Type, fvPatchField, volMesh > &fld, const List< List< scalar > > &ownWeights, const List< List< scalar > > &neiWeights) const
 Sum vol field contributions to create face values.
- Public Member Functions inherited from extendedCellToFaceStencil
 ClassName ("extendedCellToFaceStencil")
 extendedCellToFaceStencil (const polyMesh &)
 Construct from mesh.
template<class Type >
void collectData (const mapDistribute &map, const labelListList &stencil, const GeometricField< Type, fvPatchField, volMesh > &fld, List< List< Type > > &stencilFld)

Additional Inherited Members

- Static Public Member Functions inherited from extendedCellToFaceStencil
static autoPtr< mapDistributecalcDistributeMap (const polyMesh &mesh, const globalIndex &globalNumbering, labelListList &faceStencil)
 Calculate distribute map.
template<class T >
static void collectData (const mapDistribute &map, const labelListList &stencil, const GeometricField< T, fvPatchField, volMesh > &fld, List< List< T > > &stencilFld)
 Use map to get the data into stencil order.
template<class Type >
static tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
weightedSum (const mapDistribute &map, const labelListList &stencil, const GeometricField< Type, fvPatchField, volMesh > &fld, const List< List< scalar > > &stencilWeights)
 Sum vol field contributions to create face values.
- Static Protected Member Functions inherited from extendedCellToFaceStencil
static void writeStencilStats (Ostream &os, const labelListList &stencil, const mapDistribute &map)
 Write some statistics about stencil.
- Protected Attributes inherited from extendedCellToFaceStencil
const polyMeshmesh_

Constructor & Destructor Documentation

extendedUpwindCellToFaceStencil ( const cellToFaceStencil stencil,
const bool  pureUpwind,
const scalar  minOpposedness 
)

Construct from mesh and uncompacted centred face stencil.

Transports facestencil to create owner and neighbour versions. pureUpwind to remove any remaining downwind cells.

Definition at line 375 of file extendedUpwindCellToFaceStencil.C.

References fvMesh::C(), primitiveMesh::faceAreas(), primitiveMesh::faceCentres(), forAll, cellToFaceStencil::globalNumbering(), mesh, cellToFaceStencil::mesh(), points, and List< T >::size().

Construct from mesh and uncompacted centred face stencil. Splits.

stencil into owner and neighbour (so always pure upwind)

Definition at line 506 of file extendedUpwindCellToFaceStencil.C.

References forAll, cellToFaceStencil::globalNumbering(), mesh, cellToFaceStencil::mesh(), points, List< T >::setSize(), and List< T >::size().


Member Function Documentation

bool pureUpwind ( ) const
inline

Definition at line 147 of file extendedUpwindCellToFaceStencil.H.

const mapDistribute& neiMap ( ) const
inline

Return reference to the parallel distribution map.

Definition at line 159 of file extendedUpwindCellToFaceStencil.H.

const labelListList& neiStencil ( ) const
inline

Return reference to the stencil.

Definition at line 171 of file extendedUpwindCellToFaceStencil.H.


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