Set of surfaces to sample. More...
Public Member Functions | |
| TypeName ("surfaces") | |
| Runtime type information. More... | |
| sampledSurfaces (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| sampledSurfaces (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false) | |
| Construct for given objectRegistry and dictionary. More... | |
| virtual | ~sampledSurfaces ()=default |
| Destructor. More... | |
| bool | verbose (bool on) noexcept |
| Enable/disable verbose output. More... | |
| const wordRes & | fieldNames () const noexcept |
| Return names of fields to sample. More... | |
| virtual bool | read (const dictionary &dict) |
| Read the sampledSurfaces dictionary. More... | |
| virtual bool | execute () |
| Sample and store if the sampleOnExecute is enabled. More... | |
| virtual bool | write () |
| Sample and write. More... | |
| virtual void | updateMesh (const mapPolyMesh &mpm) |
| Update for changes of mesh - expires the surfaces. More... | |
| virtual void | movePoints (const polyMesh &mesh) |
| Update for mesh point-motion - expires the surfaces. More... | |
| virtual void | readUpdate (const polyMesh::readUpdateState state) |
| Update for changes of mesh due to readUpdate - expires the surfaces. More... | |
 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... | |
| 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... | |
| bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
| 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 () |
| Write access to the output objects ("functionObjectObjects") registered on Time. More... | |
| const objectRegistry & | storedObjects () const |
| Const access to the output objects ("functionObjectObjects") registered on Time. More... | |
| 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 | 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 PtrList< sampledSurface > | |
| constexpr | PtrList () noexcept |
| Default construct. More... | |
| PtrList (const label len) | |
| Construct with specified size, each element initialized to nullptr. More... | |
| PtrList (const PtrList< sampledSurface > &list) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< sampledSurface > &&list) noexcept | |
| Move construct. More... | |
| PtrList (UList< sampledSurface * > &list) | |
| Take ownership of pointers in the list, set old pointers to null. More... | |
| PtrList (const PtrList< sampledSurface > &list, const CloneArg &cloneArgs) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< sampledSurface > &list, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< sampledSurface > &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. Frees all pointers. More... | |
| PtrList< sampledSurface > | clone (Args &&... args) const |
| Make a copy by cloning each of the list elements. More... | |
| Foam::PtrList< sampledSurface > | clone (Args &&... args) const |
| const sampledSurface * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| autoPtr< sampledSurface > | set (const label i, sampledSurface *ptr) |
| Set element to given pointer and return old element (can be null) More... | |
| autoPtr< sampledSurface > | set (const label i, std::unique_ptr< sampledSurface > &&ptr) |
| Set element to given unique_ptr and return old element. More... | |
| autoPtr< sampledSurface > | set (const label i, autoPtr< sampledSurface > &&ptr) |
| Set element to given autoPtr and return old element. More... | |
| autoPtr< sampledSurface > | set (const label i, const refPtr< sampledSurface > &ptr) |
| Set element to given refPtr and return old element. More... | |
| autoPtr< sampledSurface > | set (const label i, const tmp< sampledSurface > &ptr) |
| Set element to given tmp and return old element. More... | |
| autoPtr< sampledSurface > | set (const label i, autoPtr< sampledSurface > &ptr) |
| Set element to given autoPtr and return old element. More... | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. More... | |
| void | free () |
| Free memory and nullify all entries. Does not change the list size. More... | |
| void | resize (const label newLen) |
| Adjust size of PtrList. More... | |
| void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. More... | |
| sampledSurface & | emplace_back (Args &&... args) |
| Construct and append an element to the end of the list, return reference to the new list element. More... | |
| void | push_back (sampledSurface *ptr) |
| Append an element to the end of the list. More... | |
| void | push_back (std::unique_ptr< sampledSurface > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | push_back (autoPtr< sampledSurface > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | push_back (const refPtr< sampledSurface > &ptr) |
| Move or clone append a refPtr to the end of the list. More... | |
| void | push_back (const tmp< sampledSurface > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | push_back (PtrList< sampledSurface > &&other) |
| Move append another list to the end of this list. More... | |
| void | push_back (autoPtr< sampledSurface > &ptr)=delete |
| Disallow push_back with autoPtr without std::move. More... | |
| sampledSurface & | emplace_set (const label i, Args &&... args) |
| Construct and set a new element at given position, (discard old element at that location). More... | |
| sampledSurface & | emplace (const label i, Args &&... args) |
| Same as emplace_set() More... | |
| sampledSurface & | try_emplace (const label i, Args &&... args) |
| Like emplace_set() but will not overwrite an occupied (non-null) location. More... | |
| autoPtr< sampledSurface > | release (const label i) |
| Release ownership of the pointer at the given position. More... | |
| void | transfer (PtrList< sampledSurface > &list) |
| Transfer into this list and annul the argument list. More... | |
| void | operator= (const UPtrList< sampledSurface > &list) |
| Copy assignment. More... | |
| void | operator= (const PtrList< sampledSurface > &list) |
| Copy assignment. More... | |
| void | operator= (PtrList< sampledSurface > &&list) |
| Move assignment. More... | |
| void | setSize (const label n) |
| Same as resize() More... | |
| void | append (autoPtr< sampledSurface > &ptr) |
| Move append an element to the end of the list. More... | |
| void | append (sampledSurface *ptr) |
| Append an element to the end of the list. More... | |
| void | append (std::unique_ptr< sampledSurface > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (autoPtr< sampledSurface > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (const refPtr< sampledSurface > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | append (const tmp< sampledSurface > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | append (PtrList< sampledSurface > &&other) |
| Move append another list to the end of this list. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| constexpr | UPtrList () noexcept=default |
| Default construct. More... | |
| UPtrList (const label len) | |
Construct with specified size and set all entries to nullptr. More... | |
| UPtrList (const UPtrList< T > &list) | |
| Copy construct (shallow copies addresses) More... | |
| UPtrList (UPtrList< T > &&list) noexcept | |
| 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... | |
| bool | empty () const noexcept |
| True if the list is empty (ie, size() is zero) More... | |
| label | size () const noexcept |
| The number of entries in the list. More... | |
| label | capacity () const noexcept |
| Size of the underlying storage. More... | |
| label | count_nonnull () const noexcept |
| The number of non-nullptr entries in the list. More... | |
| T & | front () |
| Reference to the first element of the list. More... | |
| const T & | front () const |
| Reference to first element of the list. More... | |
| T & | back () |
| Reference to the last element of the list. More... | |
| const T & | back () const |
| Reference to the last element of the list. More... | |
| const T * | test (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| const T * | get (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| T * | get (const label i) |
| Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| const T * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| void | clear () |
| Set list size to zero. More... | |
| void | free () |
| Nullify all entries. Does not change the list size. More... | |
| void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr. More... | |
| void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr. More... | |
| label | squeezeNull () |
| Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More... | |
| void | push_back (T *ptr) |
| Append an element to the end of the list. More... | |
| void | push_back (UPtrList< T > &&other) |
| Move append another list to the end of this list. More... | |
| void | swap (UPtrList< T > &list) noexcept |
| 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) |
| Set element to specified pointer and return the old list element, which can be a nullptr. More... | |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| Reorder elements. Reordering must be unique (ie, shuffle). More... | |
| void | sortOrder (const labelUList &order, const bool check=false) |
| Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More... | |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. More... | |
| const T & | at (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
| T & | at (const label i) |
| Return reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
| const T & | operator[] (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
| T & | operator[] (const label i) |
| Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
| FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const | |
| Deprecated(2022-09) - same as get() More... | |
| void | operator= (const UPtrList< T > &list) |
| Copy assignment (shallow copies addresses) More... | |
| void | operator= (UPtrList< T > &&list) |
| Move assignment. More... | |
| Ostream & | printAddresses (Ostream &os) const |
| Print pointer addresses to Ostream (debugging only) More... | |
| Ostream & | writeList (Ostream &os, const bool trimNull=false) const |
| Write UPtrList to Ostream, optionally ignoring null entries. 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 () |
| Return iterator to begin traversal of non-nullptr entries. More... | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. More... | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversal of non-nullptr entries. More... | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversal of non-nullptr entries. More... | |
| const_iterator | end () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
| void | setSize (const label n) |
| Alias for resize() More... | |
| T & | first () |
| 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... | |
| 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... | |
| label | count () const noexcept |
| The number of non-nullptr entries in the list. More... | |
Static Public Member Functions | |
| static scalar | mergeTol () noexcept |
| Get merge tolerance. More... | |
| static scalar | mergeTol (scalar tol) noexcept |
| Set merge tolerance and return old value. 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... | |
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... | |
| 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 |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| const ObjectType * | findObject (const word &fieldName) const |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType * | findObject (const word &fieldName) |
| Return non-const pointer to the object of the given Type, (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType * | getObjectPtr (const word &fieldName) const |
| Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More... | |
| 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< sampledSurface > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. More... | |
| Protected Member Functions inherited from UPtrList< T > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. More... | |
| label | find_next (label pos) const |
| The next non-null entry after the specified position. More... | |
| UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept | |
| 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 surfaces to sample.
The write() method is used to sample and write files.
Example of function object specification:
surfaces
{
type surfaces;
libs (sampling);
// Write at same frequency as fields
writeControl writeTime;
writeInterval 1;
// Fields to be sampled
fields (p U);
// Scheme to obtain face centre value
sampleScheme cell;
// Scheme to obtain node values
// (only used if interpolate=true for the surfaces below)
interpolationScheme cell;
// Optional: registry storage
store true
// Output surface format
surfaceFormat vtk;
formatOptions
{
default
{
verbose true;
}
vtk
{
precision 10;
}
}
surfaces
{
f0surf
{
type meshedSurface;
surface f0surf.obj;
source cells;
// Optional: keep original regions
keepIds true;
// Optional: generate values on points instead of faces
interpolate true;
// Optional: alternative output type
surfaceFormat ensight;
// Optional: registry storage
store true
}
}
}
Entries:
| Property | Description | Required | Default |
|---|---|---|---|
type | Type-name: surfaces | yes | |
surfaces | Dictionary or list of sample surfaces | expected | |
fields | word/regex list of fields to sample | yes | |
sampleScheme | scheme to obtain face centre value | no | cell |
interpolationScheme | scheme to obtain node values | no | cellPoint |
surfaceFormat | output surface format | yes | |
formatOptions | dictionary of format options | no | |
sampleOnExecute | Sample (store) on execution as well | no | false |
store | Store surface/fields on registry | no | false |
Additional per-surface entries:
| Property | Description | Required | Default |
|---|---|---|---|
store | Store surface/fields on registry | no | |
surfaceFormat | output surface format | no | |
formatOptions | dictionary of format options | no |
Definition at line 218 of file sampledSurfaces.H.
| sampledSurfaces | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 180 of file sampledSurfaces.C.
References dict, and Foam::read().
| sampledSurfaces | ( | 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 203 of file sampledSurfaces.C.
References dict, and Foam::read().
|
virtualdefault |
Destructor.
| TypeName | ( | "surfaces" | ) |
Runtime type information.
|
noexcept |
|
inlinenoexcept |
Return names of fields to sample.
Definition at line 486 of file sampledSurfaces.H.
|
virtual |
Read the sampledSurfaces dictionary.
Reimplemented from regionFunctionObject.
Definition at line 236 of file sampledSurfaces.C.
References PtrList< T >::clear(), Foam::ensightOutput::debug, dict, entry::dict(), sampledSurface::enabled(), Foam::endl(), dictionary::findEntry(), forAll, dictionary::get(), dictionary::getOrDefault(), IOobject::groupName(), Foam::Info, keyType::LITERAL, UPstream::master(), Foam::name(), sampledSurface::New(), Foam::nl, word::null, Foam::Pout, Foam::blockMeshTools::read(), dictionary::readEntry(), autoPtr< T >::release(), PtrList< T >::resize(), and s.
|
virtual |
Sample and store if the sampleOnExecute is enabled.
Implements functionObject.
Definition at line 582 of file sampledSurfaces.C.
|
virtual |
|
virtual |
Update for changes of mesh - expires the surfaces.
Reimplemented from functionObject.
Definition at line 599 of file sampledSurfaces.C.
References mapPolyMesh::mesh().
|
virtual |
Update for mesh point-motion - expires the surfaces.
Reimplemented from functionObject.
Definition at line 610 of file sampledSurfaces.C.
References mesh.
|
virtual |
Update for changes of mesh due to readUpdate - expires the surfaces.
Definition at line 619 of file sampledSurfaces.C.
References polyMesh::UNCHANGED.
|
staticnoexcept |
Get merge tolerance.
Definition at line 699 of file sampledSurfaces.C.
|
staticnoexcept |
Set merge tolerance and return old value.
Definition at line 705 of file sampledSurfaces.C.
1.8.14