mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: added functionObject::execute(int) method
- this is a provision for defining execute actions that can be called largely independently of the normal time-loop constraints. This can be useful to provide hooks for sub-cycling, or to define an action that can be triggered manually or on some other event.
This commit is contained in:
@ -52,8 +52,10 @@ SourceFiles
|
||||
namespace Foam
|
||||
{
|
||||
|
||||
class mapPolyMesh;
|
||||
// Forward declarations
|
||||
class argList;
|
||||
class mapPolyMesh;
|
||||
class wordRes;
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class functionObjectList Declaration
|
||||
@ -94,19 +96,19 @@ class functionObjectList
|
||||
void createStateDict() const;
|
||||
|
||||
//- Remove and return the function object pointer by name,
|
||||
// and returns the old index via the parameter.
|
||||
//- and returns the old index via the parameter.
|
||||
// Returns a nullptr (and index -1) if it didn't exist
|
||||
functionObject* remove(const word&, label& oldIndex);
|
||||
functionObject* remove(const word& key, label& oldIndex);
|
||||
|
||||
//- Search the specified directory for functionObject
|
||||
// configuration files, add to the given map and recurse
|
||||
//- configuration files, add to the given map and recurse
|
||||
static void listDir(const fileName& dir, HashSet<word>& foMap);
|
||||
|
||||
//- Disallow default bitwise copy construct
|
||||
functionObjectList(const functionObjectList&);
|
||||
functionObjectList(const functionObjectList&) = delete;
|
||||
|
||||
//- Disallow default bitwise assignment
|
||||
void operator=(const functionObjectList&);
|
||||
void operator=(const functionObjectList&) = delete;
|
||||
|
||||
|
||||
public:
|
||||
@ -114,7 +116,7 @@ public:
|
||||
// Static data members
|
||||
|
||||
//- Default relative path to the directory structure
|
||||
// containing the functionObject dictionary files
|
||||
//- containing the functionObject dictionary files
|
||||
static fileName functionObjectDictPath;
|
||||
|
||||
|
||||
@ -188,7 +190,7 @@ public:
|
||||
label findObjectID(const word& name) const;
|
||||
|
||||
//- Print a list of functionObject configuration files in
|
||||
// user/group/shipped directories.
|
||||
//- user/group/shipped directories.
|
||||
// The search scheme allows for version-specific and
|
||||
// version-independent files using the following hierarchy:
|
||||
// - \b user settings:
|
||||
@ -205,7 +207,7 @@ public:
|
||||
static void list();
|
||||
|
||||
//- Search for functionObject dictionary file in
|
||||
// user/group/shipped directories.
|
||||
//- user/group/shipped directories.
|
||||
// The search scheme allows for version-specific and
|
||||
// version-independent files using the following hierarchy:
|
||||
// - \b user settings:
|
||||
@ -258,6 +260,18 @@ public:
|
||||
// forces execution (used in post-processing mode)
|
||||
bool execute();
|
||||
|
||||
//- Execute function objects using the specified subIndex.
|
||||
// \param subIndex an execution sub-index corresponding to a
|
||||
// sub-cycle or something similar
|
||||
bool execute(const label subIndex);
|
||||
|
||||
//- Execute a subset of function objects using the specified subIndex.
|
||||
// \param functionNames names or regex of existing functions to
|
||||
// execute
|
||||
// \param subIndex an execution sub-index corresponding to a
|
||||
// sub-cycle or something similar
|
||||
bool execute(const wordRes& functionNames, const label subIndex);
|
||||
|
||||
//- Called when Time::run() determines that the time-loop exits
|
||||
bool end();
|
||||
|
||||
|
||||
Reference in New Issue
Block a user