functionObject base class for writing files More...
Public Member Functions | |
| writeFiles (const word &name, const Time &time, const dictionary &dict, const word &prefix) | |
| Construct from name, Time, dictionary and prefix. More... | |
| writeFiles (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix) | |
| Construct from name, objectRegistry, dictionary and prefix. More... | |
| virtual | ~writeFiles () |
| Destructor. More... | |
| const wordList & | names () const |
| Return const access to the names. More... | |
| OFstream & | file () |
| Return access to the file (if only 1) More... | |
| PtrList< OFstream > & | files () |
| Return access to the files. More... | |
| OFstream & | file (const label i) |
| Return file 'i'. More... | |
| virtual bool | write () |
| Write function. More... | |
 Public Member Functions inherited from writeFile | |
| writeFile (const word &name, const Time &t, const dictionary &dict, const word &prefix) | |
| Construct from name, Time, dictionary and prefix. More... | |
| writeFile (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix) | |
| Construct from name, objectRegistry, dictionary and prefix. More... | |
| virtual | ~writeFile () |
| Destructor. More... | |
| void | writeCommented (Ostream &os, const string &str) const |
| Write a commented string to stream. More... | |
| void | writeTabbed (Ostream &os, const string &str) const |
| Write a tabbed string to stream. More... | |
| void | writeHeader (Ostream &os, const string &str) const |
| Write a commented header to stream. More... | |
| void | writeTime (Ostream &os) const |
| Write the current time to stream. More... | |
| template<class Type > | |
| void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
| Write a (commented) header property and value pair. More... | |
| label | charWidth () const |
| Return width of character stream output. 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 () |
| Destructor. More... | |
| virtual bool | read (const dictionary &) |
| Read optional controls. More... | |
| Public Member Functions inherited from functionObject | |
| virtual const word & | type () const =0 |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
| functionObject (const word &name) | |
| Construct from components. More... | |
| autoPtr< functionObject > | clone () const |
| Return clone. More... | |
| virtual | ~functionObject () |
| Destructor. More... | |
| const word & | name () const |
| Return the name of this functionObject. More... | |
| virtual bool | execute ()=0 |
| Called at each ++ or += of the time-loop. 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 void | updateMesh (const mapPolyMesh &mpm) |
| Update for changes of mesh. More... | |
| virtual void | movePoints (const polyMesh &mesh) |
| Update for changes of mesh. More... | |
Protected Member Functions | |
| virtual void | createFiles () |
| Create the output file. More... | |
| virtual void | resetNames (const wordList &names) |
| Reset the list of names from a wordList. More... | |
| virtual void | resetName (const word &name) |
| Reset the list of names to a single name entry. More... | |
| writeFiles (const writeFiles &) | |
| Disallow default bitwise copy construct. More... | |
| void | operator= (const writeFiles &) |
| Disallow default bitwise assignment. More... | |
| Protected Member Functions inherited from writeFile | |
| virtual void | initStream (Ostream &os) const |
| Initialise the output stream for writing. More... | |
| virtual fileName | baseFileDir () const |
| Return the base directory for output. More... | |
| virtual fileName | baseTimeDir () const |
| Return the base directory for the current time value. More... | |
| virtual void | writeFileHeader (const label i=0) |
| File header information. More... | |
| virtual Omanip< int > | valueWidth (const label offset=0) const |
| Return the value width when writing to stream with optional offset. More... | |
| writeFile (const writeFile &) | |
| Disallow default bitwise copy construct. More... | |
| void | operator= (const writeFile &) |
| Disallow default bitwise assignment. More... | |
| Protected Member Functions inherited from regionFunctionObject | |
| template<class ObjectType > | |
| bool | foundObject (const word &fieldName) const |
| Find field in the objectRegistry. More... | |
| template<class ObjectType > | |
| const ObjectType & | lookupObject (const word &fieldName) const |
| Lookup field from the objectRegistry. More... | |
| template<class ObjectType > | |
| bool | store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
| Store the given field in the objectRegistry under the given name. More... | |
| bool | writeObject (const word &fieldName) |
| Write field if present in objectRegistry. More... | |
| bool | clearObject (const word &fieldName) |
| Clear field from the objectRegistry if present. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from functionObject | |
| static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
| Select from dictionary, based on its "type" entry. More... | |
| Public Attributes inherited from functionObject | |
| Switch | log |
| Switch write log to Info. More... | |
| Static Public Attributes inherited from writeFile | |
| static const word | outputPrefix |
| Directory prefix. More... | |
| static label | addChars = 7 |
| Additional characters for writing. More... | |
| Static Public Attributes inherited from functionObject | |
| static int | debug |
| static bool | postProcess |
| Global post-processing mode switch. More... | |
| Protected Attributes inherited from writeFile | |
| const word | prefix_ |
| Prefix. More... | |
| Protected Attributes inherited from regionFunctionObject | |
| const Time & | time_ |
| Reference to the Time. More... | |
| const objectRegistry & | obr_ |
| Reference to the region objectRegistry. More... | |
functionObject base class for writing files
Definition at line 56 of file writeFiles.H.
|
protected |
Disallow default bitwise copy construct.
Referenced by writeFiles::resetName(), and writeFiles::writeFiles().
| writeFiles | ( | const word & | name, |
| const Time & | time, | ||
| const dictionary & | dict, | ||
| const word & | prefix | ||
| ) |
Construct from name, Time, dictionary and prefix.
Definition at line 96 of file writeFiles.C.
References writeFiles::writeFiles().
| writeFiles | ( | const word & | name, |
| const objectRegistry & | obr, | ||
| const dictionary & | dict, | ||
| const word & | prefix | ||
| ) |
Construct from name, objectRegistry, dictionary and prefix.
Definition at line 110 of file writeFiles.C.
|
virtual |
Destructor.
Definition at line 125 of file writeFiles.C.
|
protectedvirtual |
Create the output file.
Definition at line 32 of file writeFiles.C.
References writeFile::baseFileDir(), forAll, IOstream::good(), writeFile::initStream(), UPstream::master(), Foam::mkDir(), regionFunctionObject::obr_, writeFile::prefix_, Time::startTime(), objectRegistry::time(), Time::timeName(), dimensioned< Type >::value(), and writeFile::writeFileHeader().
Referenced by writeFiles::write().
|
protectedvirtual |
Reset the list of names from a wordList.
Definition at line 67 of file writeFiles.C.
References List< T >::append(), List< T >::clear(), UPstream::master(), and List< T >::size().
Referenced by cloudInfo::read().
|
protectedvirtual |
Reset the list of names to a single name entry.
Definition at line 80 of file writeFiles.C.
References List< T >::append(), List< T >::clear(), UPstream::master(), and writeFiles::writeFiles().
|
protected |
Disallow default bitwise assignment.
| const Foam::wordList & names | ( | ) | const |
Return const access to the names.
Definition at line 131 of file writeFiles.C.
| Foam::OFstream & file | ( | ) |
Return access to the file (if only 1)
Definition at line 137 of file writeFiles.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, UPstream::master(), and WarningInFunction.
Referenced by residuals::writeFileHeader(), and residuals::writeResidual().
| Foam::PtrList< Foam::OFstream > & files | ( | ) |
Return access to the files.
Definition at line 164 of file writeFiles.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and UPstream::master().
| Foam::OFstream & file | ( | const label | i | ) |
Return file 'i'.
Definition at line 177 of file writeFiles.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and UPstream::master().
|
virtual |
Write function.
Implements functionObject.
Reimplemented in surfaceRegion, volRegion, forces, forceCoeffs, fieldMinMax, fieldValueDelta, wallShearStress, fieldValue, cloudInfo, residuals, and yPlus.
Definition at line 197 of file writeFiles.C.
References writeFiles::createFiles().
Referenced by yPlus::write(), residuals::write(), cloudInfo::write(), fieldValue::write(), wallShearStress::write(), fieldValueDelta::write(), fieldMinMax::write(), forceCoeffs::write(), and forces::write().
1.8.11
