functionObject base class for writing single files More...

Inheritance diagram for writeFile:

[legend]

Collaboration diagram for writeFile:

Public Member Functions
	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	write ()=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...

Static Public Attributes
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 Member Functions
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...

Protected Attributes
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...

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...

Detailed Description

functionObject base class for writing single files

See also: Foam::regionFunctionObject Foam::functionObject

Source files

Definition at line 56 of file writeFile.H.

Constructor & Destructor Documentation

writeFile ( const writeFile & )

protected

Disallow default bitwise copy construct.

Referenced by writeFile::valueWidth(), and writeFile::writeFile().

Here is the caller graph for this function:

writeFile	(	const word &	name,
		const Time &	t,
		const dictionary &	dict,
		const word &	prefix
	)

Construct from name, Time, dictionary and prefix.

Definition at line 101 of file writeFile.C.

References writeFile::writeFile().

Here is the call graph for this function:

writeFile	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const word &	prefix
	)

Construct from name, objectRegistry, dictionary and prefix.

Definition at line 114 of file writeFile.C.

~writeFile ( )

virtual

Destructor.

Definition at line 128 of file writeFile.C.

Member Function Documentation

void initStream ( Ostream & os ) const

protectedvirtual

Initialise the output stream for writing.

Definition at line 43 of file writeFile.C.

References writeFile::charWidth(), Foam::scientific(), IOstream::setf(), and Ostream::width().

Referenced by writeFiles::createFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::fileName baseFileDir ( ) const

protectedvirtual

Return the base directory for output.

Definition at line 50 of file writeFile.C.

References polyMesh::defaultRegion, mesh, IOobject::name(), regionFunctionObject::obr_, writeFile::outputPrefix, UPstream::parRun(), Time::path(), and objectRegistry::time().

Referenced by writeFile::baseTimeDir(), and writeFiles::createFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::fileName baseTimeDir ( ) const

protectedvirtual

Return the base directory for the current time value.

Definition at line 79 of file writeFile.C.

References writeFile::baseFileDir(), regionFunctionObject::obr_, writeFile::prefix_, objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

void writeFileHeader ( const label i = 0 )

protectedvirtual

File header information.

Reimplemented in surfaceRegion, volRegion, forces, forceCoeffs, fieldMinMax, fieldValueDelta, wallShearStress, cloudInfo, and residuals.

Definition at line 85 of file writeFile.C.

References writeFile::valueWidth().

Referenced by writeFiles::createFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::Omanip< int > valueWidth ( const label offset = 0 ) const

protectedvirtual

Return the value width when writing to stream with optional offset.

Definition at line 90 of file writeFile.C.

References writeFile::addChars, IOstream::defaultPrecision(), Foam::setw(), and writeFile::writeFile().

Referenced by writeFile::writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const writeFile & )

protected

Disallow default bitwise assignment.

void writeCommented	(	Ostream &	os,
		const string &	str
	)		const

Write a commented string to stream.

Definition at line 141 of file writeFile.C.

References writeFile::charWidth(), Foam::setw(), and writeFile::writeTabbed().

Referenced by writeFile::charWidth().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeTabbed	(	Ostream &	os,
		const string &	str
	)		const

Write a tabbed string to stream.

Definition at line 152 of file writeFile.C.

References writeFile::charWidth(), Foam::setw(), Foam::tab, and writeFile::writeHeader().

Referenced by writeFile::writeCommented(), and residuals::writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeHeader	(	Ostream &	os,
		const string &	str
	)		const

Write a commented header to stream.

Definition at line 162 of file writeFile.C.

References writeFile::charWidth(), Foam::nl, Foam::setf(), and Foam::setw().

Referenced by writeFile::writeTabbed().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeTime ( Ostream & os ) const

Write the current time to stream.

Definition at line 172 of file writeFile.C.

References writeFile::charWidth(), regionFunctionObject::obr_, Foam::setw(), objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

void writeHeaderValue	(	Ostream &	os,
		const string &	property,
		const Type &	value
	)		const

Write a (commented) header property and value pair.

Definition at line 30 of file writeFileTemplates.C.

References Foam::nl, Foam::setf(), and Foam::setw().

Here is the call graph for this function:

Foam::label charWidth ( ) const

Return width of character stream output.

Definition at line 134 of file writeFile.C.

References writeFile::addChars, IOstream::defaultPrecision(), and writeFile::writeCommented().

Referenced by writeFile::initStream(), writeFile::writeCommented(), writeFile::writeHeader(), writeFile::writeTabbed(), and writeFile::writeTime().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const word prefix_

protected

Prefix.

Definition at line 66 of file writeFile.H.

Referenced by writeFile::baseTimeDir(), and writeFiles::createFiles().

const Foam::word outputPrefix

static

Directory prefix.

Definition at line 96 of file writeFile.H.

Referenced by writeFile::baseFileDir().

Foam::label addChars = 7

static

Additional characters for writing.

Definition at line 99 of file writeFile.H.

Referenced by writeFile::charWidth(), and writeFile::valueWidth().

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

src/OpenFOAM/db/functionObjects/writeFile/writeFile.H
src/OpenFOAM/db/functionObjects/writeFile/writeFile.C
src/OpenFOAM/db/functionObjects/writeFile/writeFileTemplates.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation