Set of sets to sample. More...
Public Member Functions | |
| TypeName ("sets") | |
| Runtime type information. More... | |
| sampledSets (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| sampledSets (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false) | |
| Construct for given objectRegistry and dictionary. More... | |
| virtual | ~sampledSets ()=default |
| Destructor. More... | |
| bool | verbose (const bool on) noexcept |
| Enable/disable verbose output. More... | |
| virtual bool | read (const dictionary &) |
| Read the sampledSets. More... | |
| virtual bool | execute () |
| Execute, currently does nothing. More... | |
| virtual bool | write () |
| Sample and write. More... | |
| void | correct () |
| Correct for mesh changes. More... | |
| virtual void | updateMesh (const mapPolyMesh &) |
| Update for changes of mesh. More... | |
| virtual void | movePoints (const polyMesh &) |
| Update for mesh point-motion. More... | |
| virtual void | readUpdate (const polyMesh::readUpdateState state) |
| Update for changes of mesh due to readUpdate. More... | |
| template<class GeoField > | |
| Foam::tmp< GeoField > | getOrLoadField (const word &fieldName) const |
 Public Member Functions inherited from fvMeshFunctionObject | |
| TypeName ("fvMeshFunctionObject") | |
| Runtime type information. More... | |
| fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from the region objectRegistry and dictionary. More... | |
| virtual | ~fvMeshFunctionObject ()=default |
| Destructor. More... | |
| Public Member Functions inherited from regionFunctionObject | |
| TypeName ("regionFunctionObject") | |
| Runtime type information. More... | |
| regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from the region objectRegistry and dictionary. More... | |
| virtual | ~regionFunctionObject ()=default |
| Destructor. More... | |
| virtual bool | read (const dictionary &dict) |
| Read optional controls. More... | |
| template<class ObjectType > | |
| const ObjectType * | lookupObjectPtr (const word &fieldName) const |
| Deprecated(2018-10) More... | |
| template<class ObjectType > | |
| ObjectType * | lookupObjectRefPtr (const word &fieldName) const |
| Deprecated(2018-10) More... | |
| 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) |
| Set new trigger index. 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 | read (const dictionary &dict) |
| Read and set the function object if its data have changed. More... | |
| virtual bool | execute ()=0 |
| Called at each ++ or += of the time-loop. More... | |
| virtual bool | execute (const label subIndex) |
| Execute using the specified subIndex. More... | |
| virtual bool | write ()=0 |
| Called at each ++ or += of the time-loop. 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... | |
| virtual void | updateMesh (const mapPolyMesh &mpm) |
| Update for changes of mesh. More... | |
| virtual void | movePoints (const polyMesh &mesh) |
| Update for changes of mesh. More... | |
| Public Member Functions inherited from PtrList< sampledSet > | |
| constexpr | PtrList () noexcept |
| Default construct. More... | |
| PtrList (const label len) | |
| Construct with specified size, each element initialized to nullptr. More... | |
| PtrList (const PtrList< sampledSet > &list) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< sampledSet > &&list) | |
| Move construct. More... | |
| PtrList (UList< sampledSet * > &list) | |
| Take ownership of pointers in the list, set old pointers to null. More... | |
| PtrList (const PtrList< sampledSet > &list, const CloneArg &cloneArgs) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< sampledSet > &list, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< sampledSet > &list) | |
| Copy construct using 'clone()' on each element of SLPtrList<T> More... | |
| PtrList (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrList (Istream &is) | |
| Construct from Istream using default Istream constructor class. More... | |
| ~PtrList () | |
| Destructor. More... | |
| PtrList< sampledSet > | clone (Args &&... args) const |
| Make a copy by cloning each of the list elements. More... | |
| Foam::PtrList< sampledSet > | clone (Args &&... args) const |
| const sampledSet * | set (const label i) const |
| autoPtr< sampledSet > | set (const label i, sampledSet *ptr) |
| Set element to given pointer and return old element (can be null) More... | |
| autoPtr< sampledSet > | set (const label i, autoPtr< sampledSet > &ptr) |
| Set element to given autoPtr and return old element. More... | |
| autoPtr< sampledSet > | set (const label i, autoPtr< sampledSet > &&ptr) |
| Set element to given autoPtr and return old element. More... | |
| autoPtr< sampledSet > | set (const label i, std::unique_ptr< sampledSet > &&ptr) |
| Set element to given unique_ptr and return old element. More... | |
| autoPtr< sampledSet > | set (const label i, const refPtr< sampledSet > &ptr) |
| Set element to given refPtr and return old element. More... | |
| autoPtr< sampledSet > | set (const label i, const tmp< sampledSet > &ptr) |
| Set element to given tmp and return old element. More... | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. More... | |
| void | resize (const label newLen) |
| Adjust size of PtrList. More... | |
| void | setSize (const label newLen) |
| Same as resize() More... | |
| void | emplace_append (Args &&... args) |
| Construct and append an element to the end of the list. More... | |
| void | append (sampledSet *ptr) |
| Append an element to the end of the list. More... | |
| void | append (autoPtr< sampledSet > &ptr) |
| Move append an element to the end of the list. More... | |
| void | append (autoPtr< sampledSet > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (std::unique_ptr< sampledSet > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (const refPtr< sampledSet > &ptr) |
| Move or clone append a refPtr to the end of the list. More... | |
| void | append (const tmp< sampledSet > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | append (PtrList< sampledSet > &&other) |
| Move append another list to the end of this list. More... | |
| autoPtr< sampledSet > | emplace (const label i, Args &&... args) |
| Construct and set an element. More... | |
| Foam::autoPtr< sampledSet > | emplace (const label i, Args &&... args) |
| autoPtr< sampledSet > | release (const label i) |
| Release ownership of the pointer at the given position. More... | |
| void | transfer (PtrList< sampledSet > &list) |
| Transfer into this list and annul the argument list. More... | |
| void | operator= (const PtrList< sampledSet > &list) |
| Copy assignment. More... | |
| void | operator= (PtrList< sampledSet > &&list) |
| Move assignment. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| constexpr | UPtrList () noexcept |
| Default construct. More... | |
| UPtrList (const label len) | |
| Construct with specified size, each element initialized to nullptr. More... | |
| UPtrList (const UPtrList< T > &list) | |
| Copy construct (shallow copies addresses) More... | |
| UPtrList (UPtrList< T > &&list) | |
| Move construct. More... | |
| UPtrList (UPtrList< T > &list, bool reuse) | |
| Construct as shallow copy or re-use as specified. More... | |
| UPtrList (PtrList< T > &list) | |
| Shallow copy from PtrList. More... | |
| UPtrList (const UList< T * > &list) | |
| Construct from UList of pointers (shallow copy) More... | |
| UPtrList (UList< T > &list) | |
| Construct from UList, taking the address of each list element. More... | |
| label | size () const noexcept |
| The number of elements in the list. More... | |
| bool | empty () const noexcept |
| True if the list is empty (ie, size() is zero) More... | |
| T & | first () |
| Return reference to the first element of the list. More... | |
| const T & | first () const |
| Return reference to first element of the list. More... | |
| T & | last () |
| Return reference to the last element of the list. More... | |
| const T & | last () const |
| Return reference to the last element of the list. More... | |
| const T * | test (const label i) const |
| T * | get (const label i) |
| const T * | get (const label i) const |
| const T * | set (const label i) const |
| void | clear () |
| Set list size to zero. More... | |
| void | resize (const label newLen) |
| Change the size of the list. More... | |
| void | setSize (const label n) |
| Alias for resize() More... | |
| label | squeezeNull () |
| Squeeze out intermediate nullptr entries in the list of pointers. More... | |
| void | append (T *ptr) |
| Append an element to the end of the list. More... | |
| void | append (UPtrList< T > &&other) |
| Move append another list to the end of this list. More... | |
| void | swap (UPtrList< T > &list) |
| Swap content. More... | |
| void | transfer (UPtrList< T > &list) |
| Transfer contents into this list and annul the argument. More... | |
| T * | set (const label i, T *ptr) |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| void | sortOrder (const labelUList &order, const bool check=false) |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. More... | |
| const T & | operator[] (const label i) const |
| Return const reference to the element. More... | |
| T & | operator[] (const label i) |
| Return reference to the element. More... | |
| const T * | operator() (const label i) const |
| Return const pointer to the element - same as get(). More... | |
| void | operator= (const UPtrList< T > &list) |
| Copy assignment (shallow copies addresses) More... | |
| void | operator= (UPtrList< T > &&list) |
| Move assignment. More... | |
| T ** | begin_ptr () noexcept |
| Iterator to begin of raw pointers traversal (use with caution) More... | |
| T ** | end_ptr () noexcept |
| Iterator beyond end of raw pointers traversal (use with caution) More... | |
| iterator | begin () noexcept |
| Return an iterator to begin of UPtrList traversal. More... | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. More... | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin of UPtrList traversal. More... | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin of UPtrList traversal. More... | |
| const_iterator | end () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
Additional Inherited Members | |
| Public Types inherited from UPtrList< T > | |
| typedef T | value_type |
| Type of values the list contains. More... | |
| typedef T & | reference |
| A non-const reference to the value_type. More... | |
| typedef const T & | const_reference |
| A const reference to the value_type. 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... | |
| 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... | |
| Protected Member Functions inherited from fvMeshFunctionObject | |
| fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
| No copy construct. More... | |
| void | operator= (const fvMeshFunctionObject &)=delete |
| No copy assignment. More... | |
| Protected Member Functions inherited from regionFunctionObject | |
| virtual const objectRegistry & | obr () const |
| The region or sub-region registry being used. More... | |
| template<class ObjectType > | |
| bool | foundObject (const word &fieldName) const |
| Find object (eg, a field) in the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| const ObjectType * | cfindObject (const word &fieldName) const |
| template<class ObjectType > | |
| const ObjectType * | findObject (const word &fieldName) const |
| template<class ObjectType > | |
| ObjectType * | findObject (const word &fieldName) |
| template<class ObjectType > | |
| ObjectType * | getObjectPtr (const word &fieldName) const |
| template<class ObjectType > | |
| const ObjectType & | lookupObject (const word &fieldName) const |
| Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType & | lookupObjectRef (const word &fieldName) const |
| Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| bool | store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
| Store the field in the (sub) objectRegistry under the given name. More... | |
| template<class ObjectType > | |
| bool | storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr) |
| Store the field in an optional objectRegistry under the given name. More... | |
| bool | writeObject (const word &fieldName) |
| Write field if present in the (sub) objectRegistry. More... | |
| bool | clearObject (const word &fieldName) |
| Clear field from the (sub) objectRegistry if present. More... | |
| void | clearObjects (const wordList &objNames) |
| Clear fields from the (sub) objectRegistry if present. More... | |
| regionFunctionObject (const regionFunctionObject &)=delete | |
| No copy construct. More... | |
| void | operator= (const regionFunctionObject &)=delete |
| No copy assignment. 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 Member Functions inherited from PtrList< sampledSet > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. More... | |
| void | free () |
| Delete the allocated entries, but retain the list size. More... | |
| Protected Member Functions inherited from UPtrList< T > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. More... | |
| UPtrList (Detail::PtrListDetail< T > &&ptrs) | |
| Low-level move construct. More... | |
| Protected Attributes inherited from fvMeshFunctionObject | |
| const fvMesh & | mesh_ |
| Reference to the fvMesh. More... | |
| Protected Attributes inherited from regionFunctionObject | |
| word | subRegistryName_ |
| Name for alternative object registry. More... | |
| const objectRegistry & | obr_ |
| Reference to the region objectRegistry. More... | |
| const objectRegistry * | obrPtr_ |
| Pointer to alternative (eg, sub-region) objectRegistry. More... | |
| Protected Attributes inherited from timeFunctionObject | |
| const Time & | time_ |
| Reference to the time database. More... | |
| Protected Attributes inherited from UPtrList< T > | |
| Detail::PtrListDetail< T > | ptrs_ |
| The list of pointers. More... | |
Set of sets to sample.
The write() method is used to sample and write files.
Example of function object specification:
surfaces
{
type sets;
libs (sampling);
// Write at same frequency as fields
writeControl writeTime;
writeInterval 1;
// Fields to be sampled
fields (p U);
// Scheme to obtain values
interpolationScheme cellPoint;
// Output format
setFormat vtk;
formatOptions
{
vtk
{
precision 10;
}
}
sets
{
Uref
{
type cloud;
axis xyz;
points ((-0.0508 0.0508 0.01));
}
}
}
Entries:
| Property | Description | Required | Default |
|---|---|---|---|
type | Type-name: sets | yes | |
sets | Dictionary or list of sample sets | expected | |
fields | word/regex list of fields to sample | yes | |
interpolationScheme | scheme to obtain values | no | cellPoint |
setFormat | output format | yes | |
sampleOnExecute | Sample (store) on execution as well | no | false |
formatOptions | dictionary of format options | no |
Additional per-set entries:
| Property | Description | Required | Default |
|---|---|---|---|
store | Store surface/fields on registry | no | |
setFormat | output format | no | |
formatOptions | dictionary of format options | no |
probes can be used to output ensemble results in a format similar to the probes function object.Definition at line 192 of file sampledSets.H.
| sampledSets | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 426 of file sampledSets.C.
References fileName::clean(), dict, and sampledSets::read().
| sampledSets | ( | 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 463 of file sampledSets.C.
References fileName::clean(), dict, and sampledSets::read().
|
virtualdefault |
Destructor.
| TypeName | ( | "sets" | ) |
Runtime type information.
|
virtual |
Read the sampledSets.
Reimplemented from regionFunctionObject.
Definition at line 511 of file sampledSets.C.
References PtrList< T >::clear(), dict, Foam::endl(), dictionary::findEntry(), Foam::flatOutput(), forAll, dictionary::getOrDefault(), Foam::Info, splitCell::master(), Foam::nl, Foam::Pout, dictionary::readEntry(), and s().
Referenced by sampledSets::sampledSets().
|
virtual |
Execute, currently does nothing.
Implements functionObject.
Definition at line 724 of file sampledSets.C.
|
virtual |
| void correct | ( | ) |
Correct for mesh changes.
Definition at line 741 of file sampledSets.C.
|
virtual |
Update for changes of mesh.
Reimplemented from functionObject.
Definition at line 747 of file sampledSets.C.
References correct(), and mapPolyMesh::mesh().
|
virtual |
Update for mesh point-motion.
Reimplemented from functionObject.
Definition at line 756 of file sampledSets.C.
References correct(), and mesh.
|
virtual |
Update for changes of mesh due to readUpdate.
Definition at line 765 of file sampledSets.C.
References correct(), and polyMesh::UNCHANGED.
Definition at line 39 of file sampledSetsImpl.C.
References objectRegistry::cfindObject(), tmp< T >::cref(), fvMeshFunctionObject::mesh_, IOobject::MUST_READ, IOobject::NO_WRITE, tmp< T >::reset(), fvMesh::time(), and Time::timeName().
1.9.5