A utility class for probing field values at specified point locations within an fvMesh. More...

#include <internalFieldProbe.H>

Inheritance diagram for internalFieldProbe:

[legend]

Collaboration diagram for internalFieldProbe:

Public Member Functions
	TypeName ("internalFieldProbe")
	Runtime type information.
	internalFieldProbe (const fvMesh &mesh, const dictionary &dict)
	Construct from Time and dictionary.
virtual	~internalFieldProbe ()=default
	Destructor.
template<class Type>
tmp< Field< Type > >	sample (const VolumeField< Type > &) const
	Sample a volume field at all locations.
template<class Type>
tmp< Field< Type > >	sample (const SurfaceField< Type > &) const
	Sample a surface field at all locations.
template<class Type>
tmp< Field< Type > >	sample (const word &fieldName) const
	Sample a volume field at all locations.
template<class Type>
tmp< Field< Type > >	sampleSurfaceField (const word &fieldName) const
	Sample a surface field at all locations.
virtual bool	read (const dictionary &)
	Read the settings dictionary.
Public Member Functions inherited from probeModel
	TypeName ("probeModel")
	Runtime type information.
	probeModel (const probeModel &)=delete
	No copy construct.
void	operator= (const probeModel &)=delete
	No copy assignment.
	probeModel (const fvMesh &mesh, const dictionary &dict)
	Construct from Time and dictionary.
virtual	~probeModel ()=default
	Destructor.
bool	empty () const
	Return true if no probe locations.
label	size () const
	Return number of probe locations.
bool	fixedLocations () const
	Return true if fixed locations.
bool	includeOutOfBounds () const
	Return true if include out of bounds probes.
const word &	samplePointScheme () const
	Return the interpolation scheme to obtain values at the points.
const pointField &	probeLocations () const
	Return const reference to the probe locations.
pointField &	probeLocations ()
	Return reference to the probe locations.
const point &	probe (const label i) const
	Return the location of probe i.
const labelList &	elements () const
	Cells to be probed (obtained from the locations).
const labelList &	faces () const
	Return const reference to the faces to be probed.
const labelList &	processors () const
	Return const reference to the processor list.
const labelList &	patchIDList () const noexcept
	Return const reference to the patch ID list.
const pointField &	oldPoints () const noexcept
	Return const reference to the original probe locations.
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &)
	Update for changes of mesh.

Protected Member Functions
virtual void	findElements (const fvMesh &mesh)
	Find cells and faces containing probes.

Additional Inherited Members
Protected Attributes inherited from probeModel
const fvMesh &	thisMesh_
	Const reference to the mesh.
bool	fixedLocations_
	Fixed locations (default: true).
bool	includeOutOfBounds_
	Include probes that were not found (default: true).
word	samplePointScheme_
	Interpolation/sample scheme to obtain values at the points.
pointField	probes_
	Probe locations.
labelList	cellIds_
	Cells to be probed (obtained from the locations).
labelList	faceIds_
	Faces to be probed.
labelList	procIds_
	Processor holding the cell or face (-1 if point not found on any processor).
labelList	patchIds_
	Patch IDs on which the new probes are located.
pointField	oldPoints_
	Original probes location.

Detailed Description

A utility class for probing field values at specified point locations within an fvMesh.

The internalFieldProbe stores a list of 3D point coordinates and determines the corresponding mesh elements (cells or faces) that contain these points. It provides methods to sample volume or surface fields at the stored locations, with support for fixed or mesh-moving point coordinates.

Features include: