GeometricField< Type, PatchField, GeoMesh > Class Template Reference

Generic GeometricField class. More...

Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >:
Collaboration diagram for GeometricField< Type, PatchField, GeoMesh >:

Classes

class  Boundary
 

Public Types

typedef GeoMesh::Mesh Mesh
 Type of mesh on which this GeometricField is instantiated. More...
 
typedef GeoMesh::BoundaryMesh BoundaryMesh
 Type of boundary mesh on which this. More...
 
typedef DimensionedField< Type, GeoMeshInternal
 Type of the internal field from which this GeometricField is derived. More...
 
typedef PatchField< Type > Patch
 Type of the patch field of which the. More...
 
typedef Field< Type >::cmptType cmptType
 
- Public Types inherited from DimensionedField< Type, GeoMesh >
typedef GeoMesh::Mesh Mesh
 Type of mesh on which this DimensionedField is instantiated. More...
 
typedef Field< Type > FieldType
 Type of the field from which this DimensionedField is derived. More...
 
typedef Field< Type >::cmptType cmptType
 Component type of the elements of the field. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from 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 std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_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 field type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensions and patch field types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensioned<Type> More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensioned<Type> More...
 
 GeometricField (const IOobject &, const Internal &, const PtrList< PatchField< Type >> &)
 Constructor from components. 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 > &)
 Copy constructor. More...
 
 GeometricField (GeometricField< Type, PatchField, GeoMesh > &&)
 Move constructor. 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 field 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...
 
 GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Construct as copy resetting IO parameters and boundary types. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > clone () const
 Clone. More...
 
virtual ~GeometricField ()
 Destructor. More...
 
Internalref ()
 Return a reference to the dimensioned internal field. More...
 
const InternalinternalField () const
 Return a const-reference to the dimensioned internal field. More...
 
const Internalv () const
 Return a const-reference to the dimensioned internal field. More...
 
Internal::FieldTypeprimitiveFieldRef ()
 Return a reference to the internal field. More...
 
const Internal::FieldTypeprimitiveField () const
 Return a const-reference to the internal field. More...
 
BoundaryboundaryFieldRef ()
 Return a reference to the boundary field. More...
 
const BoundaryboundaryField () const
 Return const-reference to the boundary 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 maxMin (const dimensioned< Type > &minDt, const dimensioned< Type > &maxDt)
 
const Internaloperator() () const
 Return a const-reference to the dimensioned internal field. More...
 
void operator= (const GeometricField< Type, PatchField, GeoMesh > &)
 
void operator= (GeometricField< Type, PatchField, GeoMesh > &&)
 
void operator= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
 
void operator= (const dimensioned< Type > &)
 
void operator= (const zero &)
 
void operator== (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
 
void operator== (const dimensioned< Type > &)
 
void operator== (const zero &)
 
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 IOobject &, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
 Construct from dictionary. More...
 
 DimensionedField (const DimensionedField< Type, GeoMesh > &)
 Copy constructor. More...
 
 DimensionedField (DimensionedField< Type, GeoMesh > &, bool reuse)
 Copy constructor or re-use as specified. More...
 
 DimensionedField (DimensionedField< Type, GeoMesh > &&)
 Move constructor. More...
 
 DimensionedField (const tmp< DimensionedField< Type, GeoMesh >> &)
 Copy constructor of tmp<DimensionedField> deleting argument. More...
 
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
 Copy constructor resetting IO parameters. More...
 
 DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh > &, bool reuse)
 Copy constructor resetting IO parameters and re-use as specified. More...
 
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &)
 Copy constructor resetting name. More...
 
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reuse)
 Copy constructor resetting name and re-use as specified. More...
 
 DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &)
 Copy constructor 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= (DimensionedField< Type, GeoMesh > &&)
 
void operator= (const tmp< DimensionedField< Type, GeoMesh >> &)
 
void operator= (const dimensioned< Type > &)
 
void operator= (const zero &)
 
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 &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool 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...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool global () const
 Is object same for all processors. More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. 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...
 
wordheaderClassName ()
 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...
 
word modelName (const char *name) const
 Return the name of the object within this model. 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 localPath () const
 Return the path relative to the case. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localObjectPath () const
 Return complete localPath + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 
- 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 label, const zero)
 Construct given size and initialed to zero. More...
 
 Field (const UList< Type > &)
 Copy constructor of a UList<Type> More...
 
 Field (List< Type > &&)
 Mover constructor transferring the List contents. More...
 
 Field (const UIndirectList< Type > &)
 Copy constructor of a UIndirectList<Type> More...
 
 Field (const Field< Type > &)
 Copy constructor. More...
 
 Field (Field< Type > &, bool reuse)
 Copy constructor or re-use as specified. More...
 
 Field (Field< Type > &&)
 Move constructor transferring the Field contents. More...
 
 Field (const tmp< Field< Type >> &)
 Copy constructor of tmp<Field> 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 (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 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...
 
template<class VSForm >
VSForm block (const label start) const
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void operator= (const Field< Type > &)
 
void operator= (Field< Type > &&)
 
void operator= (const UList< Type > &)
 
void operator= (List< Type > &&)
 
void operator= (const SubField< Type > &)
 
void operator= (const tmp< Field< Type >> &)
 
void operator= (const Type &)
 
void operator= (const zero)
 
template<class Form , class Cmpt , direction 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
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is 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 >
 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 label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< Type > &)
 Copy constructor. More...
 
 List (const List< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< Type > &&)
 Move constructor. 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 (std::initializer_list< Type >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
label size () const
 Return the number of elements in the UList. 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...
 
Type & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< Type > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< Type > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Type > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< Type > &&)
 Move assignment operator. More...
 
void operator= (const SLList< Type > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Type > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Type > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< Type >)
 Assignment to an initialiser list. More...
 
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
- Public Member Functions inherited from UList< Type >
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
 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 shallowCopy (const UList< Type > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< Type > &)
 Copy elements of the given UList. More...
 
Type & operator[] (const label)
 Return element of UList. More...
 
const Type & operator[] (const label) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&. 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 tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Internal &, const PtrList< PatchField< Type >> &)
 Return a temporary field constructed from name,. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Return a temporary field constructed from name, mesh, dimensionSet. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Return a temporary field constructed from mesh, dimensioned<Type> More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Return a temporary field constructed from mesh, dimensioned<Type> More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
 Rename temporary field and return. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &, const word &)
 Rename temporary field, reset patch field type and return. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Rename and reset patch fields types of temporary field and return. More...
 
- Static Public Member Functions inherited from DimensionedField< Type, GeoMesh >
static const DimensionedField< Type, GeoMesh > & null ()
 Return a null DimensionedField. More...
 
static tmp< DimensionedField< Type, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensionSet &)
 Return a temporary field constructed from name, mesh. More...
 
static tmp< DimensionedField< Type, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensioned< Type > &)
 Return a temporary field constructed from name, mesh. More...
 
static tmp< DimensionedField< Type, GeoMesh > > New (const word &newName, const DimensionedField< Type, GeoMesh > &)
 Return a temporary field constructed from name and a field. More...
 
static tmp< DimensionedField< Type, GeoMesh > > New (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &)
 Return renamed temporary field. 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)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from 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 float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from Field< Type >
static const char *const typeName
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
- Protected Member Functions inherited from List< Type >
void size (const label)
 Override size to be inconsistent with allocated storage. 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

◆ Mesh

Type of mesh on which this GeometricField is instantiated.

Definition at line 98 of file GeometricField.H.

◆ BoundaryMesh

Type of boundary mesh on which this.

GeometricField::Boundary is instantiated

Definition at line 102 of file GeometricField.H.

◆ Internal

Type of the internal field from which this GeometricField is derived.

Definition at line 105 of file GeometricField.H.

◆ Patch

typedef PatchField<Type> Patch

Type of the patch field of which the.

GeometricField::Boundary is composed

Definition at line 109 of file GeometricField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 263 of file GeometricField.H.

Constructor & Destructor Documentation

◆ GeometricField() [1/18]

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

Constructor given IOobject, mesh, dimensions and patch field type.

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

Definition at line 192 of file GeometricField.C.

Referenced by GeometricField< vector, pointPatchField, pointMesh >::GeometricField().

Here is the caller graph for this function:

◆ GeometricField() [2/18]

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

Constructor given IOobject, mesh, dimensions and patch field types.

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

Definition at line 216 of file GeometricField.C.

◆ GeometricField() [3/18]

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

Definition at line 241 of file GeometricField.C.

◆ GeometricField() [4/18]

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

Definition at line 267 of file GeometricField.C.

◆ GeometricField() [5/18]

GeometricField ( const IOobject io,
const Internal diField,
const PtrList< PatchField< Type >> &  ptfl 
)

Constructor from components.

Definition at line 294 of file GeometricField.C.

◆ GeometricField() [6/18]

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 318 of file GeometricField.C.

◆ GeometricField() [7/18]

GeometricField ( const IOobject io,
const Mesh mesh 
)

Construct and read given IOobject.

Definition at line 344 of file GeometricField.C.

◆ GeometricField() [8/18]

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

Construct from dictionary.

Definition at line 379 of file GeometricField.C.

◆ GeometricField() [9/18]

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

Copy constructor.

Definition at line 414 of file GeometricField.C.

◆ GeometricField() [10/18]

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

Move constructor.

Definition at line 444 of file GeometricField.C.

◆ GeometricField() [11/18]

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

Construct as copy of tmp<GeometricField> deleting argument.

Definition at line 472 of file GeometricField.C.

◆ GeometricField() [12/18]

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

Construct as copy resetting IO parameters.

Definition at line 500 of file GeometricField.C.

◆ GeometricField() [13/18]

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

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

Definition at line 531 of file GeometricField.C.

◆ GeometricField() [14/18]

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

Construct as copy resetting name.

Definition at line 562 of file GeometricField.C.

◆ GeometricField() [15/18]

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

Construct as copy resetting name.

Definition at line 593 of file GeometricField.C.

◆ GeometricField() [16/18]

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

Construct as copy resetting IO parameters and patch field type.

Definition at line 622 of file GeometricField.C.

◆ GeometricField() [17/18]

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 656 of file GeometricField.C.

◆ GeometricField() [18/18]

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

Construct as copy resetting IO parameters and boundary types.

Definition at line 698 of file GeometricField.C.

◆ ~GeometricField()

~GeometricField ( )
virtual

Destructor.

Definition at line 985 of file GeometricField.C.

Member Function Documentation

◆ TypeName()

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

Runtime type information.

◆ null()

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

Return a null geometric field.

Definition at line 30 of file GeometricFieldI.H.

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

Here is the caller graph for this function:

◆ clone()

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

Clone.

Definition at line 737 of file GeometricField.C.

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

Here is the caller graph for this function:

◆ New() [1/7]

◆ New() [2/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word name,
const Mesh mesh,
const dimensionSet ds,
const word patchFieldType = PatchField<Type>::calculatedType() 
)
static

Return a temporary field constructed from name, mesh, dimensionSet.

and patch field type.

Definition at line 781 of file GeometricField.C.

◆ New() [3/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word name,
const Mesh mesh,
const dimensioned< Type > &  dt,
const word patchFieldType = PatchField<Type>::calculatedType() 
)
static

Return a temporary field constructed from mesh, dimensioned<Type>

and patch field type.

Definition at line 815 of file GeometricField.C.

◆ New() [4/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word name,
const Mesh mesh,
const dimensioned< Type > &  dt,
const wordList patchFieldTypes,
const wordList actualPatchTypes = wordList() 
)
static

Return a temporary field constructed from mesh, dimensioned<Type>

and patch field types.

Definition at line 850 of file GeometricField.C.

◆ New() [5/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word newName,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf 
)
static

Rename temporary field and return.

Definition at line 886 of file GeometricField.C.

◆ New() [6/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word newName,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf,
const word patchFieldType 
)
static

Rename temporary field, reset patch field type and return.

Definition at line 917 of file GeometricField.C.

◆ New() [7/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word newName,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf,
const wordList patchFieldTypes,
const wordList actualPatchTypes = wordList() 
)
static

Rename and reset patch fields types of temporary field and return.

Definition at line 950 of file GeometricField.C.

◆ ref()

◆ internalField()

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

Return a const-reference to the dimensioned internal field.

Definition at line 41 of file GeometricFieldI.H.

Referenced by fvMeshSubset::interpolate(), and GeometricField< vector, pointPatchField, pointMesh >::null().

Here is the caller graph for this function:

◆ v()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & v ( ) const
inline

Return a const-reference to the dimensioned internal field.

of a "vol" field. Useful in the formulation of source-terms for FV equations

Definition at line 31 of file volFieldsI.H.

Referenced by kOmega< BasicMomentumTransportModel >::correct(), realizableKE< BasicMomentumTransportModel >::correct(), kOmega2006< BasicMomentumTransportModel >::correct(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::correct().

Here is the caller graph for this function:

◆ primitiveFieldRef()

Foam::GeometricField< Type, PatchField, GeoMesh >::Internal::FieldType & primitiveFieldRef ( )

Return a reference to the internal field.

Note: this increments the event counter and checks the old-time fields; avoid in loops.

Definition at line 1010 of file GeometricField.C.

Referenced by MRFZone::addCoriolis(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), faceLimitedGrad< Type >::calcGrad(), Foam::checkMethod(), limitVelocity::constrain(), limitTemperature::constrain(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), Foam::MULES::correct(), function1Viscosity::correct(), curvatureSeparation::correct(), wideBand::correct(), Foam::evaluate(), fvMatrix< Type >::flux(), forAll(), damping::forceCoeff(), fvMatrix< Type >::H(), surfaceInterpolationScheme< GType >::interpolate(), volPointInterpolation::interpolateBoundaryField(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), Foam::levelSetFraction(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::mag(), Foam::magSqr(), meshToMesh::mapSrcToTgt(), fvMeshAdder::MapSurfaceFields(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), surfaceInterpolation::movePoints(), fvMesh::movePoints(), inverseVolumeDiffusivity::operator()(), inverseDistanceDiffusivity::operator()(), VoidFraction< CloudType >::postEvolve(), Foam::pow(), rigidBodyMeshMotion::rigidBodyMeshMotion(), fvMatrix< Type >::fvSolver::solve(), rigidBodyMeshMotion::solve(), fvMatrix< Type >::solveSegregated(), Foam::sqr(), Foam::stabilise(), ReactingCloud< Foam::DSMCCloud >::SYi(), Foam::T(), MomentumCloud< Foam::DSMCCloud >::theta(), Foam::transform(), SRFModel::Uabs(), MomentumCloud< Foam::DSMCCloud >::vDotSweep(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), AveragingMethod< Foam::Vector >::write(), MRFZone::zero(), and Basic< Type >::~Basic().

◆ primitiveField()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal::FieldType & primitiveField ( ) const
inline

Return a const-reference to the internal field.

Definition at line 51 of file GeometricFieldI.H.

Referenced by Foam::atan2(), Foam::bound(), Implicit< CloudType >::cacheFields(), Foam::calcEk(), faceLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), Foam::cmptAv(), Foam::component(), Foam::MULES::correct(), phaseChangeModel::correct(), limitedSnGrad< Type >::correction(), rigidBodyMeshMotion::curPoints(), motionSmootherAlgo::curPoints(), fvFieldDecomposer::decomposeField(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), kinematicSingleLayer::info(), fvMeshSubset::interpolate(), interpolatingSolidBodyMotionSolver::interpolatingSolidBodyMotionSolver(), Kmesh::Kmesh(), Foam::levelSetFraction(), Foam::MULES::limiterCorr(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), NamedEnum< compressibleField, 8 >::names(), GeometricField< vector, pointPatchField, pointMesh >::operator=(), Foam::pow(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), rigidBodyMeshMotion::rigidBodyMeshMotion(), patchInternalField::sampleField(), motionSmootherAlgo::scaleMesh(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::SlicedGeometricField(), fvMatrix< Type >::solveSegregated(), Foam::sqr(), Foam::stabilise(), Foam::T(), Foam::transform(), Foam::fvc::volumeIntegrate(), regionSizeDistribution::write(), Foam::writeCellGraph(), and skewCorrectionVectors::~skewCorrectionVectors().

◆ boundaryFieldRef()

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

Return a reference to the boundary field.

Note: this increments the event counter and checks the old-time fields; avoid in loops.

Definition at line 1021 of file GeometricField.C.

Referenced by thermoSingleLayer::addSources(), kinematicSingleLayer::addSources(), Foam::adjustPhi(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), P1::calculate(), viewFactor::calculate(), limitVelocity::constrain(), limitTemperature::constrain(), Foam::constrainHbyA(), Foam::constrainPhiHbyA(), Foam::constrainPressure(), wallDistData< TransferType >::correct(), meshWave::correct(), Poisson::correct(), LamBremhorstKE::correct(), ShihQuadraticKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), advectionDiffusion::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), kkLOmega::correct(), motionSmootherAlgo::correct(), motionSmootherAlgo::correctBoundaryConditions(), MRFZone::correctBoundaryVelocity(), mixtureKEpsilon< BasicMomentumTransportModel >::correctInletOutlet(), cubic< Type >::correction(), Foam::correctUphiBCs(), ReynoldsStress< LESModel< BasicMomentumTransportModel > >::correctWallShearStress(), fvFieldDecomposer::decomposeField(), fvMesh::delta(), Foam::evaluate(), Foam::evaluateConstraintTypes(), fvMatrix< Type >::flux(), fvMatrix< Type >::fvMatrix(), heThermo< BasicSolidThermo, MixtureType >::heBoundaryCorrection(), psiuReactionThermo::heuBoundaryCorrection(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), interfaceCompressionNew::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), fvMeshSubset::interpolate(), meshToMesh0::interpolate(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), Foam::levelSetFraction(), Foam::MULES::limit(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), Foam::mag(), Foam::magSqr(), MRFZone::makeAbsolute(), MRFZone::makeRelative(), Foam::MapGeometricFields(), meshToMesh::mapSrcToTgt(), fvMeshAdder::MapSurfaceFields(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), matchedFlowRateOutletVelocityFvPatchVectorField::matchedFlowRateOutletVelocityFvPatchVectorField(), fvMotionSolverEngineMesh::move(), surfaceInterpolation::movePoints(), fvMesh::movePoints(), consumptionSpeed::omega0Sigma(), inversePointDistanceDiffusivity::operator()(), inverseFaceDistanceDiffusivity::operator()(), fvPatch::patchField(), Foam::pow(), nearWallFields::sampleBoundaryField(), pointConstraints::setPatchFields(), temperatureDependent::sigma(), snGradScheme< Type >::snGrad(), rigidBodyMeshMotionSolver::solve(), fvMatrix< Type >::solveCoupled(), Foam::sqr(), Foam::stabilise(), MPLIC::surfaceAlpha(), Foam::T(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), SRFModel::Uabs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), fvDOM::updateG(), heThermo< BasicSolidThermo, MixtureType >::volScalarFieldProperty(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), MRFZone::zero(), externalCoupledMixedFvPatchField< scalar >::~externalCoupledMixedFvPatchField(), Gulders::~Gulders(), GuldersEGR::~GuldersEGR(), and skewCorrectionVectors::~skewCorrectionVectors().

◆ boundaryField()

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

Return const-reference to the boundary field.

Definition at line 60 of file GeometricFieldI.H.

Referenced by effectivenessHeatExchangerSource::addSup(), Foam::adjustPhi(), basicThermo::implementation::alpha(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), SurfaceFilmModel< Foam::MomentumCloud< CloudType > >::cacheFilmFields(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), curvatureSeparation::calcCosAngle(), CentredFitSnGradData< Polynomial >::calcFit(), forces::calcForcesMoment(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), interpolationCellPointWallModified< Type >::calcPointField(), wallShearStress::calcShearStress(), P1::calculate(), epsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), viewFactor::calculate(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), wallHeatFlux::calcWallHeatFlux(), CentredFitData< Polynomial >::CentredFitData(), fvPatch::Cf(), Foam::cmptAv(), extendedCellToFaceStencil::collectData(), extendedFaceToCellStencil::collectData(), Foam::component(), Foam::constrainHbyA(), Foam::constrainPhiHbyA(), Foam::constrainPressure(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), transferModelList::correct(), ejectionModelList::correct(), primaryRadiation::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), contactAngleForce::correct(), strainRateFunction::correct(), gaussGrad< Type >::correctBoundaryConditions(), thermoSingleLayer::correctHforMappedT(), mixtureKEpsilon< BasicMomentumTransportModel >::correctInletOutlet(), pointLinear< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), outletStabilised< Type >::correction(), Foam::correctUphiBCs(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), motionSmootherAlgo::curPoints(), fvFieldDecomposer::decomposeField(), fvPatch::deltaCoeffs(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::divj(), blackBodyEmission::EbDeltaLambdaT(), kOmega< BasicMomentumTransportModel >::epsilon(), kOmega2006< BasicMomentumTransportModel >::epsilon(), kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >::epsilon(), mixtureKEpsilon< BasicMomentumTransportModel >::epsilonBoundaryTypes(), epsilonWallFunctionFvPatchScalarField::epsilonPatch(), Foam::evaluate(), FacePostProcessing< CloudType >::FacePostProcessing(), surfaceFieldValue::filterField(), volPointInterpolation::flatBoundaryField(), PatchFlowRateInjection< CloudType >::flowRate(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), FreeStream< CloudType >::inflow(), thermalBaffle::info(), mixtureKEpsilon< BasicMomentumTransportModel >::initMixtureFields(), SurfaceFilmModel< Foam::MomentumCloud< CloudType > >::inject(), fvMeshSubset::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), interfaceCompressionNew::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), singleCellFvMesh::interpolate(), meshToMesh0::interpolate(), volPointInterpolation::interpolateBoundaryField(), kkLOmega::k(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), Foam::levelSetFraction(), Foam::MULES::limit(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), Foam::MULES::limitSum(), Foam::mag(), fvPatch::magSf(), Foam::magSqr(), MRFZone::makeAbsolute(), MRFZone::makeRelative(), meshToMesh::mapSrcToTgt(), fvMeshAdder::MapSurfaceFields(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), surfaceInterpolation::movePoints(), incompressibleTwoPhaseInteractingMixture::mu(), CompressibleMomentumTransportModel< TransportModel >::mut(), PhaseCompressibleMomentumTransportModel< typename BasicMomentumTransportModel::transportModel >::mut(), cyclicFvPatchField< Type >::nbrPatchField(), cyclicAMIFvPatchField< Type >::nbrPatchField(), cyclicACMIFvPatchField< Type >::nonOverlapPatchField(), Newtonian::nu(), strainRateFunction::nu(), CrossPowerLaw::nu(), HerschelBulkley::nu(), powerLaw::nu(), BirdCarreau::nu(), CompressibleMomentumTransportModel< TransportModel >::nu(), PhaseCompressibleMomentumTransportModel< typename BasicMomentumTransportModel::transportModel >::nu(), Casson::nu(), incompressibleTwoPhaseMixture::nu(), incompressibleTwoPhaseInteractingMixture::nu(), incompressibleThreePhaseMixture::nu(), nutUWallFunctionFvPatchScalarField::nut(), nutkFilmWallFunctionFvPatchScalarField::nut(), nutUSpaldingWallFunctionFvPatchScalarField::nut(), eddyViscosity< LESModel< BasicMomentumTransportModel > >::nut(), nutURoughWallFunctionFvPatchScalarField::nut(), ReynoldsStress< LESModel< BasicMomentumTransportModel > >::nut(), consumptionSpeed::omega0Sigma(), omegaWallFunctionFvPatchScalarField::omegaPatch(), GeometricField< vector, pointPatchField, pointMesh >::operator/=(), GeometricField< vector, pointPatchField, pointMesh >::operator=(), GeometricField< vector, pointPatchField, pointMesh >::operator==(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), inhomogeneousMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), inhomogeneousMixture< ThermoType >::patchFaceReactants(), egrMixture< ThermoType >::patchFaceReactants(), veryInhomogeneousMixture< ThermoType >::patchFaceReactants(), homogeneousMixture< ThermoType >::patchFaceThermoMixture(), inhomogeneousMixture< ThermoType >::patchFaceThermoMixture(), egrMixture< ThermoType >::patchFaceThermoMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceThermoMixture(), fvPatch::patchField(), patchMeanVelocityForce::patchMeanVelocityForce(), specieTransferTemperatureFvPatchScalarField::phiHep(), Foam::pow(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), Foam::fvc::reconstructMag(), Foam::reusable(), incompressibleTwoPhaseInteractingMixture::rho(), psiThermo::implementation::rho(), patchProbes::sample(), patch::sampleField(), triSurfaceMesh::sampleField(), epsilonWallFunctionFvPatchScalarField::setMaster(), omegaWallFunctionFvPatchScalarField::setMaster(), fvPatch::Sf(), thermoSingleLayer::Sh(), temperatureDependent::sigma(), snGradScheme< Type >::snGrad(), rigidBodyMeshMotionSolver::solve(), thermalBaffle::solveEnergy(), fvMatrix< Type >::solveSegregated(), ThermoSurfaceFilm< CloudType >::splashInteraction(), Foam::fvc::spread(), Foam::sqr(), kinematicSingleLayer::Srho(), Foam::stabilise(), kinematicSingleLayer::SU(), MPLIC::surfaceAlpha(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), cyclicPointPatchField< Type >::swapAddSeparated(), cyclicAMIPointPatchField< Type >::swapAddSeparated(), Foam::fvc::sweep(), thermoSingleLayer::SYi(), Foam::T(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), thermoSingleLayer::Tw(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), mixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), fixedEnergyFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), gradientEnergyFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), mixedEnergyFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), outletMappedUniformInletFvPatchField< Type >::updateCoeffs(), specieTransferTemperatureFvPatchScalarField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), matchedFlowRateOutletVelocityFvPatchVectorField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), motionSmootherAlgo::updateMesh(), UpwindFitData< Polynomial >::UpwindFitData(), kinematicSingleLayer::Uw(), extendedUpwindCellToFaceStencil::weightedSum(), outletStabilised< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), fvPatch::weights(), yPlus::write(), wallHeatFlux::write(), wallShearStress::write(), wallHeatTransferCoeff::write(), regionSizeDistribution::write(), externalCoupledMixedFvPatchField< scalar >::writeData(), ensightParts::writeField(), externalCoupledMixedFvPatchField< scalar >::writeGeometry(), Foam::writePatchGraph(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), Gulders::~Gulders(), GuldersEGR::~GuldersEGR(), leastSquaresVectors::~leastSquaresVectors(), skewCorrectionVectors::~skewCorrectionVectors(), and thermalBaffle::~thermalBaffle().

◆ timeIndex() [1/2]

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(), subCycleField< GeometricField >::time(), and subCycleField< GeometricField >::~subCycleField().

Here is the caller graph for this function:

◆ timeIndex() [2/2]

Foam::label & timeIndex ( )
inline

Return the time index of the field.

Definition at line 76 of file GeometricFieldI.H.

◆ storeOldTimes()

void storeOldTimes ( ) const

Store the old-time fields.

Definition at line 1030 of file GeometricField.C.

Referenced by Foam::MapGeometricFields().

Here is the caller graph for this function:

◆ storeOldTime()

void storeOldTime ( ) const

Store the old-time field.

Definition at line 1051 of file GeometricField.C.

◆ nOldTimes()

Foam::label nOldTimes ( ) const

Return the number of old time fields stored.

Definition at line 1076 of file GeometricField.C.

◆ oldTime() [1/2]

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

◆ oldTime() [2/2]

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 1120 of file GeometricField.C.

◆ storePrevIter()

void storePrevIter ( ) const

Store the field as the previous iteration value.

Definition at line 1130 of file GeometricField.C.

Referenced by viewFactor::calculate().

Here is the caller graph for this function:

◆ prevIter()

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

Return previous iteration field.

Definition at line 1156 of file GeometricField.C.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )

Correct boundary field.

Definition at line 1173 of file GeometricField.C.

Referenced by porosityModel::addResistance(), Foam::fvc::average(), Implicit< CloudType >::cacheFields(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), interpolationCellPointWallModified< Type >::calcPointField(), Foam::checkMethod(), limitPressure::constrain(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), Foam::MULES::correct(), transferModelList::correct(), ejectionModelList::correct(), mappedConvectiveHeatTransfer::correct(), function1Viscosity::correct(), ArrheniusViscosity::correct(), phaseChangeModel::correct(), meshWave::correct(), thixotropicViscosity::correct(), qZeta::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), kkLOmega::correct(), thermoSingleLayer::correctCoverage(), thermoSingleLayer::correctHforMappedT(), ShihQuadraticKE::correctNonlinearStress(), LienCubicKE::correctNonlinearStress(), qZeta::correctNut(), LienLeschziner::correctNut(), SpalartAllmaras< BasicMomentumTransportModel >::correctNut(), SpalartAllmarasDES< BasicMomentumTransportModel >::correctNut(), Foam::MULES::explicitSolve(), fvMatrix< Type >::H(), SpalartAllmarasDES< BasicMomentumTransportModel >::k(), kkLOmega::kkLOmega(), inverseVolumeDiffusivity::operator()(), inverseDistanceDiffusivity::operator()(), sampledSurface::pointAverage(), GeometricField< vector, pointPatchField, pointMesh >::prevIter(), Foam::fvc::smooth(), fvMatrix< Type >::fvSolver::solve(), kinematicSingleLayer::solveAlpha(), fvMatrix< Type >::solveCoupled(), kinematicSingleLayer::solveMomentum(), fvMatrix< Type >::solveSegregated(), Foam::fvc::spread(), Foam::fvc::sweep(), MomentumCloud< Foam::DSMCCloud >::theta(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), MomentumCloud< Foam::DSMCCloud >::vDotSweep(), and Basic< Type >::~Basic().

◆ needReference()

bool needReference ( ) const

Does the field need a reference level for solution.

Definition at line 1182 of file GeometricField.C.

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

Here is the caller graph for this function:

◆ component() [1/3]

◆ writeData()

bool writeData ( Ostream os) const
virtual

WriteData member function required by regIOobject.

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 1271 of file GeometricField.C.

Referenced by GeometricField< vector, pointPatchField, pointMesh >::operator/=(), and GeometricField< vector, pointPatchField, pointMesh >::writeMinMax().

Here is the caller graph for this function:

◆ T()

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

Return transpose (only if it is a tensor field)

Definition at line 1282 of file GeometricField.C.

Referenced by displacementSBRStressFvMotionSolver::solve().

Here is the caller graph for this function:

◆ relax() [1/2]

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 1205 of file GeometricField.C.

Referenced by viewFactor::calculate().

Here is the caller graph for this function:

◆ relax() [2/2]

void relax ( )

Relax field (for steady-state solution).

alpha is read from controlDict

Definition at line 1218 of file GeometricField.C.

◆ select()

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 1241 of file GeometricField.C.

Referenced by GeometricField< vector, pointPatchField, pointMesh >::relax().

Here is the caller graph for this function:

◆ writeMinMax()

void writeMinMax ( Ostream os) const

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

Definition at line 1258 of file GeometricField.C.

Referenced by GeometricField< vector, pointPatchField, pointMesh >::select().

Here is the caller graph for this function:

◆ negate()

void negate ( )

Definition at line 1399 of file GeometricField.C.

◆ replace() [1/4]

◆ replace() [2/4]

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

Definition at line 1352 of file GeometricField.C.

◆ max()

◆ min()

void min ( const dimensioned< Type > &  dt)

Definition at line 1375 of file GeometricField.C.

Referenced by thixotropicViscosity::correct(), waxSolventEvaporation::correctModel(), and GeometricField< vector, pointPatchField, pointMesh >::max().

Here is the caller graph for this function:

◆ maxMin()

void maxMin ( const dimensioned< Type > &  minDt,
const dimensioned< Type > &  maxDt 
)

Definition at line 1386 of file GeometricField.C.

Referenced by interfaceCompressionNew::interpolate(), and GeometricField< vector, pointPatchField, pointMesh >::min().

Here is the caller graph for this function:

◆ operator()()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & operator() ( ) const
inline

Return a const-reference to the dimensioned internal field.

Useful in the formulation of source-terms for FV equations

Definition at line 89 of file GeometricFieldI.H.

Referenced by GeometricField< vector, pointPatchField, pointMesh >::timeIndex().

Here is the caller graph for this function:

◆ operator=() [1/5]

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

Definition at line 1410 of file GeometricField.C.

◆ operator=() [2/5]

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

Definition at line 1432 of file GeometricField.C.

◆ operator=() [3/5]

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

Definition at line 1454 of file GeometricField.C.

◆ operator=() [4/5]

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

Definition at line 1494 of file GeometricField.C.

◆ operator=() [5/5]

void operator= ( const zero )

Definition at line 1505 of file GeometricField.C.

◆ operator==() [1/3]

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

Definition at line 1516 of file GeometricField.C.

◆ operator==() [2/3]

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

Definition at line 1535 of file GeometricField.C.

◆ operator==() [3/3]

void operator== ( const zero )

Definition at line 1546 of file GeometricField.C.

◆ operator+=() [1/3]

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

Definition at line 1589 of file GeometricField.C.

◆ operator+=() [2/3]

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

Definition at line 1589 of file GeometricField.C.

◆ operator-=() [1/3]

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

Definition at line 1590 of file GeometricField.C.

◆ operator-=() [2/3]

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

Definition at line 1590 of file GeometricField.C.

◆ operator*=() [1/3]

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

Definition at line 1591 of file GeometricField.C.

◆ operator*=() [2/3]

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

Definition at line 1591 of file GeometricField.C.

◆ operator/=() [1/3]

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

Definition at line 1592 of file GeometricField.C.

◆ operator/=() [2/3]

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

Definition at line 1592 of file GeometricField.C.

◆ operator+=() [3/3]

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

Definition at line 1589 of file GeometricField.C.

◆ operator-=() [3/3]

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

Definition at line 1590 of file GeometricField.C.

◆ operator*=() [3/3]

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

Definition at line 1591 of file GeometricField.C.

◆ operator/=() [3/3]

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

Definition at line 1592 of file GeometricField.C.

◆ component() [2/3]

tmp< GeometricField< scalar, fvPatchField, volMesh > > component ( const direction  ) const

Definition at line 61 of file volFields.C.

◆ replace() [3/4]

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

Definition at line 71 of file volFields.C.

◆ component() [3/3]

tmp< GeometricField< scalar, fvPatchField, volMesh > > component ( const direction  ) const

◆ replace() [4/4]

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

Friends And Related Function Documentation

◆ operator [1/2]

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

◆ operator [2/2]

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

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