Set of locations to sample. More...

Inheritance diagram for probes:

[legend]

Collaboration diagram for probes:

[legend]

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 &time, const dictionary &dict)
	Construct from Time and dictionary. More...

	probes (const probes &)=delete
	Disallow default bitwise copy construction. More...

virtual	~probes ()
	Destructor. More...

virtual wordList	fields () const
	Return the list of fields required. 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	movePoints (const polyMesh &)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	readUpdate (const polyMesh::readUpdateState state)
	Update topology using the given map due to readUpdate. More...

template<class Type >
tmp< Field< Type > >	sample (const VolField< Type > &) 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 SurfaceField< Type > &) const
	Sample a surface field at all locations. More...

void	operator= (const probes &)=delete
	Disallow default bitwise assignment. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sample (const VolField< Type > &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 SurfaceField< Type > &sField) const

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

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

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

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

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

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from Field< vector >
	Field ()
	Construct null. More...

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

	Field (const label, const vector &)
	Construct given size and initial value. More...

	Field (const label, const zero)
	Construct given size and initialised to zero. More...

	Field (const UList< vector > &)
	Copy constructor of a UList<Type> More...

	Field (List< vector > &&)
	Mover constructor transferring the List contents. More...

	Field (const UIndirectList< vector > &)
	Copy constructor of a UIndirectList<Type> More...

	Field (const Field< vector > &)
	Copy constructor. More...

	Field (Field< vector > &, bool reuse)
	Copy constructor or reuse as specified. More...

	Field (Field< vector > &&)
	Move constructor transferring the Field contents. More...

	Field (const tmp< Field< vector >> &)
	Copy constructor of tmp<Field> 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 (Istream &)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

	Field (const word &keyword, const unitConversion &, const dictionary &, const label size)
	Construct from a dictionary entry with unit conversion. 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	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	reset (const Field< vector > &)
	Reset the field values to the given field. More...

void	reset (const UList< vector > &)
	Reset the field values to the given field. More...

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

void	operator= (Field< vector > &&)

void	operator= (const UList< vector > &)

void	operator= (List< vector > &&)

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

void	operator= (const vector &)

void	operator= (const 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 refCount
int	count () const
	Return the current reference count. More...

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

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

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

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

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

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Public Member Functions inherited from List< T >
	List ()
	Null constructor. More...

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

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

	List (const label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< T > &)
	Copy constructor. More...

template<class T2 >
	List (const UList< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< T > &&)
	Move constructor. More...

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

	List (const UList< T > &, const labelUList &mapAddressing)
	Construct as subset. More...

template<class InputIterator >
	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

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

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

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

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

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

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

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

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

	~List ()
	Destructor. More...

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

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

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

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const T &)
	Reset size of List and value for new elements. More...

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

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

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

void	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< T > &)
	Transfer the contents of the argument List into this list. More...

template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< T > &)
	Transfer the contents of the argument List into this list. More...

T &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< T > &)=delete
	Disallow implicit shallowCopy. More...

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

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

void	operator= (List< T > &&)
	Move assignment operator. More...

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

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

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

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

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

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

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

	UList (const UList< T > &)=default
	Copy construct. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. 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...

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

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

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

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

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

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

const T &	operator[] (const label) 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 &)
	Assignment of all entries to the given value. More...

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

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

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

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

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

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

const_iterator	end () const
	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
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

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

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

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

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

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

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

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

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

label	appendFieldGroup (const word &fieldName, const word &fieldType)
	Append fieldName to the appropriate group. More...

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

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

label	prepare ()
	Classify field type and Open/close file streams,. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Member Functions inherited from List< T >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Protected Attributes
const fvMesh &	mesh_
	Const reference to fvMesh. More...

wordList	fields_
	Names of fields to probe. More...

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

word	interpolationScheme_
	Interpolation scheme name. More...

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

fieldGroup< vector >	vectorFields_

fieldGroup< sphericalTensor >	sphericalTensorFields_

fieldGroup< symmTensor >	symmTensorFields_

fieldGroup< tensor >	tensorFields_

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

fieldGroup< vector >	surfaceVectorFields_

fieldGroup< sphericalTensor >	surfaceSphericalTensorFields_

fieldGroup< symmTensor >	surfaceSymmTensorFields_

fieldGroup< tensor >	surfaceTensorFields_

labelList	elementList_

labelList	faceList_

HashPtrTable< OFstream >	probeFilePtrs_
	Current open files. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. 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
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

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

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

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

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

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

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

static tmp< Field< vector > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

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 null UList. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from Field< vector >
static const char *const	typeName

Detailed Description

Set of locations to sample.

Call write() to sample and write files.

Source files

Definition at line 64 of file probes.H.

Constructor & Destructor Documentation

◆ probes() [1/2]

probes	(	const word &	name,
		const Time &	time,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 259 of file probes.C.

References dict, and probes::read().

Here is the call graph for this function:

◆ probes() [2/2]

probes ( const probes & )

delete

Disallow default bitwise copy construction.

◆ ~probes()

~probes ( )

virtual

Destructor.

Definition at line 288 of file probes.C.

Member Function Documentation

◆ clearFieldGroups()

void clearFieldGroups ( )

protected

Clear old field groups.

Definition at line 34 of file probesGrouping.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::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:

◆ appendFieldGroup()

Foam::label appendFieldGroup	(	const word &	fieldName,
		const word &	fieldType
	)

protected

Append fieldName to the appropriate group.

Definition at line 50 of file probesGrouping.C.

◆ classifyFields()

Foam::label classifyFields ( )

protected

Classify field types, returns the number of fields.

Definition at line 111 of file probesGrouping.C.

References forAll.

◆ findElements()

void findElements ( const fvMesh & mesh )

protectedvirtual

Find cells and faces containing probes.

Reimplemented in patchProbes.

Definition at line 50 of file probes.C.

References primitiveMesh::cellCentres(), primitiveMesh::cells(), List< T >::clear(), probes::elementList_, Foam::endl(), primitiveMesh::faceCentres(), probes::faceList_, polyMesh::findCell(), forAll, Foam::Info, Foam::mag(), UPstream::master(), mesh, UPstream::myProcNo(), UList< T >::operator[](), Foam::Pout, Foam::reduce(), List< T >::setSize(), List< T >::size(), 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 167 of file probes.C.

References IOstream::defaultPrecision(), polyMesh::defaultRegion, Foam::endl(), HashTable< T, Key, Hash >::erase(), forAll, forAllConstIter, forAllIter, Foam::Info, HashSet< Key, Hash >::insert(), UPstream::master(), Foam::mkDir(), OFstream::name(), Foam::name(), Foam::nl, writeFile::outputPrefix, Foam::setf(), and Foam::setw().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "probes" )

Runtime type information.

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 320 of file probes.C.

◆ probeLocations()

virtual const pointField& probeLocations ( ) const

inlinevirtual

Return locations to probe.

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

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

Here is the call graph for this function:

◆ elements()

const labelList& elements ( ) const

inline

Cells to be probed (obtained from the locations)

Definition at line 222 of file probes.H.

References probes::elementList_.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the probes.

Reimplemented from functionObject.

Reimplemented in patchProbes.

Definition at line 294 of file probes.C.

References dict, dictionary::lookup(), dictionary::readIfPresent(), and WarningInFunction.

Referenced by probes::probes(), and patchProbes::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.

Definition at line 326 of file probes.C.

◆ write()

bool write ( )

virtual

Sample and write.

Implements functionObject.

Reimplemented in patchProbes.

Definition at line 332 of file probes.C.

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 353 of file probes.C.

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

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 364 of file probes.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), DebugInfo, UList< T >::empty(), Foam::endl(), forAll, Foam::Info, polyTopoChangeMap::mesh(), polyTopoChangeMap::reverseCellMap(), and polyTopoChangeMap::reverseFaceMap().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 447 of file probes.C.

References DebugInfo, and Foam::endl().

Here is the call graph for this function:

◆ readUpdate()

virtual void readUpdate ( const polyMesh::readUpdateState state )

inlinevirtual

Update topology using the given map due to readUpdate.

Definition at line 246 of file probes.H.

◆ sample() [1/6]

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

Sample a volume field at all locations.

◆ 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 SurfaceField< Type > & ) const

Sample a surface field at all locations.

◆ operator=()

void operator= ( const probes & )

delete

Disallow default bitwise assignment.

◆ sample() [4/6]

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

Definition at line 176 of file probesTemplates.C.

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

Here is the call graph for this function:

◆ sample() [5/6]

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

Definition at line 232 of file probesTemplates.C.

◆ sample() [6/6]

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

Definition at line 246 of file probesTemplates.C.

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

Here is the call graph for this function:

◆ sampleSurfaceFields() [2/2]

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

Definition at line 277 of file probesTemplates.C.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Const reference to fvMesh.

Definition at line 91 of file probes.H.

◆ fields_

wordList fields_

protected

Names of fields to probe.

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

◆ interpolationScheme_

word interpolationScheme_

protected

Interpolation scheme name.

Note: only possible when fixedLocations_ is true

Definition at line 106 of file probes.H.

◆ scalarFields_

fieldGroup<scalar> scalarFields_

protected

Categorised scalar/vector/tensor vol fields.

Definition at line 112 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ vectorFields_

fieldGroup<vector> vectorFields_

protected

Definition at line 113 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ sphericalTensorFields_

fieldGroup<sphericalTensor> sphericalTensorFields_

protected

Definition at line 114 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ symmTensorFields_

fieldGroup<symmTensor> symmTensorFields_

protected

Definition at line 115 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ tensorFields_

fieldGroup<tensor> tensorFields_

protected

Definition at line 116 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceScalarFields_

fieldGroup<scalar> surfaceScalarFields_

protected

Categorised scalar/vector/tensor surf fields.

Definition at line 119 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceVectorFields_

fieldGroup<vector> surfaceVectorFields_

protected

Definition at line 120 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceSphericalTensorFields_

fieldGroup<sphericalTensor> surfaceSphericalTensorFields_

protected

Definition at line 121 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceSymmTensorFields_

fieldGroup<symmTensor> surfaceSymmTensorFields_

protected

Definition at line 122 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ surfaceTensorFields_

fieldGroup<tensor> surfaceTensorFields_

protected

Definition at line 123 of file probes.H.

Referenced by probes::clearFieldGroups().

◆ elementList_

labelList elementList_

protected

Definition at line 126 of file probes.H.

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

◆ faceList_

labelList faceList_

protected

Definition at line 129 of file probes.H.

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

◆ probeFilePtrs_

HashPtrTable<OFstream> probeFilePtrs_

protected

Current open files.

Definition at line 132 of file probes.H.

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() [1/2]

◆ probes() [2/2]

◆ ~probes()

Member Function Documentation

◆ clearFieldGroups()

◆ appendFieldGroup()

◆ classifyFields()

◆ findElements()

◆ prepare()

◆ TypeName()

◆ fields()

◆ probeLocations()

◆ probe()

◆ elements()

◆ read()

◆ execute()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ readUpdate()

◆ sample() [1/6]

◆ sample() [2/6]

◆ sampleSurfaceFields() [1/2]

◆ sample() [3/6]

◆ operator=()

◆ sample() [4/6]

◆ sample() [5/6]

◆ sample() [6/6]

◆ sampleSurfaceFields() [2/2]

Member Data Documentation

◆ mesh_

◆ fields_

◆ fixedLocations_

◆ interpolationScheme_

◆ scalarFields_

◆ vectorFields_

◆ sphericalTensorFields_

◆ symmTensorFields_

◆ tensorFields_

◆ surfaceScalarFields_

◆ surfaceVectorFields_

◆ surfaceSphericalTensorFields_

◆ surfaceSymmTensorFields_

◆ surfaceTensorFields_

◆ elementList_

◆ faceList_

◆ probeFilePtrs_