Set of locations to sample.at patches. More...

Inheritance diagram for patchProbes:

Collaboration diagram for patchProbes:

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

	patchProbes (const word &name, const Time &time, const dictionary &dict)
	Construct from Time and dictionary. More...

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

virtual	~patchProbes ()
	Destructor. More...

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

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

void	operator= (const patchProbes &)=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 SurfaceField< Type > &sField) const

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

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

	probes (const word &name, const Time &time, const dictionary &dict, const bool initialise=true)
	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...

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

virtual bool	execute ()
	Execute, currently does nothing. 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	distribute (const polyDistributionMap &)
	Update using the given distribution map. 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 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 > >	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...

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

Additional Inherited Members
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...

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

Protected Member Functions inherited from probes
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...

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

Protected Attributes inherited from probes
const fvMesh &	mesh_
	Const reference to fvMesh. More...

pointField	locations_
	Probe locations. 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	cellList_

labelList	faceList_

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

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Set of locations to sample.at patches.

Call write() to sample and write files.

Source files

Definition at line 56 of file patchProbes.H.

Constructor & Destructor Documentation

◆ patchProbes() [1/2]

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

Construct from Time and dictionary.

Definition at line 179 of file patchProbes.C.

References dict, and patchProbes::read().

Here is the call graph for this function:

◆ patchProbes() [2/2]

patchProbes ( const patchProbes & )

delete

Disallow default bitwise copy construction.

◆ ~patchProbes()

~patchProbes ( )

virtual

Destructor.

Definition at line 194 of file patchProbes.C.

Member Function Documentation

◆ TypeName()

TypeName ( "patchProbes" )

Runtime type information.

◆ write()

bool write ( )

virtual

Sample and write.

Reimplemented from probes.

Definition at line 217 of file patchProbes.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read.

Reimplemented from probes.

Definition at line 200 of file patchProbes.C.

References dict, dictionary::lookup(), and probes::read().

Referenced by patchProbes::patchProbes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const patchProbes & )

delete

Disallow default bitwise assignment.

◆ sample() [1/3]

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

Definition at line 133 of file patchProbesTemplates.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), patches, patchi, and tmp< T >::ref().

Here is the call graph for this function:

◆ sample() [2/3]

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

Definition at line 167 of file patchProbesTemplates.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), patches, patchi, and tmp< T >::ref().

Here is the call graph for this function:

◆ sample() [3/3]

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

Definition at line 201 of file patchProbesTemplates.C.

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

src/sampling/probes/patchProbes.H
src/sampling/probes/patchProbes.C
src/sampling/probes/patchProbesTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ patchProbes() [1/2]

◆ patchProbes() [2/2]

◆ ~patchProbes()

Member Function Documentation

◆ TypeName()

◆ write()

◆ read()

◆ operator=()

◆ sample() [1/3]

◆ sample() [2/3]

◆ sample() [3/3]