patchPatchDist Class Reference

Like wallDist but calculates on a patch the distance to nearest neighbouring patches. Uses PatchEdgeFaceWave to do actual calculation. More...

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

Public Member Functions

 patchPatchDist (const polyPatch &pp, const labelHashSet &nbrPatchIDs)
 Construct from patch and neighbour patches. More...
 
virtual ~patchPatchDist ()=default
 Destructor. More...
 
const scalarFieldy () const
 
label nUnset () const
 
virtual void correct ()
 Correct for mesh geom/topo changes. More...
 
- Public Member Functions inherited from Field< scalar >
constexpr Field () noexcept
 Construct null. More...
 
 Field (const label len)
 Construct given size. More...
 
 Field (const label len, const scalar &val)
 Construct given size and initial value. More...
 
 Field (const label len, const Foam::zero)
 Construct given size and initial values of zero. More...
 
 Field (const Foam::one, const scalar &val)
 Construct with length=1, copying the value as the only content. More...
 
 Field (const Foam::one, scalar &&val)
 Construct with length=1, moving the value as the only content. More...
 
 Field (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 Field (const Field< scalar > &fld)
 Copy construct. More...
 
 Field (const UList< scalar > &list)
 Copy construct from UList<Type> More...
 
 Field (const IndirectListBase< scalar, Addr > &list)
 Copy construct from IndirectList. More...
 
 Field (Field< scalar > &&fld)
 Move construct from Field. More...
 
 Field (List< scalar > &&list)
 Move construct from List. More...
 
 Field (DynamicList< scalar, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 Field (const UList< scalar > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
 
 Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
 
 Field (Field< scalar > &fld, bool reuse)
 Copy construct or re-use as specified. More...
 
 Field (const tmp< Field< scalar >> &tfld)
 Copy or move construct from tmp. More...
 
 Field (Istream &is)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &dict, const label len)
 Construct from a dictionary entry. More...
 
tmp< Field< scalar > > clone () const
 Clone. More...
 
void map (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field. More...
 
void map (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self. More...
 
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Negate this field (negative). More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType >> &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
VSForm block (const label start) const
 
tmp< Field< scalar > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
void operator= (const Field< scalar > &)
 Copy assignment. More...
 
void operator= (const tmp< Field< scalar >> &)
 
void operator= (const UList< scalar > &)
 
void operator= (const SubField< scalar > &)
 
void operator= (Field< scalar > &&rhs)
 Move assignment. More...
 
void operator= (List< scalar > &&rhs)
 
void operator= (DynamicList< scalar, SizeMin > &&rhs)
 
void operator= (const scalar &val)
 Value assignment. More...
 
void operator= (const Foam::zero)
 
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator= (const tmp< Field > &rhs)
 
void operator+= (const UList< scalar > &)
 
void operator+= (const tmp< Field< scalar >> &)
 
void operator+= (const scalar &)
 
void operator-= (const UList< scalar > &)
 
void operator-= (const tmp< Field< scalar >> &)
 
void operator-= (const scalar &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar >> &)
 
void operator*= (const scalar &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar >> &)
 
void operator/= (const scalar &)
 

Additional Inherited Members

- Public Types inherited from Field< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type. More...
 
typedef SubField< scalar > subField
 Declare type of subField. More...
 
- Static Public Member Functions inherited from Field< scalar >
static const Field< scalar > & null ()
 Return nullObject reference field. More...
 
static autoPtr< Field< scalar > > New (Istream &is)
 Return a pointer to a new Field created on freestore. More...
 
static tmp< Field< scalar > > NewCalculatedType (const Field< Type2 > &f)
 

Detailed Description

Like wallDist but calculates on a patch the distance to nearest neighbouring patches. Uses PatchEdgeFaceWave to do actual calculation.

Source files

Definition at line 56 of file patchPatchDist.H.

Constructor & Destructor Documentation

◆ patchPatchDist()

patchPatchDist ( const polyPatch pp,
const labelHashSet nbrPatchIDs 
)

Construct from patch and neighbour patches.

Definition at line 38 of file patchPatchDist.C.

References correct().

Here is the call graph for this function:

◆ ~patchPatchDist()

virtual ~patchPatchDist ( )
virtualdefault

Destructor.

Member Function Documentation

◆ y()

const scalarField& y ( ) const
inline

Definition at line 89 of file patchPatchDist.H.

◆ nUnset()

label nUnset ( ) const
inline

Definition at line 94 of file patchPatchDist.H.

◆ correct()


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