The decomposedBlockData comprise a List<char> for each output processor, typically with IO on the master processor only. More...

Inheritance diagram for decomposedBlockData:

[legend]

Collaboration diagram for decomposedBlockData:

[legend]

Public Member Functions
	TypeName ("decomposedBlockData")
	Declare type-name, virtual type (with debug switch) More...

	decomposedBlockData (const label comm, const IOobject &io, const UPstream::commsTypes=UPstream::commsTypes::scheduled)
	Construct given an IOobject. More...

virtual	~decomposedBlockData ()=default
	Destructor. More...

virtual bool	read ()
	Read object. More...

virtual bool	writeData (Ostream &os) const
	Write separated content (assumes content is the serialised data) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const noexcept

bool	ownedByRegistry () const noexcept
	Is this object owned by the registry? More...

bool	store ()

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

label	eventNo () const noexcept
	Event number at last update. More...

label &	eventNo () noexcept
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeData (Ostream &) const =0
	Pure virtual writeData function. More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

const string &	note () const noexcept
	Return the optional note. More...

string &	note () noexcept
	Modifiable access to the optional note. More...

virtual void	rename (const word &newName)
	Rename the object. More...

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

template<class Type >
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName. More...

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const
	Return the Time::rootPath() More...

const fileName &	caseName () const
	Return the Time::caseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClass () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Member Functions
static bool	isCollatedType (const word &objectType)
	True if object type is a known collated type. More...

static bool	isCollatedType (const IOobject &io)
	True if object header class is a known collated type. More...

static bool	readHeader (IOobject &io, Istream &is)

static void	writeHeader (Ostream &os, IOstreamOption streamOptContainer, const word &objectType, const string &note, const fileName &location, const word &objectName, const dictionary &extraEntries)
	Helper: write FoamFile IOobject header. More...

static void	writeHeader (Ostream &os, IOstreamOption streamOptData, const IOobject &io)
	Helper: write FoamFile IOobject header. More...

static void	writeExtraHeaderContent (dictionary &dict, IOstreamOption streamOptData, const IOobject &io)
	Helper: generate additional entries for FoamFile header. More...

static bool	readBlockEntry (Istream &is, List< char > &charData)
	Helper: read block of (binary) character data. More...

static std::streamoff	writeBlockEntry (OSstream &os, const label blocki, const UList< char > &charData)
	Helper: write block of (binary) character data. More...

static std::streamoff	writeBlockEntry (OSstream &os, IOstreamOption streamOptData, const regIOobject &io, const label blocki, const bool withLocalHeader)
	Helper: write block of (binary) character data. More...

static autoPtr< ISstream >	readBlock (const label blocki, ISstream &is, IOobject &headerIO)
	Read selected block (non-seeking) + header information. More...

static autoPtr< ISstream >	readBlocks (const label comm, const fileName &fName, autoPtr< ISstream > &isPtr, IOobject &headerIO, const UPstream::commsTypes commsType)

static void	gather (const label comm, const label data, labelList &datas)
	Helper: gather single label. Note: using native Pstream. More...

static void	gatherSlaveData (const label comm, const UList< char > &data, const labelUList &recvSizes, const label startProc, const label nProcs, List< int > &recvOffsets, List< char > &recvData)
	Helper: gather data from (subset of) slaves. More...

static bool	writeBlocks (const label comm, autoPtr< OSstream > &osPtr, List< std::streamoff > &blockOffset, const UList< char > &masterData, const labelUList &recvSizes, const PtrList< SubList< char > > &slaveData, const UPstream::commsTypes, const bool syncReturnState=true)
	Write *this. Ostream only valid on master. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Protected Member Functions
static label	calcNumProcs (const label comm, const off_t maxBufferSize, const labelUList &recvSizes, const label startProci)

static bool	readBlocks (const label comm, autoPtr< ISstream > &isPtr, List< char > &contentChars, const UPstream::commsTypes commsType)
	Read data into *this. ISstream is only valid on master. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Protected Attributes
const UPstream::commsTypes	commsType_
	Type to use for gather. More...

const label	comm_
	Communicator for all parallel comms. More...

List< char >	contentData_
	The block content. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...

enum	writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining the write options. More...

enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

The decomposedBlockData comprise a List<char> for each output processor, typically with IO on the master processor only.

For decomposedBlockData, we make a distinction between the container description and the individual block contents.

The FoamFile header specifies the container characteristics and thus has class = decomposedBlockData and normally format = binary. This description refers to the entire file container, not the individual blocks.

Each processor block is simply a binary chunk of characters and the first block also contains the header description for all of the blocks. For example,

FoamFile
{
    version     2.0;
    format      binary;
    arch        "LSB;label=32;scalar=64";
    class       decomposedBlockData;
    location    "constant/polyMesh";
    object      points;
}

// processor0
NCHARS
(FoamFile
{
    version     2.0;
    format      ascii;
    arch        "LSB;label=32;scalar=64";
    class       vectorField;
    location    "constant/polyMesh";
    object      points;
}
...content...
)

// processor1
NCHARS
(...content...)

...

Source files

Definition at line 102 of file decomposedBlockData.H.

Constructor & Destructor Documentation

◆ decomposedBlockData()

decomposedBlockData	(	const label	comm,
		const IOobject &	io,
		const UPstream::commsTypes	commsType = `UPstream::commsTypes::scheduled`
	)

Construct given an IOobject.

Definition at line 76 of file decomposedBlockData.C.

References Foam::endl(), regIOobject::headerOk(), io(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOobject::name(), decomposedBlockData::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), and WarningInFunction.

Here is the call graph for this function:

◆ ~decomposedBlockData()

virtual ~decomposedBlockData ( )

virtualdefault

Destructor.

Member Function Documentation

◆ calcNumProcs()

Foam::label calcNumProcs	(	const label	comm,
		const off_t	maxBufferSize,
		const labelUList &	recvSizes,
		const label	startProci
	)

staticprotected

Helper: determine number of processors whose recvSizes fits into maxBufferSize

Definition at line 671 of file decomposedBlockData.C.

References splitCell::master(), n, PstreamBuffers::nProcs(), UPstream::scatter(), and Foam::Zero.

Here is the call graph for this function:

◆ readBlocks() [1/2]

bool readBlocks	(	const label	comm,
		autoPtr< ISstream > &	isPtr,
		List< char > &	contentChars,
		const UPstream::commsTypes	commsType
	)

staticprotected

Read data into *this. ISstream is only valid on master.

Definition at line 304 of file decomposedBlockData.C.

References Pstream::broadcast(), UPstream::commsTypeNames, Foam::endl(), PstreamBuffers::finishedScatters(), FUNCTION_NAME, splitCell::master(), UPstream::masterNo(), UPstream::msgType(), UPstream::nonBlocking, os(), Foam::Pout, decomposedBlockData::readBlockEntry(), UPstream::scheduled, and PstreamBuffers::subProcs().

Referenced by masterUncollatedFileOperation::readStream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "decomposedBlockData" )

Declare type-name, virtual type (with debug switch)

◆ read()

bool read ( )

virtual

Read object.

Reimplemented from regIOobject.

Definition at line 922 of file decomposedBlockData.C.

References Foam::fileHandler(), splitCell::master(), IOobject::readHeader(), and autoPtr< T >::reset().

Referenced by decomposedBlockData::decomposedBlockData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write separated content (assumes content is the serialised data)

The serialised master data should also contain a FoamFile header

Implements regIOobject.

Definition at line 936 of file decomposedBlockData.C.

References Pstream::broadcasts(), IOstreamOption::versionNumber::canonical(), IOstreamOption::format(), IOstream::good(), IOobject::headerClassName(), io(), splitCell::master(), Foam::name(), IOobject::note(), os(), IOobject::readHeader(), IOstreamOption::version(), decomposedBlockData::writeData(), IOobject::writeEndDivider(), OBJstream::writeQuoted(), and OSstream::writeRaw().

Referenced by decomposedBlockData::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeObject()

bool writeObject	(	IOstreamOption	streamOpt,
		const bool	valid
	)		const

virtual

Write using stream options.

Reimplemented from regIOobject.

Definition at line 1009 of file decomposedBlockData.C.

References IOstreamOption::BINARY, splitCell::master(), and autoPtr< T >::reset().

Here is the call graph for this function:

◆ isCollatedType() [1/2]

bool isCollatedType ( const word & objectType )

static

True if object type is a known collated type.

Definition at line 53 of file decomposedBlockData.C.

References ensightPTraits< Type >::typeName.

Referenced by decomposedBlockData::isCollatedType(), decomposedBlockData::readHeader(), uncollatedFileOperation::readStream(), and masterUncollatedFileOperation::readStream().

Here is the caller graph for this function:

◆ isCollatedType() [2/2]

bool isCollatedType ( const IOobject & io )

static

True if object header class is a known collated type.

Definition at line 65 of file decomposedBlockData.C.

References IOobject::headerClassName(), io(), and decomposedBlockData::isCollatedType().

Here is the call graph for this function:

◆ readHeader()

bool readHeader	(	IOobject &	io,
		Istream &	is
	)

static

Read header as per IOobject with additional handling of decomposedBlockData

Definition at line 108 of file decomposedBlockDataHeader.C.

References IOobject::headerClassName(), io(), decomposedBlockData::isCollatedType(), IOstream::name(), ISstream::name(), decomposedBlockData::readBlockEntry(), IOobject::readHeader(), and dictionary::readIfPresent().

Referenced by masterUncollatedFileOperation::readHeader(), and uncollatedFileOperation::readHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeHeader() [1/2]

void writeHeader	(	Ostream &	os,
		IOstreamOption	streamOptContainer,
		const word &	objectType,
		const string &	note,
		const fileName &	location,
		const word &	objectName,
		const dictionary &	extraEntries
	)

static

Helper: write FoamFile IOobject header.

Definition at line 139 of file decomposedBlockDataHeader.C.

References IOobject::bannerEnabled(), Ostream::beginBlock(), Ostream::endBlock(), Foam::nl, os(), IOobject::writeBanner(), IOobject::writeDivider(), dictionary::writeEntries(), and decomposedBlockData::writeHeader().

Referenced by decomposedBlockData::writeHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeHeader() [2/2]

void writeHeader	(	Ostream &	os,
		IOstreamOption	streamOptData,
		const IOobject &	io
	)

static

Helper: write FoamFile IOobject header.

Definition at line 200 of file decomposedBlockDataHeader.C.

References IOobject::bannerEnabled(), Ostream::beginBlock(), IOobject::db(), objectRegistry::dbDir(), Ostream::endBlock(), IOobject::findMetaData(), IOstreamOption::format(), IOobject::instance(), io(), IOobject::local(), IOobject::name(), Foam::nl, IOobject::note(), os(), ensightPTraits< Type >::typeName, IOobject::writeBanner(), IOobject::writeDivider(), dictionary::writeEntry(), decomposedBlockData::writeHeader(), and Foam::writeHeaderEntry().

Here is the call graph for this function:

◆ writeExtraHeaderContent()

void writeExtraHeaderContent	(	dictionary &	dict,
		IOstreamOption	streamOptData,
		const IOobject &	io
	)

static

Helper: generate additional entries for FoamFile header.

Definition at line 181 of file decomposedBlockDataHeader.C.

References dictionary::add(), dict, IOobject::findMetaData(), IOstreamOption::format(), io(), and dictionary::set().

Referenced by collatedFileOperation::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readBlockEntry()

bool readBlockEntry	(	Istream &	is,
		List< char > &	charData
	)

static

Helper: read block of (binary) character data.

Definition at line 113 of file decomposedBlockData.C.

References token::END_STATEMENT, IOstream::fatalCheck(), FUNCTION_NAME, token::good(), token::isCompound(), token::isWord(), Istream::putBack(), and List< T >::readList().

Referenced by decomposedBlockData::readBlock(), decomposedBlockData::readBlocks(), and decomposedBlockData::readHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeBlockEntry() [1/2]

std::streamoff writeBlockEntry	(	OSstream &	os,
		const label	blocki,
		const UList< char > &	charData
	)

static

Helper: write block of (binary) character data.

Definition at line 155 of file decomposedBlockData.C.

References Foam::name(), Foam::nl, os(), OFstream::stdStream(), and UList< T >::writeList().

Referenced by collatedFileOperation::appendObject(), decomposedBlockData::writeBlockEntry(), and decomposedBlockData::writeBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeBlockEntry() [2/2]

std::streamoff writeBlockEntry	(	OSstream &	os,
		IOstreamOption	streamOptData,
		const regIOobject &	io,
		const label	blocki,
		const bool	withLocalHeader
	)

static

Helper: write block of (binary) character data.

Returns: -1 on error

Definition at line 177 of file decomposedBlockData.C.

References IOobject::bannerEnabled(), io(), os(), decomposedBlockData::writeBlockEntry(), and IOobject::writeHeader().

Here is the call graph for this function:

◆ readBlock()

Foam::autoPtr< Foam::ISstream > readBlock	(	const label	blocki,
		ISstream &	is,
		IOobject &	headerIO
	)

static

Read selected block (non-seeking) + header information.

Definition at line 226 of file decomposedBlockData.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstreamOption::format(), IOstream::labelByteSize(), ISstream::name(), Foam::nl, Foam::Pout, decomposedBlockData::readBlockEntry(), IOobject::readHeader(), IOstream::relativeName(), autoPtr< T >::reset(), IOstream::scalarByteSize(), and IOstreamOption::version().

Referenced by uncollatedFileOperation::readStream(), and masterUncollatedFileOperation::readStream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readBlocks() [2/2]

Foam::autoPtr< Foam::ISstream > readBlocks	(	const label	comm,
		const fileName &	fName,
		autoPtr< ISstream > &	isPtr,
		IOobject &	headerIO,
		const UPstream::commsTypes	commsType
	)

static

Read master header information (into headerIO) and return data in stream. Note: isPtr is only valid on master.

Definition at line 407 of file decomposedBlockData.C.

References Pstream::broadcast(), Pstream::broadcasts(), IOstreamOption::versionNumber::canonical(), UPstream::commsTypeNames, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, PstreamBuffers::finishedScatters(), FUNCTION_NAME, IOobject::good(), IOobject::headerClassName(), splitCell::master(), UPstream::masterNo(), UPstream::msgType(), IOobject::name(), Foam::nl, UPstream::nonBlocking, IOobject::note(), os(), Foam::Pout, decomposedBlockData::readBlockEntry(), IOobject::readHeader(), IOobject::rename(), autoPtr< T >::reset(), UPstream::scheduled, PstreamBuffers::subProcs(), and UPstream::worldComm.

Here is the call graph for this function:

◆ gather()

void gather	(	const label	comm,
		const label	data,
		labelList &	datas
	)

static

Helper: gather single label. Note: using native Pstream.

datas sized with num procs but undefined contents on slaves

Definition at line 572 of file decomposedBlockData.C.

References UList< T >::data_bytes(), forAll, UPstream::gather(), splitCell::master(), PstreamBuffers::nProcs(), List< T >::resize(), and List< T >::setSize().

Referenced by OFstreamCollator::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherSlaveData()

void gatherSlaveData	(	const label	comm,
		const UList< char > &	data,
		const labelUList &	recvSizes,
		const label	startProc,
		const label	nProcs,
		List< int > &	recvOffsets,
		List< char > &	recvData
	)

static

Helper: gather data from (subset of) slaves.

Returns:

recvData : received data
recvOffsets : offset in data. recvOffsets is nProcs+1

Definition at line 611 of file decomposedBlockData.C.

References UList< T >::data(), UPstream::gather(), splitCell::master(), processorFaPatch::myProcNo(), PstreamBuffers::nProcs(), List< T >::resize(), and List< T >::setSize().

Here is the call graph for this function:

◆ writeBlocks()

bool writeBlocks	(	const label	comm,
		autoPtr< OSstream > &	osPtr,
		List< std::streamoff > &	blockOffset,
		const UList< char > &	masterData,
		const labelUList &	recvSizes,
		const PtrList< SubList< char > > &	slaveData,
		const UPstream::commsTypes	commsType,
		const bool	syncReturnState = `true`
	)

static

Write *this. Ostream only valid on master.

Returns offsets of processor blocks in blockOffset

Enable to get synchronised error checking. Is the one that keeps

slaves as slow as the master (which does all the writing)

Definition at line 711 of file decomposedBlockData.C.

References Pstream::broadcast(), UList< T >::cdata(), UPstream::commsTypeNames, UList< T >::data(), Foam::endl(), IOstream::good(), autoPtr< T >::good(), splitCell::master(), UPstream::masterNo(), UPstream::msgType(), PstreamBuffers::nProcs(), os(), Foam::Pout, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), DynamicList< T, SizeMin >::resize(), List< T >::resize(), UPstream::scheduled, UList< T >::size(), UList< T >::size_bytes(), ObukhovLength::write(), and decomposedBlockData::writeBlockEntry().

Here is the call graph for this function:

Member Data Documentation

◆ commsType_

const UPstream::commsTypes commsType_

protected

Type to use for gather.

Definition at line 125 of file decomposedBlockData.H.

◆ comm_

const label comm_

protected

Communicator for all parallel comms.

Definition at line 128 of file decomposedBlockData.H.

◆ contentData_

List<char> contentData_

protected

The block content.

Definition at line 131 of file decomposedBlockData.H.

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

src/OpenFOAM/db/IOobjects/decomposedBlockData/decomposedBlockData.H
src/OpenFOAM/db/IOobjects/decomposedBlockData/decomposedBlockData.C
src/OpenFOAM/db/IOobjects/decomposedBlockData/decomposedBlockDataHeader.C

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ decomposedBlockData()

◆ ~decomposedBlockData()

Member Function Documentation

◆ calcNumProcs()

◆ readBlocks() [1/2]

◆ TypeName()

◆ read()

◆ writeData()

◆ writeObject()

◆ isCollatedType() [1/2]

◆ isCollatedType() [2/2]

◆ readHeader()

◆ writeHeader() [1/2]

◆ writeHeader() [2/2]

◆ writeExtraHeaderContent()

◆ readBlockEntry()

◆ writeBlockEntry() [1/2]

◆ writeBlockEntry() [2/2]

◆ readBlock()

◆ readBlocks() [2/2]

◆ gather()

◆ gatherSlaveData()

◆ writeBlocks()

Member Data Documentation

◆ commsType_

◆ comm_

◆ contentData_