Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
GeometricField< Type, PatchField, GeoMesh > Class Template Reference

Generic GeometricField class. More...

Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >:
Inheritance graph
[legend]
Collaboration diagram for GeometricField< Type, PatchField, GeoMesh >:
Collaboration graph
[legend]

Classes

class  GeometricBoundaryField
 

Public Types

typedef GeoMesh::Mesh Mesh
 
typedef GeoMesh::BoundaryMesh BoundaryMesh
 
typedef DimensionedField< Type, GeoMeshDimensionedInternalField
 
typedef Field< Type > InternalField
 
typedef PatchField< Type > PatchFieldType
 
typedef Field< Type >::cmptType cmptType
 
- Public Types inherited from DimensionedField< Type, GeoMesh >
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< Type >
typedef SubList< Type > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< Type >
typedef Type value_type
 Type of values the UList contains. More...
 
typedef Type & reference
 Type that can be used for storing into. More...
 
typedef const Type & const_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 Type * iterator
 Random access iterator for traversing UList. More...
 
typedef const Type * const_iterator
 Random access iterator for traversing UList. More...
 
typedef Type * reverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Type * const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 

Public Member Functions

 TypeName ("GeometricField")
 Runtime type information. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensions and patch type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensions and patch types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensioned<Type> and patch type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensioned<Type> and patch types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
 Constructor from components. More...
 
 GeometricField (const IOobject &, const Mesh &)
 Construct and read given IOobject. More...
 
 GeometricField (const IOobject &, const Mesh &, const dictionary &)
 Construct from dictionary. More...
 
 GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy. More...
 
 GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 Construct as copy of tmp<GeometricField> deleting argument. More...
 
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy resetting IO parameters. More...
 
 GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 Construct as copy of tmp<GeometricField> resetting IO parameters. More...
 
 GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy resetting name. More...
 
 GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 Construct as copy resetting name. More...
 
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
 Construct as copy resetting IO parameters and patch type. More...
 
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Construct as copy resetting IO parameters and boundary types. More...
 
virtual ~GeometricField ()
 Destructor. More...
 
DimensionedInternalFielddimensionedInternalField ()
 Return dimensioned internal field. More...
 
const DimensionedInternalFielddimensionedInternalField () const
 Return dimensioned internal field. More...
 
InternalFieldinternalField ()
 Return internal field. More...
 
const InternalFieldinternalField () const
 Return internal field. More...
 
GeometricBoundaryFieldboundaryField ()
 Return reference to GeometricBoundaryField. More...
 
const GeometricBoundaryFieldboundaryField () const
 Return reference to GeometricBoundaryField for const field. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
labeltimeIndex ()
 Return the time index of the field. More...
 
void storeOldTimes () const
 Store the old-time fields. More...
 
void storeOldTime () const
 Store the old-time field. More...
 
label nOldTimes () const
 Return the number of old time fields stored. More...
 
const GeometricField< Type, PatchField, GeoMesh > & oldTime () const
 Return old time field. More...
 
GeometricField< Type, PatchField, GeoMesh > & oldTime ()
 Return non-const old time field. More...
 
void storePrevIter () const
 Store the field as the previous iteration value. More...
 
const GeometricField< Type, PatchField, GeoMesh > & prevIter () const
 Return previous iteration field. More...
 
void correctBoundaryConditions ()
 Correct boundary field. More...
 
bool needReference () const
 Does the field need a reference level for solution. More...
 
tmp< GeometricField< cmptType, PatchField, GeoMesh > > component (const direction) const
 Return a component of the field. More...
 
bool writeData (Ostream &) const
 WriteData member function required by regIOobject. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > T () const
 Return transpose (only if it is a tensor field) More...
 
void relax (const scalar alpha)
 Relax field (for steady-state solution). More...
 
void relax ()
 Relax field (for steady-state solution). More...
 
word select (bool final) const
 Select the final iteration parameters if `final' is true. More...
 
void writeMinMax (Ostream &os) const
 Helper function to write the min and max to an Ostream. More...
 
void negate ()
 
void replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)
 
void replace (const direction, const dimensioned< cmptType > &)
 
void max (const dimensioned< Type > &)
 
void min (const dimensioned< Type > &)
 
void max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
 
void min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
 
void scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)
 
void scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
 
void operator= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator= (const dimensioned< Type > &)
 
void operator== (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator== (const dimensioned< Type > &)
 
void operator+= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator-= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
 
void operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)
 
void operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
 
void operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)
 
void operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
 
void operator+= (const dimensioned< Type > &)
 
void operator-= (const dimensioned< Type > &)
 
void operator*= (const dimensioned< scalar > &)
 
void operator/= (const dimensioned< scalar > &)
 
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
template<>
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
 
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
template<>
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)
 
- Public Member Functions inherited from DimensionedField< Type, GeoMesh >
 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 tmp< DimensionedField< Type, GeoMesh > > &)
 Construct as copy of tmp<DimensionedField> deleting argument. More...
 
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
 Construct as copy resetting IO parameters. More...
 
 DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy resetting IO parameters and re-use as specified. 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...
 
 DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh > > &)
 Construct as copy resetting name. More...
 
tmp< DimensionedField< Type, GeoMesh > > clone () const
 Clone. 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
 
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, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. 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...
 
labeleventNo ()
 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...
 
labelwatchIndex ()
 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 &)
 
- 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...
 
word member () const
 Return member (name without the extension) 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)
 
- 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 (const tmp< Field< Type > > &)
 Construct as copy of tmp<Field> More...
 
 Field (Istream &)
 Construct from Istream. 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< Type >
label size () const
 Return the number of elements in the UList. More...
 
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const Type &)
 Construct with given size and value for all elements. More...
 
 List (const List< Type > &)
 Copy constructor. More...
 
 List (const Xfer< List< Type > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Type > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< Type, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< Type > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Type > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< Type > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< Type > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< Type > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const Type &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const Type &)
 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 Type &)
 Append an element at the end of the list. More...
 
void append (const UList< Type > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< Type > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< Type > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< Type > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< Type > > xfer ()
 Transfer contents to the Xfer container. More...
 
Type & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< Type > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Type > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Type > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Type > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< Type >
 UList ()
 Null constructor. More...
 
 UList (Type *__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 Type * cdata () const
 Return a const pointer to the first data element,. More...
 
Type * data ()
 Return a pointer to the first data element,. More...
 
Type & first ()
 Return the first element of the list. More...
 
const Type & first () const
 Return first element of the list. More...
 
Type & last ()
 Return the last element of the list. More...
 
const Type & last () 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< Type > &)
 Assign elements to those from UList. More...
 
Type & operator[] (const label)
 Return element of UList. More...
 
const Type & operator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant 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...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_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 rend () const
 Return const_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...
 
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< Type > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< Type > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< Type > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< Type > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< Type > &) const
 Return true if !(a < b). Takes linear time. More...
 

Static Public Member Functions

static const GeometricField< Type, PatchField, GeoMesh > & null ()
 Return a null geometric field. More...
 
- Static Public Member Functions inherited from DimensionedField< Type, GeoMesh >
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< Type >
static const List< Type > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< Type >
static const UList< Type > & null ()
 Return a null UList. More...
 

Friends

Ostreamoperator (Ostream &, const GeometricField< Type, PatchField, GeoMesh > &)
 
Ostreamoperator (Ostream &, const tmp< GeometricField< Type, PatchField, 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< Type >
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, template< class > class PatchField, class GeoMesh>
class Foam::GeometricField< Type, PatchField, GeoMesh >

Generic GeometricField class.

Source files

Definition at line 52 of file surfaceFieldsFwd.H.

Member Typedef Documentation

Definition at line 97 of file GeometricField.H.

Definition at line 98 of file GeometricField.H.

Definition at line 100 of file GeometricField.H.

typedef Field<Type> InternalField

Definition at line 101 of file GeometricField.H.

typedef PatchField<Type> PatchFieldType

Definition at line 102 of file GeometricField.H.

typedef Field<Type>::cmptType cmptType

Definition at line 273 of file GeometricField.H.

Constructor & Destructor Documentation

GeometricField ( const IOobject io,
const Mesh mesh,
const dimensionSet ds,
const word patchFieldType = PatchField<Type>::calculatedType() 
)

Constructor given IOobject, mesh, dimensions and patch type.

This allocates storage for the field but not values. Used only within this class to create TEMPORARY variables

Definition at line 183 of file GeometricField.C.

References Foam::endl(), and Foam::Info.

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricField().

Here is the call graph for this function:

Here is the caller graph for this function:

GeometricField ( const IOobject io,
const Mesh mesh,
const dimensionSet ds,
const wordList wantedPatchTypes,
const wordList actualPatchTypes = wordList() 
)

Constructor given IOobject, mesh, dimensions and patch types.

This allocates storage for the field but not values. Used only within this class to create TEMPORARY variables

Definition at line 209 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const IOobject io,
const Mesh mesh,
const dimensioned< Type > &  dt,
const word patchFieldType = PatchField<Type>::calculatedType() 
)

Constructor given IOobject, mesh, dimensioned<Type> and patch type.

Definition at line 236 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const IOobject io,
const Mesh mesh,
const dimensioned< Type > &  dt,
const wordList wantedPatchTypes,
const wordList actualPatchTypes = wordList() 
)

Constructor given IOobject, mesh, dimensioned<Type> and patch types.

Definition at line 264 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const IOobject io,
const Mesh mesh,
const dimensionSet ds,
const Field< Type > &  iField,
const PtrList< PatchField< Type > > &  ptfl 
)

Constructor from components.

Definition at line 293 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const IOobject io,
const Mesh mesh 
)

Construct and read given IOobject.

Definition at line 320 of file GeometricField.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, GeometricField< Type, PatchField, GeoMesh >::GeometricField(), Foam::Info, mesh, and Foam::readFields().

Here is the call graph for this function:

GeometricField ( const IOobject io,
const Mesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 360 of file GeometricField.C.

References Foam::endl(), Foam::exit(), FatalErrorIn, Foam::FatalIOError, GeometricField< Type, PatchField, GeoMesh >::GeometricField(), Foam::Info, mesh, and Foam::readFields().

Here is the call graph for this function:

GeometricField ( const GeometricField< Type, PatchField, GeoMesh > &  gf)

Construct as copy.

Definition at line 400 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf)

Construct as copy of tmp<GeometricField> deleting argument.

Definition at line 432 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const IOobject io,
const GeometricField< Type, PatchField, GeoMesh > &  gf 
)

Construct as copy resetting IO parameters.

Definition at line 462 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), Foam::Info, and IOobject::name().

Here is the call graph for this function:

GeometricField ( const IOobject io,
const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf 
)

Construct as copy of tmp<GeometricField> resetting IO parameters.

Definition at line 494 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const word newName,
const GeometricField< Type, PatchField, GeoMesh > &  gf 
)

Construct as copy resetting name.

Definition at line 526 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const word newName,
const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf 
)

Construct as copy resetting name.

Definition at line 558 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), and Foam::Info.

Here is the call graph for this function:

GeometricField ( const IOobject io,
const GeometricField< Type, PatchField, GeoMesh > &  gf,
const word patchFieldType 
)

Construct as copy resetting IO parameters and patch type.

Definition at line 588 of file GeometricField.C.

References Foam::endl(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), Foam::Info, and IOobject::name().

Here is the call graph for this function:

GeometricField ( const IOobject io,
const GeometricField< Type, PatchField, GeoMesh > &  gf,
const wordList patchFieldTypes,
const wordList actualPatchTypes = wordList() 
)

Construct as copy resetting IO parameters and boundary types.

Definition at line 622 of file GeometricField.C.

References Foam::endl(), Foam::Info, and IOobject::name().

Here is the call graph for this function:

~GeometricField ( )
virtual

Destructor.

Definition at line 665 of file GeometricField.C.

References Foam::deleteDemandDrivenData().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "GeometricField< Type, PatchField, GeoMesh >"  )

Runtime type information.

const Foam::GeometricField< Type, PatchField, GeoMesh > & null ( )
inlinestatic

Return a null geometric field.

Definition at line 30 of file GeometricFieldI.H.

References GeometricField< Type, PatchField, GeoMesh >::dimensionedInternalField().

Referenced by ddtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), and CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::GeometricField< Type, PatchField, GeoMesh >::DimensionedInternalField & dimensionedInternalField ( )
const Foam::GeometricField< Type, PatchField, GeoMesh >::DimensionedInternalField & dimensionedInternalField ( ) const
inline

Return dimensioned internal field.

Definition at line 41 of file GeometricFieldI.H.

Foam::GeometricField< Type, PatchField, GeoMesh >::InternalField & internalField ( )

Return internal field.

Definition at line 688 of file GeometricField.C.

Referenced by MRFZone::addCoriolis(), interRegionExplicitPorositySource::addSup(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), Foam::calcEk(), faceLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), cellLimitedGrad< Type >::calcGrad(), Foam::checkMethod(), Foam::cmptAv(), Foam::component(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), Foam::MULES::correct(), inverseVolumeDiffusivity::correct(), inverseDistanceDiffusivity::correct(), limitTemperature::correct(), phaseChangeModel::correct(), curvatureSeparation::correct(), wideBandAbsorptionEmission::correct(), pointLinear< Type >::correction(), limitedSnGrad< Type >::correction(), kinematicSingleLayer::CourantNumber(), motionSmootherAlgo::curPoints(), fvFieldDecomposer::decomposeField(), wideBandAbsorptionEmission::ECont(), reactingOneDim::evolveRegion(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), fvMatrix< Type >::flux(), forAll(), faceCorrectedSnGrad< Type >::fullGradCorrection(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvMatrix< Type >::H(), heThermo< BasicThermo, MixtureType >::hc(), heThermo< BasicThermo, MixtureType >::he(), rotorDiskSource::inflowVelocity(), thermoSingleLayer::info(), kinematicSingleLayer::info(), surfaceInterpolationScheme< Type >::interpolate(), fvMeshSubset::interpolate(), volPointInterpolation::interpolateBoundaryField(), isoSurface::isoSurface(), Kmesh::Kmesh(), Foam::MULES::limiterCorr(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), Foam::MapGeometricFields(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), surfaceInterpolation::movePoints(), fvMesh::movePoints(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), consumptionSpeed::omega0Sigma(), GeometricField< Type, PatchField, GeoMesh >::operator=(), VoidFraction< CloudType >::postEvolve(), Foam::pow(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), dynamicRefineFvMesh::refine(), sampledPatchInternalField::sampleField(), motionSmootherAlgo::scaleMesh(), primaryRadiation::Shs(), standardRadiation::Shs(), constantRadiation::Shs(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::SlicedGeometricField(), reactingOneDim::solidRegionDiffNo(), fvMatrix< Type >::fvSolver::solve(), fvMatrix< Type >::solveSegregated(), Foam::sqr(), Foam::stabilise(), ReactingCloud< CloudType >::SYi(), Foam::T(), KinematicCloud< CloudType >::theta(), Foam::transform(), KinematicCloud< CloudType >::vDotSweep(), Foam::fvc::volumeIntegrate(), limitedSurfaceInterpolationScheme< Type >::weights(), AveragingMethod< Type >::write(), regionSizeDistribution::write(), Foam::writeCellGraph(), Basic< Type >::~Basic(), and skewCorrectionVectors::~skewCorrectionVectors().

const Foam::GeometricField< Type, PatchField, GeoMesh >::InternalField & internalField ( ) const
inline

Return internal field.

Definition at line 51 of file GeometricFieldI.H.

Foam::GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField & boundaryField ( )

Return reference to GeometricBoundaryField.

Definition at line 699 of file GeometricField.C.

Referenced by isoSurface::adaptPatchFields(), reactingOneDim::addMassSources(), thermoSingleLayer::addSources(), kinematicSingleLayer::addSources(), effectivenessHeatExchangerSource::addSup(), Foam::adjustPhi(), basicThermo::alpha(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), SurfaceFilmModel< CloudType >::cacheFilmFields(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), curvatureSeparation::calcCosAngle(), CentredFitSnGradData< Polynomial >::calcFit(), forces::calcForcesMoment(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), cellLimitedGrad< Type >::calcGrad(), fieldMinMax::calcMinMaxFields(), nutUWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), wallShearStress::calcShearStress(), P1::calculate(), epsilonLowReWallFunctionFvPatchScalarField::calculate(), viewFactor::calculate(), epsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), reactingOneDim::calculateMassTransfer(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), CentredFitData< Polynomial >::CentredFitData(), fvPatch::Cf(), Foam::cmptAv(), extendedCellToFaceStencil::collectData(), extendedFaceToCellStencil::collectData(), Foam::component(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), injectionModelList::correct(), limitTemperature::correct(), contactAngleForce::correct(), meshWave::correct(), Poisson::correct(), LamBremhorstKE::correct(), ShihQuadraticKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), advectionDiffusion::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), motionSmootherAlgo::correct(), gaussGrad< Type >::correctBoundaryConditions(), motionSmootherAlgo::correctBoundaryConditions(), MRFZoneList::correctBoundaryFlux(), MRFZone::correctBoundaryVelocity(), thermoSingleLayer::correctHsForMappedT(), mixtureKEpsilon< BasicTurbulenceModel >::correctInletOutlet(), cubic< Type >::correction(), pointLinear< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), outletStabilised< Type >::correction(), Foam::CorrectPhi(), Foam::correctUphiBCs(), ReynoldsStress< BasicTurbulenceModel >::correctWallShearStress(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), motionSmootherAlgo::curPoints(), fvFieldDecomposer::decomposeField(), fvMesh::delta(), fvPatch::deltaCoeffs(), kOmega< BasicTurbulenceModel >::epsilon(), kOmegaSST< BasicTurbulenceModel >::epsilon(), mixtureKEpsilon< BasicTurbulenceModel >::epsilonBoundaryTypes(), epsilonWallFunctionFvPatchScalarField::epsilonPatch(), FacePostProcessing< CloudType >::FacePostProcessing(), faceSource::filterField(), PatchFlowRateInjection< CloudType >::flowRate(), fvMatrix< Type >::flux(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), fvMatrix< Type >::fvMatrix(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), SpalartAllmaras< BasicTurbulenceModel >::fw(), isoSurface::generateFaceTriPoints(), heThermo< BasicThermo, MixtureType >::hc(), heThermo< BasicThermo, MixtureType >::he(), heThermo< BasicThermo, MixtureType >::heBoundaryCorrection(), psiuReactionThermo::heuBoundaryCorrection(), psiuReactionThermo::heuBoundaryTypes(), thermoSingleLayer::hs(), FreeStream< CloudType >::inflow(), thermalBaffle::info(), mixtureKEpsilon< BasicTurbulenceModel >::initMixtureFields(), SurfaceFilmModel< CloudType >::inject(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), singleCellFvMesh::interpolate(), fvMeshSubset::interpolate(), meshToMesh0::interpolate(), volPointInterpolation::interpolateInternalField(), kkLOmega::k(), temperatureCoupledBase::kappa(), Foam::MULES::limiter(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::MULES::limiterCorr(), Foam::mag(), fvPatch::magSf(), Foam::magSqr(), patchMeanVelocityForce::magUbarAve(), MRFZone::makeAbsolute(), MRFZone::makeRelative(), Foam::MapGeometricFields(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), fvMotionSolverEngineMesh::move(), surfaceInterpolation::movePoints(), fvMesh::movePoints(), psiThermo::mu(), rhoThermo::mu(), incompressibleTwoPhaseInteractingMixture::mu(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), cyclicFvPatchField< Type >::neighbourPatchField(), cyclicAMIFvPatchField< Type >::neighbourPatchField(), cyclicACMIFvPatchField< Type >::neighbourPatchField(), cyclicACMIFvPatchField< Type >::nonOverlapPatchField(), Newtonian::nu(), CrossPowerLaw::nu(), HerschelBulkley::nu(), powerLaw::nu(), BirdCarreau::nu(), incompressibleTwoPhaseMixture::nu(), incompressibleTwoPhaseInteractingMixture::nu(), incompressibleThreePhaseMixture::nu(), eddyViscosity< RASModel< BasicTurbulenceModel > >::nut(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::nut(), consumptionSpeed::omega0Sigma(), omegaWallFunctionFvPatchScalarField::omegaPatch(), GeometricField< Type, PatchField, GeoMesh >::operator/=(), GeometricField< Type, PatchField, GeoMesh >::operator=(), GeometricField< Type, PatchField, GeoMesh >::operator==(), KinematicCloud< CloudType >::patchData(), homogeneousMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceProducts(), inhomogeneousMixture< ThermoType >::patchFaceReactants(), veryInhomogeneousMixture< ThermoType >::patchFaceReactants(), egrMixture< ThermoType >::patchFaceReactants(), fvPatch::patchField(), Foam::pow(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), thermoSingleLayer::Qconvp(), thermoSingleLayer::Qconvw(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), Foam::fvc::reconstructMag(), dynamicRefineFvMesh::refine(), psiThermo::rho(), rhoThermo::rho(), incompressibleTwoPhaseInteractingMixture::rho(), patchProbes::sample(), nearWallFields::sampleBoundaryField(), sampledPatch::sampleField(), sampledTriSurfaceMesh::sampleField(), epsilonWallFunctionFvPatchScalarField::setMaster(), omegaWallFunctionFvPatchScalarField::setMaster(), pointConstraints::setPatchFields(), fvPatch::Sf(), snGradScheme< Type >::snGrad(), fvMatrix< Type >::solveCoupled(), thermalBaffle::solveEnergy(), fvMatrix< Type >::solveSegregated(), ThermoSurfaceFilm< CloudType >::splashInteraction(), Foam::fvc::spread(), Foam::sqr(), thermoSingleLayer::Srho(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), cyclicPointPatchField< Type >::swapAddSeparated(), cyclicAMIPointPatchField< Type >::swapAddSeparated(), cyclicACMIPointPatchField< Type >::swapAddSeparated(), Foam::fvc::sweep(), Foam::T(), thermoSingleLayer::thermoSingleLayer(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), dynamicRefineFvMesh::unrefine(), mixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), mixedEnergyFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), fixedEnergyFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), gradientEnergyFvPatchScalarField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), outletMappedUniformInletFvPatchField< Type >::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), fvDOM::updateG(), motionSmootherAlgo::updateMesh(), reactingOneDim::updatePhiGas(), reactingOneDim::updateQr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), UpwindFitData< Polynomial >::UpwindFitData(), extendedUpwindCellToFaceStencil::weightedSum(), outletStabilised< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), fvPatch::weights(), regionSizeDistribution::write(), externalCoupledMixedFvPatchField< Type >::writeData(), ensightParts::writeField(), externalCoupledMixedFvPatchField< Type >::writeGeometry(), Foam::writePatchGraph(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), nutURoughWallFunctionFvPatchScalarField::yPlus(), externalCoupledMixedFvPatchField< Type >::~externalCoupledMixedFvPatchField(), Gulders::~Gulders(), GuldersEGR::~GuldersEGR(), leastSquaresVectors::~leastSquaresVectors(), skewCorrectionVectors::~skewCorrectionVectors(), and thermalBaffle::~thermalBaffle().

const Foam::GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField & boundaryField ( ) const
inline

Return reference to GeometricBoundaryField for const field.

Definition at line 60 of file GeometricFieldI.H.

Foam::label timeIndex ( ) const
inline

Return the time index of the field.

Definition at line 68 of file GeometricFieldI.H.

Referenced by fvMesh::movePoints(), fvMesh::phi(), and subCycleField< GeometricField >::~subCycleField().

Here is the caller graph for this function:

Foam::label & timeIndex ( )
inline

Return the time index of the field.

Definition at line 76 of file GeometricFieldI.H.

void storeOldTimes ( ) const

Store the old-time fields.

Definition at line 708 of file GeometricField.C.

References Foam::name(), and timeIndex.

Referenced by Foam::MapGeometricFields().

Here is the call graph for this function:

Here is the caller graph for this function:

void storeOldTime ( ) const

Store the old-time field.

Definition at line 729 of file GeometricField.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

Foam::label nOldTimes ( ) const

Return the number of old time fields stored.

Definition at line 753 of file GeometricField.C.

const Foam::GeometricField< Type, PatchField, GeoMesh > & oldTime ( ) const

Return old time field.

Definition at line 768 of file GeometricField.C.

References Foam::name(), and timeName.

Referenced by Foam::MULES::explicitSolve(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtUfCorr(), backwardDdtScheme< Type >::fvcDdtUfCorr(), CoEulerDdtScheme< Type >::fvcDdtUfCorr(), SLTSDdtScheme< Type >::fvcDdtUfCorr(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), Foam::MULES::limiter(), CrankNicolsonDdtScheme< Type >::meshPhi(), fvMesh::movePoints(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), and advectiveFvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::GeometricField< Type, PatchField, GeoMesh > & oldTime ( )

Return non-const old time field.

(Not a good idea but it is used for sub-cycling)

Definition at line 797 of file GeometricField.C.

References GeometricField< Type, PatchField, GeoMesh >::oldTime().

Here is the call graph for this function:

void storePrevIter ( ) const

Store the field as the previous iteration value.

Definition at line 807 of file GeometricField.C.

References Foam::endl(), Foam::Info, and Foam::name().

Referenced by viewFactor::calculate().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::GeometricField< Type, PatchField, GeoMesh > & prevIter ( ) const

Return previous iteration field.

Definition at line 832 of file GeometricField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::endl(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

void correctBoundaryConditions ( )

Correct boundary field.

Definition at line 851 of file GeometricField.C.

Referenced by porosityModel::addResistance(), Foam::fvc::average(), Implicit< CloudType >::cacheFields(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), cellLimitedGrad< Type >::calcGrad(), Foam::checkMethod(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), Foam::MULES::correct(), inverseVolumeDiffusivity::correct(), inverseDistanceDiffusivity::correct(), injectionModelList::correct(), primaryRadiation::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), ArrheniusViscosity::correct(), phaseChangeModel::correct(), thixotropicViscosity::correct(), SpalartAllmaras< BasicTurbulenceModel >::correct(), SpalartAllmarasDES< BasicTurbulenceModel >::correct(), qZeta::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), thermoSingleLayer::correctAlpha(), thermoSingleLayer::correctHsForMappedT(), ShihQuadraticKE::correctNonlinearStress(), LienCubicKE::correctNonlinearStress(), qZeta::correctNut(), LienLeschziner::correctNut(), SpalartAllmaras< BasicTurbulenceModel >::correctNut(), SpalartAllmarasDES< BasicTurbulenceModel >::correctNut(), Foam::MULES::explicitSolve(), forAllIter(), fvMatrix< Type >::H(), kkLOmega::kkLOmega(), sampledSurface::pointAverage(), GeometricField< Type, PatchField, GeoMesh >::prevIter(), standardRadiation::Shs(), Foam::fvc::smooth(), fvMatrix< Type >::fvSolver::solve(), fvMatrix< Type >::solveCoupled(), kinematicSingleLayer::solveMomentum(), fvMatrix< Type >::solveSegregated(), kinematicSingleLayer::solveThickness(), Foam::fvc::spread(), Foam::fvc::sweep(), KinematicCloud< CloudType >::theta(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), dynamicMotionSolverFvMesh::update(), dynamicInkJetFvMesh::update(), multiSolidBodyMotionFvMesh::update(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), reactingOneDim::updateQr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), KinematicCloud< CloudType >::vDotSweep(), and Basic< Type >::~Basic().

bool needReference ( ) const

Does the field need a reference level for solution.

Definition at line 860 of file GeometricField.C.

References forAll, patchi, and Foam::reduce().

Referenced by Foam::adjustPhi(), and Foam::setRefCell().

Here is the call graph for this function:

Here is the caller graph for this function:

tmp<GeometricField<cmptType, PatchField, GeoMesh> > component ( const direction  ) const
bool writeData ( Ostream os) const
virtual

WriteData member function required by regIOobject.

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 954 of file GeometricField.C.

References IOstream::good().

Referenced by GeometricField< Type, PatchField, GeoMesh >::writeMinMax().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > T ( ) const

Return transpose (only if it is a tensor field)

Definition at line 965 of file GeometricField.C.

References Foam::component(), GeometricField< Type, PatchField, GeoMesh >::component(), internalField(), mesh, Foam::name(), GeometricField< Type, PatchField, GeoMesh >::replace(), and Foam::T().

Referenced by displacementSBRStressFvMotionSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

void relax ( const scalar  alpha)

Relax field (for steady-state solution).

alpha = 1 : no relaxation alpha < 1 : relaxation alpha = 0 : do nothing

Definition at line 883 of file GeometricField.C.

References Foam::endl(), InfoIn, and Foam::operator==().

Referenced by viewFactor::calculate().

Here is the call graph for this function:

Here is the caller graph for this function:

void relax ( )

Relax field (for steady-state solution).

alpha is read from controlDict

Definition at line 899 of file GeometricField.C.

References mesh, Foam::name(), relax(), and GeometricField< Type, PatchField, GeoMesh >::select().

Here is the call graph for this function:

Foam::word select ( bool  final) const

Select the final iteration parameters if `final' is true.

by returning the field name + "Final" otherwise the standard parameters by returning the field name

Definition at line 924 of file GeometricField.C.

References Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::writeMinMax().

Referenced by GeometricField< Type, PatchField, GeoMesh >::relax().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeMinMax ( Ostream os) const

Helper function to write the min and max to an Ostream.

Definition at line 941 of file GeometricField.C.

References Foam::endl(), Foam::max(), Foam::min(), Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::writeData().

Referenced by GeometricField< Type, PatchField, GeoMesh >::select().

Here is the call graph for this function:

Here is the caller graph for this function:

void negate ( )

Definition at line 1078 of file GeometricField.C.

References internalField().

Here is the call graph for this function:

void replace ( const direction  ,
const GeometricField< cmptType, PatchField, GeoMesh > &   
)
void replace ( const direction  d,
const dimensioned< cmptType > &  ds 
)

Definition at line 1045 of file GeometricField.C.

References internalField(), GeometricField< Type, PatchField, GeoMesh >::max(), and dimensioned< Type >::value().

Here is the call graph for this function:

void max ( const dimensioned< Type > &  dt)
void min ( const dimensioned< Type > &  dt)

Definition at line 1068 of file GeometricField.C.

References internalField(), Foam::min(), and dimensioned< Type >::value().

Referenced by thixotropicViscosity::correct(), kinematicSingleLayer::gNormClipped(), GeometricField< Type, PatchField, GeoMesh >::max(), and laminar::Su().

Here is the call graph for this function:

Here is the caller graph for this function:

void max ( const GeometricField< Type, PatchField, GeoMesh > &  ,
const dimensioned< Type > &   
)
void min ( const GeometricField< Type, PatchField, GeoMesh > &  ,
const dimensioned< Type > &   
)
void scale ( const GeometricField< Type, PatchField, GeoMesh > &  ,
const GeometricField< Type, PatchField, GeoMesh > &   
)
void scale ( const GeometricField< Type, PatchField, GeoMesh > &  ,
const dimensioned< Type > &   
)
void operator= ( const GeometricField< Type, PatchField, GeoMesh > &  gf)
void operator= ( const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf)
void operator= ( const dimensioned< Type > &  dt)

Definition at line 1150 of file GeometricField.C.

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

Here is the call graph for this function:

void operator== ( const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf)
void operator== ( const dimensioned< Type > &  dt)

Definition at line 1180 of file GeometricField.C.

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

Here is the call graph for this function:

void operator+= ( const GeometricField< Type, PatchField, GeoMesh > &  gf)

Definition at line 1223 of file GeometricField.C.

void operator+= ( const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf)

Definition at line 1223 of file GeometricField.C.

void operator-= ( const GeometricField< Type, PatchField, GeoMesh > &  gf)

Definition at line 1224 of file GeometricField.C.

void operator-= ( const tmp< GeometricField< Type, PatchField, GeoMesh > > &  tgf)

Definition at line 1224 of file GeometricField.C.

void operator*= ( const GeometricField< scalar, PatchField, GeoMesh > &  gf)

Definition at line 1225 of file GeometricField.C.

void operator*= ( const tmp< GeometricField< scalar, PatchField, GeoMesh > > &  tgf)

Definition at line 1225 of file GeometricField.C.

void operator/= ( const GeometricField< scalar, PatchField, GeoMesh > &  gf)

Definition at line 1226 of file GeometricField.C.

void operator/= ( const tmp< GeometricField< scalar, PatchField, GeoMesh > > &  tgf)

Definition at line 1226 of file GeometricField.C.

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

Definition at line 1223 of file GeometricField.C.

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

Definition at line 1224 of file GeometricField.C.

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

Definition at line 1225 of file GeometricField.C.

void operator/= ( const dimensioned< scalar > &  dt)
tmp< GeometricField< scalar, fvPatchField, volMesh > > component ( const direction  ) const

Definition at line 62 of file volFields.C.

References GeometricField< Type, PatchField, GeoMesh >::replace().

Here is the call graph for this function:

void replace ( const direction  ,
const GeometricField< scalar, fvPatchField, volMesh > &  gsf 
)

Definition at line 73 of file volFields.C.

tmp< GeometricField< scalar, fvPatchField, volMesh > > component ( const direction  ) const
void replace ( const direction  ,
const GeometricField< scalar, fvPatchField, volMesh > &  sf 
)

Friends And Related Function Documentation

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

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