patchProbes Class Reference

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

Inheritance diagram for patchProbes:
[legend]
Collaboration diagram for patchProbes:
[legend]

Public Member Functions

 TypeName ("patchProbes")
 Runtime type information. More...
 
 patchProbes (const word &name, const Time &time, const dictionary &dict, const bool loadFromFiles=false, const bool readFields=true)
 Construct from Time and dictionary. More...
 
virtual ~patchProbes ()=default
 Destructor. More...
 
virtual bool write ()
 Public members. More...
 
virtual bool read (const dictionary &)
 Read. 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
 
- Public Member Functions inherited from probes
 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 wordResfieldNames () const
 Return names of fields to probe. More...
 
virtual const pointFieldprobeLocations () const
 Return locations to probe. More...
 
virtual const pointprobe (const label i) const
 Return location for probe i. More...
 
const labelListelements () const
 Cells to be probed (obtained from the locations) More...
 
virtual bool execute ()
 Execute, currently does nothing. 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...
 
dictionarypropertyDict ()
 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 Timetime () const
 Return time database. More...
 
objectRegistrystoredObjects ()
 
const objectRegistrystoredObjects () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()=default
 Destructor. More...
 
virtual const wordtype () const =0
 Runtime type information. More...
 
const wordname () 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< vectorslice (const label pos, label len=-1)
 Return SubField slice (non-const access) - no range checking. More...
 
const SubField< vectorslice (const label pos, label len=-1) const
 Return SubField slice (const access) - no range checking. More...
 
SubField< vectorslice (const labelRange &range)
 Return SubField slice (non-const access) - with range checking. More...
 
const SubField< vectorslice (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

template<class Type >
void sampleAndWrite (const GeometricField< Type, fvPatchField, volMesh > &)
 Sample and write a particular volume field. More...
 
template<class Type >
void sampleAndWrite (const GeometricField< Type, fvsPatchField, surfaceMesh > &)
 Sample and write a particular surface field. More...
 
template<class Type >
void sampleAndWrite (const fieldGroup< Type > &)
 Sample and write all the fields of the given type. More...
 
template<class Type >
void sampleAndWriteSurfaceFields (const fieldGroup< Type > &)
 Sample and write all the surface fields of the given type. 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 GeometricField< Type, fvsPatchField, surfaceMesh > &) const
 Sample a surface field at all locations. More...
 
template<class Type >
tmp< Field< Type > > sample (const word &fieldName) const
 Sample a single field on all sample locations. More...
 
virtual void findElements (const fvMesh &)
 Find elements containing patchProbes. More...
 
- Protected Member Functions inherited from probes
void clearFieldGroups ()
 Clear old field groups. More...
 
label classifyFields ()
 Classify field types, returns the number of fields. More...
 
label prepare ()
 Classify field type and open/close file streams,. More...
 
- Protected Member Functions inherited from stateFunctionObject
const functionObjects::propertiesstateDict () const
 Return a const reference to the state dictionary. More...
 
functionObjects::propertiesstateDict ()
 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

wordRes patchNames_
 Patches to sample. More...
 
- Protected Attributes inherited from probes
const fvMeshmesh_
 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< vectorvectorFields_
 
fieldGroup< sphericalTensorsphericalTensorFields_
 
fieldGroup< symmTensorsymmTensorFields_
 
fieldGroup< tensortensorFields_
 
fieldGroup< scalar > surfaceScalarFields_
 Categorized scalar/vector/tensor surf fields. More...
 
fieldGroup< vectorsurfaceVectorFields_
 
fieldGroup< sphericalTensorsurfaceSphericalTensorFields_
 
fieldGroup< symmTensorsurfaceSymmTensorFields_
 
fieldGroup< tensorsurfaceTensorFields_
 
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< OFstreamprobeFilePtrs_
 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 Timetime_
 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< vectorsubField
 Declare type of subField. More...
 
- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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 at patches.

Call write() to sample and write files.

  • find nearest location on nearest face
  • update *this with location (so header contains 'snapped' locations
  • use *this as the sampling location

Example of function object specification:

patchProbes
{
    type            patchProbes;
    libs            (sampling);

    // Name of the directory for probe data
    name            patchProbes;

    // Patches to sample (wildcards allowed)
    patches         (".*inl.*");

    // Write at same frequency as fields
    writeControl    writeTime;
    writeInterval   1;

    // Fields to be probed
    fields          (p U);

    // Locations to probe. These get snapped onto the nearest point
    // on the selected patches
    probeLocations
    (
        ( -100 0 0.01 )      // at inlet
    );
}
Source files

Definition at line 92 of file patchProbes.H.

Constructor & Destructor Documentation

◆ patchProbes()

patchProbes ( const word name,
const Time time,
const dictionary dict,
const bool  loadFromFiles = false,
const bool  readFields = true 
)

Construct from Time and dictionary.

Definition at line 237 of file patchProbes.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~patchProbes()

virtual ~patchProbes ( )
virtualdefault

Destructor.

Member Function Documentation

◆ sampleAndWrite() [1/3]

void sampleAndWrite ( const GeometricField< Type, fvPatchField, volMesh > &  vField)
protected

Sample and write a particular volume field.

Definition at line 37 of file patchProbesTemplates.C.

References Foam::endl(), forAll, Foam::setw(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ sampleAndWrite() [2/3]

void sampleAndWrite ( const GeometricField< Type, fvsPatchField, surfaceMesh > &  sField)
protected

Sample and write a particular surface field.

Definition at line 63 of file patchProbesTemplates.C.

References Foam::endl(), forAll, Foam::setw(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ sampleAndWrite() [3/3]

void sampleAndWrite ( const fieldGroup< Type > &  fields)
protected

Sample and write all the fields of the given type.

Definition at line 89 of file patchProbesTemplates.C.

References fields, and forAll.

◆ sampleAndWriteSurfaceFields()

void sampleAndWriteSurfaceFields ( const fieldGroup< Type > &  fields)
protected

Sample and write all the surface fields of the given type.

Definition at line 141 of file patchProbesTemplates.C.

References fields, and forAll.

◆ sample() [1/6]

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

Sample a volume field at all locations.

Referenced by patchProbes::sample().

Here is the caller graph for this function:

◆ sample() [2/6]

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

Sample a surface field at all locations.

◆ sample() [3/6]

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

Sample a single field on all sample locations.

◆ findElements()

◆ TypeName()

TypeName ( "patchProbes"  )

Runtime type information.

◆ write()

bool write ( )
virtual

Public members.

Sample and write

Reimplemented from probes.

Definition at line 256 of file patchProbes.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read.

Reimplemented from probes.

Definition at line 277 of file patchProbes.C.

References dict, dictionary::get(), probes::read(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ sample() [4/6]

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

Definition at line 196 of file patchProbesTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, patches, 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 232 of file patchProbesTemplates.C.

References objectRegistry::lookupObject(), probes::mesh_, and patchProbes::sample().

Here is the call graph for this function:

◆ sample() [6/6]

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

Definition at line 247 of file patchProbesTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, Pstream::listCombineGather(), Pstream::listCombineScatter(), patches, tmp< T >::ref(), Foam::HashTableOps::values(), and polyBoundaryMesh::whichPatch().

Here is the call graph for this function:

Member Data Documentation

◆ patchNames_

wordRes patchNames_
protected

Patches to sample.

Definition at line 101 of file patchProbes.H.

Referenced by patchProbes::findElements().


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