Generic GeometricField class. More...
Public Types | |
typedef GeoMesh::Mesh | Mesh |
The mesh type for the GeometricField. More... | |
typedef GeoMesh::BoundaryMesh | BoundaryMesh |
The boundary mesh type for the boundary fields. More... | |
typedef DimensionedField< Type, GeoMesh > | Internal |
The internal field type from which this GeometricField is derived. More... | |
typedef GeometricBoundaryField< Type, PatchField, GeoMesh > | Boundary |
Type of boundary fields. More... | |
typedef PatchField< Type > | Patch |
The patch field type for the GeometricBoundaryField. More... | |
typedef Field< Type >::cmptType | cmptType |
Component type of the field elements. More... | |
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 field elements. More... | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, MUST_READ_IF_MODIFIED = 0x3, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1 } |
Enumeration for use with registerObject(). Values map to bool (false/true) 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 |
The value type the list contains. More... | |
typedef Type * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const Type * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef Type & | reference |
The type used for storing into value_type objects. More... | |
typedef const Type & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef Type * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const Type * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Public Member Functions | |
TypeName ("GeometricField") | |
Runtime type information. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType()) | |
Construct given IOobject, mesh, dimensions and patch type. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList()) | |
Construct given IOobject, mesh, dimensions and patch types. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType()) | |
Construct given IOobject, mesh, dimensioned<Type> and patch type. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList()) | |
Construct given IOobject, mesh, dimensioned<Type> and patch types. More... | |
GeometricField (const IOobject &io, const Internal &diField, const PtrList< PatchField< Type >> &ptfl) | |
Copy construct from internal field and a patch list to clone. More... | |
GeometricField (const IOobject &io, Internal &&diField, const PtrList< PatchField< Type >> &ptfl) | |
Move construct from internal field and a patch list to clone. More... | |
GeometricField (const IOobject &io, const tmp< Internal > &tfield, const PtrList< PatchField< Type >> &ptfl) | |
Move construct from internal field and a patch list to clone. More... | |
GeometricField (const Internal &diField, const PtrList< PatchField< Type >> &ptfl) | |
Copy construct from internal field and a patch list to clone. More... | |
GeometricField (Internal &&diField, const PtrList< PatchField< Type >> &ptfl) | |
Move construct from internal field and a patch list to clone. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType()) | |
Copy construct from internal field, with specified patch type. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType()) | |
Move construct from internal field, with specified patch type. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl) | |
Copy construct from components. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const PtrList< PatchField< Type >> &ptfl) | |
Move construct from internal field and a patch list to clone. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const tmp< Field< Type >> &tiField, const PtrList< PatchField< Type >> &ptfl) | |
Copy construct from components. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true) | |
Construct and read given IOobject. More... | |
GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf) | |
Copy construct. More... | |
GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) | |
Construct from tmp<GeometricField> deleting argument. More... | |
GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf) | |
Construct as copy resetting IO parameters. More... | |
GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) | |
Construct from tmp<GeometricField> resetting IO parameters. More... | |
GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf) | |
Copy construct with a new name. More... | |
GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) | |
Construct with a new name from tmp<GeometricField> More... | |
GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType) | |
Construct as copy resetting IO parameters and patch type. More... | |
GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const labelList &patchIDs, const word &patchFieldType) | |
Construct as copy resetting IO parameters and boundary type for selected patchIDs. More... | |
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. More... | |
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. More... | |
tmp< GeometricField< Type, PatchField, GeoMesh > > | clone () const |
Clone. More... | |
virtual | ~GeometricField () |
Destructor. More... | |
const Internal & | internalField () const noexcept |
Return a const-reference to the dimensioned internal field. More... | |
Internal & | internalFieldRef (const bool updateAccessTime=true) |
Return a reference to the dimensioned internal field. More... | |
Internal & | ref (const bool updateAccessTime=true) |
Same as internalFieldRef() More... | |
const Internal & | v () const |
Return a const-reference to the dimensioned internal field of a "vol" field. More... | |
const Internal::FieldType & | primitiveField () const noexcept |
Return a const-reference to the internal field values. More... | |
Internal::FieldType & | primitiveFieldRef (const bool updateAccessTime=true) |
Return a reference to the internal field values. More... | |
const Boundary & | boundaryField () const noexcept |
Return const-reference to the boundary field. More... | |
Boundary & | boundaryFieldRef (const bool updateAccessTime=true) |
Return a reference to the boundary field. More... | |
label | timeIndex () const noexcept |
Return the time index of the field. More... | |
label & | timeIndex () noexcept |
Write-access to 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 () |
Negate the field inplace. See notes in Field. More... | |
void | normalise () |
Normalise the field inplace. See notes in Field. More... | |
void | replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf) |
Replace specified field component with content from another field. More... | |
void | replace (const direction d, const dimensioned< cmptType > &ds) |
Replace specified field component with specified value. More... | |
void | min (const dimensioned< Type > &dt) |
Use the minimum of the field and specified value. More... | |
void | max (const dimensioned< Type > &dt) |
Use the maximum of the field and specified value. More... | |
void | clip (const dimensioned< MinMax< Type >> &range) |
Clip the field to be bounded within the specified range. More... | |
void | clip (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal) |
Clip the field to be bounded within the specified range. More... | |
void | maxMin (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal) |
Deprecated(2019-01) identical to clip() More... | |
const Internal & | operator() () const |
Return a const-reference to the dimensioned internal field. Same as internalField(). More... | |
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, faPatchField, areaMesh > > | component (const direction) const |
template<> | |
void | replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf) |
template<> | |
tmp< GeometricField< scalar, faPatchField, areaMesh > > | component (const direction) const |
template<> | |
void | replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf) |
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) |
template<class AnyType > | |
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > | New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensionSet &dims, const word &patchFieldType) |
template<class AnyType > | |
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > | New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt, const word &patchFieldType) |
Public Member Functions inherited from DimensionedField< Type, GeoMesh > | |
TypeName ("DimensionedField") | |
Runtime type information. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &field) | |
Construct from components, copy initial field content. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&field) | |
Construct from components, transferring initial field content. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, List< Type > &&field) | |
Construct from components, transferring initial field content. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const tmp< Field< Type >> &tfield) | |
Construct from components, copy or transfer tmp content. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const bool checkIOFlags=true) | |
Construct from components, setting the initial size and assigning the dimensions, but not initialising any field values. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const bool checkIOFlags=true) | |
Construct from components, setting the initial size and assigning both dimensions and values. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const word &fieldDictEntry="value") | |
Construct from Istream. More... | |
DimensionedField (const IOobject &io, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value") | |
Construct from dictionary. More... | |
DimensionedField (const DimensionedField< Type, GeoMesh > &df) | |
Copy construct. More... | |
DimensionedField (DimensionedField< Type, GeoMesh > &&df) | |
Move construct. More... | |
DimensionedField (DimensionedField< Type, GeoMesh > &df, bool reuse) | |
Copy construct or reuse (move) as specified. More... | |
DimensionedField (const tmp< DimensionedField< Type, GeoMesh >> &tdf) | |
Construct from tmp<DimensionedField> deleting argument. More... | |
DimensionedField (const IOobject &io, const DimensionedField< Type, GeoMesh > &df) | |
Copy construct, resetting IO parameters. More... | |
DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &&df) | |
Move construct, resetting IO parameters. More... | |
DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &df, bool reuse) | |
Copy or move construct, resetting IO parameters. More... | |
DimensionedField (const IOobject &io, const tmp< DimensionedField< Type, GeoMesh >> &tdf) | |
Construct from tmp<DimensionedField> deleting argument, resetting IO parameters. More... | |
DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &df) | |
Copy construct with a new name. More... | |
DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &&df) | |
Move construct with a new name. More... | |
DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &df, bool reuse) | |
Copy or move construct, resetting name. More... | |
DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &tdf) | |
Construct with a new name from tmp<DimensionedField> More... | |
tmp< DimensionedField< Type, GeoMesh > > | clone () const |
Clone. More... | |
virtual | ~DimensionedField ()=default |
Destructor. More... | |
void | readField (const dictionary &fieldDict, const word &fieldDictEntry="value") |
const Mesh & | mesh () const noexcept |
Return mesh. More... | |
const dimensionSet & | dimensions () const noexcept |
Return dimensions. More... | |
dimensionSet & | dimensions () noexcept |
Return non-const access to dimensions. More... | |
orientedType | oriented () const noexcept |
Return oriented type. More... | |
orientedType & | oriented () noexcept |
Return non-const access to the oriented type. More... | |
bool | is_oriented () const noexcept |
True if field is ORIENTED. More... | |
void | setOriented (bool on=true) noexcept |
Set the oriented flag: on/off. More... | |
const Field< Type > & | field () const noexcept |
Return const-reference to the field values. More... | |
Field< Type > & | field () noexcept |
Return reference to the field values. More... | |
tmp< DimensionedField< cmptType, GeoMesh > > | component (const direction d) const |
Return a component field of the field. More... | |
void | replace (const direction d, const DimensionedField< cmptType, GeoMesh > &df) |
Replace a component field of the field. More... | |
void | replace (const direction d, const tmp< DimensionedField< cmptType, GeoMesh >> &tdf) |
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 > &weightField) const |
Calculate and return weighted average. More... | |
dimensioned< Type > | weightedAverage (const tmp< DimensionedField< scalar, GeoMesh >> &tweightField) const |
Calculate and return weighted average. More... | |
bool | writeData (Ostream &os, const word &fieldDictEntry) const |
void | operator= (const DimensionedField< Type, GeoMesh > &df) |
void | operator= (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
void | operator= (const dimensioned< Type > &dt) |
Assign dimensions and value. More... | |
void | operator+= (const DimensionedField< Type, GeoMesh > &df) |
void | operator+= (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
void | operator-= (const DimensionedField< Type, GeoMesh > &df) |
void | operator-= (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
void | operator*= (const DimensionedField< scalar, GeoMesh > &df) |
void | operator*= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf) |
void | operator/= (const DimensionedField< scalar, GeoMesh > &df) |
void | operator/= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf) |
void | operator+= (const dimensioned< Type > &dt) |
void | operator-= (const dimensioned< Type > &dt) |
void | operator*= (const dimensioned< scalar > &dt) |
void | operator/= (const dimensioned< scalar > &dt) |
template<> | |
const word | typeName ("volScalarField::Internal") |
template<> | |
const word | typeName ("volVectorField::Internal") |
template<> | |
const word | typeName ("volSphericalTensorField::Internal") |
template<> | |
const word | typeName ("volSymmTensorField::Internal") |
template<> | |
const word | typeName ("volTensorField::Internal") |
template<class AnyType > | |
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > | New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensionSet &dims) |
template<class AnyType > | |
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > | New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt) |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy f registerCopy is true. More... | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
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 as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool valid=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... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool valid) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, register, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (READ_IF_PRESENT) bits are set. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Public Member Functions inherited from Field< Type > | |
constexpr | Field () noexcept |
Default construct. More... | |
Field (const label len) | |
Construct given size. More... | |
Field (const label len, const Type &val) | |
Construct given size and initial value. More... | |
Field (const label len, const Foam::zero) | |
Construct given size and initial values of zero. More... | |
Field (const Foam::one, const Type &val) | |
Construct with length=1, copying the value as the only content. More... | |
Field (const Foam::one, Type &&val) | |
Construct with length=1, moving the value as the only content. More... | |
Field (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
Field (const Field< Type > &fld) | |
Copy construct. More... | |
Field (const UList< Type > &list) | |
Copy construct from UList<Type> More... | |
template<class Addr > | |
Field (const IndirectListBase< Type, Addr > &list) | |
Copy construct from IndirectList. More... | |
Field (Field< Type > &&fld) | |
Move construct from Field. More... | |
Field (List< Type > &&list) | |
Move construct from List. More... | |
template<int SizeMin> | |
Field (DynamicList< Type, SizeMin > &&list) | |
Move construct from DynamicList. 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, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. More... | |
Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More... | |
Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More... | |
Field (Field< Type > &fld, bool reuse) | |
Copy construct or re-use as specified. More... | |
Field (const tmp< Field< Type >> &tfld) | |
Copy or move construct from tmp. More... | |
Field (Istream &is) | |
Construct from Istream. More... | |
Field (const entry &e, const label len) | |
Construct from a dictionary (primitive) entry. More... | |
Field (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) | |
Construct from lookup of a dictionary (primitive) entry. More... | |
tmp< Field< Type > > | clone () const |
Clone. More... | |
void | assign (const entry &e, const label len) |
Assign from a dictionary (primitive) entry. More... | |
void | assign (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) |
Assign from lookup of a dictionary (primitive) entry. 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, const bool applyFlip=true) |
Map from the given field. More... | |
void | map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given tmp field. More... | |
void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
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 () |
Inplace negate this field (negative). More... | |
void | normalise () |
Inplace normalise this field. Generally a no-op except for vector fields. 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 | writeEntry (const word &keyword, Ostream &os) const |
Write the field as a dictionary entry. More... | |
SubField< Type > | slice (const label pos, label len=-1) |
Return SubField slice (non-const access) - no range checking. More... | |
const SubField< Type > | slice (const label pos, label len=-1) const |
Return SubField slice (const access) - no range checking. More... | |
SubField< Type > | slice (const labelRange &range) |
Return SubField slice (non-const access) - with range checking. More... | |
const SubField< Type > | slice (const labelRange &range) const |
Return SubField slice (const access) - with range checking. More... | |
void | operator= (const Field< Type > &) |
Copy assignment. More... | |
void | operator= (const tmp< Field< Type >> &) |
void | operator= (const UList< Type > &rhs) |
void | operator= (const SubField< Type > &rhs) |
template<class Addr > | |
void | operator= (const IndirectListBase< Type, Addr > &rhs) |
Copy assign from IndirectList. More... | |
void | operator= (Field< Type > &&rhs) |
Move assignment. More... | |
void | operator= (List< Type > &&rhs) |
template<int SizeMin> | |
void | operator= (DynamicList< Type, SizeMin > &&rhs) |
void | operator= (const Type &val) |
Value assignment. More... | |
void | operator= (const Foam::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) |
template<> | |
void | normalise () |
template<> | |
void | normalise () |
template<> | |
void | normalise () |
Inplace normalise (float) vector field. More... | |
template<> | |
void | normalise () |
Inplace normalise (double) vector field. More... | |
Public Member Functions inherited from FieldBase | |
constexpr | FieldBase () noexcept |
Default construct. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | count () const noexcept |
Return the current reference count. More... | |
bool | unique () const noexcept |
Return true if the reference count is zero. More... | |
void | operator++ () noexcept |
Increment the reference count. More... | |
void | operator++ (int) noexcept |
Increment the reference count. More... | |
void | operator-- () noexcept |
Decrement the reference count. More... | |
void | operator-- (int) noexcept |
Decrement the reference count. More... | |
Public Member Functions inherited from List< Type > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const Type &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const Type &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, Type &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< Type > &a) | |
Copy construct from list. More... | |
List (const UList< Type > &a) | |
Copy construct contents from list. More... | |
List (List< Type > &a, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< Type > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< Type > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< Type, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< Type > &list) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< Type > &list) | |
Construct as copy of SLList<T> More... | |
List (const IndirectListBase< Type, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< Type > list) | |
Construct from an initializer list. More... | |
List (List< Type > &&list) | |
Move construct from List. More... | |
List (DynamicList< Type, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (SLList< Type > &&list) | |
Move construct from SLList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< Type > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const Type &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const Type &val) |
Alias for resize() More... | |
void | transfer (List< Type > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< Type, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
Type & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
void | push_back (const Type &val) |
Append an element at the end of the list. More... | |
void | push_back (Type &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< Type > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< Type, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const Type &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< Type > &a) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< Type > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const SLList< Type > &list) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< Type, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< Type, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< Type > list) |
Assignment to an initializer list. More... | |
void | operator= (const Type &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< Type > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< Type, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SLList< Type > &&list) |
Move assignment. Takes constant time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
Istream & | readList (Istream &is) |
void | shallowCopy (const UList< Type > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const Type &val) |
Append an element at the end of the list. More... | |
void | append (Type &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< Type > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< Type, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const Type &val) |
Append an element if not already in the list. More... | |
Public Member Functions inherited from UList< Type > | |
label | size () const noexcept |
The number of elements in the UList. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
void | operator= (const Type &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
UList (const UList< Type > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (Type *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const Type & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
Type & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const Type & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
Type & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const Type * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
Type * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
Type & | front () |
Access first element of the list, position [0]. More... | |
const Type & | front () const |
Access first element of the list. More... | |
Type & | back () |
Access last element of the list, position [size()-1]. More... | |
const Type & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
label | find (const Type &val, label pos=0) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const Type &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
bool | found (const Type &val, label pos=0) const |
True if the value if found in the list. More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (const UList< Type > &list) |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< Type > &list) |
Copy elements of the given UList. Sizes must match! More... | |
void | deepCopy (const IndirectListBase< Type, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< Type > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< Type > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< Type > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< Type > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
Type & | operator[] (const label i) |
Return element of UList. More... | |
const Type & | operator[] (const label i) const |
Return element of constant UList. More... | |
const bool & | operator[] (const label i) const |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
UPstream::commsStruct & | operator[] (const label procID) |
const UPstream::commsStruct & | operator[] (const label procID) const |
operator const Foam::List< Type > & () const | |
Allow cast to a const List<T>&. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const noexcept |
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... | |
bool | empty () const noexcept |
True if the UList is empty (ie, size() is zero) More... | |
void | swap (UList< Type > &list) |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< Type > &a) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< Type > &a) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< Type > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< Type > &a) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< Type > &a) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< Type > &a) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
Istream & | readList (Istream &is) |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
Ostream & | writeList (Ostream &os, const label) const |
Specialized writeList for character lists which always uses binary format. More... | |
Ostream & | writeList (Ostream &os, const label) const |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
Type & | first () |
Access first element of the list, position [0]. More... | |
const Type & | first () const |
Access first element of the list. More... | |
Type & | last () |
Access last element of the list, position [size()-1]. More... | |
const Type & | last () const |
Access last element of the list, position [size()-1]. 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 Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType()) |
Return tmp field from name, mesh, dimensions and patch type. More... | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType()) |
Return tmp field from name, mesh, dimensions, copy of internal field, with specified patch type. More... | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType()) |
Return tmp field from name, mesh, dimensions, moved internal field contents, with specified patch type. More... | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType()) |
Return tmp field from name, mesh, dimensioned<Type> and patch type. More... | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) |
Return tmp field from name, mesh, dimensioned<Type> and patch types. More... | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) |
Return renamed tmp field. More... | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) |
Rename tmp field and reset patch field types and return. More... | |
template<class AnyType > | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType()) |
Construct tmp field based on mesh/registry information from an existing field. More... | |
template<class AnyType > | |
static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType()) |
Construct tmp field based on mesh/registry information from an existing field and initialise with value. More... | |
Static Public Member Functions inherited from DimensionedField< Type, GeoMesh > | |
static const DimensionedField< Type, GeoMesh > & | null () |
Return a NullObjectRef DimensionedField. More... | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField) |
Return tmp field from name, mesh, dimensions, copy of internal field. More... | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField) |
Return tmp field from name, mesh, dimensions, moved internal field contents. More... | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensionSet &ds) |
Return tmp field from name, mesh, dimensions. More... | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt) |
Return tmp field from name, mesh, dimensioned<Type>. More... | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &tfld) |
Return renamed tmp field. More... | |
template<class AnyType > | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensionSet &dims) |
Construct tmp field based on mesh/registry information from an existing field. More... | |
template<class AnyType > | |
static tmp< DimensionedField< Type, GeoMesh > > | New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt) |
Construct tmp field based on mesh/registry information from an existing field and initialise with value. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
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... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (READ_IF_PRESENT) bits are set. More... | |
Static Public Member Functions inherited from Field< Type > | |
static const Field< Type > & | null () |
Return nullObject reference Field. More... | |
static autoPtr< Field< Type > > | New (Istream &is) |
Return a pointer to a new Field created on freestore. More... | |
template<class Type2 > | |
static tmp< Field< Type > > | NewCalculatedType (const Field< Type2 > &f) |
Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. 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 UList reference to a nullObject. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Friends | |
Ostream & | operator (Ostream &, const GeometricField< Type, PatchField, GeoMesh > &) |
Ostream & | operator (Ostream &, const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
Additional Inherited Members | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Static Public Attributes inherited from FieldBase | |
static const char *const | typeName |
Typename for Field. More... | |
static bool | allowConstructFromLargerSize = false |
Permit read construct from a larger size. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Member Functions inherited from UList< Type > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
void | writeEntry (Ostream &os) const |
Specialized writeEntry for character lists which always uses binary format. More... | |
void | writeEntry (Ostream &os) const |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
UList< Type > & | operator= (const UList< Type > &)=delete |
No copy assignment (default: shallow copy) More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Generic GeometricField class.
Definition at line 50 of file areaFieldsFwd.H.
typedef GeoMesh::Mesh Mesh |
The mesh type for the GeometricField.
Definition at line 84 of file GeometricField.H.
typedef GeoMesh::BoundaryMesh BoundaryMesh |
The boundary mesh type for the boundary fields.
Definition at line 89 of file GeometricField.H.
typedef DimensionedField<Type, GeoMesh> Internal |
The internal field type from which this GeometricField is derived.
Definition at line 94 of file GeometricField.H.
typedef GeometricBoundaryField<Type, PatchField, GeoMesh> Boundary |
Type of boundary fields.
Definition at line 99 of file GeometricField.H.
typedef PatchField<Type> Patch |
The patch field type for the GeometricBoundaryField.
Definition at line 104 of file GeometricField.H.
Component type of the field elements.
Definition at line 109 of file GeometricField.H.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
const word & | patchFieldType = PatchField<Type>::calculatedType() |
||
) |
Construct given IOobject, mesh, dimensions and patch type.
This allocates storage for the field but does not set values. Used only within this class to create TEMPORARY variables
Definition at line 186 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
const wordList & | wantedPatchTypes, | ||
const wordList & | actualPatchTypes = wordList() |
||
) |
Construct given IOobject, mesh, dimensions and patch types.
This allocates storage for the field but does not set values. Used only within this class to create TEMPORARY variables
Definition at line 208 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensioned< Type > & | dt, | ||
const word & | patchFieldType = PatchField<Type>::calculatedType() |
||
) |
Construct given IOobject, mesh, dimensioned<Type> and patch type.
This assigns both dimensions and values. The name of the dimensioned<Type> has no influence.
Definition at line 231 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensioned< Type > & | dt, | ||
const wordList & | wantedPatchTypes, | ||
const wordList & | actualPatchTypes = wordList() |
||
) |
Construct given IOobject, mesh, dimensioned<Type> and patch types.
This assigns both dimensions and values. The name of the dimensioned<Type> has no influence.
Definition at line 255 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Internal & | diField, | ||
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Copy construct from internal field and a patch list to clone.
Definition at line 280 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
Internal && | diField, | ||
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Move construct from internal field and a patch list to clone.
Definition at line 301 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const tmp< Internal > & | tfield, | ||
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Move construct from internal field and a patch list to clone.
Definition at line 322 of file GeometricField.C.
GeometricField | ( | const Internal & | diField, |
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Copy construct from internal field and a patch list to clone.
Definition at line 343 of file GeometricField.C.
GeometricField | ( | Internal && | diField, |
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Move construct from internal field and a patch list to clone.
Definition at line 363 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
const Field< Type > & | iField, | ||
const word & | patchFieldType = PatchField<Type>::calculatedType() |
||
) |
Copy construct from internal field, with specified patch type.
Definition at line 383 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
Field< Type > && | iField, | ||
const word & | patchFieldType = PatchField<Type>::calculatedType() |
||
) |
Move construct from internal field, with specified patch type.
Definition at line 406 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
const Field< Type > & | iField, | ||
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Copy construct from components.
Definition at line 429 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
Field< Type > && | iField, | ||
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Move construct from internal field and a patch list to clone.
Definition at line 452 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dimensionSet & | ds, | ||
const tmp< Field< Type >> & | tiField, | ||
const PtrList< PatchField< Type >> & | ptfl | ||
) |
Copy construct from components.
Definition at line 475 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const bool | readOldTime = true |
||
) |
Construct and read given IOobject.
Definition at line 498 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const Mesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 534 of file GeometricField.C.
GeometricField | ( | const GeometricField< Type, PatchField, GeoMesh > & | gf | ) |
Copy construct.
Definition at line 565 of file GeometricField.C.
GeometricField | ( | const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ) |
Construct from tmp<GeometricField> deleting argument.
Definition at line 592 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const GeometricField< Type, PatchField, GeoMesh > & | gf | ||
) |
Construct as copy resetting IO parameters.
Definition at line 613 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ||
) |
Construct from tmp<GeometricField> resetting IO parameters.
Definition at line 641 of file GeometricField.C.
GeometricField | ( | const word & | newName, |
const GeometricField< Type, PatchField, GeoMesh > & | gf | ||
) |
Copy construct with a new name.
Definition at line 664 of file GeometricField.C.
GeometricField | ( | const word & | newName, |
const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ||
) |
Construct with a new name from tmp<GeometricField>
Definition at line 692 of file GeometricField.C.
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 713 of file GeometricField.C.
GeometricField | ( | const IOobject & | io, |
const GeometricField< Type, PatchField, GeoMesh > & | gf, | ||
const labelList & | patchIDs, | ||
const word & | patchFieldType | ||
) |
Construct as copy resetting IO parameters and boundary type for selected patchIDs.
Definition at line 782 of file GeometricField.C.
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 744 of file GeometricField.C.
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 813 of file GeometricField.C.
|
virtual |
Destructor.
Definition at line 853 of file GeometricField.C.
TypeName | ( | "GeometricField< Type, PatchField, GeoMesh >" | ) |
Runtime type information.
|
inlinestatic |
Return a null geometric field.
Definition at line 26 of file GeometricFieldI.H.
Referenced by ddtScheme< Type >::fvcDdt().
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > clone | ( | ) | const |
Clone.
Definition at line 844 of file GeometricField.C.
|
static |
Return tmp field from name, mesh, dimensions and patch type.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 27 of file GeometricFieldNew.C.
Referenced by Foam::makeZeroGradientField(), parseDriver::newSurfaceField(), parseDriver::newVolField(), and subCycleField< GeometricField >::subCycleField().
|
static |
Return tmp field from name, mesh, dimensions, copy of internal field, with specified patch type.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 55 of file GeometricFieldNew.C.
|
static |
Return tmp field from name, mesh, dimensions, moved internal field contents, with specified patch type.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 85 of file GeometricFieldNew.C.
|
static |
Return tmp field from name, mesh, dimensioned<Type> and patch type.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 115 of file GeometricFieldNew.C.
|
static |
Return tmp field from name, mesh, dimensioned<Type> and patch types.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 143 of file GeometricFieldNew.C.
|
static |
Return renamed tmp field.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 173 of file GeometricFieldNew.C.
|
static |
Rename tmp field and reset patch field types and return.
The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry
Definition at line 198 of file GeometricFieldNew.C.
|
static |
Construct tmp field based on mesh/registry information from an existing field.
Created NO_READ, NO_WRITE, NO_REGISTER, using the instance from the field
|
static |
Construct tmp field based on mesh/registry information from an existing field and initialise with value.
Created NO_READ, NO_WRITE, NO_REGISTER, using the instance from the field
|
inlinenoexcept |
Return a const-reference to the dimensioned internal field.
Definition at line 35 of file GeometricFieldI.H.
Referenced by ATCUaGradU::addATC(), ATCstandard::addATC(), externalFileSource::addSup(), assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), Foam::fac::div(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::famDdt(), gaussConvectionScheme< Type >::famDiv(), gaussLaplacianScheme< Type >::famLaplacian(), interfaceTrackingFvMesh::freeSurfacePressureJump(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), interfaceTrackingFvMesh::freeSurfaceSnGradUn(), skewCorrectedSnGrad< Type >::fullGradCorrection(), edgeInterpolationScheme< scalar >::interpolate(), dynamicRefineFvMesh::mapNewInternalFaces(), Foam::fac::ndiv(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator/=(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator=(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator==(), faFieldReconstructor::reconstructField(), faMatrix< Type >::residual(), liquidFilmBase::Up(), interfaceTrackingFvMesh::update(), liquidFilmBase::Uw(), and Foam::ensightOutput::writePointField().
Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & internalFieldRef | ( | const bool | updateAccessTime = true | ) |
Return a reference to the dimensioned internal field.
updateAccessTime | update event counter and check old-time fields |
Definition at line 866 of file GeometricField.C.
Referenced by GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::ref().
|
inline |
Same as internalFieldRef()
Definition at line 632 of file GeometricField.H.
Referenced by viscousDissipation::addSup(), interRegionHeatTransferModel::addSup(), adjointSensitivity::adjointMeshMovementSource(), MassTransferPhaseSystem< BasePhaseSystem >::alphaTransfer(), sensitivityVolBSplinesFI::assembleSensitivities(), Foam::atan2(), Foam::fac::average(), incompressibleAdjointSolver::computeGradDxDbMultiplier(), shapeSensitivitiesBase::constructVolSensitivtyField(), Poisson::correct(), diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), heThermo< BasicSolidThermo, MixtureType >::CpByCpv(), heThermo< BasicSolidThermo, MixtureType >::Cpv(), adjointSpalartAllmaras::distanceSensitivities(), Foam::fac::div(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), multiphaseMangrovesTurbulenceModel::epsilonCoeff(), filmFlux::execute(), adjointkOmegaSST::FISensitivityTerm(), ATCUaGradU::getFISensitivityTerm(), adjointEikonalSolver::getFISensitivityTerm(), faMatrix< Type >::H(), fvMatrix< Type >::H1(), MassTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), Foam::interpolate(), singleCellFvMesh::interpolate(), volPointInterpolation::interpolate(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), multiphaseMangrovesTurbulenceModel::kCoeff(), diffusionGasEvaporation< Thermo, OtherThermo >::Kexp(), interfaceOxideRate< Thermo, OtherThermo >::Kexp(), laplaceFilter::laplaceFilter(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::fac::ndiv(), Foam::pow(), variablesSet::renameTurbulenceField(), fvMesh::setPhi(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), surfaceAlignedSBRStressFvMotionSolver::solve(), oversetFvMeshBase::solveOverset(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), multiphaseSystem::Svm(), heheuPsiThermo< BasicPsiThermo, MixtureType >::Tb(), SRFModel::Uabs(), heThermo< BasicSolidThermo, MixtureType >::W(), extendedUpwindCellToFaceStencil::weightedSum(), extendedFaceToCellStencil::weightedSum(), extendedCellToFaceStencil::weightedSum(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), and writeCellVolumes::write().
|
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 26 of file volFieldsI.H.
|
inlinenoexcept |
Return a const-reference to the internal field values.
Definition at line 44 of file GeometricFieldI.H.
Referenced by sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), Foam::FieldOps::assign(), Foam::atan2(), Foam::bound(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), faceLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), Foam::cmptAv(), Foam::component(), phaseChangeModel::correct(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), kinematicSingleLayer::CourantNumber(), motionSmootherAlgo::curPoints(), filmTurbulenceModel::Cw(), EulerFaD2dt2Scheme< Type >::facD2dt2(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), boundedBackwardFaDdtScheme::famDdt(), EulerD2dt2Scheme< Type >::fvcD2dt2(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), ddtScheme< Type >::fvcDdtPhiCoeffExperimental(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), kinematicSingleLayer::info(), Foam::invTransform(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), isoSurfaceBase::New(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator=(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf(), Foam::pow(), fvMatrix< Type >::residual(), rigidBodyMeshMotion::rigidBodyMeshMotion(), parseDriver::setResult(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::SlicedGeometricField(), reactingOneDim::solidRegionDiffNo(), surfaceAlignedSBRStressFvMotionSolver::solve(), Foam::sqr(), Foam::stabilise(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), Foam::transform(), liquidFilmBase::Up(), Foam::fvc::volumeIntegrate(), regionSizeDistribution::write(), Foam::writeCellGraph(), and Foam::zip().
Foam::GeometricField< Type, PatchField, GeoMesh >::Internal::FieldType & primitiveFieldRef | ( | const bool | updateAccessTime = true | ) |
Return a reference to the internal field values.
updateAccessTime | update event counter and check old-time fields |
Definition at line 883 of file GeometricField.C.
Referenced by faMatrix< Type >::A(), fvMatrix< Type >::A(), MRFZone::addCoriolis(), interRegionExplicitPorositySource::addSup(), powerLawUniformBinary::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), Foam::FieldOps::assign(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), cubeRootVolDelta::calcDelta(), maxDeltaxyz::calcDelta(), curvatureSeparation::calcInvR1(), variableHeatTransfer::calculateHtc(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), shapeSensitivitiesBase::constructAndWriteSensitivtyPointField(), inverseVolumeDiffusivity::correct(), curvatureSeparation::correct(), wideBandAbsorptionEmission::correct(), distanceSurface::createGeometry(), Foam::fac::div(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), faMatrix< Type >::flux(), fvMatrix< Type >::flux(), faMatrix< Type >::H(), fvMatrix< Type >::H(), heThermo< BasicSolidThermo, MixtureType >::hc(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), cellCellStencil::interpolate(), volPointInterpolation::interpolateBoundaryField(), Foam::invTransform(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), isoSurfaceTopo::isoSurfaceTopo(), meshToMesh::mapInternalSrcToTgt(), meshToMesh::mapInternalTgtToSrc(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), Foam::fac::ndiv(), VoidFraction< CloudType >::postEvolve(), Foam::pow(), liquidFilmModel::preEvolveRegion(), snappySnapDriver::preSmoothPatch(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), variablesSet::renameTurbulenceField(), rigidBodyMeshMotion::rigidBodyMeshMotion(), acousticDampingSource::setBlendingFactor(), powerLaw::setBreakupRate(), exponential::setBreakupRate(), standardRadiation::Shs(), sensitivitySurface::smoothSensitivities(), Foam::sqr(), Foam::stabilise(), ReactingCloud< Foam::DSMCCloud >::SYi(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::theta(), Foam::transform(), Foam::unzip(), interfaceTrackingFvMesh::update(), NURBS3DVolumeCylindrical::updateLocalCoordinateSystem(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::vDotSweep(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), faNVDscheme< Type, NVDweight >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), AveragingMethod< Foam::vector >::write(), and solverInfo::write().
|
inlinenoexcept |
Return const-reference to the boundary field.
Definition at line 53 of file GeometricFieldI.H.
Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), reactingOneDim::addMassSources(), adjointkOmegaSST::addWallFunctionTerms(), adjointkOmegaSST::adjointMeanFlowSource(), basicThermo::alpha(), lumpedPointMovement::areas(), Foam::FieldOps::assign(), Foam::atan2(), Foam::fac::average(), Foam::fvc::average(), Foam::bound(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), fieldExtents::calcFieldExtents(), CentredFitSnGradData< Polynomial >::calcFit(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), nutUWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutUBlendedWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), wallShearStress::calcShearStress(), atmOmegaWallFunctionFvPatchScalarField::calculate(), atmEpsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), epsilonWallFunctionFvPatchScalarField::calculate(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), Foam::cmptAv(), adjointkOmegaSST::coeffsDifferentiation(), Foam::component(), NURBS3DVolume::computeControlPointSensitivities(), incompressibleAdjointSolver::computeGradDxDbMultiplier(), adjointSpalartAllmaras::conservativeMomentumSource(), shapeSensitivitiesBase::constructAndWriteSensitivtyPointField(), reconstructedDistanceFunction::constructRDF(), transferModelList::correct(), injectionModelList::correct(), contactAngleForce::correct(), gaussGrad< Type >::correctBoundaryConditions(), thermoSingleLayer::correctHsForMappedT(), mixtureKEpsilon< BasicTurbulenceModel >::correctInletOutlet(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwindNormal< Type >::correction(), outletStabilised< Type >::correction(), distanceSurface::createGeometry(), adjointSpalartAllmaras::diffusionCoeffVar1(), adjointkOmegaSST::diffusionCoeffVar1(), adjointkOmegaSST::diffusionCoeffVar2(), adjointEikonalSolver::distanceSensitivities(), adjointSpalartAllmaras::distanceSensitivities(), adjointkOmegaSST::dNutdbMult(), adjointkOmegaSST::dR_dF1(), adjointkOmegaSST::dR_dnut(), multiphaseSystem::dragCoeffs(), shapeSensitivities::dvdbMult(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), effectivenessTable::energyDensity(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), yPlus::execute(), surfaceDistance::execute(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), FacePostProcessing< CloudType >::FacePostProcessing(), gaussConvectionScheme< Type >::famDiv(), gaussLaplacianScheme< Type >::famLaplacian(), adjointSpalartAllmaras::FISensitivityTerm(), volPointInterpolation::flatBoundaryField(), faMatrix< Type >::flux(), lumpedPointMovement::forcesAndMoments(), interfaceTrackingFvMesh::freeSurfacePressureJump(), skewCorrectedSnGrad< Type >::fullGradCorrection(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), GenericPatchGeoFieldsWriter< PatchType >::getFaceField(), psiuReactionThermo::heuBoundaryTypes(), thermalBaffle::info(), fluxSummary::initialiseFaceZoneAndDirection(), mixtureKEpsilon< BasicTurbulenceModel >::initMixtureFields(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::injectParticles(), leastSquaresEdgeInterpolation< Type >::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), pointVolInterpolation::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), weightedFlux< Type >::interpolate(), singleCellFvMesh::interpolate(), meshToMesh0::interpolate(), Foam::invTransform(), objectiveForce::J(), objectiveMoment::J(), kkLOmega::k(), adjointkOmegaSST::kaEqnSourceFromCDkOmega(), interfaceOxideRate< Thermo, OtherThermo >::Kexp(), Foam::MULES::limit(), Foam::MULES::limiter(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::MULES::limiterCorr(), lnGradScheme< Type >::lnGrad(), Foam::mag(), Foam::magSqr(), fvMatrix< Type >::mapContributions(), dynamicRefineFvMesh::mapFields(), volSurfaceMapping::mapInternalToSurface(), dynamicRefineFvMesh::mapNewInternalFaces(), volSurfaceMapping::mapToSurface(), adjointMeshMovementSolver::meshMovementSensitivities(), incompressibleTwoPhaseInteractingMixture::mu(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), PhaseCompressibleTurbulenceModel< Foam::phaseModel >::mut(), CompressibleTurbulenceModel< TransportModel >::mut(), basicFvGeometryScheme::nonOrthCorrectionVectors(), basicFvGeometryScheme::nonOrthDeltaCoeffs(), Schaeffer::nu(), Newtonian::nu(), strainRateFunction::nu(), powerLaw::nu(), JohnsonJacksonSchaeffer::nu(), CrossPowerLaw::nu(), HerschelBulkley::nu(), BirdCarreau::nu(), CompressibleTurbulenceModel< TransportModel >::nu(), Casson::nu(), incompressibleTwoPhaseMixture::nu(), incompressibleTwoPhaseInteractingMixture::nu(), incompressibleThreePhaseMixture::nu(), eddyViscosity< RASModel< BasicTurbulenceModel > >::nut(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::nut(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator/=(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator=(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator==(), boundaryAdjointContributionIncompressible::pab(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), homogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceProducts(), inhomogeneousMixture< ThermoType >::patchFaceProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceReactants(), inhomogeneousMixture< ThermoType >::patchFaceReactants(), veryInhomogeneousMixture< ThermoType >::patchFaceReactants(), homogeneousMixture< ThermoType >::patchFaceVolMixture(), inhomogeneousMixture< ThermoType >::patchFaceVolMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceVolMixture(), fvPatch::patchField(), faPatch::patchField(), lumpedPointDisplacementPointPatchVectorField::patchIds(), boundaryAdjointContributionIncompressible::pb(), boundaryAdjointContributionIncompressible::phiab(), boundaryAdjointContributionIncompressible::phib(), Foam::pow(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), reactingEulerHtcModel::q(), thermoSingleLayer::qconvp(), thermoSingleLayer::qconvw(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::qro(), faFieldReconstructor::reconstructField(), Foam::fvc::reconstructMag(), RemoveParcels< CloudType >::RemoveParcels(), faMatrix< Type >::residual(), fvMatrix< Type >::residual(), incompressibleTwoPhaseInteractingMixture::rho(), patchProbes::sample(), sampledPatch::sampleOnFaces(), sampledFaceZone::sampleOnFaces(), extractEulerianParticles::setBlockedFaces(), fvMatrix< Type >::setBounAndInterCoeffs(), laplacianMotionSolver::setBoundaryConditions(), elasticityMotionSolver::setBoundaryConditions(), fvMatrix< Type >::setInterfaces(), lumpedPointDisplacementPointPatchVectorField::setInterpolators(), displacementMethoddisplacementLaplacian::setMotionField(), displacementMethodlaplacianMotionSolver::setMotionField(), displacementMethodvelocityLaplacian::setMotionField(), displacementMethodelasticityMotionSolver::setMotionField(), lumpedPointDisplacementPointPatchVectorField::setPatchControls(), thermoSingleLayer::Sh(), snGradScheme< Type >::snGrad(), multiphaseSystem::solveAlphas(), thermalBaffle::solveEnergy(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), KinematicSurfaceFilm< CloudType >::splashInteraction(), Foam::sqr(), thermoSingleLayer::Srho(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), multiphaseSystem::Svm(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), fluxSummary::totalArea(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), polynomial::Tsat(), function1::Tsat(), boundaryAdjointContributionIncompressible::Uab(), boundaryAdjointContributionIncompressible::Ub(), dynamicRefineFvMesh::unrefine(), liquidFilmBase::Up(), interfaceTrackingFvMesh::update(), objectiveForce::update_boundarydJdnut(), objectiveMoment::update_boundarydJdnut(), objectiveForce::update_dSdbMultiplier(), objectiveMoment::update_dSdbMultiplier(), objectiveMoment::update_dxdbDirectMultiplier(), objectiveForce::update_dxdbMultiplier(), objectiveMoment::update_dxdbMultiplier(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), fixedMultiPhaseHeatFluxFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), reactingOneDim::updateqr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), adjointkOmegaSST::waEqnSourceFromCDkOmega(), adjointSpalartAllmaras::wallFloCoSensitivities(), adjointSpalartAllmaras::wallShapeSensitivities(), adjointkOmegaSST::wallShapeSensitivities(), outletStabilised< Type >::weights(), faNVDscheme< Type, NVDweight >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), Foam::writePatchGraph(), Foam::ensightOutput::writePointField(), Foam::ensightOutput::writeVolField(), alphatJayatillekeWallFunctionFvPatchScalarField::yPlus(), and Foam::zip().
Foam::GeometricField< Type, PatchField, GeoMesh >::Boundary & boundaryFieldRef | ( | const bool | updateAccessTime = true | ) |
Return a reference to the boundary field.
updateAccessTime | update event counter and check old-time fields |
Definition at line 900 of file GeometricField.C.
Referenced by shapeSensitivities::accumulateBCSensitivityIntegrand(), adjointkOmegaSST::adjointMeanFlowSource(), Foam::FieldOps::assign(), Foam::atan2(), Foam::fac::average(), Foam::fvc::average(), Foam::bound(), wallShearStress::calcShearStress(), incompressibleAdjointSolver::computeGradDxDbMultiplier(), adjointEikonalSolver::computeYPhi(), shapeSensitivitiesBase::constructAndWriteSensitivityField(), reconstructedDistanceFunction::constructRDF(), inversePointDistanceDiffusivity::correct(), injectionModelList::correct(), wallDistData< TransferType >::correct(), ShihQuadraticKE::correct(), LamBremhorstKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), advectionDiffusion::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), cellCellStencil::correctBoundaryConditions(), motionSmootherAlgo::correctBoundaryConditions(), thermoSingleLayer::correctHsForMappedT(), phaseModel::correctInflowOutflow(), mixtureKEpsilon< BasicTurbulenceModel >::correctInletOutlet(), cubic< Type >::correction(), liquidFilmModel::correctThermoFields(), adjointkOmegaSST::dNutdbMult(), adjointkOmegaSST::dR_dF1(), adjointkOmegaSST::dR_dnut(), multiphaseSystem::dragCoeffs(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), adjointSpalartAllmaras::FISensitivityTerm(), faMatrix< Type >::flux(), fvMatrix< Type >::flux(), ddtScheme< Type >::fvcDdtPhiCoeff(), ddtScheme< Type >::fvcDdtPhiCoeffExperimental(), NURBS3DVolume::getDxCellsDb(), heThermo< BasicSolidThermo, MixtureType >::hc(), psiuReactionThermo::heuBoundaryCorrection(), localReferenceTemperature::htc(), fixedReferenceTemperature::htc(), ReynoldsAnalogy::htc(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), pointVolInterpolation::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), meshToMesh0::interpolate(), Foam::invTransform(), adjointkOmegaSST::kaEqnSourceFromCDkOmega(), Foam::MULES::limit(), lnGradScheme< Type >::lnGrad(), adjointSimple::mainIter(), fvMatrix< Type >::manipulateMatrix(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), volSurfaceMapping::mapToVolume(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), basicFvGeometryScheme::nonOrthCorrectionVectors(), Schaeffer::nu(), JohnsonJacksonSchaeffer::nu(), consumptionSpeed::omega0Sigma(), liquidFilmBase::postEvolveRegion(), Foam::pow(), phasePressureModel::pPrime(), phasePressureModel::pPrimef(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), variablesSet::renameTurbulenceField(), laplacianMotionSolver::setBoundaryConditions(), elasticityMotionSolver::setBoundaryConditions(), motionSmootherAlgo::setDisplacementPatchFields(), pointConstraints::setPatchFields(), snGradScheme< Type >::snGrad(), adjointMeshMovementSolver::solve(), multiphaseSystem::solveAlphas(), sensitivityBezierFI::solveMeshMovementEqn(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), Foam::sqr(), Foam::stabilise(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), polynomial::Tsat(), function1::Tsat(), Foam::unzip(), objectiveForce::update_dxdbMultiplier(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), reactingOneDim::updatePhiGas(), reactingOneDim::updateqr(), adjointkOmegaSST::waEqnSourceFromCDkOmega(), faNVDscheme< Type, NVDweight >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), and wallLubricationModel::zeroGradWalls().
|
inlinenoexcept |
Return the time index of the field.
Definition at line 61 of file GeometricFieldI.H.
Referenced by subCycleField< GeometricField >::updateTimeIndex(), and subCycleField< GeometricField >::~subCycleField().
|
inlinenoexcept |
Write-access to the time index of the field.
Definition at line 69 of file GeometricFieldI.H.
void storeOldTimes | ( | ) | const |
Store the old-time fields.
Definition at line 914 of file GeometricField.C.
void storeOldTime | ( | ) | const |
Store the old-time field.
Definition at line 933 of file GeometricField.C.
Foam::label nOldTimes | ( | ) | const |
Return the number of old time fields stored.
Definition at line 954 of file GeometricField.C.
const Foam::GeometricField< Type, PatchField, GeoMesh > & oldTime | ( | ) | const |
Return old time field.
Definition at line 967 of file GeometricField.C.
Referenced by EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerFaD2dt2Scheme< Type >::famD2dt2(), EulerFaDdtScheme< Type >::famDdt(), backwardFaDdtScheme< Type >::famDdt(), boundedBackwardFaDdtScheme::famDdt(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< 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(), MassTransferPhaseSystem< BasePhaseSystem >::massSpeciesTransfer(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::oldTime(), KirchhoffShell::solveDisplacement(), and waveSurfacePressureFvPatchScalarField::updateCoeffs().
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 1007 of file GeometricField.C.
void storePrevIter | ( | ) | const |
Store the field as the previous iteration value.
Definition at line 1017 of file GeometricField.C.
Referenced by adjointSpalartAllmaras::correct(), kinematicThinFilm::evolveRegion(), and kinematicThinFilm::preEvolveRegion().
const Foam::GeometricField< Type, PatchField, GeoMesh > & prevIter | ( | ) | const |
Return previous iteration field.
Definition at line 1040 of file GeometricField.C.
Referenced by Foam::fvc::alphaCorr().
void correctBoundaryConditions | ( | ) |
Correct boundary field.
Definition at line 1057 of file GeometricField.C.
Referenced by faMatrix< Type >::A(), fvMatrix< Type >::A(), porosityModel::addResistance(), Foam::fac::average(), Foam::fvc::average(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), cubeRootVolDelta::calcDelta(), maxDeltaxyz::calcDelta(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), kOmegaSST::computeG(), incompressibleAdjointSolver::computeGradDxDbMultiplier(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), reconstructedDistanceFunction::constructRDF(), inverseVolumeDiffusivity::correct(), transferModelList::correct(), injectionModelList::correct(), primaryRadiation::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), phaseChangeModel::correct(), qZeta::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), adjointSpalartAllmaras::correct(), thermoSingleLayer::correctAlpha(), thermoSingleLayer::correctHsForMappedT(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ShihQuadraticKE::correctNonlinearStress(), LienCubicKE::correctNonlinearStress(), incompressibleVars::correctNonTurbulentBoundaryConditions(), qZeta::correctNut(), LienLeschziner::correctNut(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correctNut(), Foam::fac::div(), electricPotential::electricPotential(), kinematicThinFilm::evolveRegion(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), NURBS3DVolume::getDxCellsDb(), Foam::fac::grad(), faMatrix< Type >::H(), fvMatrix< Type >::H(), patchTransformedInterpolation::interpolate(), pointVolInterpolation::interpolate(), cellCellStencil::interpolate(), adjointSimple::mainIter(), Foam::fac::ndiv(), Foam::fac::ngrad(), Schaeffer::nu(), JohnsonJacksonSchaeffer::nu(), acousticDampingSource::setBlendingFactor(), standardRadiation::Shs(), twoPhaseSystem::solve(), fvMatrix< Type >::solveSegregated(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::theta(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), dynamicMultiMotionSolverFvMesh::update(), dynamicMotionSolverListFvMesh::update(), dynamicMotionSolverFvMesh::update(), dynamicMotionSolverFvMeshAMI::update(), objectivePowerDissipation::update_divDxDbMultiplier(), objectiveUniformityCellZone::update_divDxDbMultiplier(), objectiveNutSqr::update_divDxDbMultiplier(), objectivePowerDissipation::update_gradDxDbMultiplier(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), reactingOneDim::updateqr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), and KinematicCloud< Cloud< basicKinematicCollidingParcel > >::vDotSweep().
bool needReference | ( | ) | const |
Does the field need a reference level for solution.
Definition at line 1066 of file GeometricField.C.
Referenced by Foam::setRefCell().
tmp<GeometricField<cmptType, PatchField, GeoMesh> > component | ( | const direction | ) | const |
Return a component of the field.
Referenced by incompressibleAdjointSolver::computeGradDxDbMultiplier(), fourthLnGrad< Type >::correction(), correctedLnGrad< Type >::correction(), cubic< Type >::correction(), linearUpwind< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), setFlow::execute(), skewCorrectedSnGrad< Type >::fullGradCorrection(), ATCUaGradU::getFISensitivityTerm(), Foam::fvc::magSqrGradGrad(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), and skewCorrected< Type >::skewCorrection().
|
virtual |
WriteData member function required by regIOobject.
Reimplemented from DimensionedField< Type, GeoMesh >.
Definition at line 1150 of file GeometricField.C.
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > T | ( | ) | const |
Return transpose (only if it is a tensor field)
Definition at line 1161 of file GeometricField.C.
Referenced by adjointSensitivity::adjointMeshMovementSource(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), displacementSBRStressFvMotionSolver::solve(), surfaceAlignedSBRStressFvMotionSolver::solve(), and DESModel< BasicTurbulenceModel >::Ssigma().
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 1087 of file GeometricField.C.
Referenced by diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), adjointSpalartAllmaras::correct(), kinematicThinFilm::evolveRegion(), simple::mainIter(), adjointSimple::mainIter(), and liquidFilmModel::preEvolveRegion().
void relax | ( | ) |
Relax field (for steady-state solution).
alpha is read from controlDict
Definition at line 1097 of file GeometricField.C.
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 1122 of file GeometricField.C.
void writeMinMax | ( | Ostream & | os | ) | const |
Helper function to write the min and max to an Ostream.
Definition at line 1137 of file GeometricField.C.
void negate | ( | ) |
Negate the field inplace. See notes in Field.
Definition at line 1304 of file GeometricField.C.
void normalise | ( | ) |
Normalise the field inplace. See notes in Field.
Definition at line 1312 of file GeometricField.C.
void replace | ( | const direction | d, |
const GeometricField< cmptType, PatchField, GeoMesh > & | gcf | ||
) |
Replace specified field component with content from another field.
Referenced by correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), cubic< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), fvMatrix< Type >::H(), anisotropicFilter::operator()(), and shallowWaterAbsorption::setVelocity().
void replace | ( | const direction | d, |
const dimensioned< cmptType > & | ds | ||
) |
Replace specified field component with specified value.
Definition at line 1235 of file GeometricField.C.
void min | ( | const dimensioned< Type > & | dt | ) |
Use the minimum of the field and specified value.
This sets the ceiling on the field values
Definition at line 1247 of file GeometricField.C.
Referenced by kineticTheoryModel::correct(), and laminar::Su().
void max | ( | const dimensioned< Type > & | dt | ) |
Use the maximum of the field and specified value.
This sets the floor on the field values
Definition at line 1258 of file GeometricField.C.
Referenced by dynamicKEqn< BasicTurbulenceModel >::Ce(), dynamicKEqn< BasicTurbulenceModel >::correct(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), and reactingOneDim::solveSpeciesMass().
void clip | ( | const dimensioned< MinMax< Type >> & | range | ) |
Clip the field to be bounded within the specified range.
Definition at line 1269 of file GeometricField.C.
Referenced by comfort::execute(), and twoPhaseSystem::solve().
void clip | ( | const dimensioned< Type > & | minVal, |
const dimensioned< Type > & | maxVal | ||
) |
Clip the field to be bounded within the specified range.
Definition at line 1280 of file GeometricField.C.
void maxMin | ( | const dimensioned< Type > & | minVal, |
const dimensioned< Type > & | maxVal | ||
) |
Deprecated(2019-01) identical to clip()
Definition at line 1294 of file GeometricField.C.
Return a const-reference to the dimensioned internal field. Same as internalField().
Useful in the formulation of source-terms for FV equations
Definition at line 865 of file GeometricField.H.
void operator= | ( | const GeometricField< Type, PatchField, GeoMesh > & | gf | ) |
Definition at line 1323 of file GeometricField.C.
void operator= | ( | const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ) |
Definition at line 1343 of file GeometricField.C.
void operator= | ( | const dimensioned< Type > & | dt | ) |
Definition at line 1379 of file GeometricField.C.
void operator== | ( | const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ) |
Definition at line 1390 of file GeometricField.C.
void operator== | ( | const dimensioned< Type > & | dt | ) |
Definition at line 1409 of file GeometricField.C.
void operator+= | ( | const GeometricField< Type, PatchField, GeoMesh > & | gf | ) |
Definition at line 1452 of file GeometricField.C.
void operator+= | ( | const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ) |
Definition at line 1452 of file GeometricField.C.
void operator-= | ( | const GeometricField< Type, PatchField, GeoMesh > & | gf | ) |
Definition at line 1453 of file GeometricField.C.
void operator-= | ( | const tmp< GeometricField< Type, PatchField, GeoMesh >> & | tgf | ) |
Definition at line 1453 of file GeometricField.C.
void operator*= | ( | const GeometricField< scalar, PatchField, GeoMesh > & | gf | ) |
Definition at line 1454 of file GeometricField.C.
void operator*= | ( | const tmp< GeometricField< scalar, PatchField, GeoMesh >> & | tgf | ) |
Definition at line 1454 of file GeometricField.C.
void operator/= | ( | const GeometricField< scalar, PatchField, GeoMesh > & | gf | ) |
Definition at line 1455 of file GeometricField.C.
void operator/= | ( | const tmp< GeometricField< scalar, PatchField, GeoMesh >> & | tgf | ) |
Definition at line 1455 of file GeometricField.C.
void operator+= | ( | const dimensioned< Type > & | dt | ) |
Definition at line 1452 of file GeometricField.C.
void operator-= | ( | const dimensioned< Type > & | dt | ) |
Definition at line 1453 of file GeometricField.C.
void operator*= | ( | const dimensioned< scalar > & | dt | ) |
Definition at line 1454 of file GeometricField.C.
void operator/= | ( | const dimensioned< scalar > & | dt | ) |
Definition at line 1455 of file GeometricField.C.
tmp< GeometricField< scalar, faPatchField, areaMesh > > component | ( | const direction | ) | const |
Definition at line 55 of file areaFields.C.
void replace | ( | const direction | , |
const GeometricField< scalar, faPatchField, areaMesh > & | gsf | ||
) |
Definition at line 64 of file areaFields.C.
tmp< GeometricField< scalar, faPatchField, areaMesh > > component | ( | const direction | ) | const |
void replace | ( | const direction | , |
const GeometricField< scalar, faPatchField, areaMesh > & | sf | ||
) |
tmp< GeometricField< scalar, fvPatchField, volMesh > > component | ( | const direction | ) | const |
Definition at line 54 of file volFields.C.
void replace | ( | const direction | , |
const GeometricField< scalar, fvPatchField, volMesh > & | gsf | ||
) |
Definition at line 64 of file volFields.C.
tmp< GeometricField< scalar, fvPatchField, volMesh > > component | ( | const direction | ) | const |
void replace | ( | const direction | , |
const GeometricField< scalar, fvPatchField, volMesh > & | sf | ||
) |
Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh> > New | ( | const GeometricField< AnyType, PatchField, GeoMesh > & | fld, |
const word & | name, | ||
const dimensionSet & | dims, | ||
const word & | patchFieldType | ||
) |
Definition at line 228 of file GeometricFieldNew.C.
Foam::tmp<Foam::GeometricField<Type, PatchField, GeoMesh> > New | ( | const GeometricField< AnyType, PatchField, GeoMesh > & | fld, |
const word & | name, | ||
const dimensioned< Type > & | dt, | ||
const word & | patchFieldType | ||
) |
Definition at line 257 of file GeometricFieldNew.C.
|
friend |
|
friend |
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.