This function object writes dictionaries on start-up, and on change. More...

Collaboration diagram for writeDictionary:

[legend]

Public Member Functions
	TypeName ("writeDictionary")
	Runtime type information. More...

	writeDictionary (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...

virtual	~writeDictionary ()
	Destructor. More...

virtual const word &	name () const
	Return name of the writeDictionary. More...

virtual void	read (const dictionary &)
	Read the writeDictionary data. More...

virtual void	execute ()
	Execute, currently does nothing. More...

virtual void	end ()
	Execute at the final time-loop, currently does nothing. More...

virtual void	timeSet ()
	Called when time was set at the end of the Time::operator++. More...

virtual void	write ()
	Write the writeDictionary. More...

virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &)
	Update for changes of mesh. More...

Protected Member Functions
bool	tryDirectory (const label dictI, const word &location, bool &firstDict)
	Helper function to write the dictionary if found at location. More...

	writeDictionary (const writeDictionary &)
	Disallow default bitwise copy construct. More...

void	operator= (const writeDictionary &)
	Disallow default bitwise assignment. More...

Protected Attributes
word	name_
	Name of this set of writeDictionary. More...

const objectRegistry &	obr_
	Reference to the database. More...

wordList	dictNames_
	Names of dictionaries to monitor. More...

List< SHA1Digest >	digests_
	List of changed dictionaries (only those registered to database) More...

Detailed Description

This function object writes dictionaries on start-up, and on change.

Source files

Definition at line 60 of file writeDictionary.H.

Constructor & Destructor Documentation

◆ writeDictionary() [1/2]

writeDictionary ( const writeDictionary & )

protected

Disallow default bitwise copy construct.

◆ writeDictionary() [2/2]

writeDictionary	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 90 of file writeDictionary.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~writeDictionary()

~writeDictionary ( )

virtual

Destructor.

Definition at line 110 of file writeDictionary.C.

Member Function Documentation

◆ tryDirectory()

bool tryDirectory	(	const label	dictI,
		const word &	location,
		bool &	firstDict
	)

protected

Helper function to write the dictionary if found at location.

Definition at line 42 of file writeDictionary.C.

References dict, dictIO(), Foam::endl(), Foam::Info, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ operator=()

void operator= ( const writeDictionary & )

protected

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "writeDictionary" )

Runtime type information.

◆ name()

virtual const word& name ( ) const

inlinevirtual

Return name of the writeDictionary.

Definition at line 122 of file writeDictionary.H.

References writeDictionary::name_.

◆ read()

void read ( const dictionary & dict )

virtual

Read the writeDictionary data.

Definition at line 116 of file writeDictionary.C.

References dict, Foam::endl(), forAll, Foam::Info, dictionary::lookup(), Foam::nl, List::setSize(), HashTable< nil, word, string::hash >::toc(), and Foam::type().

Here is the call graph for this function:

◆ execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 140 of file writeDictionary.C.

References dict, dictionaryName::dictName(), dictionary::digest(), Foam::endl(), forAll, Foam::Info, Foam::nl, Foam::type(), and IOobject::writeDivider().

Here is the call graph for this function:

◆ end()

void end ( )

virtual

Execute at the final time-loop, currently does nothing.

Definition at line 196 of file writeDictionary.C.

◆ timeSet()

void timeSet ( )

virtual

Called when time was set at the end of the Time::operator++.

Definition at line 202 of file writeDictionary.C.

◆ write()

void write ( )

virtual

Write the writeDictionary.

Definition at line 208 of file writeDictionary.C.

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 143 of file writeDictionary.H.

◆ movePoints()

virtual void movePoints ( const polyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 147 of file writeDictionary.H.

Field Documentation

◆ name_

word name_

protected

Name of this set of writeDictionary.

Definition at line 67 of file writeDictionary.H.

Referenced by writeDictionary::name().

◆ obr_

const objectRegistry& obr_

protected

Reference to the database.

Definition at line 70 of file writeDictionary.H.

◆ dictNames_

wordList dictNames_

protected

Names of dictionaries to monitor.

Definition at line 73 of file writeDictionary.H.

◆ digests_

List<SHA1Digest> digests_

protected

List of changed dictionaries (only those registered to database)

Definition at line 76 of file writeDictionary.H.

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

src/postProcessing/functionObjects/IO/writeDictionary/writeDictionary.H
src/postProcessing/functionObjects/IO/writeDictionary/writeDictionary.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ writeDictionary() [1/2]

◆ writeDictionary() [2/2]

◆ ~writeDictionary()

Member Function Documentation

◆ tryDirectory()

◆ operator=()

◆ TypeName()

◆ name()

◆ read()

◆ execute()

◆ end()

◆ timeSet()

◆ write()

◆ updateMesh()

◆ movePoints()

Field Documentation

◆ name_

◆ obr_

◆ dictNames_

◆ digests_