IOmapDistribute Class Reference

IOmapDistribute is derived from mapDistribute and IOobject to give the mapDistribute automatic IO functionality via the objectRegistry. More...

#include <IOmapDistribute.H>

Inheritance diagram for IOmapDistribute:

Collaboration diagram for IOmapDistribute:

Public Member Functions
	TypeName ("mapDistribute")
	Runtime type information.
	IOmapDistribute (const IOobject &io)
	Construct from IOobject.
	IOmapDistribute (const IOobject &io, const mapDistribute &map)
	Construct from IOobject, copying mapDistribute contents.
	IOmapDistribute (const IOobject &io, mapDistribute &&map)
	Construct from IOobject, moving mapDistribute contents.
virtual	~IOmapDistribute ()=default
	Destructor.
virtual bool	readData (Istream &)
	ReadData function required for regIOobject read operation.
virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation.
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.
virtual void	rename (const word &newName)
	Rename.
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	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	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
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 mapDistribute
	ClassName ("mapDistribute")
	mapDistribute () noexcept
	Default construct - uses worldComm.
	mapDistribute (const label comm) noexcept
	Default construct with specified communicator.
	mapDistribute (mapDistributeBase &&map)
	Move construct from base, no transforms.
	mapDistribute (const mapDistribute &map)
	Copy construct.
	mapDistribute (mapDistribute &&map)
	Move construct.
	mapDistribute (const dictionary &dict, const label comm=UPstream::worldComm)
	Read construct from dictionary.
	mapDistribute (const label constructSize, labelListList &&subMap, labelListList &&constructMap, labelListList &&transformElements, labelList &&transformStart, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Move construct from components.
	mapDistribute (const globalIndex &, labelList &untransformedElements, const globalIndexAndTransform &, const labelPairList &transformedElements, labelList &transformedIndices, List< Map< label > > &compactMap, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Construct from list of (possibly remote) untransformed elements in globalIndex numbering (or -1) and (possibly remote) transformed elements in globalIndexAndTransform numbering.
	mapDistribute (const globalIndex &, labelListList &cellCells, const globalIndexAndTransform &, const List< labelPairList > &transformedElements, labelListList &transformedIndices, List< Map< label > > &compactMap, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	As above but with ListLists.
	mapDistribute (const UPtrList< const mapDistribute > &maps, const labelList &localRanks, const label newComm, const labelListList &newToOldRanks, labelList &startOfLocal, List< Map< label > > &compactMaps)
	Construct from multiple maps and processor collation.
	mapDistribute (Istream &is)
	Construct from Istream.
autoPtr< mapDistribute >	clone () const
	Clone.
virtual	~mapDistribute ()=default
	Destructor.
const labelListList &	transformElements () const noexcept
	For every globalIndexAndTransform::transformPermutations gives the elements that need to be transformed.
const labelList &	transformStart () const noexcept
	Destination in constructMap for transformed elements.
label	whichTransform (const label index) const
	Find transform from transformElements.
void	clear ()
	Reset to zero size, only retaining communicator.
void	transfer (mapDistribute &map)
	Transfer the contents of the argument and annul the argument.
template<class T>
void	distribute (List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Distribute List data using default commsType, default flip/negate operator.
template<class T>
void	distribute (DynamicList< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Distribute DynamicList data using default commsType, default flip/negate operator.
template<class T>
void	distribute (const UPstream::commsTypes commsType, List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Distribute List data using specified commsType, default flip/negate operator.
template<class T>
void	distribute (const UPstream::commsTypes commsType, DynamicList< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Distribute DynamicList data using specified commsType, default flip/negate operator.
template<class T, class NegateOp>
void	distribute (List< T > &fld, const NegateOp &negOp, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Distribute List data using default commsType and the specified negate operator (for flips).
template<class T, class NegateOp>
void	distribute (const UPstream::commsTypes commsType, List< T > &fld, const NegateOp &negOp, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Distribute List data using specified commsType and the specified negate operator (for flips).
template<class T>
void	reverseDistribute (const label constructSize, List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Reverse distribute data using default commsType.
template<class T>
void	reverseDistribute (const UPstream::commsTypes commsType, const label constructSize, List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Reverse distribute data using specified commsType.
template<class T>
void	reverseDistribute (const label constructSize, const T &nullValue, List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Reverse distribute data using default commsType.
template<class T>
void	reverseDistribute (const UPstream::commsTypes commsType, const label constructSize, const T &nullValue, List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const
	Reverse distribute data using specified commsType.
template<class T, class TransformOp>
void	distribute (const globalIndexAndTransform &, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const
	Distribute with transforms.
template<class T, class TransformOp>
void	distribute (const UPstream::commsTypes commsType, const globalIndexAndTransform &, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const
	Distribute with transforms.
template<class T, class TransformOp>
void	reverseDistribute (const globalIndexAndTransform &, const label constructSize, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const
	Reverse distribute with transforms.
template<class T, class TransformOp>
void	reverseDistribute (const UPstream::commsTypes commsType, const globalIndexAndTransform &, const label constructSize, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const
	Reverse distribute with transforms.
template<class T, class TransformOp>
void	reverseDistribute (const globalIndexAndTransform &, const label constructSize, const T &nullValue, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const
	Reverse distribute with transforms.
template<class T, class TransformOp>
void	reverseDistribute (const UPstream::commsTypes commsType, const globalIndexAndTransform &, const label constructSize, const T &nullValue, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const
	Reverse distribute with transforms.
void	printLayout (Ostream &os) const
	Debug: print layout. Can only be used on maps with sorted.
void	operator= (const mapDistribute &rhs)
	Copy assignment.
void	operator= (mapDistribute &&rhs)
	Move assignment.
void	readDict (const dictionary &dict)
	Read entries from dictionary format.
void	writeEntries (Ostream &os) const
	Write entries in dictionary format.
void	updateMesh (const mapPolyMesh &)
	No correction for topo change.
	mapDistributeBase () noexcept
	Inherit constructors.
	mapDistributeBase (const label comm) noexcept
	Inherit constructors.
	mapDistributeBase (const mapDistributeBase &map)
	Inherit constructors.
	mapDistributeBase (mapDistributeBase &&map)
	Inherit constructors.
	mapDistributeBase (const dictionary &dict, const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (const label constructSize, labelListList &&subMap, labelListList &&constructMap, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (const labelUList &sendProcs, const labelUList &recvProcs, const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (const globalIndex &, labelList &elements, List< Map< label > > &compactMap, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (const globalIndex &, labelListList &cellCells, List< Map< label > > &compactMap, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (const layoutTypes constructLayout, labelListList &&subMap, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (labelListList &&subMap, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Inherit constructors.
	mapDistributeBase (const UPtrList< const mapDistributeBase > &maps, const labelList &localRanks, const label newComm, const labelListList &newToOldRanks, labelList &startOfLocal, List< Map< label > > &compactMaps)
	Inherit constructors.
	mapDistributeBase (Istream &is)
	Inherit constructors.
Public Member Functions inherited from mapDistributeBase
	ClassName ("mapDistributeBase")
	mapDistributeBase () noexcept
	Default construct (uses worldComm).
	mapDistributeBase (const label comm) noexcept
	Default construct with specified communicator.
	mapDistributeBase (const mapDistributeBase &map)
	Copy construct.
	mapDistributeBase (mapDistributeBase &&map)
	Move construct.
	mapDistributeBase (const dictionary &dict, const label comm=UPstream::worldComm)
	Read construct from dictionary.
	mapDistributeBase (const label constructSize, labelListList &&subMap, labelListList &&constructMap, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Move construct from components.
	mapDistributeBase (const labelUList &sendProcs, const labelUList &recvProcs, const label comm=UPstream::worldComm)
	Construct from reverse addressing: per data item the send processor and the receive processor.
	mapDistributeBase (const globalIndex &, labelList &elements, List< Map< label > > &compactMap, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Construct from list of (possibly) remote elements in globalIndex numbering (or -1).
	mapDistributeBase (const globalIndex &, labelListList &cellCells, List< Map< label > > &compactMap, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Special variant that works with the info sorted into bins according to local indices.
	mapDistributeBase (const layoutTypes constructLayout, labelListList &&subMap, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Construct from my elements to send, targetting the specified constructMap layout.
	mapDistributeBase (labelListList &&subMap, const bool subHasFlip=false, const bool constructHasFlip=false, const label comm=UPstream::worldComm)
	Construct from my elements to send.
	mapDistributeBase (const UPtrList< const mapDistributeBase > &maps, const labelList &localRanks, const label newComm, const labelListList &newToOldRanks, labelList &startOfLocal, List< Map< label > > &compactMaps)
	Construct from multiple maps and processor collation.
	mapDistributeBase (Istream &is)
	Construct from Istream.
label	constructSize () const noexcept
	Constructed data size.
label &	constructSize () noexcept
	Constructed data size.
const labelListList &	subMap () const noexcept
	From subsetted data back to original data.
labelListList &	subMap () noexcept
	From subsetted data back to original data.
const labelListList &	constructMap () const noexcept
	From subsetted data to new reconstructed data.
labelListList &	constructMap () noexcept
	From subsetted data to new reconstructed data.
bool	subHasFlip () const noexcept
	Does subMap include a sign.
bool &	subHasFlip () noexcept
	Does subMap include a sign.
bool	constructHasFlip () const noexcept
	Does constructMap include a sign.
bool &	constructHasFlip () noexcept
	Does constructMap include a sign.
label	comm () const noexcept
	The communicator used.
label	nMaps () const noexcept
	The number of sub-lists within the maps.
labelList	subMapSizes () const
	The sizes of the subMap lists.
labelList	constructMapSizes () const
	The sizes of the constructMap lists.
label	subMapTotalSize () const noexcept
	The sum of the subMap list sizes.
label	constructMapTotalSize () const noexcept
	The sum of the constructMap list sizes.
const List< labelPair > &	schedule () const
	Return a schedule. Demand driven. See above.
const List< labelPair > &	whichSchedule (const UPstream::commsTypes commsType) const
	Return real or dummy schedule depending on the communication type.
void	clear ()
	Reset to zero size, only retaining communicator.
void	transfer (mapDistributeBase &rhs)
	Transfer the contents of the argument and annul the argument.
void	compactLocalData (const bitSet &allowedLocalElems, const int tag=UPstream::msgType(), const bool doRenumber=false)
	Compact send/receive maps based on selection of originating local (send) elements.
void	compactRemoteData (const bitSet &allowedRemoteElems, const int tag=UPstream::msgType(), const bool doRenumber=false)
	Compact send/receive maps based on selection of remote (receive) elements.
void	compactLocalData (const bitSet &allowedLocalElems, labelList &oldToNewSub, labelList &oldToNewConstruct, const label localSize=-1, const int tag=UPstream::msgType())
	Compact send/receive maps based on selection of originating local (send) elements. Returns compaction mappings for subMap and constructMap.
void	compactRemoteData (const bitSet &allowedRemoteElems, labelList &oldToNewSub, labelList &oldToNewConstruct, const label localSize=-1, const int tag=UPstream::msgType())
	Compact send/receive maps based on selection of remote (receive) elements. Returns compaction mappings for subMap and constructMap.
void	compactData (const labelUList &localElements, const labelUList &remoteElements, labelList &oldToNewSub, labelList &oldToNewConstruct, const label localSize=-1, const int tag=UPstream::msgType())
	Compact send/receive maps based on selection of originating local (send) and remote (receive) elements.
void	compactLocalData (const labelUList &localElements, labelList &oldToNewSub, labelList &oldToNewConstruct, const label localSize=-1, const int tag=UPstream::msgType())
	Compact send/receive maps based on selection of originating local (send) elements.
void	compactRemoteData (const labelUList &remoteElements, labelList &oldToNewSub, labelList &oldToNewConstruct, const label localSize=-1, const int tag=UPstream::msgType())
	Compact send/receive maps based on selection of remote (receive) elements.
template<class T>
void	distribute (List< T > &values, const int tag=UPstream::msgType()) const
	Distribute List data using default commsType and the default flip/negate operator.
template<class T>
void	distribute (DynamicList< T > &values, const int tag=UPstream::msgType()) const
	Distribute DynamicList data using default commsType and the default flip/negate operator.
template<class T>
void	distribute (const UPstream::commsTypes commsType, List< T > &values, const int tag=UPstream::msgType()) const
	Distribute List data using specified commsType and the default flip/negate operator.
template<class T>
void	distribute (const UPstream::commsTypes commsType, DynamicList< T > &values, const int tag=UPstream::msgType()) const
	Distribute DynamicList data using specified commsType and the default flip/negate operator.
template<class T, class NegateOp>
void	distribute (List< T > &values, const NegateOp &negOp, const int tag=UPstream::msgType()) const
	Distribute data using default commsType and the specified negate operator (for flips).
template<class T, class NegateOp>
void	distribute (const UPstream::commsTypes commsType, List< T > &values, const NegateOp &negOp, const int tag=UPstream::msgType()) const
	Distribute data using specified commsType and the specified negate operator (for flips).
template<class T, class NegateOp>
void	distribute (const UPstream::commsTypes commsType, const T &nullValue, List< T > &values, const NegateOp &negOp, const int tag=UPstream::msgType()) const
	Distribute data using specified commsType and the specified negate operator (for flips).
template<class T>
void	reverseDistribute (const label constructSize, List< T > &values, const int tag=UPstream::msgType()) const
	Reverse distribute data using default commsType and the default flip/negate operator.
template<class T>
void	reverseDistribute (const label constructSize, const T &nullValue, List< T > &values, const int tag=UPstream::msgType()) const
	Reverse distribute data using default commsType and the default flip/negate operator.
template<class T>
void	reverseDistribute (const UPstream::commsTypes commsType, const label constructSize, List< T > &values, const int tag=UPstream::msgType()) const
	Reverse distribute data using specified commsType and the default flip/negate operator.
template<class T, class NegateOp>
void	reverseDistribute (const UPstream::commsTypes commsType, const label constructSize, List< T > &values, const NegateOp &negOp, const int tag=UPstream::msgType()) const
	Reverse distribute data using specified commsType and the specified flip/negate operator.
template<class T>
void	reverseDistribute (const UPstream::commsTypes commsType, const label constructSize, const T &nullValue, List< T > &values, const int tag=UPstream::msgType()) const
	Reverse distribute data using specified commsType and the default flip/negate operator.
template<class T>
void	send (PstreamBuffers &pBufs, const UList< T > &field) const
	Do all sends using PstreamBuffers.
template<class T>
void	receive (PstreamBuffers &pBufs, List< T > &field) const
	Do all receives using PstreamBuffers.
template<class T>
void	send (const UList< T > &field, labelRange &sendRequests, PtrList< List< T > > &sendFields, labelRange &recvRequests, PtrList< List< T > > &recvFields, const int tag=UPstream::msgType()) const
	Start all sends and receives (always non-blocking).
template<class T>
void	receive (const labelRange &requests, const UPtrList< List< T > > &recvFields, List< T > &field, const int tag=UPstream::msgType()) const
	Wait for (receive) requests to finish and consume.
void	printLayout (Ostream &os) const
	Debug: print layout. Can only be used on maps with sorted.
void	operator= (const mapDistributeBase &rhs)
	Copy assignment.
void	operator= (mapDistributeBase &&rhs)
	Move assignment.
InfoProxy< mapDistributeBase >	info () const noexcept
	Return info proxy, used to print summary information to a stream.
void	readDict (const dictionary &dict)
	Read entries from dictionary format.
void	writeEntries (Ostream &os) const
	Write entries in dictionary format.
void	updateMesh (const mapPolyMesh &)
	No correction for topo change.
void	compact (const boolList &remoteElemUsed, const int tag=UPstream::msgType())
	OpenFOAM-v2112 and earlier naming for compactRemoteData() using boolList.
void	compact (const boolList &remoteElemUsed, const label localSize, labelList &oldToNewSub, labelList &oldToNewConstruct, const int tag=UPstream::msgType())
	OpenFOAM-v2112 and earlier naming for compactRemoteData(). using boolList.
template<class T, class NegateOp>
Foam::List< T >	accessAndFlip (const UList< T > &values, const labelUList &map, const bool hasFlip, const NegateOp &negOp)

Additional Inherited Members
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 mapDistributeBase
enum class	layoutTypes : char { linear , localFirst }
	The map layout (eg, of the constructMap). More...
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 mapDistributeBase
static bool	hasFlipAddressing (const labelUList &map)
	Test for flip addressing, where flips are encoded as negative indices and non-flips are encoded as positive non-zero indices.
static bool	hasFlipAddressing (const labelListList &maps)
	Test for flip addressing, where flips are encoded as negative indices and non-flips are encoded as positive non-zero indices.
static label	countUnmapped (const labelUList &elements, const labelListList &maps, const bool hasFlip)
	Count the number of unmapped elements.
static List< labelPair >	schedule (const labelListList &subMap, const labelListList &constructMap, const int tag, const label comm=UPstream::worldComm)
	Calculate a communication schedule. See above.
static label	renumber (const globalIndex &, const label comm, const List< Map< label > > &compactMap, const label globalElement)
	Helper for construct from globalIndex. Renumbers element.
static label	renumberMap (labelListList &mapElements, const labelUList &oldToNew, const bool hasFlip)
	Helper for renumbering the (compacted) map elements using the supplied old-to-new mapping.
static label	renumberMap (labelList &map, const label localSize, const label offset, const Map< label > &cMap, const bool hasFlip)
	Helper for renumbering the map elements. Assumes local elements are first, followed by any remote. Local elements get offset, remote elements are mapped.
static label	renumberMap (labelListList &mapElements, const label localSize, const label offset, const Map< label > &cMap, const bool hasFlip)
	Helper for a list of maps. Calls above renumberMap for all elements.
template<class T, class CombineOp, class NegateOp>
static void	distribute (const UPstream::commsTypes commsType, const UList< labelPair > &schedule, const label constructSize, const labelListList &subMap, const bool subHasFlip, const labelListList &constructMap, const bool constructHasFlip, List< T > &field, const T &nullValue, const CombineOp &cop, const NegateOp &negOp, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Distribute combine data with specified combine operation and negate operator (for flips).
template<class T, class CombineOp, class NegateOp>
static void	distribute (const UPstream::commsTypes commsType, const UList< labelPair > &schedule, const UList< T > &inField, const labelListList &subMap, const bool subHasFlip, List< T > &field, const label constructSize, const labelListList &constructMap, const bool constructHasFlip, const T &nullValue, const CombineOp &cop, const NegateOp &negOp, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Distribute combine data with specified combine operation and negate operator (for flips).
template<class T, class NegateOp>
static void	distribute (const UPstream::commsTypes commsType, const UList< labelPair > &schedule, const label constructSize, const labelListList &subMap, const bool subHasFlip, const labelListList &constructMap, const bool constructHasFlip, List< T > &field, const NegateOp &negOp, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
	Distribute assign data with specified negate operator (for flips). Uses assignment for combine operation.
template<class T, class negateOp>
static void	send (const labelListList &subMap, const bool subHasFlip, const labelListList &constructMap, const bool constructHasFlip, const UList< T > &field, labelRange &sendRequests, PtrList< List< T > > &sendFields, labelRange &recvRequests, PtrList< List< T > > &recvFields, const negateOp &negOp, const int tag, const label comm)
	Start all sends and receives (always non-blocking).
template<class T, class CombineOp, class negateOp>
static void	receive (const label constructSize, const labelListList &constructMap, const bool constructHasFlip, const labelRange &requests, const UPtrList< List< T > > &recvFields, List< T > &field, const CombineOp &cop, const negateOp &negOp, const int tag, const label comm)
	Wait for (receive) requests to finish and consume.
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.
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 mapDistributeBase
void	calcCompactAddressing (const globalIndex &globalNumbering, const labelUList &elements, List< Map< label > > &compactMap) const
	Construct per processor compact addressing of the global elements.
void	calcCompactAddressing (const globalIndex &globalNumbering, const labelListList &elements, List< Map< label > > &compactMap) const
void	exchangeAddressing (const int tag, const globalIndex &globalNumbering, labelList &elements, List< Map< label > > &compactMap, labelList &compactStart)
void	exchangeAddressing (const int tag, const globalIndex &globalNumbering, labelListList &elements, List< Map< label > > &compactMap, labelList &compactStart)
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 mapDistributeBase
static void	checkReceivedSize (const label proci, const label expectedSize, const label receivedSize)
	Fatal if expected != received size.
static label	getMappedSize (const labelListList &maps, const bool hasFlip)
	Scan the maps for the max addressed index.
static void	exchangeMasks (const UList< bitSet > &sendMasks, UList< bitSet > &recvMasks, const int tag, const label comm)
	Synchronize send/recv mask buffers as a 'copy' operation.
static void	unionCombineMasks (UList< bitSet > &sendMasks, UList< bitSet > &recvMasks, const int tag, const label comm)
	Bi-direction sync of send/recv buffers using bitwise '&=' combine operation.
template<class T, class CombineOp, class NegateOp>
static void	flipAndCombine (UList< T > &lhs, const UList< T > &rhs, const labelUList &map, const bool hasFlip, const CombineOp &cop, const NegateOp &negOp)
	Combine field values (after any flip negation operation) into the specified mapped target locations.
template<class T, class NegateOp>
static void	accessAndFlip (UList< T > &output, const UList< T > &values, const labelUList &map, const bool hasFlip, const NegateOp &negOp)
	Lookup field values at specified map indices and save after any flip negation operations.
template<class T, class NegateOp>
static List< T >	accessAndFlip (const UList< T > &values, const labelUList &map, const bool hasFlip, const NegateOp &negOp)
	Lookup field values at specified indices and return after any flip negation operations.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

IOmapDistribute is derived from mapDistribute and IOobject to give the mapDistribute automatic IO functionality via the objectRegistry.

Source files

• IOmapDistribute.H
• IOmapDistribute.C

Definition at line 50 of file IOmapDistribute.H.

Constructor & Destructor Documentation

IOmapDistribute() [1/3]

IOmapDistribute

(

const IOobject &

io

)

Construct from IOobject.

Definition at line 49 of file IOmapDistribute.C.

References io, regIOobject::regIOobject(), and IOobject::warnNoRereading().

Here is the call graph for this function:

IOmapDistribute() [2/3]

IOmapDistribute	(	const IOobject &	io,
		const mapDistribute &	map )

Construct from IOobject, copying mapDistribute contents.

Definition at line 60 of file IOmapDistribute.C.

References io, mapDistribute::mapDistribute(), mapDistribute::operator=(), regIOobject::regIOobject(), and IOobject::warnNoRereading().

Here is the call graph for this function:

IOmapDistribute() [3/3]

IOmapDistribute	(	const IOobject &	io,
		mapDistribute &&	map )

Construct from IOobject, moving mapDistribute contents.

Definition at line 78 of file IOmapDistribute.C.

References io, mapDistribute::mapDistribute(), regIOobject::regIOobject(), mapDistribute::transfer(), and IOobject::warnNoRereading().

Here is the call graph for this function:

~IOmapDistribute()

virtual ~IOmapDistribute ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"mapDistribute"

)

Runtime type information.

References io, and mapDistribute::mapDistribute().

Here is the call graph for this function:

readData()

bool readData ( Istream & is )

virtual

ReadData function required for regIOobject read operation.

Reimplemented from regIOobject.

Definition at line 97 of file IOmapDistribute.C.

writeData()

bool writeData ( Ostream & os ) const

virtual

WriteData function required for regIOobject write operation.

Implements regIOobject.

Definition at line 103 of file IOmapDistribute.C.

References os().

Here is the call graph for this function:

---

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

• src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/IOmapDistribute.H
• src/OpenFOAM/meshes/polyMesh/mapPolyMesh/mapDistribute/IOmapDistribute.C