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

Inheritance diagram for pointPatchDist:

Collaboration diagram for pointPatchDist:

Public Member Functions
	pointPatchDist (const pointMesh &pMesh, const labelHashSet &patchIDs, const pointField &points)
	Construct from mesh and set of patches. More...

virtual	~pointPatchDist ()=default
	Destructor. More...

const pointScalarField &	y () const

label	nUnset () const

void	correct ()
	Correct for mesh geom/topo changes. More...

Public Member Functions inherited from GeometricField< scalar, pointPatchField, pointMesh >
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=pointPatchField< scalar >::calculatedType())
	Construct given IOobject, mesh, dimensions and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensions and patch types. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< scalar > &dt, const word &patchFieldType=pointPatchField< scalar >::calculatedType())
	Construct given IOobject, mesh, dimensioned<Type> and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< scalar > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensioned<Type> and patch types. More...

	GeometricField (const IOobject &io, const Internal &diField, const PtrList< pointPatchField< scalar >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const word &patchFieldType=pointPatchField< scalar >::calculatedType())
	Copy construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< scalar > &&iField, const word &patchFieldType=pointPatchField< scalar >::calculatedType())
	Move construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const PtrList< pointPatchField< scalar >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
	Construct and read given IOobject. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

	GeometricField (const GeometricField< scalar, pointPatchField, pointMesh > &gf)
	Copy construct. More...

	GeometricField (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &tgf)
	Construct from tmp<GeometricField> deleting argument. More...

	GeometricField (const IOobject &io, const GeometricField< scalar, pointPatchField, pointMesh > &gf)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &tgf)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< scalar, pointPatchField, pointMesh > &gf)
	Copy construct with a new name. More...

	GeometricField (const word &newName, const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &tgf)
	Construct with a new name from tmp<GeometricField> More...

	GeometricField (const IOobject &io, const GeometricField< scalar, pointPatchField, pointMesh > &gf, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...

	GeometricField (const IOobject &io, const GeometricField< scalar, pointPatchField, pointMesh > &gf, const labelList &patchIDs, const word &patchFieldType)

	GeometricField (const IOobject &io, const GeometricField< scalar, pointPatchField, pointMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

tmp< GeometricField< scalar, pointPatchField, pointMesh > >	clone () const
	Clone. More...

virtual	~GeometricField ()
	Destructor. More...

Internal &	ref (const bool updateAccessTime=true)
	Return a reference to the dimensioned internal field. More...

const Internal &	internalField () const
	Return a const-reference to the dimensioned internal field. More...

const Internal &	v () const

Internal::FieldType &	primitiveFieldRef (const bool updateAccessTime=true)
	Return a reference to the internal field. More...

const Internal::FieldType &	primitiveField () const
	Return a const-reference to the internal field. More...

Boundary &	boundaryFieldRef (const bool updateAccessTime=true)
	Return a reference to the boundary field. More...

const Boundary &	boundaryField () const
	Return const-reference to the boundary field. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	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< scalar, pointPatchField, pointMesh > &	oldTime () const
	Return old time field. More...

GeometricField< scalar, pointPatchField, pointMesh > &	oldTime ()
	Return non-const old time field. More...

void	storePrevIter () const
	Store the field as the previous iteration value. More...

const GeometricField< scalar, pointPatchField, pointMesh > &	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, pointPatchField, pointMesh > >	component (const direction) const
	Return a component of the field. More...

tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

bool	writeData (Ostream &) const
	WriteData member function required by regIOobject. More...

tmp< GeometricField< scalar, pointPatchField, pointMesh > >	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 ()
	Negate the field inplace. More...

void	replace (const direction d, const GeometricField< cmptType, pointPatchField, pointMesh > &gcf)
	Replace specified field component with content from another field. More...

void	replace (const direction d, const dimensioned< cmptType > &ds)
	Replace specified field component with specified value. More...

void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)

void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)

void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)

void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)

void	min (const dimensioned< scalar > &dt)
	Use the minimum of the field and specified value. More...

void	max (const dimensioned< scalar > &dt)
	Use the maximum of the field and specified value. More...

void	clip (const dimensioned< MinMax< scalar >> &range)
	Clip the field to be bounded within the specified range. More...

void	clip (const dimensioned< scalar > &minVal, const dimensioned< scalar > &maxVal)
	Clip the field to be bounded within the specified range. More...

void	maxMin (const dimensioned< scalar > &minVal, const dimensioned< scalar > &maxVal)
	Deprecated(2019-01) identical to clip() More...

const Internal &	operator() () const
	Return a const-reference to the dimensioned internal field. More...

void	operator= (const GeometricField< scalar, pointPatchField, pointMesh > &)

void	operator= (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &)

void	operator= (const dimensioned< scalar > &)

void	operator== (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &)

void	operator== (const dimensioned< scalar > &)

void	operator+= (const GeometricField< scalar, pointPatchField, pointMesh > &)

void	operator+= (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &)

void	operator+= (const dimensioned< scalar > &)

void	operator-= (const GeometricField< scalar, pointPatchField, pointMesh > &)

void	operator-= (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &)

void	operator-= (const dimensioned< scalar > &)

void	operator*= (const GeometricField< scalar, pointPatchField, pointMesh > &)

void	operator*= (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &)

void	operator*= (const dimensioned< scalar > &)

void	operator/= (const GeometricField< scalar, pointPatchField, pointMesh > &)

void	operator/= (const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &)

void	operator/= (const dimensioned< scalar > &)

Additional Inherited Members
Public Types inherited from GeometricField< scalar, pointPatchField, pointMesh >
typedef pointMesh ::Mesh	Mesh
	Type of mesh on which this GeometricField is instantiated. More...

typedef pointMesh ::BoundaryMesh	BoundaryMesh

typedef DimensionedField< scalar, pointMesh >	Internal
	Type of the internal field from which this GeometricField is derived. More...

typedef pointPatchField< scalar >	Patch

typedef Field< scalar >::cmptType	cmptType

Static Public Member Functions inherited from GeometricField< scalar, pointPatchField, pointMesh >
static const GeometricField< scalar, pointPatchField, pointMesh > &	null ()
	Return a null geometric field. More...

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=pointPatchField< scalar >::calculatedType())
	Return tmp field from name, mesh, dimensions and patch type. More...

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const word &patchFieldType=pointPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< scalar > &&iField, const word &patchFieldType=pointPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< scalar > &dt, const word &patchFieldType=pointPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< scalar > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &newName, const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &tgf)
	Return renamed tmp field. More...

static tmp< GeometricField< scalar, pointPatchField, pointMesh > >	New (const word &newName, const tmp< GeometricField< scalar, pointPatchField, pointMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Rename tmp field and reset patch field types and return. More...

Detailed Description

Calculation of distance to nearest patch for all points.

Source files

Definition at line 54 of file pointPatchDist.H.

Constructor & Destructor Documentation

◆ pointPatchDist()

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

Construct from mesh and set of patches.

Definition at line 37 of file pointPatchDist.C.

References correct().

Here is the call graph for this function:

◆ ~pointPatchDist()

virtual ~pointPatchDist ( )

virtualdefault

Destructor.

Member Function Documentation

◆ y()

const pointScalarField& y ( ) const

inline

Definition at line 100 of file pointPatchDist.H.

◆ nUnset()

label nUnset ( ) const

inline

Definition at line 105 of file pointPatchDist.H.

◆ correct()

void correct ( )

Correct for mesh geom/topo changes.

Definition at line 64 of file pointPatchDist.C.

References forAll, mesh, Foam::constant::atomic::mp, nPoints, externalPointEdgePoint::trackingData::points_, and Foam::sqrt().