A Cloud of solid particles. More...

#include <solidParticleCloud.H>

Inheritance diagram for solidParticleCloud:

Collaboration diagram for solidParticleCloud:

Public Types
typedef solidParticle	parcelType
	Type of parcel within the cloud.
Public Types inherited from Cloud< solidParticle >
typedef solidParticle	particleType
typedef solidParticle	parcelType
	Parcels are just particles.
Public Types inherited from cloud
enum class	geometryType { COORDINATES , POSITIONS }
	Cloud geometry type (internal or IO representations). More...
Public Types inherited from IOobject
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp \| inotify) \| (all \| masterOnly). More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true). More...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Public Types inherited from HashTable< regIOobject * >
typedef HashTable< regIOobject *, word, Foam::Hash< word > >	this_type
	The template instance used for this HashTable.
using	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions.
typedef word	key_type
	The second template parameter, type of keys used.
typedef regIOobject *	mapped_type
	The first template parameter, type of objects contained.
typedef regIOobject *	value_type
	Same as mapped_type for OpenFOAM HashTables.
typedef Foam::Hash< word >	hasher
	The third template parameter, the hash index method.
typedef regIOobject **	pointer
	Pointer type for storing into value_type objects.
typedef regIOobject *&	reference
	Reference to the stored value_type.
typedef const regIOobject **	const_pointer
	Const pointer type for the stored value_type.
typedef const regIOobject *&	const_reference
	Const reference to the stored value_type.
typedef label	difference_type
	The type to represent the difference between two iterators.
typedef label	size_type
	The type that can represent the size of a HashTable.
using	key_iterator
	Forward iterator returning the key.
using	const_key_iterator
	Forward const iterator returning the key.
Public Types inherited from UILList< DLListBase, T >
typedef T	value_type
	Type of values stored.
typedef T *	pointer
	Pointer for value_type.
typedef const T *	const_pointer
	Const pointer for value_type.
typedef T &	reference
	Reference for value_type.
typedef const T &	const_reference
	Const reference for value_type.
typedef label	size_type
	The type that can represent the container size.
typedef label	difference_type
	The difference between iterator objects.
using	base_iterator
using	const_base_iterator

Public Member Functions
	solidParticleCloud (const solidParticleCloud &)=delete
	No copy construct.
void	operator= (const solidParticleCloud &)=delete
	No copy assignment.
	solidParticleCloud (const fvMesh &mesh, const word &cloudName=cloud::defaultName, bool readFields=true)
	Read construct.
const fvMesh &	mesh () const
scalar	rhop () const noexcept
scalar	e () const noexcept
scalar	mu () const noexcept
void	move (const dimensionedVector &g)
	Move the particles under the influence of the given gravitational acceleration.
Public Member Functions inherited from Cloud< solidParticle >
	TypeName ("Cloud")
	Runtime type information.
	Cloud (const polyMesh &mesh, const Foam::zero, const word &cloudName)
	Construct without particles.
const polyMesh &	pMesh () const noexcept
	Return the polyMesh reference.
virtual label	nParcels () const
	Return the number of particles in the cloud.
DynamicList< label > &	labels () const
	Return temporary addressing.
void	addParticle (solidParticle *pPtr)
	Transfer particle to cloud.
void	deleteParticle (solidParticle &p)
	Remove particle from cloud and delete.
void	deleteLostParticles ()
	Remove lost particles from cloud and delete.
void	cloudReset (const Cloud< solidParticle > &c)
	Reset the particles.
void	move (TrackCloudType &cloud, typename solidParticle::trackingData &td, const scalar trackTime)
	Move the particles.
void	autoMap (const mapPolyMesh &)
	Remap the cells of particles corresponding to the.
void	checkFieldIOobject (const Cloud< solidParticle > &c, const IOField< DataType > &data) const
	Check lagrangian data field.
void	checkFieldFieldIOobject (const Cloud< solidParticle > &c, const CompactIOField< Field< DataType > > &data) const
	Check lagrangian data fieldfield.
bool	readStoreFile (const IOobject &io, const IOobject &ioNew) const
	Helper function to store a cloud field on its registry.
void	readFromFiles (objectRegistry &obr, const wordRes &selectFields, const wordRes &excludeFields=wordRes::null()) const
	Read from files into objectRegistry.
virtual void	writeFields () const
	Write the field data for the cloud of particles Dummy at.
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
void	writePositions () const
	Write positions to <cloudName>_positions.obj file.
void	storeGlobalPositions () const
	Call this before a topology change.
IOobject	fieldIOobject (const word &fieldName, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ) const
	Helper to construct IOobject for field and current time.
Public Member Functions inherited from cloud
	TypeName ("cloud")
	Runtime type information.
	cloud (const cloud &)=delete
	No copy construct.
void	operator= (const cloud &)=delete
	No copy assignment.
	cloud (const objectRegistry &obr)
	Construct for given objectRegistry. Uses default cloud name.
	cloud (const objectRegistry &obr, const word &cloudName)
	Construct for given objectRegistry and named cloud.
virtual	~cloud ()=default
	Destructor.
virtual void	readObjects (const objectRegistry &obr)
	Read particle fields from objects in the obr registry.
virtual void	writeObjects (objectRegistry &obr) const
	Write particle fields as objects into the obr registry.
template<class Type>
Foam::IOField< Type > &	createIOField (const word &fieldName, const label nParticle, objectRegistry &obr)
Public Member Functions inherited from objectRegistry
	TypeName ("objectRegistry")
	Declare type name for this IOobject.
	objectRegistry (const Time &db, const label initialCapacity=128)
	Construct the time objectRegistry, with estimated table capacity (default: 128).
	objectRegistry (const IOobject &io, const label initialCapacity=128)
	Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128).
virtual	~objectRegistry ()
	Destructor, with checkOut() for all objects that are ownedByRegistry.
const objectRegistry &	thisDb () const noexcept
	Return the object registry.
const objectRegistry &	parent () const noexcept
	Return the parent objectRegistry.
const Time &	time () const noexcept
	Return time registry.
bool	isTimeDb () const noexcept
	True if the registry is Time.
virtual const fileName &	dbDir () const
	Local directory path of this objectRegistry relative to the time.
IOobject	newIOobject (const word &name, IOobjectOption ioOpt) const
	Create an IOobject at the current time instance (timeName) with the specified options.
IOobject	newIOobject (const word &name, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption regOpt=IOobjectOption::NO_REGISTER) const
	Create an IOobject at the current time instance (timeName).
HashTable< wordHashSet >	classes () const
	A summary hash of classes used and their associated object names.
template<class MatchPredicate>
HashTable< wordHashSet >	classes (const MatchPredicate &matchName) const
	A summary hash of classes used and their associated object names, restricted to objects that have a matching object name.
template<class Type, bool Strict = false>
UPtrList< const Type >	cobjects () const
	Return unsorted list of objects with a class satisfying `isA<Type>` or `isType<Type>` (with Strict).
template<class Type, bool Strict = false>
UPtrList< Type >	objects ()
	Return unsorted list of objects with a class satisfying `isA<Type>` or `isType<Type>` (with Strict).
template<class Type, class MatchPredicate>
UPtrList< const Type >	cobjects (const MatchPredicate &matchName) const
	Return unsorted list of objects with a class satisfying `isA<Type>` that also have a matching object name.
template<class Type, class MatchPredicate>
UPtrList< Type >	objects (const MatchPredicate &matchName)
	Return sorted list of objects with a class satisfying `isA<Type>` that also have a matching object name.
template<class Type, bool Strict = false>
UPtrList< const Type >	csorted () const
	Return sorted list of objects with a class satisfying `isA<Type>` or `isType<Type>` (with Strict).
template<class Type, bool Strict = false>
UPtrList< Type >	sorted ()
	Return sorted list of objects with a class satisfying `isA<Type>` or `isType<Type>` (with Strict).
UPtrList< const regIOobject >	csorted () const
	Return sorted list of objects.
UPtrList< regIOobject >	sorted ()
	Return sorted list of objects.
template<class Type, class MatchPredicate>
UPtrList< const Type >	csorted (const MatchPredicate &matchName) const
	Return sorted list of objects with a class satisfying `isA<Type>` that also have a matching object name.
template<class Type, class MatchPredicate>
UPtrList< Type >	sorted (const MatchPredicate &matchName)
	Return sorted list of objects with a class satisfying `isA<Type>` that also have a matching object name.
label	count (const char *clsName) const
	The number of objects of the given class name.
template<class MatchPredicate>
label	count (const MatchPredicate &matchClass) const
	The number of objects of the given class name.
template<class MatchPredicate1, class MatchPredicate2>
label	count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The number of objects of the given class name.
template<class Type>
label	count (const bool strict=false) const
	The names of objects with a class satisfying `isA<Type>`.
template<class Type, class MatchPredicate>
label	count (const MatchPredicate &matchName) const
	The names of objects with a class satisfying `isA<Type>` that also have a matching object name.
wordList	names () const
	The unsorted names of all objects.
wordList	names (const char *clsName) const
	The unsorted names of objects with the given class name.
template<class MatchPredicate>
wordList	names (const MatchPredicate &matchClass) const
	The unsorted names of objects with a matching class name.
template<class MatchPredicate1, class MatchPredicate2>
wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The unsorted names of objects with a matching class name that also have a matching object name.
template<class Type>
wordList	names () const
	The unsorted names of objects with a class satisfying `isA<Type>`.
template<class Type, class MatchPredicate>
wordList	names (const MatchPredicate &matchName) const
	The unsorted names of objects with a class satisfying `isA<Type>` that also have a matching object name.
wordList	sortedNames () const
	The sorted names of all objects.
wordList	sortedNames (const char *clsName) const
	The sorted names of objects with the given class name.
template<class MatchPredicate>
wordList	sortedNames (const MatchPredicate &matchClass) const
	The sorted names objects with a matching class name.
template<class MatchPredicate1, class MatchPredicate2>
wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The sorted names of objects with a matching class name that also have a matching object name.
template<class Type>
wordList	sortedNames () const
	The sorted names of objects with a class satisfying `isA<Type>`.
template<class Type, class MatchPredicate>
wordList	sortedNames (const MatchPredicate &matchName) const
	The sorted names of objects with a class satisfying `isA<Type>` that also have a matching object name.
const objectRegistry &	subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const
	Lookup and return a const sub-objectRegistry.
template<class Type, bool Strict = false>
HashTable< const Type * >	lookupClass () const
	Return all objects with a class satisfying `isA<Type>` or `isType<Type>` (with Strict).
template<class Type, bool Strict = false>
HashTable< Type * >	lookupClass ()
	Return all objects with a class satisfying `isA<Type>` or `isType<Type>` (with Strict).
template<class Type>
HashTable< const Type * >	lookupClass (const bool strict) const
	Return all objects with a class satisfying `isA<Type>`.
template<class Type>
HashTable< Type * >	lookupClass (const bool strict)
	Return all objects with a class satisfying `isA<Type>`.
const regIOobject *	cfindIOobject (const word &name, const bool recursive=false) const
	Return const pointer to the regIOobject.
bool	contains (const word &name, const bool recursive=false) const
	Does the registry contain the regIOobject object (by name).
template<class Type>
bool	foundObject (const word &name, const bool recursive=false) const
	Contains the named Type?
template<class Type>
const Type *	cfindObject (const word &name, const bool recursive=false) const
	Return const pointer to the object of the given Type.
template<class Type>
const Type *	findObject (const word &name, const bool recursive=false) const
	Return const pointer to the object of the given Type.
template<class Type>
Type *	findObject (const word &name, const bool recursive=false)
	Return non-const pointer to the object of the given Type.
template<class Type>
Type *	getObjectPtr (const word &name, const bool recursive=false) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class Type>
const Type &	lookupObject (const word &name, const bool recursive=false) const
	Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type.
template<class Type>
Type &	lookupObjectRef (const word &name, const bool recursive=false) const
	Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type.
label	getEvent () const
	Return new event number.
bool	checkIn (regIOobject *io) const
	Add a regIOobject to registry. A nullptr is ignored.
bool	checkIn (regIOobject &io) const
	Add a regIOobject to registry.
bool	checkOut (regIOobject *io) const
	Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored.
bool	checkOut (regIOobject &io) const
	Remove a regIOobject from registry and free memory if the object is ownedByRegistry.
bool	checkOut (const word &key) const
	Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry.
void	clear ()
	Clear all entries from the registry.
void	clearStorage ()
	Clear all entries from the registry and the table itself.
bool	erase (const iterator &iter)
	Erase an entry specified by the given iterator.
bool	erase (const word &key)
	Erase an entry specified by the given key.
label	erase (std::initializer_list< word > keys)
	Remove entries given by the listed keys.
label	erase (const UList< word > &keys)
	Remove entries given by the listed keys.
virtual void	rename (const word &newName)
	Rename.
bool	is_cacheTemporaryObject (const word &name) const
	True if given name is in the cacheTemporaryObjects set.
bool	is_cacheTemporaryObject (const regIOobject *io) const
	True if name of object is in the cacheTemporaryObjects set.
bool	is_cacheTemporaryObject (const regIOobject &io) const
	True if name of object is in the cacheTemporaryObjects set.
template<class Type>
bool	cacheTemporaryObject (Type &obj) const
	Cache the given object. Moves content and stores.
void	resetCacheTemporaryObject (const regIOobject *io) const
	Reset the cache state of the given object (nullptr is ignored).
void	resetCacheTemporaryObject (const regIOobject &io) const
	Reset the cache state of the given object in the cacheTemporaryObjects set.
bool	checkCacheTemporaryObjects () const
	Check that all objects specified in the cacheTemporaryObjects were also cached.
virtual bool	modified () const
	Return true if any of the object's files have been modified.
void	readModifiedObjects ()
	Read the objects that have been modified.
virtual bool	readIfModified ()
	Read object if modified.
virtual bool	writeData (Ostream &) const
	The writeData function is required by regIOobject but not used.
bool	found (const word &name, bool recursive=false) const
	Same as contains().
template<class Type>
const Type *	lookupObjectPtr (const word &name, bool recursive=false) const
	Deprecated(2018-10) find object.
template<class Type>
Type *	lookupObjectRefPtr (const word &name, bool recursive=false) const
	Deprecated(2018-10) get object pointer, ignoring constness.
template<class Type>
UPtrList< const Type >	sorted () const
	Deprecated(2023-07) use csorted() method.
UPtrList< const regIOobject >	sorted () const
	Deprecated(2023-07) use csorted() method.
template<class Type, class MatchPredicate>
UPtrList< const Type >	sorted (const MatchPredicate &matchName) const
	Deprecated(2023-07) use csorted() method.
template<class MatchPredicate>
Foam::HashTable< Foam::wordHashSet >	classesImpl (const objectRegistry &list, const MatchPredicate &matchName)
template<class MatchPredicate1, class MatchPredicate2>
Foam::label	countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)
template<class Type, class MatchPredicate>
Foam::label	countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName)
template<class MatchPredicate1, class MatchPredicate2>
Foam::wordList	namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort)
template<class Type, class MatchPredicate>
Foam::wordList	namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
template<class Type, class MatchPredicate>
Foam::UPtrList< Type >	objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
template<class Type>
Foam::HashTable< Type * >	lookupClassTypeImpl (const bool strict, const objectRegistry &list)
template<class MatchPredicate>
Foam::HashTable< Foam::wordHashSet >	classes (const MatchPredicate &matchName) const
template<class MatchPredicate>
Foam::label	count (const MatchPredicate &matchClass) const
template<class MatchPredicate1, class MatchPredicate2>
Foam::label	count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
template<class Type, class MatchPredicate>
Foam::label	count (const MatchPredicate &matchName) const
template<class Type>
Foam::label	count (const bool strict) const
template<class Type, bool Strict>
Foam::UPtrList< const Type >	cobjects () const
template<class Type, bool Strict>
Foam::UPtrList< Type >	objects ()
template<class Type, bool Strict>
Foam::UPtrList< const Type >	csorted () const
template<class Type, bool Strict>
Foam::UPtrList< Type >	sorted ()
template<class Type, class MatchPredicate>
Foam::UPtrList< const Type >	cobjects (const MatchPredicate &matchName) const
template<class Type, class MatchPredicate>
Foam::UPtrList< Type >	objects (const MatchPredicate &matchName)
template<class Type, class MatchPredicate>
Foam::UPtrList< const Type >	csorted (const MatchPredicate &matchName) const
template<class Type, class MatchPredicate>
Foam::UPtrList< Type >	sorted (const MatchPredicate &matchName)
template<class MatchPredicate>
Foam::wordList	names (const MatchPredicate &matchClass) const
template<class MatchPredicate1, class MatchPredicate2>
Foam::wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
template<class Type>
Foam::wordList	names () const
template<class Type, class MatchPredicate>
Foam::wordList	names (const MatchPredicate &matchName) const
template<class MatchPredicate>
Foam::wordList	sortedNames (const MatchPredicate &matchClass) const
template<class MatchPredicate1, class MatchPredicate2>
Foam::wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
template<class Type>
Foam::wordList	sortedNames () const
template<class Type, class MatchPredicate>
Foam::wordList	sortedNames (const MatchPredicate &matchName) const
template<class Type, bool Strict>
Foam::HashTable< const Type * >	lookupClass () const
template<class Type, bool Strict>
Foam::HashTable< Type * >	lookupClass ()
template<class Type>
Foam::HashTable< const Type * >	lookupClass (const bool strict) const
template<class Type>
Foam::HashTable< Type * >	lookupClass (const bool strict)
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a `void` type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
template<class Type>
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. A `void` type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A `void` type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
template<class StringType>
Foam::word	groupName (StringType base, const word &group)
template<class Type>
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.
Public Member Functions inherited from HashTable< regIOobject * >
Foam::List< word >	sortedToc (const Compare &comp) const
Foam::List< word >	tocKeys (const UnaryPredicate &pred, const bool invert) const
Foam::List< word >	tocValues (const UnaryPredicate &pred, const bool invert) const
Foam::List< word >	tocEntries (const BinaryPredicate &pred, const bool invert) const
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const
Foam::label	erase (InputIter first, InputIter last)
Foam::label	erase (const FixedList< word, N > &keys)
Foam::label	erase (const HashTable< AnyType, word, AnyHash > &other)
Foam::label	retain (const HashTable< AnyType, word, AnyHash > &other)
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)
constexpr	HashTable () noexcept
	Default construct: empty without allocation (capacity=0).
	~HashTable ()
	Destructor.
bool	empty () const noexcept
	True if the hash table is empty.
label	size () const noexcept
	The number of elements in table.
label	capacity () const noexcept
	The size of the underlying table (the number of buckets).
regIOobject *&	at (const word &key)
	Find and return a hashed entry. FatalError if it does not exist.
bool	contains (const word &key) const
	True if hashed key is contained (found) in table.
iterator	find (const word &key)
	Find and return an iterator set at the hashed entry.
const_iterator	cfind (const word &key) const
	Find and return an const_iterator set at the hashed entry.
const regIOobject *&	lookup (const word &key, const regIOobject *&deflt) const
	Return hashed entry if it exists, or return the given default.
List< word >	toc () const
	The table of contents (the keys) in unsorted order.
UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys).
UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys).
bool	emplace (const word &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries.
bool	emplace_set (const word &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries.
bool	insert (const word &key, const regIOobject *&obj)
	Copy insert a new entry, not overwriting existing entries.
bool	set (const word &key, const regIOobject *&obj)
	Copy assign a new entry, overwriting existing entries.
void	clear ()
	Remove all entries from table.
void	clearStorage ()
	Remove all entries from table and the table itself.
void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets).
void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity().
void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table.
void	swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept
	Swap contents into this table.
void	transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
	Transfer contents into this table.
void	merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
regIOobject *&	operator[] (const word &key)
	Find and return a hashed entry. FatalError if it does not exist.
regIOobject *&	operator() (const word &key)
	Return existing entry or create a new entry.
void	operator= (const this_type &rhs)
	Copy assign.
bool	operator== (const this_type &rhs) const
	Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable.
const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys.
iterator	begin ()
	iterator set to the beginning of the HashTable
const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable
iterator	end () noexcept
	iterator to signal the end (for any HashTable)
constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable)
Ostream &	printInfo (Ostream &os) const
	Print information.
Ostream &	writeKeys (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	found (const word &key) const
	Same as contains().
Public Member Functions inherited from HashTableCore
	ClassName ("HashTable")
	Declare type-name (with debug switch).
constexpr	HashTableCore () noexcept=default
	Default construct.
Public Member Functions inherited from ILList< DLListBase, T >
	ILList ()=default
	Default construct.
	ILList (T *item)
	Construct and add initial item pointer.
	ILList (Istream &is)
	Construct from Istream.
	ILList (const ILList< DLListBase, T > &lst)
	Copy construct using the 'clone()' method for each element.
	ILList (ILList< DLListBase, T > &&lst)
	Move construct.
	ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'.
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class.
	~ILList ()
	Destructor. Calls clear().
void	clear ()
	Clear the contents of the list.
void	pop_front (label n=1)
	Remove first element(s) from the list (deletes pointers).
bool	erase (T *item)
	Remove the specified element from the list and delete it.
void	transfer (ILList< DLListBase, T > &lst)
	Transfer the contents of the argument into this List and annul the argument list.
void	operator= (const ILList< DLListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element.
void	operator= (ILList< DLListBase, T > &&lst)
	Move assignment.
Public Member Functions inherited from UILList< DLListBase, T >
	UILList ()=default
	Default construct.
	UILList (T *item)
	Construct and add initial item pointer.
	UILList (const UILList< DLListBase, T > &list)
	Construct as copy.
T *	front ()
	The first entry in the list.
const T *	front () const
	The first entry in the list (const access).
T *	back ()
	The last entry in the list.
const T *	back () const
	The last entry in the list (const access).
T *	removeHead ()
	Remove and return head.
T *	remove (T *item)
	Remove and return element.
T *	remove (iterator &iter)
	Remove and return item specified by iterator.
void	operator= (const UILList< DLListBase, T > &lst)
	Copy assignment.
bool	operator== (const UILList< DLListBase, T > &lst) const
	Equality. True both lists are element-wise equal.
bool	operator!= (const UILList< DLListBase, T > &lst) const
	The opposite of the equality operation. Takes linear time.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write UILList with line-breaks when length exceeds shortLen.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
reverse_iterator	rbegin ()
	Iterator to last item in list with non-const access.
const_reverse_iterator	crbegin () const
	Iterator to last item in list with const access.
const_iterator	begin () const
	Iterator to first item in list with const access.
const_reverse_iterator	rbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for forward iterators.
const const_iterator &	cend () const
	End of list for forward iterators.
const reverse_iterator &	rend ()
	End of list for reverse iterators.
const const_reverse_iterator &	crend () const
	End of list for reverse iterators.
const const_iterator &	end () const
	End of list for forward iterators.
const const_reverse_iterator &	rend () const
	End of list for reverse iterators.
T *	first ()
	The first entry in the list.
const T *	first () const
	The first entry in the list (const access).
T *	last ()
	The last entry in the list.
const T *	last () const
	The last entry in the list (const access).
Public Member Functions inherited from DLListBase
	DLListBase ()=default
	Default construct.
	DLListBase (const DLListBase &)=delete
	No copy construct.
void	operator= (const DLListBase &)=delete
	No copy assignment.
	~DLListBase ()=default
	Destructor.
bool	empty () const noexcept
	True if the list is empty.
label	size () const noexcept
	The number of elements in list.
link *	front ()
	Return first entry.
const link *	front () const
	Return const access to first entry.
link *	back ()
	Return last entry.
const link *	back () const
	Return const access to last entry.
void	push_front (link *item)
	Add at front of list.
void	push_back (link *item)
	Add at back of list.
bool	swapUp (link *item)
	Swap this element with the one above unless it is at the top.
bool	swapDown (link *item)
	Swap this element with the one below unless it is at the bottom.
link *	removeHead ()
	Remove and return first entry.
link *	remove (link *item)
	Remove and return element.
link *	remove (iterator &iter)
	Remove and return element specified by iterator.
link *	replace (link oldLink, link newLink)
	Replace oldLink with newLink and return element.
link *	replace (iterator &oldIter, link *newitem)
	Replace oldIter with newItem and return element.
void	clear ()
	Clear the list.
void	swap (DLListBase &lst)
	Swap the contents of the list.
void	transfer (DLListBase &lst)
	Transfer the contents of the argument into this list and annul the argument list.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
const_iterator	crbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for iterators.
const const_iterator &	cend () const
	End of list for iterators.
const const_iterator &	crend () const
	End of list for reverse iterators.
link *	first ()
	Return first entry.
const link *	first () const
	Return const access to first entry.
link *	last ()
	Return last entry.
const link *	last () const
	Return const access to last entry.
void	prepend (link *item)
	Add at front of list.
void	append (link *item)
	Add at back of list.

Additional Inherited Members
Static Public Member Functions inherited from cloud
template<class Type>
static IOField< Type > &	createIOField (const word &fieldName, const label nParticle, objectRegistry &obr)
	Helper to construct IOField on a supplied object registry.
template<class Type>
static const IOField< Type > *	findIOField (const word &fieldName, const objectRegistry &obr)
	Locate an IOField within object registry.
static const IOField< point > *	findIOPosition (const objectRegistry &obr)
	Locate the "position" IOField within object registry.
template<class Type>
static const IOField< Type > &	lookupIOField (const word &fieldName, const objectRegistry &obr)
	Lookup an IOField within object registry.
template<class Type>
static const IOField< Type > &	lookupIOField (const char *fieldName, const objectRegistry &obr)
	Lookup an IOField within object registry.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.
Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label size) noexcept
	Return a canonical (power-of-two) of the requested size.
Static Public Attributes inherited from Cloud< solidParticle >
static word	cloudPropertiesName
	Name of cloud properties dictionary.
Static Public Attributes inherited from cloud
static const Enum< geometryType >	geometryTypeNames
	Named enumerations "coordinates", "positions".
static const word	prefix
	The prefix to local: lagrangian.
static word	defaultName
	The default cloud name: defaultCloud.
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
Static Public Attributes inherited from HashTableCore
static constexpr int32_t	maxTableSize = (1 << (32-3))
	Maximum allowable internal table size (must be a power of two!).
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.
Protected Member Functions inherited from DLListBase
template<class IteratorType>
IteratorType	iterator_first () const
	Return iterator to first item or end-iterator if list is empty.
template<class IteratorType>
IteratorType	iterator_last () const
	Return iterator to last item or end-iterator if list is empty.
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information.
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information.
Static Protected Member Functions inherited from DLListBase
template<class IteratorType>
static const IteratorType &	iterator_end ()
	Factory method to return an iterator end.
template<class IteratorType>
static const IteratorType &	iterator_rend ()
	Factory method to return an iterator reverse end.
Protected Attributes inherited from Cloud< solidParticle >
cloud::geometryType	geometryType_
	Geometry type.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.