DimensionedField< Type, GeoMesh > Class Template Reference

Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a reference to it is maintained. More...

Inheritance diagram for DimensionedField< Type, GeoMesh >:
Collaboration diagram for DimensionedField< Type, GeoMesh >:

Public Types

typedef GeoMesh::Mesh Mesh
 
typedef Field< Type >::cmptType cmptType
 
- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. 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...
 
- Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 

Public Member Functions

 TypeName ("DimensionedField")
 Runtime type information. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const Field< Type > &)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const bool checkIOFlags=true)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &, const bool checkIOFlags=true)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
 Construct from Istream. More...
 
 DimensionedField (const DimensionedField< Type, GeoMesh > &)
 Construct as copy. More...
 
 DimensionedField (DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 DimensionedField (const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField. More...
 
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
 Construct as copy of tmp<DimensionedField> deleting argument. More...
 
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &)
 Construct as copy resetting name. More...
 
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy resetting name and re-use as specified. More...
 
 DimensionedField (const word &newName, const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField with a new name. More...
 
tmp< DimensionedField< Type,
GeoMesh > > 
clone () const
 Construct as copy resetting name. More...
 
virtual ~DimensionedField ()
 Destructor. More...
 
void readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
 
const Meshmesh () const
 Return mesh. More...
 
const dimensionSetdimensions () const
 Return dimensions. More...
 
dimensionSetdimensions ()
 Return non-const access to dimensions. More...
 
const Field< Type > & field () const
 
Field< Type > & field ()
 
tmp< DimensionedField
< cmptType, GeoMesh > > 
component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const DimensionedField< cmptType, GeoMesh > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh > > &)
 Replace a component field of the field. More...
 
tmp< DimensionedField< Type,
GeoMesh > > 
T () const
 Return the field transpose (only defined for second rank tensors) More...
 
dimensioned< Type > average () const
 Calculate and return arithmetic average. More...
 
dimensioned< Type > weightedAverage (const DimensionedField< scalar, GeoMesh > &) const
 Calculate and return weighted average. More...
 
dimensioned< Type > weightedAverage (const tmp< DimensionedField< scalar, GeoMesh > > &) const
 Calculate and return weighted average. More...
 
bool writeData (Ostream &, const word &fieldDictEntry) const
 
bool writeData (Ostream &) const
 Pure virtual writaData function. More...
 
void operator= (const DimensionedField< Type, GeoMesh > &)
 
void operator= (const tmp< DimensionedField< Type, GeoMesh > > &)
 
void operator= (const dimensioned< Type > &)
 
void operator+= (const DimensionedField< Type, GeoMesh > &)
 
void operator+= (const tmp< DimensionedField< Type, GeoMesh > > &)
 
void operator-= (const DimensionedField< Type, GeoMesh > &)
 
void operator-= (const tmp< DimensionedField< Type, GeoMesh > > &)
 
void operator*= (const DimensionedField< scalar, GeoMesh > &)
 
void operator*= (const tmp< DimensionedField< scalar, GeoMesh > > &)
 
void operator/= (const DimensionedField< scalar, GeoMesh > &)
 
void operator/= (const tmp< DimensionedField< scalar, GeoMesh > > &)
 
void operator+= (const dimensioned< Type > &)
 
void operator-= (const dimensioned< Type > &)
 
void operator*= (const dimensioned< scalar > &)
 
void operator/= (const dimensioned< scalar > &)
 
- 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 &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from 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...
 
IstreamreadStream (const word &)
 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...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
label & watchIndex ()
 Return file-monitoring handle. 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
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
template<class Type >
Type & store (Type *tPtr)
 
template<class Type >
Type & store (autoPtr< Type > &atPtr)
 
- 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...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Stream >
Stream & writeBanner (Stream &os, bool noHint)
 
template<class Stream >
Stream & writeDivider (Stream &os)
 
template<class Stream >
Stream & writeEndDivider (Stream &os)
 
- Public Member Functions inherited from Field< Type >
 Field ()
 Construct null. More...
 
 Field (const label)
 Construct given size. More...
 
 Field (const label, const Type &)
 Construct given size and initial value. More...
 
 Field (const UList< Type > &)
 Construct as copy of a UList<Type> More...
 
 Field (const Xfer< List< Type > > &)
 Construct by transferring the List contents. More...
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue)
 Construct by mapping from the given tmp field. Supplied uniform. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues)
 Construct by mapping from the given tmp field. Supplied values. More...
 
 Field (const Field< Type > &)
 Construct as copy. More...
 
 Field (Field< Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 Field (const Xfer< Field< Type > > &)
 Construct by transferring the Field contents. More...
 
 Field (Istream &)
 Construct as copy of tmp<Field> More...
 
 Field (const word &keyword, const dictionary &, const label size)
 Construct from a dictionary entry. More...
 
tmp< Field< Type > > clone () const
 Clone. More...
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< Type > &mapF, const FieldMapper &map)
 Map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map)
 Map from self. More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Negate this field. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType > > &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
void operator= (const Field< Type > &)
 
void operator= (const UList< Type > &)
 
void operator= (const SubField< Type > &)
 
void operator= (const tmp< Field< Type > > &)
 
void operator= (const Type &)
 
template<class Form , class Cmpt , int nCmpt>
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator+= (const UList< Type > &)
 
void operator+= (const tmp< Field< Type > > &)
 
void operator-= (const UList< Type > &)
 
void operator-= (const tmp< Field< Type > > &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar > > &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar > > &)
 
void operator+= (const Type &)
 
void operator-= (const Type &)
 
void operator*= (const scalar &)
 
void operator/= (const scalar &)
 
template<class Type>
void operator= (const tmp< Field > &rhs)
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
- Public Member Functions inherited from List< T >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const T &)
 Construct with given size and value for all elements. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< T > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
label size () const
 Return the number of elements in the UList. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const T &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const T &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const T &)
 Append an element at the end of the list. More...
 
void append (const UList< T > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< T > &)
 Transfer the contents of the argument List into this list. More...
 
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1). More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size). More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1). More...
 
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero). More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
template<>
const bool & operator[] (const label i) const
 

Static Public Member Functions

static const DimensionedField
< Type, GeoMesh > & 
null ()
 Return a null DimensionedField. More...
 
- 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)
 
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 Field< Type >
static const Field< Type > & null ()
 Return a null field. More...
 
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 

Friends

Ostreamoperator (Ostream &, const DimensionedField< Type, GeoMesh > &)
 
Ostreamoperator (Ostream &, const tmp< DimensionedField< Type, GeoMesh > > &)
 

Additional Inherited Members

- Static Public Attributes inherited from regIOobject
static const NamedEnum
< fileCheckTypes, 4 > 
fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from Field< Type >
static const char *const typeName
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Member Functions inherited from List< T >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

template<class Type, class GeoMesh>
class Foam::DimensionedField< Type, GeoMesh >

Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a reference to it is maintained.

Source files

Definition at line 52 of file DimensionedField.H.

Member Typedef Documentation

Definition at line 82 of file DimensionedField.H.

typedef Field<Type>::cmptType cmptType

Definition at line 83 of file DimensionedField.H.

Constructor & Destructor Documentation

DimensionedField ( const IOobject io,
const Mesh mesh,
const dimensionSet dims,
const Field< Type > &  field 
)

Construct from components.

Definition at line 52 of file DimensionedField.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and List< T >::size().

Here is the call graph for this function:

DimensionedField ( const IOobject io,
const Mesh mesh,
const dimensionSet dims,
const bool  checkIOFlags = true 
)

Construct from components.

Used for temporary fields which are initialised after construction

Definition at line 81 of file DimensionedField.C.

DimensionedField ( const IOobject io,
const Mesh mesh,
const dimensioned< Type > &  dt,
const bool  checkIOFlags = true 
)

Construct from components.

Definition at line 102 of file DimensionedField.C.

DimensionedField ( const IOobject io,
const Mesh mesh,
const word fieldDictEntry = "value" 
)

Construct from Istream.

Definition at line 68 of file DimensionedFieldIO.C.

DimensionedField ( const DimensionedField< Type, GeoMesh > &  df)

Construct as copy.

Definition at line 123 of file DimensionedField.C.

DimensionedField ( DimensionedField< Type, GeoMesh > &  df,
bool  reUse 
)

Construct as copy or re-use as specified.

Definition at line 136 of file DimensionedField.C.

DimensionedField ( const Xfer< DimensionedField< Type, GeoMesh > > &  df)

Construct by transferring the DimensionedField.

Definition at line 150 of file DimensionedField.C.

DimensionedField ( const IOobject io,
const DimensionedField< Type, GeoMesh > &  df 
)

Construct as copy of tmp<DimensionedField> deleting argument.

Construct as copy resetting IO parameters

Definition at line 184 of file DimensionedField.C.

DimensionedField ( const word newName,
const DimensionedField< Type, GeoMesh > &  df 
)

Construct as copy resetting name.

Definition at line 198 of file DimensionedField.C.

DimensionedField ( const word newName,
DimensionedField< Type, GeoMesh > &  df,
bool  reUse 
)

Construct as copy resetting name and re-use as specified.

Definition at line 212 of file DimensionedField.C.

DimensionedField ( const word newName,
const Xfer< DimensionedField< Type, GeoMesh > > &  df 
)

Construct by transferring the DimensionedField with a new name.

Definition at line 227 of file DimensionedField.C.

~DimensionedField ( )
virtual

Destructor.

Definition at line 275 of file DimensionedField.C.

Member Function Documentation

TypeName ( "DimensionedField< Type, GeoMesh >"  )

Runtime type information.

const DimensionedField< Type, GeoMesh > & null ( )
inlinestatic

Return a null DimensionedField.

Definition at line 35 of file DimensionedFieldI.H.

tmp< DimensionedField< Type, GeoMesh > > clone ( ) const

Construct as copy resetting name.

Clone

Definition at line 263 of file DimensionedField.C.

void readField ( const dictionary fieldDict,
const word fieldDictEntry = "value" 
)

Definition at line 34 of file DimensionedFieldIO.C.

References f(), and dictionary::lookup().

Here is the call graph for this function:

const GeoMesh::Mesh & mesh ( ) const
inline

Return mesh.

Definition at line 43 of file DimensionedFieldI.H.

Referenced by isoSurface::adaptPatchFields(), Foam::atan2(), Foam::fvc::average(), motionSmootherAlgo::avg(), Foam::fvc::cellReduce(), motionSmootherAlgo::checkConstraints(), Foam::cmptAv(), extendedCellToFaceStencil::collectData(), gaussGrad< Type >::correctBoundaryConditions(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), Foam::fvm::ddt(), Foam::fvc::ddt(), Foam::fvc::ddtCorr(), fvFieldDecomposer::decomposeField(), Foam::fvm::div(), Foam::fvc::div(), Foam::fvc::flux(), fvMatrix< Type >::fvMatrix(), Foam::fvc::grad(), fvMeshSubset::interpolate(), harmonic::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), Foam::fvc::interpolate(), pointMVCWeight::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateBoundaryField(), sampledCuttingPlane::interpolateField(), sampledIsoSurface::interpolateField(), volPointInterpolation::interpolateInternalField(), interpolationCellPoint< Type >::interpolationCellPoint(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::linearInterpolate(), Foam::mag(), Foam::magSqr(), Foam::MapGeometricFields(), fvMeshAdder::MapSurfaceField(), fvMeshAdder::MapVolField(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh >::New(), reuseTmpGeometricField< TypeR, Type1, PatchField, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, Type2, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), fvMatrix< Type >::operator+=(), fvMatrix< Type >::operator-=(), sampledSurface::pointAverage(), Foam::pow(), Foam::fvc::reconstruct(), fvFieldReconstructor::reconstructFvVolumeField(), motionSmootherAlgo::smooth(), snGradScheme< Type >::sndGrad(), Foam::fvc::snGrad(), snGradScheme< Type >::snGrad(), fvMatrix< Type >::fvSolver::solve(), fvMatrix< Type >::solveCoupled(), fvMatrix< Type >::solveSegregated(), Foam::sqr(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::transform(), Foam::fvc::volumeIntegrate(), extendedUpwindCellToFaceStencil::weightedSum(), extendedFaceToCellStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

const dimensionSet & dimensions ( ) const
inline

Return dimensions.

Definition at line 50 of file DimensionedFieldI.H.

Referenced by SemiImplicitSource< Type >::addSup(), Foam::atan2(), Foam::fvc::average(), motionSmootherAlgo::avg(), Foam::fvc::cellReduce(), Foam::cmptAv(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), limitedSnGrad< Type >::correction(), fvFieldDecomposer::decomposeField(), Foam::fvc::domainIntegrate(), faceCorrectedSnGrad< Type >::fullGradCorrection(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), steadyStateDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), steadyStateDdtScheme< Type >::fvcDdtUfCorr(), EulerDdtScheme< Type >::fvcDdtUfCorr(), backwardDdtScheme< Type >::fvcDdtUfCorr(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), CoEulerDdtScheme< Type >::fvcDdtUfCorr(), SLTSDdtScheme< Type >::fvcDdtUfCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr(), steadyStateD2dt2Scheme< Type >::fvmD2dt2(), EulerD2dt2Scheme< Type >::fvmD2dt2(), steadyStateDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvMatrix< Type >::H(), fvMeshSubset::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), volPointInterpolation::interpolate(), singleCellFvMesh::interpolate(), Foam::mag(), Foam::magSqr(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), optionList::operator()(), DimensionedField< Type, GeoMesh >::operator=(), GeometricField< Type, PatchField, GeoMesh >::operator=(), Foam::pow(), skewCorrected< Type >::skewCorrection(), snGradScheme< Type >::snGrad(), Foam::sqr(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::transform(), extendedUpwindCellToFaceStencil::weightedSum(), extendedFaceToCellStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

dimensionSet & dimensions ( )
inline

Return non-const access to dimensions.

Definition at line 56 of file DimensionedFieldI.H.

const Field< Type > & field ( ) const
inline
Field< Type > & field ( )
inline

Definition at line 69 of file DimensionedFieldI.H.

tmp<DimensionedField<cmptType, GeoMesh> > component ( const direction  ) const

Return a component field of the field.

void replace ( const direction  ,
const DimensionedField< cmptType, GeoMesh > &   
)

Replace a component field of the field.

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

Replace a component field of the field.

tmp< DimensionedField< Type, GeoMesh > > T ( ) const

Return the field transpose (only defined for second rank tensors)

Definition at line 343 of file DimensionedField.C.

References Foam::name(), and Foam::T().

Here is the call graph for this function:

dimensioned< Type > average ( ) const

Calculate and return arithmetic average.

Definition at line 367 of file DimensionedField.C.

References Foam::gAverage(), and Foam::name().

Here is the call graph for this function:

dimensioned< Type > weightedAverage ( const DimensionedField< scalar, GeoMesh > &  weightField) const

Calculate and return weighted average.

Definition at line 382 of file DimensionedField.C.

References Foam::gSum(), and Foam::name().

Here is the call graph for this function:

dimensioned< Type > weightedAverage ( const tmp< DimensionedField< scalar, GeoMesh > > &  tweightField) const

Calculate and return weighted average.

Definition at line 400 of file DimensionedField.C.

bool writeData ( Ostream os,
const word fieldDictEntry 
) const

Definition at line 87 of file DimensionedFieldIO.C.

References IOstream::check(), IOstream::good(), and Ostream::writeKeyword().

Here is the call graph for this function:

void operator= ( const DimensionedField< Type, GeoMesh > &  df)

Definition at line 414 of file DimensionedField.C.

References Foam::abort(), checkField, DimensionedField< Type, GeoMesh >::dimensions(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

void operator= ( const tmp< DimensionedField< Type, GeoMesh > > &  tdf)

Definition at line 438 of file DimensionedField.C.

References Foam::abort(), checkField, DimensionedField< Type, GeoMesh >::dimensions(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

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

Definition at line 465 of file DimensionedField.C.

References dimensioned< Type >::dimensions(), and dimensioned< Type >::value().

Here is the call graph for this function:

void operator+= ( const DimensionedField< Type, GeoMesh > &  df)

Definition at line 508 of file DimensionedField.C.

void operator+= ( const tmp< DimensionedField< Type, GeoMesh > > &  tdf)

Definition at line 508 of file DimensionedField.C.

void operator-= ( const DimensionedField< Type, GeoMesh > &  df)

Definition at line 509 of file DimensionedField.C.

void operator-= ( const tmp< DimensionedField< Type, GeoMesh > > &  tdf)

Definition at line 509 of file DimensionedField.C.

void operator*= ( const DimensionedField< scalar, GeoMesh > &  df)

Definition at line 510 of file DimensionedField.C.

void operator*= ( const tmp< DimensionedField< scalar, GeoMesh > > &  tdf)

Definition at line 510 of file DimensionedField.C.

void operator/= ( const DimensionedField< scalar, GeoMesh > &  df)

Definition at line 511 of file DimensionedField.C.

void operator/= ( const tmp< DimensionedField< scalar, GeoMesh > > &  tdf)

Definition at line 511 of file DimensionedField.C.

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

Definition at line 508 of file DimensionedField.C.

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

Definition at line 509 of file DimensionedField.C.

void operator*= ( const dimensioned< scalar > &  dt)

Definition at line 510 of file DimensionedField.C.

void operator/= ( const dimensioned< scalar > &  dt)

Definition at line 511 of file DimensionedField.C.

Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const DimensionedField< Type, GeoMesh > &   
)
friend
Ostream& operator ( Ostream ,
const tmp< DimensionedField< Type, GeoMesh > > &   
)
friend

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