mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
DOC: elaborate the usage of function objects
ENH: update libs of etc/caseDicts/postProcess items
ENH: ensure destructor=default
ENH: ensure constness
ENH: ensure no 'copy construct' and 'no copy assignment' exist
TUT: add examples of function objects with full set
of settings into a TUT if unavailable
TUT: update pisoFoam/RAS/cavity tutorial in terms of usage
This commit is contained in:
committed by
Andrew Heather
parent
b549116588
commit
a5c6516e23
@ -6,7 +6,7 @@
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
Copyright (C) 2012-2016 OpenFOAM Foundation
|
||||
Copyright (C) 2015-2019 OpenCFD Ltd.
|
||||
Copyright (C) 2015-2020 OpenCFD Ltd.
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
This file is part of OpenFOAM.
|
||||
@ -28,11 +28,34 @@ Class
|
||||
Foam::functionObjects::writeFile
|
||||
|
||||
Description
|
||||
functionObject base class for writing single files
|
||||
Base class for writing single files from the function objects.
|
||||
|
||||
Usage
|
||||
|
||||
\verbatim
|
||||
<userDefinedSubDictName1>
|
||||
{
|
||||
// Mandatory and other optional entries
|
||||
...
|
||||
|
||||
// Optional (inherited) entries (runtime modifiable)
|
||||
writePrecision 8;
|
||||
writeToFile true;
|
||||
useUserTime true;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
where the entries mean:
|
||||
\table
|
||||
Property | Description | Type | Req'd | Dflt
|
||||
writePrecision | Number of decimal points | label | no | \<system dflt\>
|
||||
writeToFile | Flag to produce text file output | bool | no | true
|
||||
useUserTime | Flag to use user time, e.g. degrees | bool | no | true
|
||||
\endtable
|
||||
|
||||
See also
|
||||
Foam::functionObject
|
||||
Foam::functionObjects::logFiles
|
||||
- Foam::functionObject
|
||||
- Foam::functionObjects::logFiles
|
||||
|
||||
SourceFiles
|
||||
writeFile.C
|
||||
|
||||
Reference in New Issue
Block a user