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

[legend]

Collaboration diagram for UniformGeometricField< Type >:

[legend]

Public Types
typedef UniformDimensionedField< Type >	Internal

typedef UniformField< Type >	Patch

typedef UniformFieldField< Type >	Boundary

typedef Type	cmptType

Public Types inherited from UniformDimensionedField< Type >
typedef UniformField< Type >	FieldType
	Type of the non-dimensioned field. More...

typedef UniformField< Type >::cmptType	cmptType
	Component type of the elements of the field. More...

Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

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

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

Public Types inherited from dimensioned< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

Public Member Functions
	TypeName ("UniformGeometricField")
	Runtime type information. More...

	UniformGeometricField (const IOobject &, const dimensioned< Type > &)
	Construct from components. Either reads or uses supplied value. More...

	UniformGeometricField (const UniformGeometricField< Type > &)
	Copy constructor. More...

	UniformGeometricField (const IOobject &)
	Construct from Istream. More...

virtual	~UniformGeometricField ()
	Destructor. More...

const UniformGeometricField< Type > &	oldTime () const

const Internal &	operator() () const

const Internal &	v () const

Internal::FieldType	primitiveField () const

Boundary	boundaryField () const

Public Member Functions inherited from UniformDimensionedField< Type >
	TypeName ("UniformDimensionedField")
	Runtime type information. More...

	UniformDimensionedField (const IOobject &, const dimensioned< Type > &)
	Construct from components. Either reads or uses supplied value. More...

	UniformDimensionedField (const UniformDimensionedField< Type > &)
	Copy constructor. More...

	UniformDimensionedField (const IOobject &)
	Construct from Istream. More...

virtual	~UniformDimensionedField ()
	Destructor. More...

virtual const word &	name () const
	Name function provided to resolve the ambiguity between the. More...

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

FieldType	field () const
	Return the non-dimensioned field. More...

bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

void	operator= (const UniformDimensionedField< Type > &)

void	operator= (const dimensioned< Type > &)

Type	operator[] (const label) const

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

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

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

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

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

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

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

bool	registered () const
	Is this object registered with the registry? More...

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

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

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

label &	eventNo ()
	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 up to date (obviously) More...

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

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=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...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

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

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

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

void	operator= (const IOobject &)

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

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

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

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

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

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

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

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

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

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

const word &	name () const
	Return name. More...

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

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

string &	note ()
	Return non-constant access to the optional note. More...

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

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

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

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

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

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

bool	writeHeader (Ostream &) const
	Write header. More...

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

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Public Member Functions inherited from dimensioned< Type >
	dimensioned (const word &, const dimensionSet &, const Type &)
	Construct given name, dimensions and value. More...

	dimensioned (const dimensionSet &, const Type &)
	Construct given dimensions and value. More...

	dimensioned (const Type &)
	Construct dimensionless given value only. More...

	dimensioned (const word &, const dimensioned< Type > &)
	Construct from a dimensioned<Type> changing the name. More...

	dimensioned (Istream &)
	Construct from Istream. More...

	dimensioned (const word &, Istream &)
	Construct from an Istream with a given name. More...

	dimensioned (const word &, const dimensionSet &, Istream &)
	Construct from an Istream with a given name and dimensions. More...

	dimensioned (const word &, const dimensionSet &, const dictionary &)
	Construct from dictionary lookup with a given name and dimensions. More...

	dimensioned ()
	Null constructor. More...

const word &	name () const
	Return const reference to name. More...

word &	name ()
	Return non-const reference to name. More...

const dimensionSet &	dimensions () const
	Return const reference to dimensions. More...

dimensionSet &	dimensions ()
	Return non-const reference to dimensions. More...

const Type &	value () const
	Return const reference to value. More...

Type &	value ()
	Return non-const reference to value. More...

dimensioned< cmptType >	component (const direction) const
	Return a component as a dimensioned<cmptType> More...

void	replace (const direction, const dimensioned< cmptType > &)
	Return a component with a dimensioned<cmptType> More...

dimensioned< Type >	T () const
	Return transpose. More...

void	read (const dictionary &)
	Update the value of dimensioned<Type> More...

bool	readIfPresent (const dictionary &)
	Update the value of dimensioned<Type> if found in the dictionary. More...

Istream &	read (Istream &is, const dictionary &)
	Read value from stream and units from dictionary. More...

Istream &	read (Istream &is, const HashTable< dimensionedScalar > &)
	Read value from stream and units from table. More...

Istream &	read (Istream &is)
	Read value from stream and units from system table. More...

dimensioned< cmptType >	operator[] (const direction) const
	Return a component as a dimensioned<cmptType> More...

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

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

void	operator*= (const scalar)

void	operator/= (const scalar)

Additional Inherited Members
Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

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...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dimensioned< Type >
static dimensioned< Type >	lookupOrDefault (const word &, const dictionary &, const dimensionSet &dims=dimless, const Type &defaultValue=pTraits< Type >::zero)
	Construct from dictionary, with default dimensions and value. More...

static dimensioned< Type >	lookupOrDefault (const word &, const dictionary &, const Type &defaultValue=pTraits< Type >::zero)
	Construct from dictionary dimensionless with value. More...

static dimensioned< Type >	lookupOrAddToDict (const word &, dictionary &, const dimensionSet &dims=dimless, const Type &defaultValue=pTraits< Type >::zero)
	Construct from dictionary, with default value. More...

static dimensioned< Type >	lookupOrAddToDict (const word &, dictionary &, const Type &defaultValue=pTraits< Type >::zero)
	Construct from dictionary, dimensionless with default value. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

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

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

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

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Detailed Description

template<class Type>
class Foam::UniformGeometricField< 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.

Source files

Definition at line 52 of file UniformGeometricField.H.

Member Typedef Documentation

◆ Internal

typedef UniformDimensionedField<Type> Internal

Definition at line 60 of file UniformGeometricField.H.

◆ Patch

typedef UniformField<Type> Patch

Definition at line 61 of file UniformGeometricField.H.

◆ Boundary

typedef UniformFieldField<Type> Boundary

Definition at line 62 of file UniformGeometricField.H.

◆ cmptType

typedef Type cmptType

Definition at line 63 of file UniformGeometricField.H.

Constructor & Destructor Documentation

◆ UniformGeometricField() [1/3]

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

Construct from components. Either reads or uses supplied value.

Definition at line 31 of file UniformGeometricField.C.

◆ UniformGeometricField() [2/3]

UniformGeometricField ( const UniformGeometricField< Type > & rdt )

Copy constructor.

Definition at line 42 of file UniformGeometricField.C.

◆ UniformGeometricField() [3/3]

UniformGeometricField ( const IOobject & io )

Construct from Istream.

Definition at line 52 of file UniformGeometricField.C.

◆ ~UniformGeometricField()

~UniformGeometricField

virtual

Destructor.

Definition at line 64 of file UniformGeometricField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "UniformGeometricField< Type >" )

Runtime type information.

◆ oldTime()

const Foam::UniformGeometricField< Type > & oldTime

inline

Definition at line 32 of file UniformGeometricFieldI.H.

◆ operator()()

const Foam::UniformGeometricField< Type >::Internal & operator()

inline

Definition at line 40 of file UniformGeometricFieldI.H.

◆ v()

const Foam::UniformGeometricField< Type >::Internal & v

inline

Definition at line 48 of file UniformGeometricFieldI.H.

◆ primitiveField()

Foam::UniformGeometricField< Type >::Internal::FieldType primitiveField

inline

Definition at line 56 of file UniformGeometricFieldI.H.

◆ boundaryField()

Foam::UniformGeometricField< Type >::Boundary boundaryField

inline

Definition at line 64 of file UniformGeometricFieldI.H.

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

src/OpenFOAM/fields/UniformGeometricFields/UniformGeometricField.H
src/OpenFOAM/fields/UniformGeometricFields/UniformGeometricField.C
src/OpenFOAM/fields/UniformGeometricFields/UniformGeometricFieldI.H

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::UniformGeometricField< Type >

Member Typedef Documentation

◆ Internal

◆ Patch

◆ Boundary

◆ cmptType

Constructor & Destructor Documentation

◆ UniformGeometricField() [1/3]

◆ UniformGeometricField() [2/3]

◆ UniformGeometricField() [3/3]

◆ ~UniformGeometricField()

Member Function Documentation

◆ TypeName()

◆ oldTime()

◆ operator()()

◆ v()

◆ primitiveField()

◆ boundaryField()

template<class Type>
class Foam::UniformGeometricField< Type >