Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
logFiles Class Referenceabstract

functionObject base class for creating, maintaining and writing log files e.g. integrated of averaged field data vs time. More...

Inheritance diagram for logFiles:
Inheritance graph
[legend]
Collaboration diagram for logFiles:
Collaboration graph
[legend]

Public Member Functions

 logFiles (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
 logFiles (const logFiles &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~logFiles ()
 Destructor. More...
 
const wordList & names () const
 Return const access to the names. More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstream & file ()
 Return access to the file (if only 1) More...
 
OFstream & file (const label i)
 Return file 'i'. More...
 
virtual bool write ()
 Write function. More...
 
void operator= (const logFiles &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
 writeFile (const writeFile &)=delete
 Disallow default bitwise copy construction. More...
 
 ~writeFile ()
 Destructor. More...
 
void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
fileName baseFileDir () const
 Return the base directory for output. More...
 
fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. 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...
 
void operator= (const writeFile &)=delete
 Disallow default bitwise assignment. 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...
 
virtual void writeFileHeader (const label i=0)=0
 File header information. More...
 

Protected Attributes

wordList names_
 File names. More...
 
PtrList< OFstream > filePtrs_
 File pointer. More...
 
- Protected Attributes inherited from writeFile
const objectRegistry & fileObr_
 Reference to the region objectRegistry. More...
 
const word prefix_
 Prefix. More...
 

Additional Inherited Members

- Static Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
static label addChars = 8
 Additional characters for writing. More...
 

Detailed Description

functionObject base class for creating, maintaining and writing log files e.g. integrated of averaged field data vs time.

See also
Foam::functionObject Foam::functionObjects::writeFile
Source files

Definition at line 57 of file logFiles.H.

Constructor & Destructor Documentation

◆ logFiles() [1/2]

logFiles ( const objectRegistry &  obr,
const word &  prefix 
)

Construct from objectRegistry and prefix.

Definition at line 82 of file logFiles.C.

Referenced by logFiles::resetName().

Here is the caller graph for this function:

◆ logFiles() [2/2]

logFiles ( const logFiles &  )
delete

Disallow default bitwise copy construction.

◆ ~logFiles()

~logFiles ( )
virtual

Destructor.

Definition at line 95 of file logFiles.C.

Member Function Documentation

◆ createFiles()

void createFiles ( )
protectedvirtual

Create the output file.

Definition at line 32 of file logFiles.C.

References writeFile::baseFileDir(), writeFile::fileObr_, logFiles::filePtrs_, forAll, writeFile::initStream(), UPstream::master(), Foam::mkDir(), logFiles::names_, writeFile::prefix_, objectRegistry::time(), timeName, Time::timeName(), and logFiles::writeFileHeader().

Referenced by logFiles::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ resetNames()

void resetNames ( const wordList &  names)
protectedvirtual

Reset the list of names from a wordList.

Definition at line 53 of file logFiles.C.

References List< T >::append(), List< T >::clear(), logFiles::filePtrs_, UPstream::master(), logFiles::names_, and List< T >::size().

Here is the call graph for this function:

◆ resetName()

void resetName ( const word &  name)
protectedvirtual

Reset the list of names to a single name entry.

Definition at line 66 of file logFiles.C.

References List< T >::append(), List< T >::clear(), logFiles::filePtrs_, logFiles::logFiles(), UPstream::master(), and logFiles::names_.

Here is the call graph for this function:

◆ writeFileHeader()

virtual void writeFileHeader ( const label  i = 0)
protectedpure virtual

File header information.

Implemented in surfaceFieldValue, volFieldValue, forces, sizeDistribution, forceCoeffs, fieldValueDelta, wallHeatTransferCoeff, interfaceHeight, wallShearStress, wallHeatFlux, cloudInfo, sixDoFRigidBodyState, rigidBodyState, residuals, time, and timeStep.

Referenced by logFiles::createFiles().

Here is the caller graph for this function:

◆ names()

const Foam::wordList & names ( ) const

Return const access to the names.

Definition at line 101 of file logFiles.C.

References logFiles::names_.

◆ files()

Foam::PtrList< Foam::OFstream > & files ( )

Return access to the files.

Definition at line 134 of file logFiles.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, logFiles::filePtrs_, and UPstream::master().

Here is the call graph for this function:

◆ file() [1/2]

Foam::OFstream & file ( )

Return access to the file (if only 1)

Definition at line 107 of file logFiles.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, logFiles::filePtrs_, UPstream::master(), and WarningInFunction.

Referenced by forces::file(), residuals::writeFileHeader(), and residuals::writeResidual().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ file() [2/2]

Foam::OFstream & file ( const label  i)

Return file 'i'.

Definition at line 147 of file logFiles.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, logFiles::filePtrs_, and UPstream::master().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write function.

Reimplemented in surfaceFieldValue, volFieldValue, forces, sizeDistribution, forceCoeffs, fieldValueDelta, wallHeatTransferCoeff, interfaceHeight, fieldValue, wallShearStress, wallHeatFlux, yPlus, sixDoFRigidBodyState, cloudInfo, turbulenceIntensity, rigidBodyState, residuals, time, timeStep, and specieReactionRates.

Definition at line 167 of file logFiles.C.

References logFiles::createFiles().

Referenced by specieReactionRates::write(), timeStep::write(), time::write(), residuals::write(), turbulenceIntensity::write(), rigidBodyState::write(), cloudInfo::write(), sixDoFRigidBodyState::write(), yPlus::write(), wallHeatFlux::write(), fieldValue::write(), wallShearStress::write(), interfaceHeight::write(), wallHeatTransferCoeff::write(), fieldValueDelta::write(), forceCoeffs::write(), and forces::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const logFiles &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ names_

wordList names_
protected

File names.

Definition at line 67 of file logFiles.H.

Referenced by logFiles::createFiles(), logFiles::names(), logFiles::resetName(), and logFiles::resetNames().

◆ filePtrs_

PtrList<OFstream> filePtrs_
protected

File pointer.

Definition at line 70 of file logFiles.H.

Referenced by logFiles::createFiles(), logFiles::file(), logFiles::files(), logFiles::resetName(), and logFiles::resetNames().

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