FreeFOAM The Cross-Platform CFD Toolkit
UniformDimensionedField< Type > Class Template Reference

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

#include <OpenFOAM/UniformDimensionedField.H>


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.

Source files

Definition at line 53 of file UniformDimensionedField.H.

+ Inheritance diagram for UniformDimensionedField< Type >:
+ Collaboration diagram for UniformDimensionedField< Type >:

List of all members.

Public Member Functions

 TypeName ("UniformDimensionedField")
 Runtime type information.
 UniformDimensionedField ()
 Construct null.
 UniformDimensionedField (const IOobject &, const dimensioned< Type > &)
 Construct from components.
 UniformDimensionedField (const UniformDimensionedField< Type > &)
 Construct as copy.
 UniformDimensionedField (const IOobject &)
 Construct from Istream.
virtual ~UniformDimensionedField ()
 Destructor.
virtual const wordname () const
 Name function provided to resolve the ambiguity between the.
bool writeData (Ostream &) const
 Pure virtual writaData function.
void operator= (const UniformDimensionedField< Type > &)
void operator= (const dimensioned< Type > &)
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 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.
 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.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.
- Public Member Functions inherited from dimensioned< Type >
 dimensioned (const word &, const dimensionSet &, const Type)
 Construct given a name, a value and its dimensionSet.
 dimensioned (const word &, const dimensioned< Type > &)
 Construct from a dimensioned<Type> changing the name.
 dimensioned (const Type &t)
 Construct given a value (creates dimensionless value).
 dimensioned (Istream &)
 Construct from Istream.
 dimensioned (const word &, Istream &)
 Construct from an Istream with a given name.
 dimensioned (const word &, const dimensionSet &, Istream &)
 Construct from an Istream with a given name and dimensions.
wordname ()
 Return non-const reference to name.
const dimensionSetdimensions () const
 Return const reference to dimensions.
dimensionSetdimensions ()
 Return non-const reference to dimensions.
const Type & value () const
 Return const reference to value.
Type & value ()
 Return non-const reference to value.
dimensioned< cmptTypecomponent (const direction) const
 Return a component as a dimensioned<cmptType>
void replace (const direction, const dimensioned< cmptType > &)
 Return a component with a dimensioned<cmptType>
dimensioned< Type > T () const
 Return transpose.
bool readIfPresent (const dictionary &)
 Update the value of dimensioned<Type> if found in the dictionary.
dimensioned< cmptTypeoperator[] (const direction) const
 Return a component as a dimensioned<cmptType>
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator*= (const scalar)
void operator/= (const scalar)

Additional Inherited Members

- Public Types inherited from dimensioned< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type.
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry.
- 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.
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider.
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider.
- Static Public Member Functions inherited from dimensioned< Type >
static dimensioned< Type > lookupOrDefault (const word &, const dictionary &, const Type &defaultValue=pTraits< Type >::zero, const dimensionSet &dims=dimless)
 Construct from dictionary, with default value.
static dimensioned< Type > lookupOrAddToDict (const word &, dictionary &, const Type &defaultValue=pTraits< Type >::zero, const dimensionSet &dims=dimless)
 Construct from dictionary, with default value.
- Static Public Attributes inherited from regIOobject
static int fileModificationSkew

Constructor & Destructor Documentation

Construct null.

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

Construct from components.

Definition at line 32 of file UniformDimensionedField.C.

Construct as copy.

Definition at line 44 of file UniformDimensionedField.C.

Construct from Istream.

Definition at line 55 of file UniformDimensionedField.C.

References dictionary::lookup().

Destructor.

Definition at line 71 of file UniformDimensionedField.C.


Member Function Documentation

TypeName ( "UniformDimensionedField< Type >"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Name function provided to resolve the ambiguity between the.

name functions in regIOobject and dimensioned<Type>

Reimplemented from dimensioned< Type >.

Definition at line 88 of file UniformDimensionedField.H.

bool writeData ( Ostream ) const
virtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 78 of file UniformDimensionedField.C.

References IOstream::good(), Foam::nl, and Ostream::writeKeyword().

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

Definition at line 93 of file UniformDimensionedField.C.

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

Definition at line 103 of file UniformDimensionedField.C.


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