FreeFOAM The Cross-Platform CFD Toolkit
patchProbes Class Reference

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

#include <sampling/patchProbes.H>


Detailed Description

Set of locations to sample.at patches.

Call write() to sample and write files.

Source files

Definition at line 57 of file patchProbes.H.

+ Inheritance diagram for patchProbes:
+ Collaboration diagram for patchProbes:

List of all members.

Public Member Functions

 TypeName ("patchProbes")
 Runtime type information.
 patchProbes (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary.
virtual ~patchProbes ()
 Destructor.
virtual void write ()
 Public members.
virtual void read (const dictionary &)
 Read.
virtual void findElements (const fvMesh &)
 Find elements containing patchProbes.
- Public Member Functions inherited from probes
 TypeName ("probes")
 Runtime type information.
 probes (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary.
virtual ~probes ()
 Destructor.
virtual const wordname () const
 Return name of the set of probes.
virtual const wordListfieldNames () const
 Return names of fields to probe.
virtual const vectorFieldprobeLocations () const
 Return locations to probe.
const labelListelements () const
 Cells to be probed (obtained from the locations)
virtual void execute ()
 Execute, currently does nothing.
virtual void end ()
 Execute at the final time-loop, currently does nothing.
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh.
virtual void movePoints (const pointField &)
 Update for changes of mesh.
virtual void readUpdate (const polyMesh::readUpdateState state)
 Update for changes of mesh due to readUpdate.

Additional Inherited Members

- Protected Member Functions inherited from probes
bool checkFieldTypes ()
 classify field types, return true if nFields > 0
template<class Type >
label countFields (fieldGroup< Type > &fieldList, const wordList &fieldTypes) const
 Find the fields in the list of the given type, return count.
- Protected Attributes inherited from probes
word name_
 Name of this set of probes,.
const objectRegistryobr_
 Const reference to objectRegistry.
bool loadFromFiles_
 Load fields from files (not from objectRegistry)
wordList fieldNames_
 Names of fields to probe.
vectorField probeLocations_
 Locations to probe.
fieldGroup< scalar > scalarFields_
 Categorized scalar/vector/tensor fields.
fieldGroup< vectorvectorFields_
fieldGroup< sphericalTensorsphericalTensorFields_
fieldGroup< symmTensorsymmTensorFields_
fieldGroup< tensortensorFields_
labelList elementList_
HashPtrTable< OFstreamprobeFilePtrs_
 Current open files.

Constructor & Destructor Documentation

patchProbes ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 204 of file patchProbes.C.

~patchProbes ( )
virtual

Destructor.

Definition at line 219 of file patchProbes.C.


Member Function Documentation

TypeName ( "patchProbes"  )

Runtime type information.

void write ( )
virtual

Public members.

Sample and write

Reimplemented from probes.

Definition at line 223 of file patchProbes.C.

void read ( const dictionary dict)
virtual

Read.

Reimplemented from probes.

Definition at line 235 of file patchProbes.C.

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


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