sampledSets Class Reference

Set of sets to sample. Call sampledSets.write() to sample and write files. More...

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

Public Member Functions

 TypeName ("sets")
 Runtime type information. More...
 
 sampledSets (const word &name, const Time &time, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 sampledSets (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~sampledSets ()=default
 Destructor. More...
 
bool verbose (const bool on)
 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 Type >
Foam::fileName writeSampleFile (const coordSet &masterSampleSet, const PtrList< volFieldSampler< Type >> &masterFields, const label setI, const fileName &timeDir, const writer< Type > &formatter)
 
- 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...
 
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 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< sampledSetclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< sampledSetclone (Args &&... args) const
 
const sampledSetset (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< sampledSetset (const label i, sampledSet *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< sampledSetset (const label i, autoPtr< sampledSet > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< sampledSetset (const label i, autoPtr< sampledSet > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< sampledSetset (const label i, std::unique_ptr< sampledSet > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< sampledSetset (const label i, const refPtr< sampledSet > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< sampledSetset (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...
 
autoPtr< sampledSetemplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< sampledSetemplace (const label i, Args &&... args)
 
autoPtr< sampledSetrelease (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...
 

Additional Inherited Members

- 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...
 
- 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 regionFunctionObject
virtual const objectRegistryobr () 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::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 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 Attributes inherited from regionFunctionObject
word subRegistryName_
 Name for alternative object registry. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
const objectRegistryobrPtr_
 Pointer to alternative (eg, sub-region) objectRegistry. More...
 
- Protected Attributes inherited from timeFunctionObject
const Timetime_
 Reference to the time database. More...
 

Detailed Description

Set of sets to sample. Call sampledSets.write() to sample and write files.

Source files

Definition at line 65 of file sampledSets.H.

Constructor & Destructor Documentation

◆ sampledSets() [1/2]

sampledSets ( const word name,
const Time time,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 87 of file sampledSets.C.

References polyMesh::defaultRegion, dict, Foam::name(), functionObject::outputPrefix, and Foam::read().

Here is the call graph for this function:

◆ sampledSets() [2/2]

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 120 of file sampledSets.C.

References polyMesh::defaultRegion, dict, Foam::name(), functionObject::outputPrefix, and Foam::read().

Here is the call graph for this function:

◆ ~sampledSets()

virtual ~sampledSets ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "sets"  )

Runtime type information.

◆ verbose()

bool verbose ( const bool  on)

Enable/disable verbose output.

Returns
old value

Definition at line 155 of file sampledSets.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read the sampledSets.

Reimplemented from regionFunctionObject.

Definition at line 218 of file sampledSets.C.

References Foam::expressions::patchExpr::debug, dict, Foam::endl(), forAll, Foam::Info, UPstream::master(), Foam::nl, Foam::Pout, and dictionary::readEntry().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 163 of file sampledSets.C.

◆ write()

bool write ( )
virtual

Sample and write.

Implements functionObject.

Definition at line 169 of file sampledSets.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, UPstream::master(), Foam::mkDir(), Foam::nl, and Foam::Pout.

Here is the call graph for this function:

◆ correct()

void correct ( )

Correct for mesh changes.

Definition at line 265 of file sampledSets.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 282 of file sampledSets.C.

References correct(), and mapPolyMesh::mesh().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh mesh)
virtual

Update for mesh point-motion.

Reimplemented from functionObject.

Definition at line 291 of file sampledSets.C.

References correct(), and mesh.

Here is the call graph for this function:

◆ readUpdate()

void readUpdate ( const polyMesh::readUpdateState  state)
virtual

Update for changes of mesh due to readUpdate.

Definition at line 300 of file sampledSets.C.

References correct(), and polyMesh::UNCHANGED.

Here is the call graph for this function:

◆ writeSampleFile()

Foam::fileName writeSampleFile ( const coordSet masterSampleSet,
const PtrList< volFieldSampler< Type >> &  masterFields,
const label  setI,
const fileName timeDir,
const writer< Type > &  formatter 
)

Definition at line 129 of file sampledSetsTemplates.C.

References Foam::average(), Foam::endl(), forAll, writer< Type >::getFileName(), UPstream::master(), Foam::max(), maxValue, Foam::min(), minValue, OFstream::name(), IOstream::opened(), Pstream::scatter(), WarningInFunction, and writer< Type >::write().

Here is the call graph for this function:

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