Set of locations to sample. More...

Inheritance diagram for probes:

Collaboration diagram for probes:

Classes
struct	fieldGroup
	Grouping of field names by GeometricField type. More...

Public Member Functions
	TypeName ("probes")
	Runtime type information. More...

	probes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true)
	Construct from Time and dictionary. More...

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

bool	verbose (const bool on) noexcept
	Enable/disable verbose output. More...

virtual const wordRes &	fieldNames () const noexcept
	Return names of fields to probe. More...

virtual const pointField &	probeLocations () const noexcept
	Return locations to probe. More...

virtual const point &	probe (const label i) const
	Return location for probe i. More...

const labelList &	elements () const noexcept
	Cells to be probed (obtained from the locations) More...

virtual bool	read (const dictionary &)
	Read the probes. More...

virtual bool	execute ()
	Sample and store result if the sampleOnExecute is enabled. More...

virtual bool	write ()
	Sample and write. More...

virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &)
	Update for changes of mesh. More...

virtual void	readUpdate (const polyMesh::readUpdateState state)
	Update for changes of mesh due to readUpdate. More...

template<class Type >
tmp< Field< Type > >	sample (const VolumeField< Type > &) const
	Sample a volume field at all locations. More...

template<class Type >
tmp< Field< Type > >	sample (const SurfaceField< Type > &) const
	Sample a surface field at all locations. More...

template<class Type >
tmp< Field< Type > >	sample (const word &fieldName) const
	Sample a volume field at all locations. More...

template<class Type >
tmp< Field< Type > >	sampleSurfaceField (const word &fieldName) const
	Sample a surface field at all locations. More...

template<class GeoField >
Foam::tmp< GeoField >	getOrLoadField (const word &fieldName) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const VolumeField< Type > &vField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const SurfaceField< Type > &sField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const word &fieldName) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleSurfaceField (const word &fieldName) const

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

virtual bool	read (const dictionary &dict)
	Read optional controls. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

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

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

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

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Public Member Functions inherited from Field< vector >
constexpr	Field () noexcept
	Default construct. More...

	Field (const label len)
	Construct given size. More...

	Field (const label len, const vector &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 vector &val)
	Construct with length=1, copying the value as the only content. More...

	Field (const Foam::one, vector &&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< vector > &fld)
	Copy construct. More...

	Field (const UList< vector > &list)
	Copy construct from UList<Type> More...

	Field (const IndirectListBase< vector, Addr > &list)
	Copy construct from IndirectList. More...

	Field (Field< vector > &&fld)
	Move construct from Field. More...

	Field (List< vector > &&list)
	Move construct from List. More...

	Field (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList. More...

	Field (const UList< vector > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)

	Field (Field< vector > &fld, bool reuse)
	Copy construct or re-use as specified. More...

	Field (const tmp< Field< vector > > &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< vector > >	clone () const
	Clone. More...

void	map (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< vector > > &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< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Inplace negate this field (negative). More...

void	normalise ()

void	normalise ()

void	normalise ()

void	normalise ()
	Inplace normalise (float) vector field. More...

void	normalise ()
	Inplace normalise (double) vector field. 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< vector > >	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...

SubField< vector >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking. More...

const SubField< vector >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking. More...

SubField< vector >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking. More...

const SubField< vector >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking. More...

void	operator= (const Field< vector > &)
	Copy assignment. More...

void	operator= (const tmp< Field< vector > > &)

void	operator= (const UList< vector > &rhs)

void	operator= (const SubField< vector > &rhs)

void	operator= (const IndirectListBase< vector, Addr > &rhs)
	Copy assign from IndirectList. More...

void	operator= (Field< vector > &&rhs)
	Move assignment. More...

void	operator= (List< vector > &&rhs)

void	operator= (DynamicList< vector, SizeMin > &&rhs)

void	operator= (const vector &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< vector > &)

void	operator+= (const tmp< Field< vector > > &)

void	operator+= (const vector &)

void	operator-= (const UList< vector > &)

void	operator-= (const tmp< Field< vector > > &)

void	operator-= (const vector &)

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 &)

Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct, refCount zero. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Public Member Functions inherited from List< T >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const T &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const T &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, T &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< T > &a)
	Copy construct from list. More...

	List (const UList< T > &a)
	Copy construct contents from list. More...

	List (List< T > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &list, const labelUList &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const FixedList< T, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< T > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< T > &list)
	Construct as copy of SLList<T> More...

template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< T > list)
	Construct from an initializer list. More...

	List (List< T > &&list)
	Move construct from List. More...

template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SLList< T > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< T > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const T &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const T &val)
	Alias for resize() More...

void	append (const T &val)
	Append an element at the end of the list. More...

void	append (T &&val)
	Move append an element at the end of the list. More...

void	append (const UList< T > &list)
	Append a List to the end of this list. More...

template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const T &val)
	Append an element if not already in the list. More...

void	transfer (List< T > &list)

template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)

T &	newElmt (const label i)

void	operator= (const UList< T > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< T > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< T > &list)
	Assignment to SLList operator. Takes linear time. More...

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

template<unsigned N>
void	operator= (const FixedList< T, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< T > list)
	Assignment to an initializer list. More...

void	operator= (const T &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< T > &&list)
	Move assignment. Takes constant time. More...

template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< T > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

void	shallowCopy (const UList< T > &)=delete
	No shallowCopy permitted. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Istream &	readList (Istream &is)

void	resize (const label newLen)

Istream &	readList (Istream &is)

Public Member Functions inherited from UList< T >
	UList (const UList< T > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (T *__restrict__ v, const label len) noexcept
	Construct from components. More...

label	fcIndex (const label i) const noexcept

label	rcIndex (const label i) const noexcept

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

T *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

label	find (const T &val, label pos=0) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

bool	found (const T &val, label pos=0) const
	True if the value if found in the list. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (const UList< T > &list)
	Copy the pointer and size held by the given UList. More...

void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match! More...

template<class Addr >
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

T &	operator[] (const label i)
	Return element of UList. More...

const T &	operator[] (const label i) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const T &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...

iterator	end () noexcept
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const noexcept
	The number of elements in the UList. More...

bool	empty () const noexcept
	True if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &list)
	Swap content with another UList of the same type in constant time. More...

bool	operator== (const UList< T > &a) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &a) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &a) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &a) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &a) const
	Return true if !(a < b). Takes linear time. More...

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Istream &	readList (Istream &is)

Ostream &	writeList (Ostream &os, const label) const

const bool &	operator[] (const label i) const

Foam::UPstream::commsStruct &	operator[] (const label procID)

const Foam::UPstream::commsStruct &	operator[] (const label procID) const

UPstream::commsStruct &	operator[] (const label procID)

const UPstream::commsStruct &	operator[] (const label procID) const

Ostream &	writeList (Ostream &os, const label) const

Istream &	readList (Istream &is)

Protected Types
enum	sampleActionType : unsigned { ACTION_NONE = 0 , ACTION_WRITE = 0x1 , ACTION_STORE = 0x2 , ACTION_ALL = 0xF }
	Local control for sampling actions. More...

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

label	prepare (unsigned request)
	Classify field types, close/open file streams. More...

template<class GeoField >
tmp< GeoField >	getOrLoadField (const word &fieldName) const
	Get from registry or load from disk. More...

template<class Type >
void	storeResults (const word &fieldName, const Field< Type > &values)
	Store results: min/max/average/size. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

labelRange	validateRange (const labelRange &requestedRange) const

UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy) More...

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

Protected Attributes
bool	loadFromFiles_
	Load fields from files (not from objectRegistry) More...

bool	fixedLocations_
	Fixed locations (default: true) More...

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

bool	verbose_
	Output verbosity. More...

bool	onExecute_
	Perform sample actions on execute as well. More...

wordRes	fieldSelection_
	Requested names of fields to probe. More...

word	samplePointScheme_
	Interpolation/sample scheme to obtain values at the points. More...

DynamicList< word >	selectedFieldNames_
	Current list of field names selected for sampling. More...

fieldGroup< volScalarField >	scalarFields_
	Categorized scalar/vector/tensor volume fields. More...

fieldGroup< volVectorField >	vectorFields_

fieldGroup< volSphericalTensorField >	sphericalTensorFields_

fieldGroup< volSymmTensorField >	symmTensorFields_

fieldGroup< volTensorField >	tensorFields_

fieldGroup< surfaceScalarField >	surfaceScalarFields_
	Categorized scalar/vector/tensor surface fields. More...

fieldGroup< surfaceVectorField >	surfaceVectorFields_

fieldGroup< surfaceSphericalTensorField >	surfaceSphericalTensorFields_

fieldGroup< surfaceSymmTensorField >	surfaceSymmTensorFields_

fieldGroup< surfaceTensorField >	surfaceTensorFields_

labelList	elementList_
	Cells to be probed (obtained from the locations) More...

labelList	faceList_
	Faces to be probed. More...

labelList	processor_
	Processor holding the cell or face (-1 if point not found. More...

HashPtrTable< OFstream >	probeFilePtrs_
	Current open files (non-empty on master only) More...

labelList	patchIDList_
	Patch IDs on which the new probes are located (for patchProbes) More...

pointField	oldPoints_
	Original probes location (only used for patchProbes) More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Additional Inherited Members
Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType	cmptType
	Component type. More...

typedef SubField< vector >	subField
	Declare type of subField. More...

Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

typedef T *	iterator
	Random access iterator for traversing a UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing a UList. More...

typedef label	size_type
	The type to represent the size of a UList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Static Public Member Functions inherited from Field< vector >
static const Field< vector > &	null ()
	Return nullObject reference Field. More...

static autoPtr< Field< vector > >	New (Istream &is)
	Return a pointer to a new Field created on freestore. More...

static tmp< Field< vector > >	NewCalculatedType (const Field< Type2 > &f)

Static Public Member Functions inherited from List< T >
static const List< T > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a UList reference to a nullObject. More...

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field. More...

static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size. More...

Detailed Description

Set of locations to sample.

Call write() to sample and write files.

Example of function object specification:

probes
{
    type            probes;
    libs            (sampling);

    // Name of the directory for probe data
    name            probes;

    // Write at same frequency as fields
    writeControl    outputTime;
    writeInterval   1;

    // Fields to be probed
    fields          (U "p.*");

    // Optional: do not recalculate cells if mesh moves
    fixedLocations  false;

    // Optional: interpolation scheme to use (default is cell)
    interpolationScheme cellPoint;

    probeLocations
    (
        ( 1e-06 0 0.01 )      // at inlet
        (0.21 -0.20999 0.01)  // at outlet1
        (0.21 0.20999 0.01)   // at outlet2
        (0.21 0 0.01)         // at central block
    );

    // Optional: filter out points that haven't been found. Default
    //           is to include them (with value -VGREAT)
    includeOutOfBounds  true;
}

Entries:

Property	Description	Required	Default
`type`	Type-name: probes	yes
`probeLocations`	Probe locations	yes
`fields`	word/regex list of fields to sample	yes
`interpolationScheme`	scheme to obtain values	no	cell
`fixedLocations`	Do not recalculate cells if mesh moves	no	true
`includeOutOfBounds`	Include out-of-bounds locations	no	true
`sampleOnExecute`	Sample on execution and store results	no	false

Source files

Definition at line 162 of file probes.H.

Member Enumeration Documentation

◆ sampleActionType

enum sampleActionType : unsigned

protected

Local control for sampling actions.

Enumerator
ACTION_NONE
ACTION_WRITE
ACTION_STORE
ACTION_ALL

Definition at line 179 of file probes.H.

Constructor & Destructor Documentation

◆ probes()

probes	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`,
		const bool	readFields = `true`
	)

Construct from Time and dictionary.

Definition at line 366 of file probes.C.

References dict, probes::read(), and Foam::readFields().

Here is the call graph for this function:

◆ ~probes()

virtual ~probes ( )

virtualdefault

Destructor.

Member Function Documentation

◆ findElements()

void findElements ( const fvMesh & mesh )

protectedvirtual

Find cells and faces containing probes.

Reimplemented in patchProbes.

Definition at line 163 of file probes.C.

References primitiveMesh::cellCentres(), primitiveMesh::cells(), DebugInfo, Foam::endl(), primitiveMesh::faceCentres(), polyMesh::findCell(), forAll, Foam::mag(), splitCell::master(), mesh, processorFaPatch::myProcNo(), Foam::nl, Foam::Pout, Foam::reduce(), interfaceDefinitions::size(), and WarningInFunction.

Here is the call graph for this function:

◆ prepare()

Foam::label prepare ( unsigned request )

protected

Classify field types, close/open file streams.

Returns: number of fields to sample

Definition at line 279 of file probes.C.

References IOobjectList::classes(), DebugInfo, doLocalCode, HashTable< T, Key, Hash >::empty(), Foam::endl(), HashTable< T, Key, Hash >::erase(), forAllIters, HashSet< Key, Hash >::insert(), splitCell::master(), Foam::nl, and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ getOrLoadField() [1/2]

tmp< GeoField > getOrLoadField ( const word & fieldName ) const

protected

Get from registry or load from disk.

◆ storeResults()

void storeResults	(	const word &	fieldName,
		const Field< Type > &	values
	)

protected

Store results: min/max/average/size.

Definition at line 103 of file probesTemplates.C.

References Foam::average(), Foam::Info, MinMax< T >::max(), MinMax< T >::min(), Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "probes" )

Runtime type information.

◆ verbose()

bool verbose ( const bool on )

noexcept

Enable/disable verbose output.

Returns: old value

Definition at line 394 of file probes.C.

◆ fieldNames()

virtual const wordRes & fieldNames ( ) const

inlinevirtualnoexcept

Return names of fields to probe.

Definition at line 335 of file probes.H.

References probes::fieldSelection_.

◆ probeLocations()

virtual const pointField & probeLocations ( ) const

inlinevirtualnoexcept

Return locations to probe.

Definition at line 341 of file probes.H.

Referenced by patchProbes::findElements().

Here is the caller graph for this function:

◆ probe()

virtual const point & probe ( const label i ) const

inlinevirtual

Return location for probe i.

Definition at line 347 of file probes.H.

References UList< T >::operator[]().

Here is the call graph for this function:

◆ elements()

const labelList & elements ( ) const

inlinenoexcept

Cells to be probed (obtained from the locations)

Definition at line 353 of file probes.H.

References probes::elementList_.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the probes.

Reimplemented from regionFunctionObject.

Reimplemented in thermoCoupleProbes, and patchProbes.

Definition at line 402 of file probes.C.

References dict, Foam::endl(), dictionary::getOrDefault(), dictionary::readEntry(), dictionary::readIfPresent(), and WarningInFunction.

Referenced by probes::probes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Sample and store result if the sampleOnExecute is enabled.

Implements functionObject.

Reimplemented in thermoCoupleProbes, and patchProbes.

Definition at line 455 of file probes.C.

◆ write()

bool write ( )

virtual

Sample and write.

Implements functionObject.

Reimplemented in thermoCoupleProbes, and patchProbes.

Definition at line 466 of file probes.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 472 of file probes.C.

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

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 563 of file probes.C.

References DebugInfo, Foam::endl(), and mesh.

Here is the call graph for this function:

◆ readUpdate()

virtual void readUpdate ( const polyMesh::readUpdateState state )

inlinevirtual

Update for changes of mesh due to readUpdate.

Definition at line 374 of file probes.H.

◆ sample() [1/6]

tmp< Field< Type > > sample ( const VolumeField< Type > & ) const

Sample a volume field at all locations.

◆ sample() [2/6]

tmp< Field< Type > > sample ( const SurfaceField< Type > & ) const

Sample a surface field at all locations.

◆ sample() [3/6]

tmp< Field< Type > > sample ( const word & fieldName ) const

Sample a volume field at all locations.

◆ sampleSurfaceField() [1/2]

tmp< Field< Type > > sampleSurfaceField ( const word & fieldName ) const

Sample a surface field at all locations.

◆ getOrLoadField() [2/2]

Foam::tmp< GeoField > getOrLoadField ( const word & fieldName ) const

Definition at line 69 of file probesTemplates.C.

References objectRegistry::cfindObject(), tmp< T >::cref(), probes::loadFromFiles_, fvMeshFunctionObject::mesh_, IOobject::MUST_READ, IOobject::NO_WRITE, tmp< T >::reset(), fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

◆ sample() [4/6]

Foam::tmp< Foam::Field< Type > > sample ( const VolumeField< Type > & vField ) const

Definition at line 188 of file probesTemplates.C.

References forAll, Pstream::listCombineAllGather(), and Foam::New().

Here is the call graph for this function:

◆ sample() [5/6]

Foam::tmp< Foam::Field< Type > > sample ( const SurfaceField< Type > & sField ) const

Definition at line 236 of file probesTemplates.C.

References forAll, Pstream::listCombineAllGather(), and Foam::New().

Here is the call graph for this function:

◆ sample() [6/6]

Foam::tmp< Foam::Field< Type > > sample ( const word & fieldName ) const

Definition at line 259 of file probesTemplates.C.

◆ sampleSurfaceField() [2/2]

Foam::tmp< Foam::Field< Type > > sampleSurfaceField ( const word & fieldName ) const

Definition at line 267 of file probesTemplates.C.

Member Data Documentation

◆ loadFromFiles_

bool loadFromFiles_

protected

Load fields from files (not from objectRegistry)

Definition at line 191 of file probes.H.

Referenced by probes::getOrLoadField().

◆ 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 196 of file probes.H.

◆ includeOutOfBounds_

bool includeOutOfBounds_

protected

Include probes that were not found (default: true)

Definition at line 199 of file probes.H.

◆ verbose_

bool verbose_

protected

Output verbosity.

Definition at line 202 of file probes.H.

◆ onExecute_

bool onExecute_

protected

Perform sample actions on execute as well.

Definition at line 205 of file probes.H.

◆ fieldSelection_

wordRes fieldSelection_

protected

Requested names of fields to probe.

Definition at line 208 of file probes.H.

Referenced by probes::fieldNames().

◆ samplePointScheme_

word samplePointScheme_

protected

Interpolation/sample scheme to obtain values at the points.

Note: only possible when fixedLocations_ is true

Definition at line 212 of file probes.H.

◆ selectedFieldNames_

DynamicList<word> selectedFieldNames_

protected

Current list of field names selected for sampling.

Definition at line 218 of file probes.H.

◆ scalarFields_

fieldGroup<volScalarField> scalarFields_

protected

Categorized scalar/vector/tensor volume fields.

Definition at line 221 of file probes.H.

◆ vectorFields_

fieldGroup<volVectorField> vectorFields_

protected

Definition at line 222 of file probes.H.

◆ sphericalTensorFields_

fieldGroup<volSphericalTensorField> sphericalTensorFields_

protected

Definition at line 223 of file probes.H.

◆ symmTensorFields_

fieldGroup<volSymmTensorField> symmTensorFields_

protected

Definition at line 224 of file probes.H.

◆ tensorFields_

fieldGroup<volTensorField> tensorFields_

protected

Definition at line 225 of file probes.H.

◆ surfaceScalarFields_

fieldGroup<surfaceScalarField> surfaceScalarFields_

protected

Categorized scalar/vector/tensor surface fields.

Definition at line 228 of file probes.H.

◆ surfaceVectorFields_

fieldGroup<surfaceVectorField> surfaceVectorFields_

protected

Definition at line 229 of file probes.H.

◆ surfaceSphericalTensorFields_

fieldGroup<surfaceSphericalTensorField> surfaceSphericalTensorFields_

protected

Definition at line 230 of file probes.H.

◆ surfaceSymmTensorFields_

fieldGroup<surfaceSymmTensorField> surfaceSymmTensorFields_

protected

Definition at line 231 of file probes.H.

◆ surfaceTensorFields_

fieldGroup<surfaceTensorField> surfaceTensorFields_

protected

Definition at line 232 of file probes.H.

◆ elementList_

labelList elementList_

protected

Cells to be probed (obtained from the locations)

Definition at line 235 of file probes.H.

Referenced by probes::elements(), and patchProbes::findElements().

◆ faceList_

labelList faceList_

protected

Faces to be probed.

Definition at line 238 of file probes.H.

Referenced by patchProbes::findElements().

◆ processor_

labelList processor_

protected

Processor holding the cell or face (-1 if point not found.

on any processor)

Definition at line 242 of file probes.H.

Referenced by patchProbes::findElements().

◆ probeFilePtrs_

HashPtrTable<OFstream> probeFilePtrs_

protected

Current open files (non-empty on master only)

Definition at line 245 of file probes.H.

◆ patchIDList_

labelList patchIDList_

protected

Patch IDs on which the new probes are located (for patchProbes)

Definition at line 248 of file probes.H.

Referenced by patchProbes::findElements().

◆ oldPoints_

pointField oldPoints_

protected

Original probes location (only used for patchProbes)

Definition at line 251 of file probes.H.

Referenced by patchProbes::findElements().

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

src/sampling/probes/probes.H
src/sampling/probes/probes.C
src/sampling/probes/probesTemplates.C

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ sampleActionType

Constructor & Destructor Documentation

◆ probes()

◆ ~probes()

Member Function Documentation

◆ findElements()

◆ prepare()

◆ getOrLoadField() [1/2]

◆ storeResults()

◆ TypeName()

◆ verbose()

◆ fieldNames()

◆ probeLocations()

◆ probe()

◆ elements()

◆ read()

◆ execute()

◆ write()

◆ updateMesh()

◆ movePoints()

◆ readUpdate()

◆ sample() [1/6]

◆ sample() [2/6]

◆ sample() [3/6]

◆ sampleSurfaceField() [1/2]

◆ getOrLoadField() [2/2]

◆ sample() [4/6]

◆ sample() [5/6]

◆ sample() [6/6]

◆ sampleSurfaceField() [2/2]

Member Data Documentation

◆ loadFromFiles_

◆ fixedLocations_

◆ includeOutOfBounds_

◆ verbose_

◆ onExecute_

◆ fieldSelection_

◆ samplePointScheme_

◆ selectedFieldNames_

◆ scalarFields_

◆ vectorFields_

◆ sphericalTensorFields_

◆ symmTensorFields_

◆ tensorFields_

◆ surfaceScalarFields_

◆ surfaceVectorFields_

◆ surfaceSphericalTensorFields_

◆ surfaceSymmTensorFields_

◆ surfaceTensorFields_

◆ elementList_

◆ faceList_

◆ processor_

◆ probeFilePtrs_

◆ patchIDList_

◆ oldPoints_