Inheritance diagram for dictionary:

Collaboration diagram for dictionary:

[legend]

Public Member Functions
	TypeInfo ("dictionary")

	dictionary ()

	dictionary (const word &keyword)

	dictionary (const word &keyword, bool global)

	dictionary (const word &keyword, const fileSystem &file)

	dictionary (const word &keyword, const dictionary &parDict)

	dictionary (const word &keyword, const dictionary &parDict, iIstream &is)

	dictionary (const word &keyword, const dictionary &parDict, const dictionary &dict)

	dictionary (const dictionary &)

dictionary &	operator= (const dictionary &rhs)

virtual dictionary *	dictPtr ()

virtual const dictionary *	dictPtr () const

virtual bool	isDictionary () const

virtual word	globalName () const

virtual const dictionary &	parrentDict () const

virtual dictionary &	dict ()

virtual const dictionary &	dict () const

virtual bool	isFileDict () const

bool	addPtr (const word &keyword, uniquePtr< iEntry > &etry)

bool	add (const word &keyword, const float &v)

bool	add (const word &keyword, const double &v)

bool	add (const word &keyword, const word &v)

bool	add (const word &keyword, const int64 &v)

bool	add (const word &keyword, const int32 &v)

bool	add (const word &keyword, const int16 &v)

bool	add (const word &keyword, const int8 &v)

bool	add (const word &keyword, const label &v)

bool	add (const word &keyword, const uint32 &v)

bool	addDict (const word &keyword, const dictionary &dict)

template<typename T >
bool	add (const word &keyword, const T &v)

void	clear ()

dictionary *	subDictPtr (const word &keyword)

dictionary &	subDict (const word &keyword)

const dictionary &	subDict (const word &keyword) const

dataEntry *	dataEntryPtr (const word &keyword)

dataEntry &	dataEntryRef (const word &keyword)

const dataEntry &	dataEntryRef (const word &keyword) const

dictionary &	subDictOrCreate (const word &keyword)

template<typename T >
T	getVal (const word &keyword) const

template<typename T >
T	getValOrSet (const word &keyword, const T &setVal) const

size_t	numEntries () const

size_t	numDataEntries () const

size_t	numDictionaries () const

wordList	allKeywords () const

wordList	dataEntryKeywords () const

wordList	dictionaryKeywords () const

bool	containsDictionay (const word &name) const

bool	containsDataEntry (const word &name) const

virtual uniquePtr< iEntry >	clone () const

virtual iEntry *	clonePtr () const

virtual uniquePtr< iEntry >	clone (const dictionary &parDict) const

virtual iEntry *	clonePtr (const dictionary &parDict) const

virtual bool	read (iIstream &is)

virtual bool	write (iOstream &os) const

Public Member Functions inherited from iEntry
	TypeInfo ("iEntry")

	iEntry ()

	iEntry (const word &key)

virtual	~iEntry ()

virtual const word &	keyword () const

virtual word &	keyword ()

virtual word	name () const

Static Public Attributes
static dictionary	nullDict

Protected Member Functions
iEntry *	findEntry (const word &keyword)

iEntry *	findEntry (const word &keyword) const

template<typename T >
bool	readDataEntry (const word &keyword, T &val) const

bool	readDictionary (iIstream &is)

bool	writeDictionary (iOstream &os, bool withBlock=true) const

Protected Member Functions inherited from iEntry
bool	writeKeyword (iOstream &os) const

Protected Attributes
word	name_

wordOrderedMapPtr< iEntry >	entries_

List< iEntry * >	orderedEntries_

const dictionary &	parDict_

bool	isGlobal_

Protected Attributes inherited from iEntry
word	keyword_

Additional Inherited Members
Static Public Member Functions inherited from iEntry
static bool	readKeyword (iIstream &is, word &keyword, token &tok)

static bool	createEntry (dictionary &parDict, iIstream &is, bool hasBlockToken=false)

Detailed Description

Definition at line 38 of file dictionary.hpp.

Constructor & Destructor Documentation

◆ dictionary() [1/8]

dictionary ( )

Definition at line 135 of file dictionary.cpp.

◆ dictionary() [2/8]

dictionary ( const word & keyword )

Definition at line 146 of file dictionary.cpp.

◆ dictionary() [3/8]

dictionary	(	const word &	keyword,
		bool	global
	)

Definition at line 160 of file dictionary.cpp.

◆ dictionary() [4/8]

dictionary	(	const word &	keyword,
		const fileSystem &	file
	)

Definition at line 175 of file dictionary.cpp.

References pFlow::endl(), fatalExit, ioErrorInFile, IOstream::lineNumber(), and Istream::name().

Here is the call graph for this function:

◆ dictionary() [5/8]

dictionary	(	const word &	keyword,
		const dictionary &	parDict
	)

Definition at line 199 of file dictionary.cpp.

◆ dictionary() [6/8]

dictionary	(	const word &	keyword,
		const dictionary &	parDict,
		iIstream &	is
	)

Definition at line 215 of file dictionary.cpp.

References pFlow::endl(), fatalExit, ioErrorInFile, IOstream::lineNumber(), and IOstream::name().

Here is the call graph for this function:

◆ dictionary() [7/8]

dictionary	(	const word &	keyword,
		const dictionary &	parDict,
		const dictionary &	dict
	)

Definition at line 238 of file dictionary.cpp.

References iEntry::clone(), pFlow::endl(), fatalErrorInFunction, fatalExit, and dictionary::orderedEntries_.

Here is the call graph for this function:

◆ dictionary() [8/8]

dictionary ( const dictionary & src )

Definition at line 271 of file dictionary.cpp.

References iEntry::clone(), pFlow::endl(), fatalErrorInFunction, fatalExit, and dictionary::orderedEntries_.

Here is the call graph for this function:

Member Function Documentation

◆ findEntry() [1/2]

pFlow::iEntry * findEntry ( const word & keyword )

protected

Definition at line 106 of file dictionary.cpp.

◆ findEntry() [2/2]

pFlow::iEntry * findEntry ( const word & keyword ) const

protected

Definition at line 121 of file dictionary.cpp.

◆ readDataEntry()

bool readDataEntry	(	const word &	keyword,
		T &	val
	)		const

protected

Definition at line 287 of file dictionary.hpp.

References dataEntry::stream().

Here is the call graph for this function:

◆ readDictionary()

bool readDictionary ( iIstream & is )

protected

Definition at line 37 of file dictionary.cpp.

References IOstream::eof(), IOstream::good(), ioErrorInFile, IOstream::lineNumber(), IOstream::name(), and iIstream::putBack().

Here is the call graph for this function:

◆ writeDictionary()

bool writeDictionary	(	iOstream &	os,
		bool	withBlock = `true`
	)		const

protected

Definition at line 87 of file dictionary.cpp.

References iOstream::beginBlock(), iOstream::endBlock(), and iOstream::write().

Here is the call graph for this function:

◆ TypeInfo()

TypeInfo ( "dictionary" )

◆ operator=()

pFlow::dictionary & operator= ( const dictionary & rhs )

Definition at line 303 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Here is the call graph for this function:

◆ dictPtr() [1/2]

const pFlow::dictionary * dictPtr ( )

virtual

Reimplemented from iEntry.

Definition at line 332 of file dictionary.cpp.

◆ dictPtr() [2/2]

virtual const dictionary* dictPtr ( ) const

virtual

Reimplemented from iEntry.

◆ isDictionary()

bool isDictionary ( ) const

virtual

Reimplemented from iEntry.

Definition at line 344 of file dictionary.cpp.

◆ globalName()

pFlow::word globalName ( ) const

virtual

Implements iEntry.

Definition at line 349 of file dictionary.cpp.

Referenced by iEntry< Key, T * >::createEntry(), cylinder::cylinder(), processField::getFieldType(), multiRotatingAxis::multiRotatingAxis(), positionOrdered::positionOrdered(), positionRandom::positionRandom(), Insertion< ShapeType >::read(), shapeMixture::read(), sphereShape::readDictionary(), property::readDictionary(), insertionRegion::readInsertionRegion(), planeWall::readPlaneWall(), rotatingAxis::rotatingAxis(), selectRandom::selectRandom(), vibrating::vibrating(), sphereRegion::write(), Insertion< ShapeType >::write(), timeInterval::write(), rotatingAxis::write(), shapeMixture::write(), iBox< intType >::write(), vibrating::write(), box::write(), sphere::write(), line::write(), cylinder::write(), sphereShape::writeDictionary(), property::writeDictionary(), and insertion::writeInsertionDict().

Here is the caller graph for this function:

◆ parrentDict()

const pFlow::dictionary & parrentDict ( ) const

virtual

Implements iEntry.

Definition at line 355 of file dictionary.cpp.

◆ dict() [1/2]

const pFlow::dictionary & dict ( )

virtual

Implements iEntry.

Definition at line 362 of file dictionary.cpp.

◆ dict() [2/2]

virtual const dictionary& dict ( ) const

virtual

Implements iEntry.

◆ isFileDict()

bool isFileDict ( ) const

virtual

Definition at line 373 of file dictionary.cpp.

◆ addPtr()

bool addPtr	(	const word &	keyword,
		uniquePtr< iEntry > &	etry
	)

Definition at line 379 of file dictionary.cpp.

References warningInFunction.

Referenced by dictionary::add(), and iEntry< Key, T * >::createEntry().

Here is the caller graph for this function:

◆ add() [1/10]

bool add	(	const word &	keyword,
		const float &	v
	)

Definition at line 422 of file dictionary.cpp.

Referenced by timeInterval::write(), rotatingAxis::write(), shapeMixture::write(), iBox< intType >::write(), vibrating::write(), box::write(), sphere::write(), line::write(), multiRotatingAxis::write(), cylinder::write(), sphereShape::writeDictionary(), property::writeDictionary(), fixedWall::writeDictionary(), rotatingAxisMotion::writeDictionary(), vibratingMotion::writeDictionary(), multiRotatingAxisMotion::writeDictionary(), insertion::writeInsertionDict(), insertionRegion::writeInsertionRegion(), and timeFlowControl::writeTimeFlowControl().

Here is the caller graph for this function:

◆ add() [2/10]

bool add	(	const word &	keyword,
		const double &	v
	)

Definition at line 432 of file dictionary.cpp.

◆ add() [3/10]

bool add	(	const word &	keyword,
		const word &	v
	)

Definition at line 442 of file dictionary.cpp.

◆ add() [4/10]

bool add	(	const word &	keyword,
		const int64 &	v
	)

Definition at line 452 of file dictionary.cpp.

◆ add() [5/10]

bool add	(	const word &	keyword,
		const int32 &	v
	)

Definition at line 462 of file dictionary.cpp.

◆ add() [6/10]

bool add	(	const word &	keyword,
		const int16 &	v
	)

Definition at line 472 of file dictionary.cpp.

◆ add() [7/10]

bool add	(	const word &	keyword,
		const int8 &	v
	)

Definition at line 482 of file dictionary.cpp.

◆ add() [8/10]

bool add	(	const word &	keyword,
		const label &	v
	)

Definition at line 492 of file dictionary.cpp.

◆ add() [9/10]

bool add	(	const word &	keyword,
		const uint32 &	v
	)

Definition at line 502 of file dictionary.cpp.

◆ addDict()

bool addDict	(	const word &	keyword,
		const dictionary &	dict
	)

Definition at line 513 of file dictionary.cpp.

◆ add() [10/10]

bool add	(	const word &	keyword,
		const T &	v
	)

Definition at line 276 of file dictionary.hpp.

References dictionary::addPtr(), and iEntry::keyword().

Here is the call graph for this function:

◆ clear()

void clear ( )

Definition at line 522 of file dictionary.cpp.

◆ subDictPtr()

pFlow::dictionary * subDictPtr ( const word & keyword )

Definition at line 529 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Here is the call graph for this function:

◆ subDict() [1/2]

pFlow::dictionary & subDict ( const word & keyword )

Definition at line 547 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Referenced by pFlow::applySelector(), interaction::create(), main(), positionParticles::positionParticles(), rotatingAxisMotion::readDictionary(), vibratingMotion::readDictionary(), multiRotatingAxisMotion::readDictionary(), Insertion< ShapeType >::readInsertionDict(), and insertionRegion::readInsertionRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subDict() [2/2]

const pFlow::dictionary & subDict ( const word & keyword ) const

Definition at line 567 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Here is the call graph for this function:

◆ dataEntryPtr()

pFlow::dataEntry * dataEntryPtr ( const word & keyword )

Definition at line 585 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Here is the call graph for this function:

◆ dataEntryRef() [1/2]

pFlow::dataEntry & dataEntryRef ( const word & keyword )

Definition at line 600 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, fatalExit, and dataEntry::nullDataEntry.

Referenced by processField::getFieldType(), and setFieldList::readSetFieldList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dataEntryRef() [2/2]

const pFlow::dataEntry & dataEntryRef ( const word & keyword ) const

Definition at line 616 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, fatalExit, and dataEntry::nullDataEntry.

Here is the call graph for this function:

◆ subDictOrCreate()

pFlow::dictionary & subDictOrCreate ( const word & keyword )

Definition at line 634 of file dictionary.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Referenced by postprocess::postprocess(), processField::processField(), fixedWall::writeDictionary(), rotatingAxisMotion::writeDictionary(), vibratingMotion::writeDictionary(), multiRotatingAxisMotion::writeDictionary(), Insertion< ShapeType >::writeInsertionDict(), and insertionRegion::writeInsertionRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVal()

T getVal ( const word & keyword ) const

Definition at line 309 of file dictionary.hpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Referenced by pStructSelector::create(), interaction::create(), Wall::create(), contactSearch::create(), positionParticles::create(), geometry::create(), cylinder::cylinder(), dynamicLinkLibs::dynamicLinkLibs(), processField::getFieldType(), shapeMixture::read(), iBox< intType >::read(), vibrating::read(), box::read(), sphere::read(), line::read(), cylinder::read(), Wall::readCommon(), cuboidWall::readcuboidWall(), cylinderWall::readCylinderWall(), sphereShape::readDictionary(), property::readDictionary(), fixedWall::readDictionary(), rotatingAxisMotion::readDictionary(), vibratingMotion::readDictionary(), multiRotatingAxisMotion::readDictionary(), insertion::readInsertionDict(), insertionRegion::readInsertionRegion(), linear< limited >::readLinearDictionary(), nonLinearMod< limited >::readNonLinearDictionary(), nonLinear< limited >::readNonLinearDictionary(), normalRolling< contactForceModel >::readNormalDict(), planeWall::readPlaneWall(), stlWall::readSTLWall(), timeFlowControl::readTimeFlowControl(), and sphere::sphere().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValOrSet()

T getValOrSet	(	const word &	keyword,
		const T &	setVal
	)		const

Definition at line 325 of file dictionary.hpp.

Referenced by includeMask::getFieldType(), positionParticles::positionParticles(), timeInterval::read(), rotatingAxis::read(), vibrating::read(), multiRotatingAxis::read(), Wall::readCommon(), cuboidWall::readcuboidWall(), cylinderWall::readCylinderWall(), and planeWall::readPlaneWall().

Here is the caller graph for this function:

◆ numEntries()

size_t numEntries ( ) const

Definition at line 664 of file dictionary.cpp.

◆ numDataEntries()

size_t numDataEntries ( ) const

Definition at line 669 of file dictionary.cpp.

◆ numDictionaries()

size_t numDictionaries ( ) const

Definition at line 682 of file dictionary.cpp.

◆ allKeywords()

pFlow::wordList allKeywords ( ) const

Definition at line 695 of file dictionary.cpp.

◆ dataEntryKeywords()

pFlow::wordList dataEntryKeywords ( ) const

Definition at line 706 of file dictionary.cpp.

Referenced by shapeMixture::read(), and setFieldList::readSetFieldList().

Here is the caller graph for this function:

◆ dictionaryKeywords()

pFlow::wordList dictionaryKeywords ( ) const

Definition at line 721 of file dictionary.cpp.

Referenced by main(), postprocess::postprocess(), rotatingAxisMotion::readDictionary(), vibratingMotion::readDictionary(), multiRotatingAxisMotion::readDictionary(), and Insertion< ShapeType >::readInsertionDict().

Here is the caller graph for this function:

◆ containsDictionay()

bool containsDictionay ( const word & name ) const

Definition at line 736 of file dictionary.cpp.

Referenced by positionParticles::positionParticles(), and insertionRegion::readInsertionRegion().

Here is the caller graph for this function:

◆ containsDataEntry()

bool containsDataEntry ( const word & name ) const

Definition at line 748 of file dictionary.cpp.

Referenced by dynamicLinkLibs::dynamicLinkLibs(), and processField::getFieldType().

Here is the caller graph for this function:

◆ clone() [1/2]

pFlow::uniquePtr< pFlow::iEntry > clone ( ) const

virtual

Implements iEntry.

Definition at line 791 of file dictionary.cpp.

◆ clonePtr() [1/2]

pFlow::iEntry * clonePtr ( ) const

virtual

Implements iEntry.

Definition at line 797 of file dictionary.cpp.

◆ clone() [2/2]

pFlow::uniquePtr< pFlow::iEntry > clone ( const dictionary & parDict ) const

virtual

Implements iEntry.

Definition at line 805 of file dictionary.cpp.

◆ clonePtr() [2/2]

pFlow::iEntry * clonePtr ( const dictionary & parDict ) const

virtual

Implements iEntry.

Definition at line 813 of file dictionary.cpp.

◆ read()

bool read ( iIstream & is )

virtual

Implements iEntry.

Definition at line 759 of file dictionary.cpp.

References pFlow::endl(), fatalExit, ioErrorInFile, IOstream::lineNumber(), and IOstream::name().

Referenced by Insertion< ShapeType >::read(), sphereShape::read(), fixedWall::read(), multiRotatingAxisMotion::read(), vibratingMotion::read(), and rotatingAxisMotion::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( iOstream & os ) const

virtual

Implements iEntry.

Definition at line 780 of file dictionary.cpp.

References fatalExit, ioErrorInFile, IOstream::lineNumber(), and IOstream::name().

Referenced by Insertion< ShapeType >::write(), sphereShape::write(), fixedWall::write(), multiRotatingAxisMotion::write(), vibratingMotion::write(), rotatingAxisMotion::write(), and insertionRegion::writeInsertionRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_

protected

Definition at line 47 of file dictionary.hpp.

◆ entries_

wordOrderedMapPtr<iEntry> entries_

protected

Definition at line 50 of file dictionary.hpp.

◆ orderedEntries_

List<iEntry*> orderedEntries_

protected

Definition at line 53 of file dictionary.hpp.

Referenced by dictionary::dictionary().

◆ parDict_

const dictionary& parDict_

protected

Definition at line 56 of file dictionary.hpp.

◆ isGlobal_

bool isGlobal_

protected

Definition at line 58 of file dictionary.hpp.

◆ nullDict

pFlow::dictionary nullDict

static

Definition at line 85 of file dictionary.hpp.

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

src/phasicFlow/dictionary/dictionary.hpp
src/phasicFlow/dictionary/dictionary.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dictionary() [1/8]

◆ dictionary() [2/8]

◆ dictionary() [3/8]

◆ dictionary() [4/8]

◆ dictionary() [5/8]

◆ dictionary() [6/8]

◆ dictionary() [7/8]

◆ dictionary() [8/8]

Member Function Documentation

◆ findEntry() [1/2]

◆ findEntry() [2/2]

◆ readDataEntry()

◆ readDictionary()

◆ writeDictionary()

◆ TypeInfo()

◆ operator=()

◆ dictPtr() [1/2]

◆ dictPtr() [2/2]

◆ isDictionary()

◆ globalName()

◆ parrentDict()

◆ dict() [1/2]

◆ dict() [2/2]

◆ isFileDict()

◆ addPtr()

◆ add() [1/10]

◆ add() [2/10]

◆ add() [3/10]

◆ add() [4/10]

◆ add() [5/10]

◆ add() [6/10]

◆ add() [7/10]

◆ add() [8/10]

◆ add() [9/10]

◆ addDict()

◆ add() [10/10]

◆ clear()

◆ subDictPtr()

◆ subDict() [1/2]

◆ subDict() [2/2]

◆ dataEntryPtr()

◆ dataEntryRef() [1/2]

◆ dataEntryRef() [2/2]

◆ subDictOrCreate()

◆ getVal()

◆ getValOrSet()

◆ numEntries()

◆ numDataEntries()

◆ numDictionaries()

◆ allKeywords()

◆ dataEntryKeywords()

◆ dictionaryKeywords()

◆ containsDictionay()

◆ containsDataEntry()

◆ clone() [1/2]

◆ clonePtr() [1/2]

◆ clone() [2/2]

◆ clonePtr() [2/2]

◆ read()

◆ write()

Member Data Documentation

◆ name_

◆ entries_

◆ orderedEntries_

◆ parDict_

◆ isGlobal_

◆ nullDict