Public Member Functions | Private Member Functions | Private Attributes
pointPatchDist Class Reference

Calculation of distance to nearest patch for all points. More...

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

Public Member Functions

 pointPatchDist (const pointMesh &pMesh, const labelHashSet &patchIDs, const pointField &points)
 Construct from mesh and set of patches. More...
 
virtual ~pointPatchDist ()
 Destructor. More...
 
const pointScalarFieldy () const
 
label nUnset () const
 
void correct ()
 Correct for mesh geom/topo changes. More...
 
- Public Member Functions inherited from GeometricField
 TypeName ("GeometricField")
 Runtime type information. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensions and patch type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensions and patch types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensioned<Type> and patch type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensioned<Type> and patch types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
 Constructor from components. More...
 
 GeometricField (const IOobject &, const Mesh &, const bool readOldTime=true)
 Construct and read given IOobject. More...
 
 GeometricField (const IOobject &, const Mesh &, const dictionary &)
 Construct from dictionary. More...
 
 GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy. More...
 
 GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 Construct as copy of tmp<GeometricField> deleting argument. More...
 
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy resetting IO parameters. More...
 
 GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 Construct as copy of tmp<GeometricField> resetting IO parameters. More...
 
 GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy resetting name. More...
 
 GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 Construct as copy resetting name. More...
 
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
 Construct as copy resetting IO parameters and patch type. More...
 
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Construct as copy resetting IO parameters and boundary types. More...
 
virtual ~GeometricField ()
 Destructor. More...
 
DimensionedInternalFielddimensionedInternalField ()
 Return dimensioned internal field. More...
 
const DimensionedInternalFielddimensionedInternalField () const
 Return dimensioned internal field. More...
 
InternalFieldinternalField ()
 Return internal field. More...
 
const InternalFieldinternalField () const
 Return internal field. More...
 
GeometricBoundaryFieldboundaryField ()
 Return reference to GeometricBoundaryField. More...
 
const GeometricBoundaryFieldboundaryField () const
 Return reference to GeometricBoundaryField for const field. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
labeltimeIndex ()
 Return the time index of the field. More...
 
void storeOldTimes () const
 Store the old-time fields. More...
 
void storeOldTime () const
 Store the old-time field. More...
 
label nOldTimes () const
 Return the number of old time fields stored. More...
 
const GeometricField< Type, PatchField, GeoMesh > & oldTime () const
 Return old time field. More...
 
GeometricField< Type, PatchField, GeoMesh > & oldTime ()
 Return non-const old time field. More...
 
void storePrevIter () const
 Store the field as the previous iteration value. More...
 
const GeometricField< Type, PatchField, GeoMesh > & prevIter () const
 Return previous iteration field. More...
 
void correctBoundaryConditions ()
 Correct boundary field. More...
 
bool needReference () const
 Does the field need a reference level for solution. More...
 
tmp< GeometricField< cmptType, PatchField, GeoMesh > > component (const direction) const
 Return a component of the field. More...
 
bool writeData (Ostream &) const
 WriteData member function required by regIOobject. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > T () const
 Return transpose (only if it is a tensor field) More...
 
void relax (const scalar alpha)
 Relax field (for steady-state solution). More...
 
void relax ()
 Relax field (for steady-state solution). More...
 
word select (bool final) const
 Select the final iteration parameters if `final' is true. More...
 
void writeMinMax (Ostream &os) const
 Helper function to write the min and max to an Ostream. More...
 
void negate ()
 
void replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)
 
void replace (const direction, const dimensioned< cmptType > &)
 
void max (const dimensioned< Type > &)
 
void min (const dimensioned< Type > &)
 
void max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
 
void min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
 
void scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)
 
void scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
 
void operator= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator= (const dimensioned< Type > &)
 
void operator== (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator== (const dimensioned< Type > &)
 
void operator+= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator-= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)
 
void operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
 
void operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)
 
void operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
 
void operator+= (const dimensioned< Type > &)
 
void operator-= (const dimensioned< Type > &)
 
void operator*= (const dimensioned< scalar > &)
 
void operator/= (const dimensioned< scalar > &)
 
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
 
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)
 

Private Member Functions

 pointPatchDist (const pointPatchDist &)
 Disallow default bitwise copy construct. More...
 
void operator= (const pointPatchDist &)
 Disallow default bitwise assignment. More...
 

Private Attributes

const pointFieldpoints_
 Reference to pointField. More...
 
const labelHashSet patchIDs_
 Set of patch IDs. More...
 
label nUnset_
 Number of unset points. More...
 

Additional Inherited Members

- Public Types inherited from GeometricField
typedef GeoMesh::Mesh Mesh
 
typedef GeoMesh::BoundaryMesh BoundaryMesh
 
typedef DimensionedField< Type, GeoMeshDimensionedInternalField
 
typedef Field< Type > InternalField
 
typedef PatchField< Type > PatchFieldType
 
typedef Field< Type >::cmptType cmptType
 
- Static Public Member Functions inherited from GeometricField
static const GeometricField< Type, PatchField, GeoMesh > & null ()
 Return a null geometric field. More...
 

Detailed Description

Calculation of distance to nearest patch for all points.

Source files

Definition at line 50 of file pointPatchDist.H.

Constructor & Destructor Documentation

◆ pointPatchDist() [1/2]

pointPatchDist ( const pointPatchDist )
private

Disallow default bitwise copy construct.

◆ pointPatchDist() [2/2]

pointPatchDist ( const pointMesh pMesh,
const labelHashSet patchIDs,
const pointField points 
)

Construct from mesh and set of patches.

Definition at line 34 of file pointPatchDist.C.

References correct().

Here is the call graph for this function:

◆ ~pointPatchDist()

~pointPatchDist ( )
virtual

Destructor.

Definition at line 61 of file pointPatchDist.C.

Member Function Documentation

◆ operator=()

void operator= ( const pointPatchDist )
private

Disallow default bitwise assignment.

◆ y()

const pointScalarField& y ( ) const
inline

Definition at line 97 of file pointPatchDist.H.

◆ nUnset()

label nUnset ( ) const
inline

Definition at line 102 of file pointPatchDist.H.

References pointPatchDist::nUnset_.

◆ correct()

void correct ( )

Correct for mesh geom/topo changes.

Definition at line 67 of file pointPatchDist.C.

References fvMesh::boundary(), forAll, forAllConstIter(), mesh, Foam::constant::atomic::mp, nPoints, externalPointEdgePoint::trackingData::points_, PtrList::size(), and Foam::sqrt().

Here is the call graph for this function:

Field Documentation

◆ points_

const pointField& points_
private

Reference to pointField.

Definition at line 60 of file pointPatchDist.H.

◆ patchIDs_

const labelHashSet patchIDs_
private

Set of patch IDs.

Definition at line 63 of file pointPatchDist.H.

◆ nUnset_

label nUnset_
private

Number of unset points.

Definition at line 66 of file pointPatchDist.H.

Referenced by pointPatchDist::nUnset().


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