zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

functionObjects::writeObjects: improved code and docs

Browse Source 
Patch contributed by Bruno Santos
Resolves bug-report http://bugs.openfoam.org/view.php?id=2090
This commit is contained in:
Henry Weller
2016-08-17 14:41:42 +01:00
parent e078fa031b
commit b2e9655495
2 changed files with 36 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/functionObjects/utilities/writeObjects/writeObjects.H
View File

@ -42,9 +42,11 @@ Description
It also has the ability to write the selected objects that were defined
with the respective write mode for the requested \c writeOption, namely:
- \c autoWrite - objects set to write at output time
- \c noWrite - objects set to not write by default
- \c anyWrite - any option of the previous two
\vartable
autoWrite | objects set to write at output time
noWrite | objects set to not write by default
anyWrite | any option of the previous two
\endvartable
Example of function object specification:
\verbatim
@ -60,10 +62,10 @@ Description
Usage
\table
Property | Description | Required | Default value
type | type name: writeObjects | yes |
objects | objects to write | yes |
writeOption | only those with this write option | no | any
Property | Description | Required | Default value
type | type name: writeObjects | yes |
objects | objects to write | yes |
writeOption | only those with this write option | no | anyWrite
\endtable
Note: Regular expressions can also be used in \c objects.
@ -116,7 +118,7 @@ public:
ANY_WRITE
};
static const NamedEnum<writeOption, 3> writeOptionNames;
static const NamedEnum<writeOption, 3> writeOptionNames_;
private:
@ -125,7 +127,7 @@ private:
//- Reference to Db
const objectRegistry& obr_;
//- Takes over the writing from Db
//- To only write objects of defined writeOption
writeOption writeOption_;
//- Names of objects to control