IOField with global data (so optionally read from master) More...

Inheritance diagram for GlobalIOField< Type >:

[legend]

Collaboration diagram for GlobalIOField< Type >:

Public Member Functions
	TypeName ("Field")

	GlobalIOField (const GlobalIOField &)=default

	GlobalIOField (const IOobject &io)

	GlobalIOField (const IOobject &io, const label size)

	GlobalIOField (const IOobject &io, const UList< Type > &content)

	GlobalIOField (const IOobject &io, Field< Type > &&content)

	GlobalIOField (const IOobject &io, const tmp< Field< Type >> &tf)

virtual	~GlobalIOField ()=default

virtual bool	global () const

virtual fileName	filePath () const

virtual bool	readData (Istream &is)

bool	writeData (Ostream &os) const

void	operator= (const GlobalIOField< Type > &rhs)

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

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

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

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

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

virtual bool	write (const bool valid=true) const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

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)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

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

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

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

Public Member Functions inherited from Field< Type >
constexpr	Field () noexcept

	Field (const label len)

	Field (const label len, const Type &val)

	Field (const label len, const Foam::zero)

	Field (const Foam::one, const Type &val)

	Field (const Foam::one, Type &&val)

	Field (const Foam::one, const Foam::zero)

	Field (const Field< Type > &fld)

	Field (const UList< Type > &list)

	Field (const IndirectListBase< Type, Addr > &list)

	Field (Field< Type > &&fld)

	Field (List< Type > &&list)

	Field (DynamicList< Type, SizeMin > &&list)

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)

	Field (const tmp< Field< Type >> &tfld)

	Field (Istream &is)

	Field (const word &keyword, const dictionary &dict, const label len)

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

	Field (const UList< Type > &mapF, const FieldMapper &mapper, const bool applyFlip)

	Field (const UList< Type > &mapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

	Field (const UList< Type > &mapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const bool applyFlip)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

	Field (const word &keyword, const dictionary &dict, const label len)

constexpr	Field () noexcept

	Field (const label len)

	Field (const label len, const Type &val)

	Field (const label len, const Foam::zero)

	Field (const Foam::one, const Type &val)

	Field (const Foam::one, Type &&val)

	Field (const Foam::one, const Foam::zero)

	Field (const Field< Type > &fld)

	Field (const UList< Type > &list)

	Field (Field< Type > &&fld)

	Field (List< Type > &&list)

	Field (Field< Type > &fld, bool reuse)

	Field (const tmp< Field< Type >> &tfld)

	Field (Istream &is)

tmp< Field< Type > >	clone () const

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

void	autoMap (const FieldMapper &map, const bool applyFlip=true)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	negate ()

tmp< Field< cmptType > >	component (const direction) const

void	replace (const direction, const UList< cmptType > &)

void	replace (const direction, const tmp< Field< cmptType >> &)

void	replace (const direction, const cmptType &)

VSForm	block (const label start) const

tmp< Field< Type > >	T () const

void	writeEntry (const word &keyword, Ostream &os) const

SubField< Type >	slice (const label pos, label len=-1)

const SubField< Type >	slice (const label pos, label len=-1) const

SubField< Type >	slice (const labelRange &range)

const SubField< Type >	slice (const labelRange &range) const

void	operator= (const Field< Type > &)

void	operator= (const tmp< Field< Type >> &)

void	operator= (const UList< Type > &rhs)

void	operator= (const SubField< Type > &rhs)

void	operator= (const IndirectListBase< Type, Addr > &rhs)

void	operator= (Field< Type > &&rhs)

void	operator= (List< Type > &&rhs)

void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator= (const Field< Type > &rhs)

void	operator= (const tmp< Field > &rhs)

void	operator= (const UList< Type > &rhs)

void	operator= (const SubField< Type > &rhs)

void	operator= (Field< Type > &&rhs)

void	operator= (List< Type > &&rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator+= (const Type &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator-= (const Type &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator*= (const scalar &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator/= (const scalar &)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType

typedef SubField< Type >	subField

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

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

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()

static autoPtr< Field< Type > >	New (Istream &is)

static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

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)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

template<class Type>
class Foam::GlobalIOField< Type >

IOField with global data (so optionally read from master)

Source files

Definition at line 49 of file GlobalIOField.H.

Constructor & Destructor Documentation

◆ GlobalIOField() [1/6]

GlobalIOField ( const GlobalIOField< Type > & )

default

◆ GlobalIOField() [2/6]

GlobalIOField ( const IOobject & io )

explicit

Definition at line 27 of file GlobalIOField.C.

◆ GlobalIOField() [3/6]

GlobalIOField	(	const IOobject &	io,
		const label	size
	)

Definition at line 39 of file GlobalIOField.C.

◆ GlobalIOField() [4/6]

GlobalIOField	(	const IOobject &	io,
		const UList< Type > &	content
	)

Definition at line 55 of file GlobalIOField.C.

◆ GlobalIOField() [5/6]

GlobalIOField	(	const IOobject &	io,
		Field< Type > &&	content
	)

Definition at line 74 of file GlobalIOField.C.

◆ GlobalIOField() [6/6]

GlobalIOField	(	const IOobject &	io,
		const tmp< Field< Type >> &	tf
	)

Definition at line 92 of file GlobalIOField.C.

◆ ~GlobalIOField()

virtual ~GlobalIOField ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "Field" )

◆ global()

virtual bool global ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 88 of file GlobalIOField.H.

◆ filePath()

virtual fileName filePath ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 95 of file GlobalIOField.H.

◆ readData()

bool readData ( Istream & is )

virtual

Reimplemented from regIOobject.

Definition at line 121 of file GlobalIOField.C.

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Implements regIOobject.

Definition at line 129 of file GlobalIOField.C.

◆ operator=()

void operator= ( const GlobalIOField< Type > & rhs )

Definition at line 138 of file GlobalIOField.C.

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

src/OpenFOAM/db/IOobjects/GlobalIOField/GlobalIOField.H
src/OpenFOAM/db/IOobjects/GlobalIOField/GlobalIOField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::GlobalIOField< Type >

Constructor & Destructor Documentation

◆ GlobalIOField() [1/6]

◆ GlobalIOField() [2/6]

◆ GlobalIOField() [3/6]

◆ GlobalIOField() [4/6]

◆ GlobalIOField() [5/6]

◆ GlobalIOField() [6/6]

◆ ~GlobalIOField()

Member Function Documentation

◆ TypeName()

◆ global()

◆ filePath()

◆ readData()

◆ writeData()

◆ operator=()

template<class Type>
class Foam::GlobalIOField< Type >