Function object to sample fields at specified internal-mesh locations and write to file. More...

#include <probes.H>

Inheritance diagram for probes:

[legend]

Collaboration diagram for probes:

Public Member Functions
	TypeName ("probes")
	Runtime type information.
	probes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true)
	Construct from Time and dictionary.
virtual	~probes ()=default
	Destructor.
virtual bool	read (const dictionary &)
	Read the settings from the dictionary.
const internalFieldProbe &	probeModel () const noexcept
	Bring Base::probeModel into this class's public scope.
Public Member Functions inherited from Probes< internalFieldProbe >
	Probes (const word &name, const Time &runTime, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true)
	Construct from Time and dictionary.
virtual	~Probes ()=default
	Destructor.
bool	verbose (const bool on) noexcept
	Enable/disable verbose output.
virtual const wordRes &	fieldNames () const noexcept
	Return names of fields to probe.
const internalFieldProbe &	probeModel () const noexcept
	Return const reference to the point probeModel.
virtual bool	execute ()
	Sample and store result if the sampleOnExecute is enabled.
virtual bool	write ()
	Sample and write.
virtual void	readUpdate (const polyMesh::readUpdateState state)
	Update for changes of mesh due to readUpdate.
Foam::tmp< GeoField >	getOrLoadField (const word &fieldName) const
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.

Additional Inherited Members
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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Protected Types inherited from Probes< internalFieldProbe >
enum	sampleActionType
	Local control for sampling actions. More...
Protected Member Functions inherited from Probes< internalFieldProbe >
label	prepare (unsigned request)
	Classify field types, close/open file streams.
tmp< GeoField >	getOrLoadField (const word &fieldName) const
	Get from registry or load from disk.
void	storeResults (const word &fieldName, const Field< Type > &values)
	Store results: min/max/average/size.
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
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.
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.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.
Protected Attributes inherited from Probes< internalFieldProbe >
internalFieldProbe	probeModel_
	The specified point probeModel.
bool	loadFromFiles_
	Load fields from files (not from objectRegistry).
bool	verbose_
	Output verbosity.
bool	onExecute_
	Perform sample actions on execute as well.
wordRes	fieldSelection_
	Requested names of fields to probe.
DynamicList< word >	selectedFieldNames_
	Current list of field names selected for sampling.
fieldGroup< volScalarField >	scalarFields_
	Categorized scalar/vector/tensor volume fields.
fieldGroup< volVectorField >	vectorFields_
fieldGroup< volSphericalTensorField >	sphericalTensorFields_
fieldGroup< volSymmTensorField >	symmTensorFields_
fieldGroup< volTensorField >	tensorFields_
fieldGroup< surfaceScalarField >	surfaceScalarFields_
	Categorized scalar/vector/tensor surface fields.
fieldGroup< surfaceVectorField >	surfaceVectorFields_
fieldGroup< surfaceSphericalTensorField >	surfaceSphericalTensorFields_
fieldGroup< surfaceSymmTensorField >	surfaceSymmTensorFields_
fieldGroup< surfaceTensorField >	surfaceTensorFields_
HashPtrTable< OFstream >	probeFilePtrs_
	Current open files (non-empty on master only).
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.

Detailed Description

Function object to sample fields at specified internal-mesh locations and write to file.

Usage

Minimal example by using system/controlDict.functions:

probes
{
    // Mandatory entries
    type            probes;
    libs            (sampling);

    fields          (<wordRes>);
    probeLocations  (<vectorList>);

    // Optional entries
    verbose         <bool>;
    sampleOnExecute <bool>;
    fixedLocations  <bool>;
    includeOutOfBounds <bool>;
    interpolationScheme <word>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: probes	word	yes	-
`libs`	Library name: sampling	word	yes	-
`fields`	Names of fields to probe	wordRes	yes	-
`probeLocations`	Locations of probes	vectorList	yes	-
`verbose`	Enable/disable verbose output	bool	no	false
`sampleOnExecute`	Sample on execution and store results	bool	no	false
`fixedLocations`	Do not recalculate cells if mesh moves	bool	no	true
`includeOutOfBounds`	Include out-of-bounds locations	bool	no	true
`interpolationScheme`	Scheme to obtain values at the points	word	no	cell