inverseDistance Class Reference

Inverse-distance-weighted interpolation stencil. More...

Inheritance diagram for inverseDistance:
[legend]
Collaboration diagram for inverseDistance:
[legend]

Public Member Functions

 TypeName ("inverseDistance")
 Runtime type information. More...
 
 inverseDistance (const fvMesh &, const dictionary &, const bool)
 Construct from fvMesh. More...
 
virtual ~inverseDistance ()
 Destructor. More...
 
virtual bool update ()
 Update stencils. Return false if nothing changed. More...
 
virtual const labelUListcellTypes () const
 Return the cell type list. More...
 
virtual const labelUListinterpolationCells () const
 Indices of interpolated cells. More...
 
virtual const mapDistributecellInterpolationMap () const
 Return a communication schedule. More...
 
virtual const labelListListcellStencil () const
 Per interpolated cell the neighbour cells (in terms of slots as. More...
 
virtual const scalarListListcellInterpolationWeights () const
 Weights for cellStencil. More...
 
virtual const scalarListcellInterpolationWeight () const
 Per interpolated cell the interpolation factor. (0 = use. More...
 
virtual void stencilWeights (const point &sample, const pointList &donorCcs, scalarList &weights) const
 Calculate inverse distance weights for a single acceptor. More...
 
- Public Member Functions inherited from cellCellStencil
 TypeName ("cellCellStencil")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, cellCellStencil, mesh,(const fvMesh &mesh, const dictionary &dict, const bool update),(mesh, dict, update))
 
 cellCellStencil (const fvMesh &)
 Construct from fvMesh. More...
 
virtual ~cellCellStencil ()
 Destructor. More...
 
virtual const wordHashSetnonInterpolatedFields () const
 Return the names of any (stencil or mesh specific) fields that. More...
 
virtual wordHashSetnonInterpolatedFields ()
 Return non-const non-interpolating fields. More...
 
bool localStencil (const labelUList &) const
 Helper: is stencil fully local. More...
 
const labelIOListzoneID () const
 Helper: get reference to registered zoneID. Loads volScalarField. More...
 
template<class Type >
Foam::tmp< Foam::volScalarFieldcreateField (const fvMesh &mesh, const word &name, const UList< Type > &psi)
 

Protected Member Functions

void markPatchesAsHoles (PstreamBuffers &pBufs, const PtrList< fvMeshSubset > &meshParts, const List< treeBoundBoxList > &patchBb, const List< labelVector > &patchDivisions, const PtrList< PackedList< 2 >> &patchParts, const label srcI, const label tgtI, labelList &allCellTypes) const
 Mark all cells overlapping (a voxel covered by) a src patch. More...
 
bool betterDonor (const label destMesh, const label currentDonorMesh, const label newDonorMesh) const
 If multiple donors meshes: decide which is best. More...
 
void markDonors (const globalIndex &globalCells, PstreamBuffers &pBufs, const PtrList< fvMeshSubset > &meshParts, const List< treeBoundBoxList > &meshBb, const labelList &allCellTypes, const label srcI, const label tgtI, labelListList &allStencil, labelList &allDonor) const
 Determine donors for all tgt cells. More...
 
void uncompactedRegionSplit (const fvMesh &mesh, const globalIndex &globalFaces, const label nZones, const labelList &zoneID, const labelList &cellTypes, const boolList &isBlockedFace, labelList &cellRegion) const
 Replacement of regionSplit. More...
 
autoPtr< globalIndexcompactedRegionSplit (const fvMesh &mesh, const globalIndex &globalFaces, labelList &cellRegion) const
 
void findHoles (const globalIndex &globalCells, const fvMesh &mesh, const labelList &zoneID, const labelListList &stencil, labelList &cellTypes) const
 Do flood filling to detect unreachable (from patches) sections. More...
 
void seedCell (const label cellI, const scalar wantedFraction, bitSet &isFront, scalarField &fraction) const
 Seed faces of cell with wantedFraction (if higher than current) More...
 
void walkFront (const scalar layerRelax, const labelListList &allStencil, labelList &allCellTypes, scalarField &allWeight) const
 Surround holes with layer(s) of interpolated cells. More...
 
virtual void createStencil (const globalIndex &)
 Create stencil starting from the donor containing the acceptor. More...
 

Static Protected Member Functions

static label index (const labelVector &nDivs, const labelVector &)
 Convert ijk indices into single index. More...
 
static labelVector index3 (const labelVector &nDivs, const label)
 Convert single index into ijk. More...
 
static labelVector index3 (const boundBox &bb, const labelVector &nDivs, const point &pt)
 Convert coordinate into ijk. More...
 
static point position (const boundBox &bb, const labelVector &nDivs, const label boxI)
 Convert index back into coordinate. More...
 
static void fill (PackedList< 2 > &elems, const boundBox &bb, const labelVector &nDivs, const boundBox &subBb, const unsigned int val)
 Fill all elements overlapping subBb with value val. More...
 
static bool overlaps (const boundBox &bb, const labelVector &nDivs, const PackedList< 2 > &voxels, const treeBoundBox &subBb, const unsigned int val)
 Is any voxel inside subBb set to val. More...
 
static void markBoundaries (const fvMesh &mesh, const vector &smallVec, const boundBox &bb, const labelVector &nDivs, PackedList< 2 > &patchTypes, const labelList &cellMap, labelList &patchCellTypes)
 Mark voxels of patchTypes with type of patch face. More...
 
static treeBoundBox cellBb (const primitiveMesh &mesh, const label celli)
 Calculate bounding box of cell. More...
 
- Static Protected Member Functions inherited from cellCellStencil
static labelList count (const label size, const labelUList &lst)
 Count occurrences (in parallel) More...
 
template<class Type >
static tmp< volScalarFieldcreateField (const fvMesh &mesh, const word &name, const UList< Type > &)
 Helper: create volScalarField for postprocessing. More...
 

Protected Attributes

const dictionary dict_
 Dictionary of motion control parameters. More...
 
vector smallVec_
 Small perturbation vector for geometric tests. More...
 
labelList cellTypes_
 Per cell the cell type. More...
 
labelList interpolationCells_
 Indices of interpolated cells. More...
 
autoPtr< mapDistributecellInterpolationMap_
 Fetch interpolated cells. More...
 
labelListList cellStencil_
 Interpolation stencil. More...
 
scalarListList cellInterpolationWeights_
 Interpolation weights. More...
 
volScalarField cellInterpolationWeight_
 Amount of interpolation. More...
 
- Protected Attributes inherited from cellCellStencil
const fvMeshmesh_
 Reference to the mesh. More...
 
wordHashSet nonInterpolatedFields_
 Set of fields that should not be interpolated. More...
 

Additional Inherited Members

- Public Types inherited from cellCellStencil
enum  patchCellType { OTHER = 0, PATCH = 1, OVERSET = 2 }
 
enum  cellType { CALCULATED = 0, INTERPOLATED = 1, HOLE = 2 }
 
- Static Public Member Functions inherited from cellCellStencil
static autoPtr< cellCellStencilNew (const fvMesh &, const dictionary &dict, const bool update=true)
 New function which constructs and returns pointer to a. More...
 
static const labelIOListzoneID (const fvMesh &)
 Helper: get reference to registered zoneID. Loads volScalarField. More...
 
static void globalCellCells (const globalIndex &gi, const polyMesh &mesh, const boolList &isValidDonor, const labelList &selectedCells, labelListList &cellCells, pointListList &cellCellCentres)
 Helper: create cell-cell addressing in global numbering. More...
 
- Static Protected Attributes inherited from cellCellStencil
static const Enum< cellTypecellTypeNames_
 Mode type names. More...
 

Detailed Description

Inverse-distance-weighted interpolation stencil.

hole finding:

  • mark boundary faces on helper (voxel) mesh
  • mark any cell overlaying these voxels
  • use flood filling to find any unreachable cell Alternative is to use an octree of the boundary faces and determine directly for all cells whether we are outside. Might be slow though.
Source files

Definition at line 67 of file inverseDistanceCellCellStencil.H.

Constructor & Destructor Documentation

◆ inverseDistance()

inverseDistance ( const fvMesh mesh,
const dictionary dict,
const bool  doUpdate 
)

Construct from fvMesh.

Definition at line 1656 of file inverseDistanceCellCellStencil.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Pout, update(), and zoneID.

Here is the call graph for this function:

◆ ~inverseDistance()

~inverseDistance ( )
virtual

Destructor.

Definition at line 1736 of file inverseDistanceCellCellStencil.C.

Member Function Documentation

◆ index()

Foam::label index ( const labelVector nDivs,
const labelVector ijk 
)
staticprotected

Convert ijk indices into single index.

Definition at line 60 of file inverseDistanceCellCellStencil.C.

◆ index3() [1/2]

Foam::labelVector index3 ( const labelVector nDivs,
const label  boxI 
)
staticprotected

Convert single index into ijk.

Definition at line 70 of file inverseDistanceCellCellStencil.C.

References k.

◆ index3() [2/2]

Foam::labelVector index3 ( const boundBox bb,
const labelVector nDivs,
const point pt 
)
staticprotected

Convert coordinate into ijk.

Definition at line 85 of file inverseDistanceCellCellStencil.C.

References boundBox::min(), and boundBox::span().

Here is the call graph for this function:

◆ position()

Foam::point position ( const boundBox bb,
const labelVector nDivs,
const label  boxI 
)
staticprotected

Convert index back into coordinate.

Definition at line 104 of file inverseDistanceCellCellStencil.C.

References boundBox::min(), and boundBox::span().

Here is the call graph for this function:

◆ fill()

void fill ( PackedList< 2 > &  elems,
const boundBox bb,
const labelVector nDivs,
const boundBox subBb,
const unsigned int  val 
)
staticprotected

Fill all elements overlapping subBb with value val.

Definition at line 121 of file inverseDistanceCellCellStencil.C.

References k, boundBox::max(), Foam::max(), boundBox::min(), and Foam::min().

Here is the call graph for this function:

◆ overlaps()

bool overlaps ( const boundBox bb,
const labelVector nDivs,
const PackedList< 2 > &  voxels,
const treeBoundBox subBb,
const unsigned int  val 
)
staticprotected

Is any voxel inside subBb set to val.

Definition at line 271 of file inverseDistanceCellCellStencil.C.

References k, boundBox::max(), Foam::max(), boundBox::min(), and Foam::min().

Here is the call graph for this function:

◆ markBoundaries()

void markBoundaries ( const fvMesh mesh,
const vector smallVec,
const boundBox bb,
const labelVector nDivs,
PackedList< 2 > &  patchTypes,
const labelList cellMap,
labelList patchCellTypes 
)
staticprotected

Mark voxels of patchTypes with type of patch face.

Definition at line 159 of file inverseDistanceCellCellStencil.C.

References fvPatch::faceCells(), forAll, VectorSpace< Form, Cmpt, Ncmpts >::max, mesh, boundBox::min(), boundBox::overlaps(), fvPatch::patch(), patchTypes(), and PrimitivePatch< FaceList, PointField >::points().

Here is the call graph for this function:

◆ cellBb()

Foam::treeBoundBox cellBb ( const primitiveMesh mesh,
const label  celli 
)
staticprotected

Calculate bounding box of cell.

Definition at line 237 of file inverseDistanceCellCellStencil.C.

References cells, f(), forAll, boundBox::max(), Foam::max(), mesh, boundBox::min(), Foam::min(), p, and points.

Here is the call graph for this function:

◆ markPatchesAsHoles()

void markPatchesAsHoles ( PstreamBuffers pBufs,
const PtrList< fvMeshSubset > &  meshParts,
const List< treeBoundBoxList > &  patchBb,
const List< labelVector > &  patchDivisions,
const PtrList< PackedList< 2 >> &  patchParts,
const label  srcI,
const label  tgtI,
labelList allCellTypes 
) const
protected

Mark all cells overlapping (a voxel covered by) a src patch.

with type HOLE

Definition at line 315 of file inverseDistanceCellCellStencil.C.

References PstreamBuffers::clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, PstreamBuffers::finishedSends(), forAll, boundBox::max(), meshParts(), boundBox::min(), and treeBoundBox::overlaps().

Here is the call graph for this function:

◆ betterDonor()

bool betterDonor ( const label  destMesh,
const label  currentDonorMesh,
const label  newDonorMesh 
) const
protected

If multiple donors meshes: decide which is best.

Definition at line 441 of file inverseDistanceCellCellStencil.C.

References Foam::mag().

Here is the call graph for this function:

◆ markDonors()

void markDonors ( const globalIndex globalCells,
PstreamBuffers pBufs,
const PtrList< fvMeshSubset > &  meshParts,
const List< treeBoundBoxList > &  meshBb,
const labelList allCellTypes,
const label  srcI,
const label  tgtI,
labelListList allStencil,
labelList allDonor 
) const
protected

◆ uncompactedRegionSplit()

void uncompactedRegionSplit ( const fvMesh mesh,
const globalIndex globalFaces,
const label  nZones,
const labelList zoneID,
const labelList cellTypes,
const boolList isBlockedFace,
labelList cellRegion 
) const
protected

Replacement of regionSplit.

◆ compactedRegionSplit()

autoPtr<globalIndex> compactedRegionSplit ( const fvMesh mesh,
const globalIndex globalFaces,
labelList cellRegion 
) const
protected

◆ findHoles()

void findHoles ( const globalIndex globalCells,
const fvMesh mesh,
const labelList zoneID,
const labelListList stencil,
labelList cellTypes 
) const
protected

Do flood filling to detect unreachable (from patches) sections.

of mesh

Definition at line 945 of file inverseDistanceCellCellStencil.C.

References cellTypes, DebugInfo, mapDistribute::distribute(), Foam::endl(), fvPatch::faceCells(), Foam::findIndices(), forAll, FUNCTION_NAME, mesh, regionSplit::nRegions(), reduce(), and Foam::Zero.

Here is the call graph for this function:

◆ seedCell()

void seedCell ( const label  cellI,
const scalar  wantedFraction,
bitSet isFront,
scalarField fraction 
) const
protected

Seed faces of cell with wantedFraction (if higher than current)

Definition at line 1227 of file inverseDistanceCellCellStencil.C.

References forAll, and bitSet::set().

Here is the call graph for this function:

◆ walkFront()

void walkFront ( const scalar  layerRelax,
const labelListList allStencil,
labelList allCellTypes,
scalarField allWeight 
) const
protected

Surround holes with layer(s) of interpolated cells.

Definition at line 1248 of file inverseDistanceCellCellStencil.C.

References bitSet::any(), forAll, Foam::returnReduce(), bitSet::set(), bitSet::test(), bitSet::transfer(), and Foam::Zero.

Here is the call graph for this function:

◆ createStencil()

void createStencil ( const globalIndex globalCells)
protectedvirtual

Create stencil starting from the donor containing the acceptor.

Definition at line 1470 of file inverseDistanceCellCellStencil.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, nSamples(), Foam::returnReduce(), samples(), and List< T >::transfer().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "inverseDistance"  )

Runtime type information.

◆ update()

bool update ( )
virtual

◆ cellTypes()

virtual const labelUList& cellTypes ( ) const
inlinevirtual

Return the cell type list.

Implements cellCellStencil.

Definition at line 292 of file inverseDistanceCellCellStencil.H.

References inverseDistance::cellTypes_.

◆ interpolationCells()

virtual const labelUList& interpolationCells ( ) const
inlinevirtual

Indices of interpolated cells.

Implements cellCellStencil.

Definition at line 298 of file inverseDistanceCellCellStencil.H.

References inverseDistance::interpolationCells_.

◆ cellInterpolationMap()

virtual const mapDistribute& cellInterpolationMap ( ) const
inlinevirtual

Return a communication schedule.

Implements cellCellStencil.

Definition at line 304 of file inverseDistanceCellCellStencil.H.

References inverseDistance::cellInterpolationMap_, and inverseDistance::update().

Here is the call graph for this function:

◆ cellStencil()

virtual const labelListList& cellStencil ( ) const
inlinevirtual

Per interpolated cell the neighbour cells (in terms of slots as.

constructed by above cellInterpolationMap) to interpolate

Implements cellCellStencil.

Definition at line 315 of file inverseDistanceCellCellStencil.H.

◆ cellInterpolationWeights()

virtual const scalarListList& cellInterpolationWeights ( ) const
inlinevirtual

Weights for cellStencil.

Implements cellCellStencil.

Definition at line 321 of file inverseDistanceCellCellStencil.H.

References inverseDistance::cellInterpolationWeights_.

◆ cellInterpolationWeight()

virtual const scalarList& cellInterpolationWeight ( ) const
inlinevirtual

Per interpolated cell the interpolation factor. (0 = use.

calculated, 1 = use interpolated)

Implements cellCellStencil.

Definition at line 328 of file inverseDistanceCellCellStencil.H.

◆ stencilWeights()

void stencilWeights ( const point sample,
const pointList donorCcs,
scalarList weights 
) const
virtual

Calculate inverse distance weights for a single acceptor.

Implements cellCellStencil.

Reimplemented in leastSquares.

Definition at line 1435 of file inverseDistanceCellCellStencil.C.

References forAll, Foam::mag(), List< T >::setSize(), and Foam::sum().

Here is the call graph for this function:

Member Data Documentation

◆ dict_

const dictionary dict_
protected

Dictionary of motion control parameters.

Definition at line 76 of file inverseDistanceCellCellStencil.H.

◆ smallVec_

vector smallVec_
protected

Small perturbation vector for geometric tests.

Definition at line 79 of file inverseDistanceCellCellStencil.H.

◆ cellTypes_

labelList cellTypes_
protected

Per cell the cell type.

Definition at line 82 of file inverseDistanceCellCellStencil.H.

Referenced by inverseDistance::cellTypes().

◆ interpolationCells_

labelList interpolationCells_
protected

Indices of interpolated cells.

Definition at line 85 of file inverseDistanceCellCellStencil.H.

Referenced by inverseDistance::interpolationCells().

◆ cellInterpolationMap_

autoPtr<mapDistribute> cellInterpolationMap_
protected

Fetch interpolated cells.

Definition at line 88 of file inverseDistanceCellCellStencil.H.

Referenced by inverseDistance::cellInterpolationMap().

◆ cellStencil_

labelListList cellStencil_
protected

Interpolation stencil.

Definition at line 91 of file inverseDistanceCellCellStencil.H.

◆ cellInterpolationWeights_

scalarListList cellInterpolationWeights_
protected

Interpolation weights.

Definition at line 94 of file inverseDistanceCellCellStencil.H.

Referenced by inverseDistance::cellInterpolationWeights().

◆ cellInterpolationWeight_

volScalarField cellInterpolationWeight_
protected

Amount of interpolation.

Definition at line 97 of file inverseDistanceCellCellStencil.H.


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