Set of locations to sample. More...

Inheritance diagram for probes:

Collaboration diagram for probes:

Classes
class	fieldGroup
	Class used for grouping field types. 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...

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

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

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

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

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

virtual bool	execute ()
	Execute, currently does nothing. 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 GeometricField< Type, fvPatchField, volMesh > &) const
	Sample a volume field at all locations. More...

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

template<class Type >
tmp< Field< Type > >	sampleSurfaceFields (const word &fieldName) const
	Sample a single scalar field on all sample locations. More...

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const GeometricField< Type, fvPatchField, volMesh > &vField) const

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const GeometricField< Type, fvsPatchField, surfaceMesh > &sField) const

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

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, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. 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	execute (const label subIndex)
	Execute using the specified subIndex. 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...

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 ()
	Negate this field (negative). 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 &)

Protected Member Functions
void	clearFieldGroups ()
	Clear old field groups. More...

label	classifyFields ()
	Classify field types, returns the number of fields. More...

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

label	prepare ()
	Classify field type and open/close file streams,. 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 Attributes
const fvMesh &	mesh_
	Const reference to fvMesh. More...

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

wordRes	fieldSelection_
	Names of fields to probe. More...

bool	fixedLocations_
	Fixed locations, default = yes. More...

word	interpolationScheme_
	Interpolation scheme name. More...

bool	includeOutOfBounds_
	Include probes that were not found. More...

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

fieldGroup< vector >	vectorFields_

fieldGroup< sphericalTensor >	sphericalTensorFields_

fieldGroup< symmTensor >	symmTensorFields_

fieldGroup< tensor >	tensorFields_

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

fieldGroup< vector >	surfaceVectorFields_

fieldGroup< sphericalTensor >	surfaceSphericalTensorFields_

fieldGroup< symmTensor >	surfaceSymmTensorFields_

fieldGroup< tensor >	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. More...

labelList	patchIDList_
	Patch IDs on which the new probes are located. More...

pointField	oldPoints_
	Original probes location (only used for patchProbes) 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...

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)

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...

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          (p U);

    // 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;
}

Source files

Definition at line 110 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 303 of file probes.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~probes()

virtual ~probes ( )

virtualdefault

Destructor.

Member Function Documentation

◆ clearFieldGroups()

void clearFieldGroups ( )

protected

Clear old field groups.

Definition at line 36 of file probesGrouping.C.

References DynamicList< T, SizeMin >::clear(), probes::scalarFields_, probes::sphericalTensorFields_, probes::surfaceScalarFields_, probes::surfaceSphericalTensorFields_, probes::surfaceSymmTensorFields_, probes::surfaceTensorFields_, probes::surfaceVectorFields_, probes::symmTensorFields_, probes::tensorFields_, and probes::vectorFields_.

Here is the call graph for this function:

◆ classifyFields()

Foam::label classifyFields ( )

protected

Classify field types, returns the number of fields.

Definition at line 52 of file probesGrouping.C.

References List< T >::append(), Foam::BitOps::count(), fieldNames(), and forAllConstIters().

Here is the call graph for this function:

◆ findElements()

void findElements ( const fvMesh & mesh )

protectedvirtual

Find cells and faces containing probes.

Reimplemented in patchProbes.

Definition at line 54 of file probes.C.

References List< T >::clear(), functionObject::debug, DebugInfo, probes::elementList_, Foam::endl(), probes::faceList_, forAll, Foam::mag(), UPstream::master(), mesh, UPstream::myProcNo(), Foam::nl, Foam::Pout, probes::processor_, Foam::reduce(), List< T >::setSize(), and WarningInFunction.

Here is the call graph for this function:

◆ prepare()

Foam::label prepare ( )

protected

Classify field type and open/close file streams,.

returns number of fields to sample

Definition at line 174 of file probes.C.

References fileName::clean(), DebugInfo, IOstream::defaultPrecision(), polyMesh::defaultRegion, Foam::endl(), forAll, forAllIters, HashSet< Key, Hash >::insert(), Foam::mag(), UPstream::master(), Foam::mkDir(), UPstream::myProcNo(), Foam::name(), fileName::name(), IOobject::name(), autoPtr< T >::New(), Foam::nl, polyBoundaryMesh::nNonProcessor(), functionObject::outputPrefix, and Foam::setw().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "probes" )

Runtime type information.

◆ fieldNames()

virtual const wordRes& fieldNames ( ) const

inlinevirtual

Return names of fields to probe.

Definition at line 273 of file probes.H.

◆ probeLocations()

virtual const pointField& probeLocations ( ) const

inlinevirtual

Return locations to probe.

Definition at line 279 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 285 of file probes.H.

◆ elements()

const labelList& elements ( ) const

inline

Cells to be probed (obtained from the locations)

Definition at line 291 of file probes.H.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the probes.

Reimplemented from functionObject.

Reimplemented in thermoCoupleProbes, and patchProbes.

Definition at line 338 of file probes.C.

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

Referenced by patchProbes::read(), and thermoCoupleProbes::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Reimplemented in thermoCoupleProbes.

Definition at line 366 of file probes.C.

◆ write()

bool write ( )

virtual

Sample and write.

Implements functionObject.

Reimplemented in thermoCoupleProbes, and patchProbes.

Definition at line 372 of file probes.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 393 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 484 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 312 of file probes.H.

◆ sample() [1/6]

tmp<Field<Type> > sample ( const GeometricField< Type, fvPatchField, volMesh > & ) const

Sample a volume field at all locations.

Referenced by thermoCoupleProbes::derivatives(), and thermoCoupleProbes::thermoCoupleProbes().

Here is the caller graph for this function:

◆ sample() [2/6]

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

Sample a single vol field on all sample locations.

◆ sampleSurfaceFields() [1/2]

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

Sample a single scalar field on all sample locations.

◆ sample() [3/6]

tmp<Field<Type> > sample ( const GeometricField< Type, fvsPatchField, surfaceMesh > & ) const

Sample a surface field at all locations.

◆ sample() [4/6]

Foam::tmp<Foam::Field<Type> > sample ( const GeometricField< Type, fvPatchField, volMesh > & vField ) const

Definition at line 225 of file probesTemplates.C.

References forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), tmp< T >::ref(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ sample() [5/6]

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

Definition at line 280 of file probesTemplates.C.

◆ sample() [6/6]

Foam::tmp<Foam::Field<Type> > sample ( const GeometricField< Type, fvsPatchField, surfaceMesh > & sField ) const

Definition at line 295 of file probesTemplates.C.

References forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), tmp< T >::ref(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ sampleSurfaceFields() [2/2]

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

Definition at line 325 of file probesTemplates.C.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Const reference to fvMesh.

Definition at line 137 of file probes.H.

Referenced by patchProbes::sample().

◆ loadFromFiles_

bool loadFromFiles_

protected

Load fields from files (not from objectRegistry)

Definition at line 140 of file probes.H.

◆ fieldSelection_

wordRes fieldSelection_

protected

Names of fields to probe.

Definition at line 146 of file probes.H.

◆ fixedLocations_

bool fixedLocations_

protected

Fixed locations, default = yes.

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

Definition at line 151 of file probes.H.

◆ interpolationScheme_

word interpolationScheme_

protected

Interpolation scheme name.

Note: only possible when fixedLocations_ is true

Definition at line 155 of file probes.H.

◆ includeOutOfBounds_

bool includeOutOfBounds_

protected

Include probes that were not found.

Definition at line 158 of file probes.H.

◆ scalarFields_

fieldGroup<scalar> scalarFields_

protected

Categorized scalar/vector/tensor vol fields.

Definition at line 164 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ vectorFields_

fieldGroup<vector> vectorFields_

protected

Definition at line 165 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ sphericalTensorFields_

fieldGroup<sphericalTensor> sphericalTensorFields_

protected

Definition at line 166 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ symmTensorFields_

fieldGroup<symmTensor> symmTensorFields_

protected

Definition at line 167 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ tensorFields_

fieldGroup<tensor> tensorFields_

protected

Definition at line 168 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceScalarFields_

fieldGroup<scalar> surfaceScalarFields_

protected

Categorized scalar/vector/tensor surf fields.

Definition at line 171 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceVectorFields_

fieldGroup<vector> surfaceVectorFields_

protected

Definition at line 172 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceSphericalTensorFields_

fieldGroup<sphericalTensor> surfaceSphericalTensorFields_

protected

Definition at line 173 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceSymmTensorFields_

fieldGroup<symmTensor> surfaceSymmTensorFields_

protected

Definition at line 174 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceTensorFields_

fieldGroup<tensor> surfaceTensorFields_

protected

Definition at line 175 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ elementList_

labelList elementList_

protected

Cells to be probed (obtained from the locations)

Definition at line 178 of file probes.H.

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

◆ faceList_

labelList faceList_

protected

Faces to be probed.

Definition at line 181 of file probes.H.

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

◆ processor_

labelList processor_

protected

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

on any processor)

Definition at line 185 of file probes.H.

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

◆ probeFilePtrs_

HashPtrTable<OFstream> probeFilePtrs_

protected

Current open files.

Definition at line 188 of file probes.H.

◆ patchIDList_

labelList patchIDList_

protected

Patch IDs on which the new probes are located.

Definition at line 193 of file probes.H.

Referenced by patchProbes::findElements().

◆ oldPoints_

pointField oldPoints_

protected

Original probes location (only used for patchProbes)

Definition at line 196 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/probesGrouping.C
src/sampling/probes/probesTemplates.C

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ probes()

◆ ~probes()

Member Function Documentation

◆ clearFieldGroups()

◆ classifyFields()

◆ findElements()

◆ prepare()

◆ TypeName()

◆ fieldNames()

◆ probeLocations()

◆ probe()

◆ elements()

◆ read()

◆ execute()

◆ write()

◆ updateMesh()

◆ movePoints()

◆ readUpdate()

◆ sample() [1/6]

◆ sample() [2/6]

◆ sampleSurfaceFields() [1/2]

◆ sample() [3/6]

◆ sample() [4/6]

◆ sample() [5/6]

◆ sample() [6/6]

◆ sampleSurfaceFields() [2/2]

Member Data Documentation

◆ mesh_

◆ loadFromFiles_

◆ fieldSelection_

◆ fixedLocations_

◆ interpolationScheme_

◆ includeOutOfBounds_

◆ scalarFields_

◆ vectorFields_

◆ sphericalTensorFields_

◆ symmTensorFields_

◆ tensorFields_

◆ surfaceScalarFields_

◆ surfaceVectorFields_

◆ surfaceSphericalTensorFields_

◆ surfaceSymmTensorFields_

◆ surfaceTensorFields_

◆ elementList_

◆ faceList_

◆ processor_

◆ probeFilePtrs_

◆ patchIDList_

◆ oldPoints_