Dimensioned<Type> registered with the database as a registered IOobject which has the functionality of a uniform field and allows values from the top-level code to be passed to boundary conditions etc. More...

Inheritance diagram for UniformDimensionedField< Type >:

[legend]

Collaboration diagram for UniformDimensionedField< Type >:

[legend]

Public Member Functions
	TypeName ("UniformDimensionedField")

	UniformDimensionedField (const IOobject &io, const dimensioned< Type > &dt)

	UniformDimensionedField (const UniformDimensionedField< Type > &rdt)

	UniformDimensionedField (const IOobject &io)

virtual	~UniformDimensionedField ()

virtual const word &	name () const

virtual bool	readData (Istream &)

bool	writeData (Ostream &) const

virtual bool	global () const

virtual fileName	filePath () const

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

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

Type	operator[] (const label) const

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 dimensioned< Type >
	dimensioned ()

	dimensioned (const dimensionSet &dims)

	dimensioned (const dimensionSet &dims, const Foam::zero)

	dimensioned (const dimensionSet &dims, const Foam::one)

	dimensioned (const Type &val)

	dimensioned (const dimensionSet &dims, const Type &val)

	dimensioned (const word &name, const dimensionSet &dims, const Type &val)

	dimensioned (const word &name, const dimensioned< Type > &dt)

	dimensioned (const primitiveEntry &e)

	dimensioned (const primitiveEntry &e, const dimensionSet &dims)

	dimensioned (const word &name, const dictionary &dict)

	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict)

	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName)

	dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict)

	dimensioned (Istream &is)

	dimensioned (const word &name, Istream &is)

	dimensioned (const word &name, const dimensionSet &dims, Istream &is)

const word &	name () const

word &	name ()

const dimensionSet &	dimensions () const

dimensionSet &	dimensions ()

const Type &	value () const

Type &	value ()

dimensioned< cmptType >	component (const direction d) const

void	replace (const direction d, const dimensioned< cmptType > &dc)

dimensioned< Type >	T () const

bool	read (const dictionary &dict)

bool	read (const word &entryName, const dictionary &dict)

Istream &	read (Istream &is, const bool readName=true)

Istream &	read (Istream &is, const dictionary &readSet)

Istream &	read (Istream &is, const HashTable< dimensionedScalar > &readSet)

bool	readIfPresent (const dictionary &dict)

bool	readIfPresent (const word &entryName, const dictionary &dict)

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

dimensioned< cmptType >	operator[] (const direction d) const

void	operator+= (const dimensioned< Type > &dt)

void	operator-= (const dimensioned< Type > &dt)

void	operator*= (const scalar s)

void	operator/= (const scalar s)

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 dimensioned< Type >
typedef Type	value_type

typedef pTraits< Type >::cmptType	cmptType

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 dimensioned< Type >
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))

static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))

static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))

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::UniformDimensionedField< Type >

Dimensioned<Type> registered with the database as a registered IOobject which has the functionality of a uniform field and allows values from the top-level code to be passed to boundary conditions etc.

Is a 'global' field, same on all processors

Source files

Definition at line 52 of file UniformDimensionedField.H.

Constructor & Destructor Documentation

◆ UniformDimensionedField() [1/3]

UniformDimensionedField	(	const IOobject &	io,
		const dimensioned< Type > &	dt
	)

Definition at line 27 of file UniformDimensionedField.C.

◆ UniformDimensionedField() [2/3]

UniformDimensionedField ( const UniformDimensionedField< Type > & rdt )

Definition at line 42 of file UniformDimensionedField.C.

◆ UniformDimensionedField() [3/3]

UniformDimensionedField ( const IOobject & io )

Definition at line 53 of file UniformDimensionedField.C.

◆ ~UniformDimensionedField()

~UniformDimensionedField

virtual

Definition at line 71 of file UniformDimensionedField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "UniformDimensionedField< Type >" )

◆ name()

virtual const word& name ( ) const

inlinevirtual

Definition at line 90 of file UniformDimensionedField.H.

◆ readData()

bool readData ( Istream & is )

virtual

Reimplemented from regIOobject.

Definition at line 78 of file UniformDimensionedField.C.

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Implements regIOobject.

Definition at line 96 of file UniformDimensionedField.C.

◆ global()

virtual bool global ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 102 of file UniformDimensionedField.H.

◆ filePath()

virtual fileName filePath ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 109 of file UniformDimensionedField.H.

◆ operator=() [1/2]

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

Definition at line 111 of file UniformDimensionedField.C.

◆ operator=() [2/2]

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

Definition at line 121 of file UniformDimensionedField.C.

◆ operator[]()

Type operator[] ( const label ) const

inline

Definition at line 123 of file UniformDimensionedField.H.

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

src/OpenFOAM/fields/UniformDimensionedFields/UniformDimensionedField.H
src/OpenFOAM/fields/UniformDimensionedFields/UniformDimensionedField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::UniformDimensionedField< Type >

Constructor & Destructor Documentation

◆ UniformDimensionedField() [1/3]

◆ UniformDimensionedField() [2/3]

◆ UniformDimensionedField() [3/3]

◆ ~UniformDimensionedField()

Member Function Documentation

◆ TypeName()

◆ name()

◆ readData()

◆ writeData()

◆ global()

◆ filePath()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]()

template<class Type>
class Foam::UniformDimensionedField< Type >