Base class for sampling fields at specified internal and boundary locations. More...

#include <probeModel.H>

Inheritance diagram for probeModel:

[legend]

Collaboration diagram for probeModel:

[legend]

Classes
struct	isNotEqOp

Public Member Functions
	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 bool	read (const dictionary &)
	Read the settings dictionary.
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)=0
	Find cells and faces containing probes.

Protected Attributes
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

Base class for sampling fields at specified internal and boundary locations.

Source files

Definition at line 48 of file probeModel.H.

Constructor & Destructor Documentation

◆ probeModel() [1/2]

probeModel ( const probeModel & )

delete

No copy construct.

References probeModel().

Referenced by internalFieldProbe::internalFieldProbe(), operator=(), patchFieldProbe::patchFieldProbe(), and probeModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ probeModel() [2/2]

probeModel	(	const fvMesh &	mesh,
		const dictionary &	dict )

Construct from Time and dictionary.

Definition at line 35 of file probeModel.C.

References dict, mesh, read(), samplePointScheme_, and thisMesh_.

Here is the call graph for this function:

◆ ~probeModel()

virtual ~probeModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ findElements()

virtual void findElements ( const fvMesh & mesh )

protectedpure virtual

Find cells and faces containing probes.

Implemented in internalFieldProbe, and patchFieldProbe.

References mesh.

Referenced by movePoints(), and updateMesh().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "probeModel" )

Runtime type information.

◆ operator=()

void operator= ( const probeModel & )

delete

No copy assignment.

References dict, mesh, and probeModel().

Here is the call graph for this function:

◆ empty()

bool empty ( ) const

inline

Return true if no probe locations.

Definition at line 191 of file probeModel.H.

References probes_.

◆ size()

label size ( ) const

inline

Return number of probe locations.

Definition at line 196 of file probeModel.H.

References probes_.

Referenced by patchFieldProbe::findElements(), and radiometerProbes::read().

Here is the caller graph for this function:

◆ fixedLocations()

bool fixedLocations ( ) const

inline

Return true if fixed locations.

Definition at line 201 of file probeModel.H.

References fixedLocations_.

◆ includeOutOfBounds()

bool includeOutOfBounds ( ) const

inline

Return true if include out of bounds probes.

Definition at line 206 of file probeModel.H.

References includeOutOfBounds_.

◆ samplePointScheme()

const word & samplePointScheme ( ) const

inline

Return the interpolation scheme to obtain values at the points.

Note: only possible when fixedLocations_ is true

Definition at line 213 of file probeModel.H.

References samplePointScheme_.

◆ probeLocations() [1/2]

const pointField & probeLocations ( ) const

inline

Return const reference to the probe locations.

Definition at line 218 of file probeModel.H.

References probes_.

Referenced by internalFieldProbe::findElements(), and patchFieldProbe::findElements().

Here is the caller graph for this function:

◆ probeLocations() [2/2]

pointField & probeLocations ( )

inline

Return reference to the probe locations.

Definition at line 223 of file probeModel.H.

References probes_.

◆ probe()

const point & probe ( const label i ) const

inline

Return the location of probe i.

Definition at line 228 of file probeModel.H.

References probes_.

◆ elements()

const labelList & elements ( ) const

inline

Cells to be probed (obtained from the locations).

Definition at line 233 of file probeModel.H.

References cellIds_.

◆ faces()

const labelList & faces ( ) const

inline

Return const reference to the faces to be probed.

Definition at line 238 of file probeModel.H.

References faceIds_.

◆ processors()

const labelList & processors ( ) const

inline

Return const reference to the processor list.

Definition at line 243 of file probeModel.H.

References procIds_.

◆ patchIDList()

const labelList & patchIDList ( ) const

inlinenoexcept

Return const reference to the patch ID list.

Definition at line 248 of file probeModel.H.

References Foam::noexcept, and patchIds_.

◆ oldPoints()

const pointField & oldPoints ( ) const

inlinenoexcept

Return const reference to the original probe locations.

Definition at line 253 of file probeModel.H.

References Foam::noexcept, and oldPoints_.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the settings dictionary.

Reimplemented in radiometerProbes, internalFieldProbe, patchFieldProbe, and gauge.

Definition at line 50 of file probeModel.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, fixedLocations_, includeOutOfBounds_, probes_, samplePointScheme_, and WarningInFunction.

Referenced by probeModel(), internalFieldProbe::read(), and patchFieldProbe::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes of mesh.

Definition at line 80 of file probeModel.C.

References DynamicList< T, SizeMin >::append(), cellIds_, DebugInfo, Foam::endl(), faceIds_, findElements(), fixedLocations_, forAll, mapPolyMesh::mesh(), mapPolyMesh::reverseCellMap(), mapPolyMesh::reverseFaceMap(), and thisMesh_.

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for changes of mesh.

Definition at line 171 of file probeModel.C.

References DebugInfo, Foam::endl(), findElements(), fixedLocations_, mesh, and thisMesh_.

Here is the call graph for this function:

Member Data Documentation

◆ thisMesh_

const fvMesh& thisMesh_

protected

Const reference to the mesh.

Definition at line 80 of file probeModel.H.

Referenced by movePoints(), probeModel(), internalFieldProbe::read(), patchFieldProbe::read(), and updateMesh().

◆ fixedLocations_

bool fixedLocations_

protected

Fixed locations (default: true).

Note: set to false for moving mesh calculations where locations should move with the mesh

Definition at line 88 of file probeModel.H.

Referenced by fixedLocations(), movePoints(), read(), and updateMesh().

◆ includeOutOfBounds_

bool includeOutOfBounds_

protected

Include probes that were not found (default: true).

Definition at line 93 of file probeModel.H.

Referenced by includeOutOfBounds(), and read().

◆ samplePointScheme_

word samplePointScheme_

protected

Interpolation/sample scheme to obtain values at the points.

Note: only possible when fixedLocations_ is true

Definition at line 100 of file probeModel.H.

Referenced by probeModel(), read(), and samplePointScheme().

◆ probes_

pointField probes_

protected

Probe locations.

Definition at line 108 of file probeModel.H.

Referenced by empty(), probe(), probeLocations(), probeLocations(), read(), and size().

◆ cellIds_

labelList cellIds_

protected

Cells to be probed (obtained from the locations).

Definition at line 113 of file probeModel.H.

Referenced by elements(), internalFieldProbe::findElements(), patchFieldProbe::findElements(), and updateMesh().

◆ faceIds_

labelList faceIds_

protected

Faces to be probed.

Definition at line 118 of file probeModel.H.

Referenced by faces(), internalFieldProbe::findElements(), patchFieldProbe::findElements(), and updateMesh().

◆ procIds_

labelList procIds_

protected

Processor holding the cell or face (-1 if point not found on any processor).

Definition at line 124 of file probeModel.H.

Referenced by internalFieldProbe::findElements(), patchFieldProbe::findElements(), and processors().

◆ patchIds_

labelList patchIds_

protected

Patch IDs on which the new probes are located.

Definition at line 129 of file probeModel.H.

Referenced by patchFieldProbe::findElements(), and patchIDList().

◆ oldPoints_

pointField oldPoints_

protected

Original probes location.

Definition at line 134 of file probeModel.H.

Referenced by patchFieldProbe::findElements(), and oldPoints().

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

src/sampling/probes/probeModels/probeModel.H
src/sampling/probes/probeModels/probeModel.C

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ probeModel() [1/2]

◆ probeModel() [2/2]

◆ ~probeModel()

Member Function Documentation

◆ findElements()

◆ TypeName()

◆ operator=()

◆ empty()

◆ size()

◆ fixedLocations()

◆ includeOutOfBounds()

◆ samplePointScheme()

◆ probeLocations() [1/2]

◆ probeLocations() [2/2]

◆ probe()

◆ elements()

◆ faces()

◆ processors()

◆ patchIDList()

◆ oldPoints()

◆ read()

◆ updateMesh()

◆ movePoints()

Member Data Documentation

◆ thisMesh_

◆ fixedLocations_

◆ includeOutOfBounds_

◆ samplePointScheme_

◆ probes_

◆ cellIds_

◆ faceIds_

◆ procIds_

◆ patchIds_

◆ oldPoints_