Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or are in a file. More...

Inheritance diagram for dictionary:

Collaboration diagram for dictionary:

Public Member Functions
	TypeInfo ("dictionary")

	dictionary (const word &keyword, bool global)
	construct an empty dictionary with keyword and make it global/fileDictionary (if true) More...

	dictionary (const word &keyword, const fileSystem &file)
	construct a dictionary with name and read it from file More...

	dictionary ()
	cunstructs a null dictionary More...

	dictionary (const word &keyword)
	construct an empty dictionary with keyword More...

	dictionary (const word &keyword, const dictionary &parDict)
	cunstruct an empty dictionary with keyword and parDict More...

	dictionary (const word &keyword, const dictionary &parDict, iIstream &is)
	cunstruct a dictionary with keyword and parDict and from stream More...

	dictionary (const word &keyword, const dictionary &parDict, const dictionary &dict)
	copy construct with keyword and new parrent dict discard the keyword and parDict of dict More...

	dictionary (const dictionary &)
	copy construct as default behavior entries_ are copied smoothly. More...

	dictionary (const dictionary &src, bool global)

dictionary &	operator= (const dictionary &rhs)
	assignment preserve name of this dictionary only entries are transfered with ownership More...

virtual dictionary *	dictPtr ()
	pointer to this dictionary More...

virtual const dictionary *	dictPtr () const
	pointer to this dictionary More...

virtual bool	isDictionary () const
	if this is a dictionary More...

virtual word	globalName () const
	global name of entry, separated with dots More...

virtual const dictionary &	parrentDict () const
	const ref to parrent dictionary More...

virtual dictionary &	dict ()
	ref to this dictionary, if it is a dictionary More...

virtual const dictionary &	dict () const
	const ref to this dictionary, if it is a dictionary More...

virtual bool	isFileDict () const
	if dictionary is file dictionary, return false More...

bool	addPtr (const word &keyword, uniquePtr< iEntry > &etry, bool warning=true)
	add a pointer entry (dictionary/dataEntry) replaces this entry with existing one and issue a warning More...

bool	add (const word &keyword, const float &v)
	add a float dataEntry More...

bool	add (const word &keyword, const double &v)
	add a double dataEntry More...

bool	add (const word &keyword, const word &v)
	add a word dataEntry More...

bool	add (const word &keyword, const int64 &v)
	add a int64 dataEntry More...

bool	add (const word &keyword, const int32 &v)
	add a int32 dataEntry More...

bool	add (const word &keyword, const int8 &v)
	add a int8 dataEntry More...

bool	add (const word &keyword, const uint64 &v)
	add a uint64 dataEntry More...

bool	add (const word &keyword, const uint32 &v)
	add a uint32 dataEntry More...

bool	add (const word &keyword, const uint8 &v)
	add a uint8 dataEntry More...

bool	addDict (const word &keyword, const dictionary &dict)
	add a dictionary with the specifiedd keyword, if it exists, replace it. More...

template<typename T >
bool	add (const word &keyword, const T &v)
	add a dataEntry of type T More...

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

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

void	clear ()

dictionary *	subDictPtr (const word &keyword)
	pointer to a subdictionary fatalExit if not found More...

dictionary &	subDict (const word &keyword)
	ref to a subdictioanry fatalExit if not found More...

const dictionary &	subDict (const word &keyword) const
	const ref to a subdictioanry fatalExit if not found More...

dataEntry *	dataEntryPtr (const word &keyword)
	pointer to a dataEntry fatalExit if not found/not a dataEntry More...

dataEntry &	dataEntryRef (const word &keyword)
	ref to a subdictioanry fatalExit if not found/not a dataEntry More...

const dataEntry &	dataEntryRef (const word &keyword) const
	const ref to a subdictioanry fatalExit if not found/not a dataEntry More...

dictionary &	subDictOrCreate (const word &keyword)
	search for a sub-dict with keyword create a new sub-dict if not found and return a ref to it fatalExit if fails More...

template<typename T >
T	getVal (const word &keyword) const
	get the value of data entry More...

template<typename T >
T	getValMax (const word &keyword, const T &maxVal) const
	get the value of data entry and return max(value, maxVal) More...

template<typename T >
T	getValMin (const word &keyword, const T &minVal) const
	get the value of data entry and return min(value, minVal) More...

template<typename T >
T	getValOrSet (const word &keyword, const T &setVal) const
	get the value of data entry or if not found, set the value to setVal More...

template<typename T >
T	getValOrSetMax (const word &keyword, const T &setMaxVal) const
	get the value of data entry anf return max(setMaxVal, value) if not found, set the value to setMaxVal More...

template<typename T >
T	getValOrSetMin (const word &keyword, const T &setMinVal) const
	get the value of data entry anf return max(setMinVal, value) if not found, set the value to setMinVal More...

size_t	numEntries () const
	return number of entris in this dictionary More...

size_t	numDataEntries () const
	return number of non-nullptr dataEntries More...

size_t	numDictionaries () const
	return number of non-nullptr dictionaries More...

wordList	allKeywords () const
	return all keywords (non-nullptr) in this dictionary More...

wordList	dataEntryKeywords () const
	return a list of all dataEntries (non-nullptr) keywords More...

wordList	dictionaryKeywords () const
	return a list of all dictionary (non-null) keywords More...

bool	containsDictionay (const word &name) const
	check if a sub-dictionary exists More...

bool	containsDataEntry (const word &name) const
	check if a data entry exist More...

virtual uniquePtr< iEntry >	clone () const
	clone polymorphic object (here dictionary) More...

virtual iEntry *	clonePtr () const
	clone the object More...

virtual uniquePtr< iEntry >	clone (const dictionary &parDict) const
	clone the polymorhpic object with parDict as the new parrent dictionary More...

virtual iEntry *	clonePtr (const dictionary &parDict) const
	clone the object and change its ownership to parDict More...

bool	read (iIstream &is) override
	read from stream More...

bool	write (iOstream &os) const override
	write to stream More...

Public Member Functions inherited from iEntry
	TypeInfo ("iEntry")
	Type info. More...

	iEntry ()
	empty constructor More...

	iEntry (const word &key)
	construct with a keyword More...

virtual	~iEntry ()
	destructor More...

virtual const word &	keyword () const
	return keyword More...

virtual word &	keyword ()
	return keyword More...

virtual word	name () const
	name/keyword of entry More...

Static Public Attributes
static dictionary	nullDict

Protected Member Functions
iEntry *	findEntry (const word &keyword)
	find an entry based on keyword return nullptr if not found More...

iEntry *	findEntry (const word &keyword) const
	find and entry based on keyword return nullptr if not found More...

template<typename T >
bool	readDataEntry (const word &keyword, T &val) const
	reads a dataEntry with keyword from dictionary More...

bool	readDictionary (iIstream &is)
	read dictionary from stream - without keyword More...

bool	writeDictionary (iOstream &os, bool withBlock=true) const
	write dictionary to stream - with keyword More...

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

Protected Attributes
word	name_
	global name of dictionary, separated with dots More...

wordOrderedMapPtr< iEntry >	entries_
	all the entries (data and dictionary) of the current dictionary More...

List< iEntry * >	orderedEntries_
	entries in order of insertion More...

const dictionary &	parDict_
	ref to parrent dictionary More...

bool	isGlobal_ = false

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)
	read a keyword from stream More...

static bool	createEntry (dictionary &parDict, iIstream &is, bool hasBlockToken=false)
	create an entry (dataEntry or dictionary) from stream More...

Detailed Description

Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or are in a file.

data entry format is:

entryName value;

and a dictionary in a file can be:

entryName2  value2;
 
entryName3  value3;
 
subDict1
{
   entryName4 value4;
  
   ....
  
}
 
subDict2
{
   ...
}

Definition at line 67 of file dictionary.hpp.

Constructor & Destructor Documentation

◆ dictionary() [1/9]

dictionary	(	const word &	keyword,
		bool	global
	)

construct an empty dictionary with keyword and make it global/fileDictionary (if true)

Constructors

Definition at line 160 of file dictionary.cpp.

◆ dictionary() [2/9]

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

construct a dictionary with name and read it from 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() [3/9]

dictionary ( )

cunstructs a null dictionary

Definition at line 135 of file dictionary.cpp.

◆ dictionary() [4/9]

dictionary ( const word & keyword )

construct an empty dictionary with keyword

Definition at line 146 of file dictionary.cpp.

◆ dictionary() [5/9]

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

cunstruct an empty dictionary with keyword and parDict

Definition at line 199 of file dictionary.cpp.

◆ dictionary() [6/9]

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

cunstruct a dictionary with keyword and parDict and from stream

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/9]

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

copy construct with keyword and new parrent dict discard the keyword and parDict of 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/9]

dictionary ( const dictionary & src )

copy construct as default behavior entries_ are copied smoothly.

set parrent dict to nullDict

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:

◆ dictionary() [9/9]

dictionary	(	const dictionary &	src,
		bool	global
	)

Definition at line 302 of file dictionary.cpp.

References dictionary::isGlobal_.

Member Function Documentation

◆ findEntry() [1/2]

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

protected

find an entry based on keyword return nullptr if not found

Definition at line 106 of file dictionary.cpp.

◆ findEntry() [2/2]

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

protected

find and entry based on keyword return nullptr if not found

Definition at line 121 of file dictionary.cpp.

◆ readDataEntry()

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

protected

reads a dataEntry with keyword from dictionary

Definition at line 357 of file dictionary.hpp.

References dataEntry::stream().

Here is the call graph for this function:

◆ readDictionary()

bool readDictionary ( iIstream & is )

protected

read dictionary from stream - without keyword

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

write dictionary to stream - with keyword

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 )

assignment preserve name of this dictionary only entries are transfered with ownership

Definition at line 310 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

pointer to this dictionary

Reimplemented from iEntry.

Definition at line 339 of file dictionary.cpp.

◆ dictPtr() [2/2]

virtual const dictionary* dictPtr ( ) const

virtual

pointer to this dictionary

Reimplemented from iEntry.

◆ isDictionary()

bool isDictionary ( ) const

virtual

if this is a dictionary

Reimplemented from iEntry.

Definition at line 351 of file dictionary.cpp.

◆ globalName()

pFlow::word globalName ( ) const

virtual

global name of entry, separated with dots

Implements iEntry.

Definition at line 356 of file dictionary.cpp.

Referenced by baseTimeControl::baseTimeControl(), conveyorBelt::conveyorBelt(), regularSimulationDomain::createBoundaryDicts(), iEntry< Key, T * >::createEntry(), cylinder::cylinder(), shape::findPropertyIds(), processField::getFieldType(), main(), multiRotatingAxis::multiRotatingAxis(), simulationDomain::prepareBoundaryDicts(), shapeMixture::read(), property::readDictionary(), sphereShape::readFromDictionary3(), grainShape::readFromDictionary3(), planeWall::readPlaneWall(), rotatingAxis::rotatingAxis(), shapeMixture::shapeMixture(), vibrating::vibrating(), sphereRegion::write(), conveyorBelt::write(), timeInterval::write(), stationaryWall::write(), conveyorBeltMotion::write(), rotatingAxisMotion::write(), vibratingMotion::write(), iBox< intType >::write(), shapeMixture::write(), sphere::write(), box::write(), insertion::write(), line::write(), vibrating::write(), rotatingAxis::write(), cylinder::write(), insertion::writeInsertionDict(), sphereShape::writeToDict(), shape::writeToDict(), and baseShapeNames::writeToDict().

Here is the caller graph for this function:

◆ parrentDict()

const pFlow::dictionary & parrentDict ( ) const

virtual

const ref to parrent dictionary

Implements iEntry.

Definition at line 362 of file dictionary.cpp.

◆ dict() [1/2]

const pFlow::dictionary & dict ( )

virtual

ref to this dictionary, if it is a dictionary

Implements iEntry.

Definition at line 369 of file dictionary.cpp.

◆ dict() [2/2]

virtual const dictionary& dict ( ) const

virtual

const ref to this dictionary, if it is a dictionary

Implements iEntry.

◆ isFileDict()

bool isFileDict ( ) const

virtual

if dictionary is file dictionary, return false

Definition at line 380 of file dictionary.cpp.

◆ addPtr()

bool addPtr	(	const word &	keyword,
		uniquePtr< iEntry > &	etry,
		bool	warning = `true`
	)

add a pointer entry (dictionary/dataEntry) replaces this entry with existing one and issue a warning

Definition at line 386 of file dictionary.cpp.

References warningInFunction.

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

Here is the caller graph for this function:

◆ add() [1/10]

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

add a float dataEntry

Definition at line 435 of file dictionary.cpp.

Referenced by regularSimulationDomain::createBoundaryDicts(), MotionModel< rotatingAxisMotion, rotatingAxis >::impl_writeDictionary(), baseTimeControl::write(), conveyorBelt::write(), timeInterval::write(), iBox< intType >::write(), shapeMixture::write(), sphere::write(), box::write(), line::write(), vibrating::write(), rotatingAxis::write(), cylinder::write(), multiRotatingAxis::write(), multiRotatingAxisMotion::writeDictionary(), insertion::writeInsertionDict(), insertionRegion::writeInsertionRegion(), sphereShape::writeToDict(), shape::writeToDict(), and baseShapeNames::writeToDict().

Here is the caller graph for this function:

◆ add() [2/10]

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

add a double dataEntry

Definition at line 445 of file dictionary.cpp.

◆ add() [3/10]

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

add a word dataEntry

Definition at line 455 of file dictionary.cpp.

◆ add() [4/10]

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

add a int64 dataEntry

Definition at line 465 of file dictionary.cpp.

◆ add() [5/10]

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

add a int32 dataEntry

Definition at line 475 of file dictionary.cpp.

◆ add() [6/10]

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

add a int8 dataEntry

Definition at line 486 of file dictionary.cpp.

◆ add() [7/10]

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

add a uint64 dataEntry

Definition at line 496 of file dictionary.cpp.

◆ add() [8/10]

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

add a uint32 dataEntry

Definition at line 506 of file dictionary.cpp.

◆ add() [9/10]

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

add a uint8 dataEntry

Definition at line 516 of file dictionary.cpp.

◆ addDict()

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

add a dictionary with the specifiedd keyword, if it exists, replace it.

Definition at line 526 of file dictionary.cpp.

Referenced by simulationDomain::prepareBoundaryDicts(), and insertionRegion::writeInsertionRegion().

Here is the caller graph for this function:

◆ add() [10/10]

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

add a dataEntry of type T

Definition at line 333 of file dictionary.hpp.

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

Here is the call graph for this function:

◆ addOrKeep()

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

Definition at line 343 of file dictionary.hpp.

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

Here is the call graph for this function:

◆ addOrReplace()

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

inline

Definition at line 445 of file dictionary.hpp.

Referenced by regularSimulationDomain::createBoundaryDicts(), and simulationDomain::prepareBoundaryDicts().

Here is the caller graph for this function:

◆ clear()

void clear ( )

Definition at line 535 of file dictionary.cpp.

◆ subDictPtr()

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

pointer to a subdictionary fatalExit if not found

Definition at line 542 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 )

ref to a subdictioanry fatalExit if not found

Definition at line 560 of file dictionary.cpp.

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

Referenced by pFlow::applySelector(), subDomain::bottomDict(), simulationDomain::boundaryDict(), interaction::create(), regularSimulationDomain::createBoundaryDicts(), subDomain::frontDict(), MotionModel< rotatingAxisMotion, rotatingAxis >::impl_readDictionary(), subDomain::leftDict(), main(), positionParticles::positionParticles(), simulationDomain::prepareBoundaryDicts(), countFields::process(), postprocess::processTimeFolder(), multiRotatingAxisMotion::readDictionary(), subDomain::rearDict(), subDomain::rightDict(), simulationDomain::thisBoundariesDict(), and subDomain::topDict().

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

const ref to a subdictioanry fatalExit if not found

Definition at line 580 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 )

pointer to a dataEntry fatalExit if not found/not a dataEntry

Definition at line 598 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 )

ref to a subdictioanry fatalExit if not found/not a dataEntry

Definition at line 613 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

const ref to a subdictioanry fatalExit if not found/not a dataEntry

Definition at line 629 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 )

search for a sub-dict with keyword create a new sub-dict if not found and return a ref to it fatalExit if fails

Definition at line 647 of file dictionary.cpp.

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

Referenced by countField::countField(), MotionModel< rotatingAxisMotion, rotatingAxis >::impl_writeDictionary(), postprocess::postprocess(), processField::processField(), 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

get the value of data entry

Definition at line 379 of file dictionary.hpp.

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

Referenced by baseTimeControl::baseTimeControl(), boundaryList::boundaryList(), countField::countField(), pStructSelector::create(), interaction::create(), Wall::create(), positionParticles::create(), contactSearch::create(), geometry::create(), boundaryBase::create(), regularSimulationDomain::createBoundaryDicts(), cylinder::cylinder(), dynamicLinkLibs::dynamicLinkLibs(), processField::getFieldType(), MotionModel< rotatingAxisMotion, rotatingAxis >::impl_readDictionary(), simulationDomain::prepareBoundaryDicts(), conveyorBelt::read(), iBox< intType >::read(), shapeMixture::read(), sphere::read(), box::read(), line::read(), vibrating::read(), cylinder::read(), Wall::readCommon(), cuboidWall::readcuboidWall(), cylinderWall::readCylinderWall(), multiRotatingAxisMotion::readDictionary(), grainRolling< contactForceModel >::readGrainDict(), systemControl::readIncludeExclue(), linear< limited >::readLinearDictionary(), cGAbsoluteLinear< limited >::readLinearDictionary(), cGRelativeLinear< limited >::readLinearDictionary(), nonLinearMod< limited >::readNonLinearDictionary(), nonLinear< limited >::readNonLinearDictionary(), normalRolling< contactForceModel >::readNormalDict(), planeWall::readPlaneWall(), stlWall::readSTLWall(), and sphere::sphere().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValMax()

T getValMax	(	const word &	keyword,
		const T &	maxVal
	)		const

get the value of data entry and return max(value, maxVal)

Definition at line 395 of file dictionary.hpp.

References pFlow::max().

Referenced by boundaryList::boundaryList(), and simulationDomain::prepareBoundaryDicts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValMin()

T getValMin	(	const word &	keyword,
		const T &	minVal
	)		const

get the value of data entry and return min(value, minVal)

Definition at line 405 of file dictionary.hpp.

References pFlow::min().

Here is the call graph for this function:

◆ getValOrSet()

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

get the value of data entry or if not found, set the value to setVal

Definition at line 415 of file dictionary.hpp.

Referenced by baseTimeControl::baseTimeControl(), boundaryExit::boundaryExit(), boundaryReflective::boundaryReflective(), includeMask::getFieldType(), dictionary::getValOrSetMax(), dictionary::getValOrSetMin(), timeInterval::read(), vibrating::read(), rotatingAxis::read(), multiRotatingAxis::read(), Wall::readCommon(), cuboidWall::readcuboidWall(), cylinderWall::readCylinderWall(), Time::readDictionary(), and planeWall::readPlaneWall().

Here is the caller graph for this function:

◆ getValOrSetMax()

T getValOrSetMax	(	const word &	keyword,
		const T &	setMaxVal
	)		const

get the value of data entry anf return max(setMaxVal, value) if not found, set the value to setMaxVal

Definition at line 432 of file dictionary.hpp.

References dictionary::getValOrSet(), iEntry::keyword(), and pFlow::max().

Referenced by simulationDomain::prepareBoundaryDicts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValOrSetMin()

T getValOrSetMin	(	const word &	keyword,
		const T &	setMinVal
	)		const

get the value of data entry anf return max(setMinVal, value) if not found, set the value to setMinVal

Definition at line 438 of file dictionary.hpp.

References dictionary::getValOrSet(), iEntry::keyword(), and pFlow::min().

Here is the call graph for this function:

◆ numEntries()

size_t numEntries ( ) const

return number of entris in this dictionary

Definition at line 677 of file dictionary.cpp.

◆ numDataEntries()

size_t numDataEntries ( ) const

return number of non-nullptr dataEntries

Definition at line 682 of file dictionary.cpp.

◆ numDictionaries()

size_t numDictionaries ( ) const

return number of non-nullptr dictionaries

Definition at line 695 of file dictionary.cpp.

◆ allKeywords()

pFlow::wordList allKeywords ( ) const

return all keywords (non-nullptr) in this dictionary

Definition at line 708 of file dictionary.cpp.

◆ dataEntryKeywords()

pFlow::wordList dataEntryKeywords ( ) const

return a list of all dataEntries (non-nullptr) keywords

Definition at line 719 of file dictionary.cpp.

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

Here is the caller graph for this function:

◆ dictionaryKeywords()

pFlow::wordList dictionaryKeywords ( ) const

return a list of all dictionary (non-null) keywords

Definition at line 734 of file dictionary.cpp.

Referenced by MotionModel< rotatingAxisMotion, rotatingAxis >::impl_readDictionary(), postprocess::postprocess(), and multiRotatingAxisMotion::readDictionary().

Here is the caller graph for this function:

◆ containsDictionay()

bool containsDictionay ( const word & name ) const

check if a sub-dictionary exists

Definition at line 749 of file dictionary.cpp.

Referenced by simulationDomain::prepareBoundaryDicts().

Here is the caller graph for this function:

◆ containsDataEntry()

bool containsDataEntry ( const word & name ) const

check if a data entry exist

Definition at line 761 of file dictionary.cpp.

Referenced by dictionary::addOrKeep(), dynamicLinkLibs::dynamicLinkLibs(), processField::getFieldType(), and systemControl::readIncludeExclue().

Here is the caller graph for this function:

◆ clone() [1/2]

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

virtual

clone polymorphic object (here dictionary)

Implements iEntry.

Definition at line 804 of file dictionary.cpp.

◆ clonePtr() [1/2]

pFlow::iEntry * clonePtr ( ) const

virtual

clone the object

Implements iEntry.

Definition at line 810 of file dictionary.cpp.

◆ clone() [2/2]

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

virtual

clone the polymorhpic object with parDict as the new parrent dictionary

Implements iEntry.

Definition at line 818 of file dictionary.cpp.

◆ clonePtr() [2/2]

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

virtual

clone the object and change its ownership to parDict

Implements iEntry.

Definition at line 826 of file dictionary.cpp.

◆ read()

bool read ( iIstream & is )

overridevirtual

read from stream

Implements iEntry.

Definition at line 772 of file dictionary.cpp.

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

Referenced by fileDictionary::read(), and multiRotatingAxisMotion::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( iOstream & os ) const

overridevirtual

write to stream

Implements iEntry.

Definition at line 793 of file dictionary.cpp.

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

Referenced by fileDictionary::write(), stationaryWall::write(), conveyorBeltMotion::write(), rotatingAxisMotion::write(), vibratingMotion::write(), insertion::write(), baseShapeNames::write(), and multiRotatingAxisMotion::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_

protected

global name of dictionary, separated with dots

Definition at line 76 of file dictionary.hpp.

Referenced by fileDictionary::fileDictionary().

◆ entries_

wordOrderedMapPtr<iEntry> entries_

protected

all the entries (data and dictionary) of the current dictionary

Definition at line 79 of file dictionary.hpp.

◆ orderedEntries_

List<iEntry*> orderedEntries_

protected

entries in order of insertion

Definition at line 82 of file dictionary.hpp.

Referenced by dictionary::dictionary().

◆ parDict_

const dictionary& parDict_

protected

ref to parrent dictionary

Definition at line 85 of file dictionary.hpp.

◆ isGlobal_

bool isGlobal_ = false

protected

Definition at line 87 of file dictionary.hpp.

Referenced by dictionary::dictionary().

◆ nullDict

pFlow::dictionary nullDict

static

Definition at line 116 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/9]

◆ dictionary() [2/9]

◆ dictionary() [3/9]

◆ dictionary() [4/9]

◆ dictionary() [5/9]

◆ dictionary() [6/9]

◆ dictionary() [7/9]

◆ dictionary() [8/9]

◆ dictionary() [9/9]

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]

◆ addOrKeep()

◆ addOrReplace()

◆ clear()

◆ subDictPtr()

◆ subDict() [1/2]

◆ subDict() [2/2]

◆ dataEntryPtr()

◆ dataEntryRef() [1/2]

◆ dataEntryRef() [2/2]

◆ subDictOrCreate()

◆ getVal()

◆ getValMax()

◆ getValMin()

◆ getValOrSet()

◆ getValOrSetMax()

◆ getValOrSetMin()

◆ 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_