DimensionedField< Type, GeoMesh, PrimitiveField > Class Template Reference

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

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

Public Types

typedef GeoMesh::Mesh Mesh
 Type of mesh on which this DimensionedField is instantiated. More...
 
typedef PrimitiveField< Type > FieldType
 Type of the field from which this DimensionedField is derived. More...
 
typedef PrimitiveField< Type > Base
 Type of the field from which this DimensionedField is derived. More...
 
typedef PrimitiveField< Type >::cmptType cmptType
 Component type of the elements of the field. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 

Public Member Functions

 TypeName ("DimensionedField")
 Runtime type information. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const bool checkIOFlags=true)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &, const bool checkIOFlags=true)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
 Construct from Istream. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
 Construct from dictionary. More...
 
 DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
 Copy constructor. More...
 
 DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField > &&)
 Move constructor. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Copy constructor. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
 Copy constructor or reuse as specified. More...
 
 DimensionedField (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Copy constructor of tmp<DimensionedField> deleting argument. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool checkIOFlags=true)
 Copy constructor resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse, const bool checkIOFlags=true)
 Copy constructor resetting IO parameters and reuse as specified. More...
 
 DimensionedField (const IOobject &, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &, const bool checkIOFlags=true)
 Copy constructor from tmp resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Copy constructor resetting name. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
 Copy constructor resetting name and reuse as specified. More...
 
 DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Copy constructor from tmp resetting name. More...
 
tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > clone () const
 Clone. More...
 
virtual ~DimensionedField ()
 Destructor. More...
 
void readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
 
const Meshmesh () const
 Return mesh. More...
 
const dimensionSetdimensions () const
 Return dimensions. More...
 
dimensionSetdimensions ()
 Return non-const access to dimensions. More...
 
PrimitiveField< Type > & primitiveFieldRef ()
 Return a reference to the internal field. More...
 
const PrimitiveField< Type > & primitiveField () const
 Return a const-reference to the primitive field. More...
 
 USING_OLD_TIME_FIELD (DimensionedField)
 Use old-time methods from the base class. More...
 
tmp< DimensionedField< cmptType, GeoMesh, Field > > component (const direction) const
 Return a component field of the field. More...
 
template<template< class > class PrimitiveField2>
void replace (const direction, const DimensionedField< cmptType, GeoMesh, PrimitiveField2 > &)
 Replace a component field of the field. More...
 
template<template< class > class PrimitiveField2>
void replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh, PrimitiveField2 >> &)
 Replace a component field of the field. More...
 
tmp< DimensionedField< Type, GeoMesh, Field > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
dimensioned< Type > average () const
 Calculate and return arithmetic average. More...
 
template<template< class > class PrimitiveField2>
dimensioned< Type > weightedAverage (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &) const
 Calculate and return weighted average. More...
 
template<template< class > class PrimitiveField2>
dimensioned< Type > weightedAverage (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &) const
 Calculate and return weighted average. More...
 
template<template< class > class PrimitiveField2>
void reset (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Reset the field values to the given field. More...
 
void reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Reset the field values to the given tmp-field. More...
 
template<template< class > class PrimitiveField2>
void reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 Reset the field values to the given tmp-field. More...
 
bool writeData (Ostream &, const word &fieldDictEntry) const
 
bool writeData (Ostream &) const
 Pure virtual writaData function. More...
 
void operator= (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
 
void operator= (DimensionedField< Type, GeoMesh, PrimitiveField > &&)
 
void operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 
template<template< class > class PrimitiveField2>
void operator= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator= (const dimensioned< Type > &)
 
void operator= (const zero &)
 
template<template< class > class PrimitiveField2>
void operator== (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator== (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator== (const dimensioned< Type > &)
 
void operator== (const zero &)
 
template<template< class > class PrimitiveField2>
void operator+= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator+= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator+= (const dimensioned< Type > &)
 
template<template< class > class PrimitiveField2>
void operator-= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator-= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator-= (const dimensioned< Type > &)
 
template<template< class > class PrimitiveField2>
void operator*= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator*= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)
 
void operator*= (const dimensioned< scalar > &)
 
template<template< class > class PrimitiveField2>
void operator/= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator/= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)
 
void operator/= (const dimensioned< scalar > &)
 
template<template< class > class PrimitiveField2>
Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df)
 
template<template< class > class PrimitiveField2>
void replace (const direction d, const DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &df)
 
template<template< class > class PrimitiveField2>
void replace (const direction d, const tmp< DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &tdf)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)=delete
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
void updateTimeInstance () const
 Update instance to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
 OldTimeField (const label timeIndex)
 Construct from a time index. More...
 
 OldTimeField (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &otf)
 Copy construct. More...
 
 OldTimeField (OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &&otf)
 Move construct. More...
 
 ~OldTimeField ()
 Destructor. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
labeltimeIndex ()
 Return a non-const reference to the time index of the field. More...
 
bool isOldTime () const
 Return whether or not this is an old-time field. More...
 
bool hasStoredOldTimes () const
 Return whether old-time fields have been stored yet. More...
 
void storeOldTimes () const
 Store the old-time fields. More...
 
void clearOldTimes ()
 Clear old-time fields. More...
 
void nullOldestTime ()
 Set the oldest field pointer to nullObjectPtr. This removes the. More...
 
label nOldTimes (const bool includeNull=true) const
 Return the number of old-time fields stored. More...
 
const Field0Type & oldTime () const
 Return the old-time field. More...
 
const Field0Type & oldTime (const label n) const
 Return the n-th old-time field. More...
 
Field0Type & oldTimeRef ()
 Return a non-const reference to the old-time field. More...
 
Field0Type & oldTimeRef (const label n)
 Return a non-const reference to the n-th old time field. More...
 
void operator= (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static const DimensionedField< Type, GeoMesh, PrimitiveField > & null ()
 Return a null DimensionedField. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
 Return a temporary field constructed from name, mesh,. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &mesh, const dimensionSet &)
 Return a temporary field constructed from name, mesh. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &mesh, const dimensioned< Type > &)
 Return a temporary field constructed from name, mesh. More...
 
template<template< class > class PrimitiveField2>
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Return a temporary field constructed from name and a field. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Return renamed temporary field. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 

Friends

template<class Type2 , class GeoMesh2 , template< class > class PrimitiveField2>
class DimensionedField
 Declare friendship with other dimensioned fields. More...
 
Ostreamoperator (Ostream &, const DimensionedField< Type, GeoMesh, PrimitiveField > &)
 
Ostreamoperator (Ostream &, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 

Additional Inherited Members

- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 
- Protected Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
bool readOldTimeIfPresent ()
 Read old-time field from file if it is present. More...
 
void copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
 Copy the old-times from the given field. More...
 
void copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
 Copy the old-times from the given field. More...
 

Detailed Description

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

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

Source files

Definition at line 76 of file DimensionedField.H.

Member Typedef Documentation

◆ Mesh

Type of mesh on which this DimensionedField is instantiated.

Definition at line 88 of file DimensionedField.H.

◆ FieldType

typedef PrimitiveField<Type> FieldType

Type of the field from which this DimensionedField is derived.

Definition at line 91 of file DimensionedField.H.

◆ Base

typedef PrimitiveField<Type> Base

Type of the field from which this DimensionedField is derived.

Definition at line 94 of file DimensionedField.H.

◆ cmptType

typedef PrimitiveField<Type>::cmptType cmptType

Component type of the elements of the field.

Definition at line 97 of file DimensionedField.H.

Constructor & Destructor Documentation

◆ DimensionedField() [1/16]

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

Construct from components.

Definition at line 66 of file DimensionedField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and DimensionedField< Type, GeoMesh, PrimitiveField >::mesh().

Here is the call graph for this function:

◆ DimensionedField() [2/16]

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

Construct from components.

Used for temporary fields which are initialised after construction

Definition at line 92 of file DimensionedField.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), and setSize().

Here is the call graph for this function:

◆ DimensionedField() [3/16]

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

Construct from components.

Definition at line 117 of file DimensionedField.C.

◆ DimensionedField() [4/16]

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

Construct from Istream.

Definition at line 90 of file DimensionedFieldIO.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::readField(), and regIOobject::readStream().

Here is the call graph for this function:

◆ DimensionedField() [5/16]

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

Construct from dictionary.

Definition at line 108 of file DimensionedFieldIO.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::readField().

Here is the call graph for this function:

◆ DimensionedField() [6/16]

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

Copy constructor.

Definition at line 139 of file DimensionedField.C.

◆ DimensionedField() [7/16]

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

Move constructor.

Definition at line 153 of file DimensionedField.C.

◆ DimensionedField() [8/16]

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

Copy constructor.

Definition at line 168 of file DimensionedField.C.

◆ DimensionedField() [9/16]

DimensionedField ( DimensionedField< Type, GeoMesh, PrimitiveField2 > &  df,
const bool  reuse 
)

Copy constructor or reuse as specified.

Definition at line 183 of file DimensionedField.C.

◆ DimensionedField() [10/16]

DimensionedField ( const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &  tdf)

Copy constructor of tmp<DimensionedField> deleting argument.

Definition at line 198 of file DimensionedField.C.

◆ DimensionedField() [11/16]

DimensionedField ( const IOobject io,
const DimensionedField< Type, GeoMesh, PrimitiveField2 > &  df,
const bool  checkIOFlags = true 
)

Copy constructor resetting IO parameters.

Definition at line 219 of file DimensionedField.C.

◆ DimensionedField() [12/16]

DimensionedField ( const IOobject io,
DimensionedField< Type, GeoMesh, PrimitiveField2 > &  df,
const bool  reuse,
const bool  checkIOFlags = true 
)

Copy constructor resetting IO parameters and reuse as specified.

Definition at line 241 of file DimensionedField.C.

◆ DimensionedField() [13/16]

DimensionedField ( const IOobject io,
const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &  tdf,
const bool  checkIOFlags = true 
)

Copy constructor from tmp resetting IO parameters.

Definition at line 263 of file DimensionedField.C.

◆ DimensionedField() [14/16]

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

Copy constructor resetting name.

Definition at line 291 of file DimensionedField.C.

References OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >::copyOldTimes().

Here is the call graph for this function:

◆ DimensionedField() [15/16]

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

Copy constructor resetting name and reuse as specified.

Definition at line 309 of file DimensionedField.C.

◆ DimensionedField() [16/16]

DimensionedField ( const word newName,
const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &  tdf 
)

Copy constructor from tmp resetting name.

Definition at line 325 of file DimensionedField.C.

◆ ~DimensionedField()

~DimensionedField
virtual

Destructor.

Definition at line 522 of file DimensionedField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "DimensionedField< Type, GeoMesh, PrimitiveField >"  )

Runtime type information.

◆ null()

const Foam::DimensionedField< Type, GeoMesh, PrimitiveField > & null
inlinestatic

Return a null DimensionedField.

Definition at line 32 of file DimensionedFieldI.H.

Referenced by fvPatchField< Type >::NewCalculatedType(), fvsPatchField< Type >::NewCalculatedType(), and volPointInterpolation::volPointInterpolation().

Here is the caller graph for this function:

◆ clone()

tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > clone

Clone.

Definition at line 347 of file DimensionedField.C.

◆ New() [1/6]

Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > > New ( const word name,
const Mesh mesh,
const dimensionSet ds,
const PrimitiveField< Type > &  field 
)
static

Return a temporary field constructed from name, mesh,.

dimensionSet and field

Definition at line 358 of file DimensionedField.C.

Referenced by fvSpecificSource::addSupType(), compressibleVoF::alphaSuSp(), incompressibleDriftFlux::alphaSuSp(), incompressibleVoF::alphaSuSp(), SpalartAllmarasDES< BasicMomentumTransportModel >::cacheLESRegion(), uniformSizeNumberLagrangianScalarFieldSource::calcSizes(), turbulentDispersion::calculate(), zeroDimensionalFixedPressureConstraint::constrain(), homogeneousCondensation::correct(), homogeneousLiquidPhaseSeparation::correct(), massDiffusionLimitedPhaseChange::correct(), waveForcing::correct(), wallBoiling::d(), SpalartAllmarasDDES< BasicMomentumTransportModel >::dTilda(), SpalartAllmarasDES< BasicMomentumTransportModel >::dTilda(), SpalartAllmarasIDDES< BasicMomentumTransportModel >::dTilda(), Foam::saturationModels::evaluate(), CloudDerivedField< Type >::field(), kOmegaSSTLM< BasicMomentumTransportModel >::Flength(), kOmegaSSTLM< BasicMomentumTransportModel >::Fonset(), forcing::forceCoeff(), kOmegaSSTLM< BasicMomentumTransportModel >::Fthetat(), Function1LagrangianFieldSource< vector >::Function1LagrangianFieldSource(), SpalartAllmarasDES< BasicMomentumTransportModel >::fv2(), SpalartAllmaras< BasicMomentumTransportModel >::fv2(), fvMeshToFvMesh::fvMeshToFvMesh(), SpalartAllmarasDES< BasicMomentumTransportModel >::fw(), SpalartAllmaras< BasicMomentumTransportModel >::fw(), ParcelCloudBase< ParticleType >::hsCoeff(), parcelCloudList::hsCoeff(), ParcelCloudBase< ParticleType >::hsTrans(), parcelCloudList::hsTrans(), twoPhaseMixture::interfaceFraction(), nucleationInterfacialCurvatureFvScalarFieldSource::internalCoeff(), nucleationSizeGroupFvScalarFieldSource::internalCoeff(), nucleationSurfaceAreaVolumeRatioFvScalarFieldSource::internalCoeff(), distributionSizeGroupFvScalarFieldSource::internalCoeff(), singleSizeGroupFvScalarFieldSource::internalCoeff(), uniformFixedValueSurfaceAreaVolumeRatioFvScalarFieldSource::internalCoeff(), internalFvFieldSource< Type >::internalCoeff(), NaNFvFieldSource< Type >::internalCoeff(), uniformFixedValueFvFieldSource< Type >::internalCoeff(), uniformFixedEnergyTemperatureFvScalarFieldSource::internalCoeff(), uniformFixedValueLagrangianFieldSource< Type >::internalCoeff(), LagrangianAverage< Type >::interpolate(), multiphaseEulerCavitation::Lfraction(), phaseSurfaceBoiling::Lfraction(), wallBoiling::Lfraction(), zeroDimensionalFixedPressureConstraint::massSource(), adjustTimeStepToNucleation::maxDeltaT(), adjustTimeStepToCombustion::maxDeltaT(), multiphaseEulerCavitation::mDot(), phaseChange::mDot(), massDiffusionLimitedPhaseChange::mDot(), reactionDrivenPhaseChange::mDot(), populationBalanceModel::modelSourceSu(), wallBoiling::nDot(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh, PrimitiveField >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type2, GeoMesh, PrimitiveField1, PrimitiveField2 >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh, Field >::New(), SpalartAllmarasDES< BasicMomentumTransportModel >::Omega(), zeroDimensionalFixedPressureConstraint::pEqnSource(), LagrangianMesh::position(), InertPhaseModel< BasePhaseModel >::R(), noCombustion::R(), SpalartAllmarasDES< BasicMomentumTransportModel >::r(), chemistryModel< ThermoType >::reactionRR(), kOmegaSSTLM< BasicMomentumTransportModel >::ReThetac(), kOmegaSSTLM< BasicMomentumTransportModel >::ReThetat0(), massTransfer::rho(), noRadiation::Ru(), opaqueSolid::Ru(), viewFactor::Ru(), forcing::scale(), phaseSystem::solve(), LagrangianModels::source(), uniformFixedEnergyTemperatureFvScalarFieldSource::sourceHeValue(), uniformInletOutletEnergyTemperatureFvScalarFieldSource::sourceHeValue(), distributionSizeGroupFvScalarFieldSource::sourceValue(), singleSizeGroupFvScalarFieldSource::sourceValue(), NaNFvFieldSource< Type >::sourceValue(), uniformFixedValueFvFieldSource< Type >::sourceValue(), uniformInletOutletFvFieldSource< Type >::sourceValue(), fvMatrix< Type >::Sp(), chemistryModel< ThermoType >::specieReactionRR(), ParcelCloudBase< ParticleType >::Srho(), parcelCloudList::Srho(), SpalartAllmaras< BasicMomentumTransportModel >::Stilda(), SpalartAllmarasDES< BasicMomentumTransportModel >::Stilda(), phaseChange::Tchange(), ParcelCloudBase< ParticleType >::UCoeff(), parcelCloudList::UCoeff(), ParcelCloudBase< ParticleType >::UTrans(), parcelCloudList::UTrans(), coneDiskVelocityLagrangianVectorFieldSource::value(), coneVelocityLagrangianVectorFieldSource::value(), distributionDiameterLagrangianScalarFieldSource::value(), and noneStateLagrangianLabelFieldSource::value().

Here is the caller graph for this function:

◆ New() [2/6]

Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > > New ( const word name,
const Mesh mesh,
const dimensionSet ds 
)
static

Return a temporary field constructed from name, mesh.

and dimensionSet

Definition at line 392 of file DimensionedField.C.

◆ New() [3/6]

Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > > New ( const word name,
const Mesh mesh,
const dimensioned< Type > &  dt 
)
static

Return a temporary field constructed from name, mesh.

and dimensionType providing dimensions and value

Definition at line 425 of file DimensionedField.C.

◆ New() [4/6]

static tmp<DimensionedField<Type, GeoMesh, PrimitiveField> > New ( const word newName,
const DimensionedField< Type, GeoMesh, PrimitiveField2 > &   
)
static

Return a temporary field constructed from name and a field.

◆ New() [5/6]

Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > > New ( const word newName,
const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &  tdf 
)
static

Return renamed temporary field.

Definition at line 490 of file DimensionedField.C.

◆ readField()

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

Definition at line 33 of file DimensionedFieldIO.C.

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

Referenced by DimensionedField< Type, GeoMesh, PrimitiveField >::DimensionedField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mesh()

const GeoMesh::Mesh & mesh
inline

Return mesh.

Definition at line 40 of file DimensionedFieldI.H.

Referenced by accumulationScheme< Type >::accumulate(), Foam::Lagrangianc::accumulate(), cellPointLagrangianAccumulator::accumulate(), turbulentDispersion::addSup(), Foam::atan2(), Foam::fvc::average(), Foam::byDt(), cellMDLimitedGrad< Type >::calcGrad(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), specieFluxBase::calcPhiYif(), kinematicParcel::calculate(), kinematicParticle::calculate(), parcel::calculate(), particle::calculate(), turbulentDispersion::calculate(), cloudAge::calculate(), cloudMass::calculate(), cloudSurfaceArea::calculate(), cloudVolume::calculate(), Foam::cmptAv(), compressibleVoFphase::compressibleVoFphase(), conformedFvsPatchField< Type >::conform(), conformedFvPatchField< Type >::conform(), pointConstraints::constrainDisplacement(), spherical::correct(), gaussGrad< Type >::correctBoundaryConditions(), motionSmootherAlgo::correctBoundaryConditions(), Foam::correctContactAngle(), phaseStabilisedSnGrad< Type >::correction(), Foam::fv::CorrectPhi(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), Foam::fvc::DDt(), Foam::fvc::ddt(), Foam::fvm::ddt(), DimensionedField< Type, GeoMesh, PrimitiveField >::DimensionedField(), Foam::fvm::div(), Foam::fvc::div(), Foam::fvm::divc(), MaxwellStefan< BasicThermophysicalTransportModel >::divj(), sizeGroup::fieldIo(), Foam::fvc::flux(), gaussConvectionScheme< Type >::fvmDiv(), Foam::fvc::grad(), Foam::hydrostaticInitialisation(), wallCellWallFunctionFvPatchScalarField::initMaster(), pointMVCWeight::interpolate(), surfaceInterpolationScheme< scalar >::interpolate(), harmonic::interpolate(), volPointInterpolation::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), fvMeshSubset::interpolate(), PLIC::interpolate(), PLICU::interpolate(), volPointInterpolation::interpolateDisplacement(), Foam::interpolatePointToCell(), interpolationCellPoint< scalar >::interpolationCellPoint(), MaxwellStefan< BasicThermophysicalTransportModel >::j(), CrankNicolson< Type >::LagrangianmNoDdt(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::fvm::laplacianCorrection(), Foam::levelSetFraction(), Foam::MULES::limitSum(), Foam::linearInterpolate(), Foam::mag(), Foam::magSqr(), Foam::fvc::makeAbsolute(), Foam::fvc::makeRelative(), Foam::MapGeometricFields(), twoPhases::mesh(), Foam::fvc::meshPhi(), combustionModel::New(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh, PrimitiveField >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type2, GeoMesh, PrimitiveField1, PrimitiveField2 >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh, Field >::New(), reuseTmpGeometricField< TypeR, Type1, GeoMesh, PrimitiveField >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type2, GeoMesh, PrimitiveField1, PrimitiveField2 >::New(), reuseTmpTmpGeometricField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), reuseTmpGeometricField< TypeR, TypeR, GeoMesh, Field >::New(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), LagrangianAverage< Type >::New(), LagrangianSubMesh::nf(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), none::nu(), strainRateFunction::nu(), multivariateIndependentScheme< Type >::operator()(), fvMatrix< Type >::operator+=(), fvMatrix< Type >::operator-=(), wallCellWallFunctionFvPatchScalarField::patchFieldsToWallCellField(), externalDisplacementMeshMover::pMesh(), cloudBoundaryCollisionFlux::postCrossFaces(), cloudFlux::postCrossFaces(), cloudSurfaceDistribution::postCrossFaces(), Foam::pow(), cloudFlux::preCrossFaces(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), motionSmootherAlgo::setDisplacement(), motionSmootherAlgo::setDisplacementPatchFields(), Foam::setRefCell(), SlicedGeometricField< Type, GeoMesh >::SlicedGeometricField(), Foam::fvc::smooth(), snGradScheme< Type >::sndGrad(), snGradScheme< Type >::snGrad(), Foam::fvc::snGrad(), LagrangianModels::source(), Foam::fvc::spread(), Foam::sqr(), fvMeshToFvMesh::srcToTgt(), Foam::stabilise(), MPLIC::surfaceAlpha(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceIntegrateExtrapolate(), Foam::fvc::surfaceSum(), Foam::surfaceToVolVelocity(), Foam::fvc::sweep(), LagrangianMesh::track(), LagrangianSubMesh::Uf(), conformedFvsPatchField< Type >::unconform(), conformedFvPatchField< Type >::unconform(), prghCyclicPressureFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), velocityGroup::velocityGroup(), Foam::fvc::volumeIntegrate(), XiCorrModel::XiCorr(), and wallLubricationModel::zeroGradWalls().

Here is the caller graph for this function:

◆ dimensions() [1/2]

const Foam::dimensionSet & dimensions
inline

Return dimensions.

Definition at line 48 of file DimensionedFieldI.H.

Referenced by accumulationScheme< Type >::accumulate(), fvSpecificSource::addSupType(), fvTotalSource::addSupType(), massTransfer::addSupType(), LehrMilliesMewes::addToBinaryBreakupRate(), advectiveFvPatchField< Type >::advectionSpeed(), waveTransmissiveFvPatchField< Type >::advectionSpeed(), advectiveFvPatchField< Type >::advectiveFvPatchField(), alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField(), compressibleVoF::alphaSuSp(), Foam::atan2(), atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), Foam::fvc::average(), cellCoBlended< Type >::blendingFactor(), CoBlended< Type >::blendingFactor(), XiFluid::bSolve(), Foam::checkMethod(), dynamicKEqn< BasicMomentumTransportModel >::Ck(), Foam::cmptAv(), constSolidThermo::constSolidThermo(), contactAngleFvPatchScalarField::contactAngleFvPatchScalarField(), transport::correct(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), limitedSnGrad< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), Foam::fv::correctPhi(), coupledTemperatureFvPatchScalarField::coupledTemperatureFvPatchScalarField(), pointFieldDecomposer::decomposeField(), fvFieldDecomposer::decomposeFvSurfaceField(), fvFieldDecomposer::decomposeVolField(), fvFieldDecomposer::decomposeVolInternalField(), Fickian< BasicThermophysicalTransportModel >::divq(), MaxwellStefan< BasicThermophysicalTransportModel >::divq(), Foam::fvc::domainIntegrate(), dynamicPressureFvPatchScalarField::dynamicPressureFvPatchScalarField(), fluxCorrectedVelocityFvPatchVectorField::evaluate(), age::execute(), phaseScalarTransport::execute(), scalarTransport::execute(), externalCoupledMixedFvPatchField< Type >::externalCoupledMixedFvPatchField(), externalTemperatureFvPatchScalarField::externalTemperatureFvPatchScalarField(), fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField(), CloudDerivedField< Type >::field(), filmSurfaceVelocityFvPatchVectorField::filmSurfaceVelocityFvPatchVectorField(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedJumpFvPatchField< Type >::fixedJumpFvPatchField(), fixedMeanOutletInletFvPatchField< Type >::fixedMeanOutletInletFvPatchField(), fixedNormalInletOutletVelocityFvPatchVectorField::fixedNormalInletOutletVelocityFvPatchVectorField(), flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField(), flowRateOutletVelocityFvPatchVectorField::flowRateOutletVelocityFvPatchVectorField(), freestreamFvPatchField< Type >::freestreamFvPatchField(), freestreamPressureFvPatchScalarField::freestreamPressureFvPatchScalarField(), freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField(), faceCorrectedSnGrad< Type >::fullGradCorrection(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), CrankNicolsonDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), steadyStateDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr(), steadyStateDdtScheme< Type >::fvcDdtUfCorr(), backwardDdtScheme< Type >::fvcDdtUfCorr(), CoEulerDdtScheme< Type >::fvcDdtUfCorr(), EulerDdtScheme< Type >::fvcDdtUfCorr(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), SLTSDdtScheme< Type >::fvcDdtUfCorr(), EulerD2dt2Scheme< Type >::fvmD2dt2(), steadyStateD2dt2Scheme< Type >::fvmD2dt2(), backwardDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), steadyStateDdtScheme< Type >::fvmDdt(), ddtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), SpalartAllmaras< BasicMomentumTransportModel >::fw(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::greyDiffusiveViewFactorFixedValueFvPatchScalarField(), fvMatrix< Type >::H(), inletOutletFvPatchField< Type >::inletOutletFvPatchField(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), surfaceInterpolationScheme< scalar >::interpolate(), singleCellFvMesh::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), fvMeshSubset::interpolate(), volPointInterpolation::interpolate(), Foam::isFlux< scalar >(), JohnsonJacksonParticleSlipFvPatchVectorField::JohnsonJacksonParticleSlipFvPatchVectorField(), JohnsonJacksonParticleThetaFvPatchScalarField::JohnsonJacksonParticleThetaFvPatchScalarField(), CrankNicolson< Type >::LagrangianmDdt(), Foam::mag(), Foam::magSqr(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), PatchFlowRateInjection< CloudType >::massFlowRate(), matchedFlowRateOutletVelocityFvPatchVectorField::matchedFlowRateOutletVelocityFvPatchVectorField(), maxwellSlipUFvPatchVectorField::maxwellSlipUFvPatchVectorField(), mixedFvPatchField< Type >::mixedFvPatchField(), movingWallSlipVelocityFvPatchVectorField::movingWallSlipVelocityFvPatchVectorField(), MRFnoSlipFvPatchVectorField::MRFnoSlipFvPatchVectorField(), MRFslipFvPatchVectorField::MRFslipFvPatchVectorField(), BinghamPlastic::mu(), reuseTmpTmpDimensionedField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh, Field >::New(), reuseTmpTmpGeometricField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), reuseTmpGeometricField< TypeR, TypeR, GeoMesh, Field >::New(), LagrangianAverage< Type >::New(), DimensionedField< Type, GeoMesh, PrimitiveField >::operator=(), GeometricField< Type, GeoMesh, PrimitiveField >::operator=(), GeometricField< Type, GeoMesh, PrimitiveField >::operator==(), outletInletFvPatchField< Type >::outletInletFvPatchField(), outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField(), phaseHydrostaticPressureFvPatchScalarField::phaseHydrostaticPressureFvPatchScalarField(), phasePressureModel::phasePressureModel(), Foam::pow(), incompressibleMultiphaseVoF::pressureCorrector(), pressureDirectedInletOutletVelocityFvPatchVectorField::pressureDirectedInletOutletVelocityFvPatchVectorField(), pressureFvPatchScalarField::pressureFvPatchScalarField(), pressureInletOutletParSlipVelocityFvPatchVectorField::pressureInletOutletParSlipVelocityFvPatchVectorField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), pressureNormalInletOutletVelocityFvPatchVectorField::pressureNormalInletOutletVelocityFvPatchVectorField(), prghCyclicPressureFvPatchScalarField::prghCyclicPressureFvPatchScalarField(), Fickian< BasicThermophysicalTransportModel >::q(), MaxwellStefan< BasicThermophysicalTransportModel >::q(), SpalartAllmarasDES< BasicMomentumTransportModel >::r(), turbulentBreakUp::R(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), DimensionedField< Type, GeoMesh, PrimitiveField >::reset(), GeometricField< Type, GeoMesh, PrimitiveField >::reset(), rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField(), skewCorrected< Type >::skewCorrection(), smoluchowskiJumpTFvPatchScalarField::smoluchowskiJumpTFvPatchScalarField(), snGradScheme< Type >::snGrad(), specieTransferMassFractionFvPatchScalarField::specieTransferMassFractionFvPatchScalarField(), specieTransferTemperatureFvPatchScalarField::specieTransferTemperatureFvPatchScalarField(), Foam::sqr(), Foam::stabilise(), LagrangianSubMesh::sub(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceIntegrateExtrapolate(), Foam::fvc::surfaceSum(), Foam::surfaceToVolVelocity(), swirlFlowRateInletVelocityFvPatchVectorField::swirlFlowRateInletVelocityFvPatchVectorField(), swirlInletVelocityFvPatchVectorField::swirlInletVelocityFvPatchVectorField(), thermalBaffle1DFvPatchScalarField< solidType >::thermalBaffle1DFvPatchScalarField(), timeVaryingMappedFixedValueFvPatchField< Type >::timeVaryingMappedFixedValueFvPatchField(), timeVaryingMappedFixedValuePointPatchField< Type >::timeVaryingMappedFixedValuePointPatchField(), timeVaryingMappedFvPatchField< Type >::timeVaryingMappedFvPatchField(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::totalFlowRateAdvectiveDiffusiveFvPatchScalarField(), totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField(), transonicEntrainmentPressureFvPatchScalarField::transonicEntrainmentPressureFvPatchScalarField(), turbulentInletFvPatchField< Type >::turbulentInletFvPatchField(), turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), uniformDensityHydrostaticPressureFvPatchScalarField::uniformDensityHydrostaticPressureFvPatchScalarField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField(), uniformJumpFvPatchField< Type >::uniformJumpFvPatchField(), uniformTotalPressureFvPatchScalarField::uniformTotalPressureFvPatchScalarField(), entrainmentPressureFvPatchScalarField::updateCoeffs(), mappedFlowRateVelocityFvPatchVectorField::updateCoeffs(), pressureDirectedInletOutletVelocityFvPatchVectorField::updateCoeffs(), pressureDirectedInletVelocityFvPatchVectorField::updateCoeffs(), pressureInletOutletParSlipVelocityFvPatchVectorField::updateCoeffs(), pressureInletVelocityFvPatchVectorField::updateCoeffs(), pressureNormalInletOutletVelocityFvPatchVectorField::updateCoeffs(), syringePressureFvPatchScalarField::updateCoeffs(), transonicEntrainmentPressureFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), totalPressureVelocityLagrangianVectorFieldSource::value(), valuePointPatchField< Type >::valuePointPatchField(), variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField(), PatchFlowRateInjection< CloudType >::volumetricFlowRate(), waveAlphaFvPatchScalarField::waveAlphaFvPatchScalarField(), waveInletOutletFvPatchField< Type >::waveInletOutletFvPatchField(), waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), Gulder::XiEq(), and zeroInletOutletFvPatchField< Type >::zeroInletOutletFvPatchField().

◆ dimensions() [2/2]

Foam::dimensionSet & dimensions
inline

Return non-const access to dimensions.

Definition at line 55 of file DimensionedFieldI.H.

◆ primitiveFieldRef()

PrimitiveField< Type > & primitiveFieldRef

◆ primitiveField()

◆ USING_OLD_TIME_FIELD()

USING_OLD_TIME_FIELD ( DimensionedField< Type, GeoMesh, PrimitiveField >  )

Use old-time methods from the base class.

◆ component()

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

Return a component field of the field.

◆ replace() [1/4]

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

Replace a component field of the field.

◆ replace() [2/4]

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

Replace a component field of the field.

◆ T()

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

Definition at line 611 of file DimensionedField.C.

References Foam::name(), tmp< T >::ref(), and Foam::T().

Referenced by ballisticCollisions::addToCoalescenceRate(), BrownianCollisions::addToCoalescenceRate(), massDiffusionLimitedPhaseChange::correct(), BrownianCollisions::precompute(), and phaseChange::Tchange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ average()

dimensioned< Type > average

Calculate and return arithmetic average.

Definition at line 631 of file DimensionedField.C.

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

Here is the call graph for this function:

◆ weightedAverage() [1/2]

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

Calculate and return weighted average.

Definition at line 647 of file DimensionedField.C.

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

Referenced by fluidSolver::continuityErrors(), velocityGroup::correct(), populationBalanceModel::solve(), and phaseSystem::solve().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ weightedAverage() [2/2]

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

Calculate and return weighted average.

Definition at line 667 of file DimensionedField.C.

◆ reset() [1/3]

void reset ( const DimensionedField< Type, GeoMesh, PrimitiveField2 > &  df)

Reset the field values to the given field.

Used for mesh to mesh mapping

Definition at line 680 of file DimensionedField.C.

References checkFieldAssignment, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), and DimensionedField< Type, GeoMesh, PrimitiveField >::primitiveField().

Here is the call graph for this function:

◆ reset() [2/3]

void reset ( const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &  tdf)

Reset the field values to the given tmp-field.

Used for mesh to mesh mapping

Definition at line 693 of file DimensionedField.C.

References checkFieldAssignment, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), and DimensionedField< Type, GeoMesh, PrimitiveField >::primitiveField().

Here is the call graph for this function:

◆ reset() [3/3]

void reset ( const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &  tdf)

Reset the field values to the given tmp-field.

Used for mesh to mesh mapping

Definition at line 719 of file DimensionedField.C.

◆ writeData() [1/2]

bool writeData ( Ostream os,
const word fieldDictEntry 
) const

Definition at line 129 of file DimensionedFieldIO.C.

References IOstream::check(), Foam::dimensions(), IOstream::good(), Foam::nl, and Foam::writeEntry().

Here is the call graph for this function:

◆ writeData() [2/2]

bool writeData ( Ostream ) const
virtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Reimplemented in GeometricField< Type, GeoMesh, PrimitiveField >, GeometricField< symmTensor >, GeometricField< Type, pointMesh, Field >, GeometricField< scalar >, GeometricField< vector >, GeometricField< Type >, and GeometricField< Type, GeoMesh >.

Definition at line 157 of file DimensionedFieldIO.C.

References writeData().

Here is the call graph for this function:

◆ operator=() [1/7]

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

Definition at line 733 of file DimensionedField.C.

References checkFieldAssignment, checkFieldOperation, and DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions().

Here is the call graph for this function:

◆ operator=() [2/7]

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

Definition at line 747 of file DimensionedField.C.

References checkFieldAssignment, checkFieldOperation, and DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions().

Here is the call graph for this function:

◆ operator=() [3/7]

◆ operator=() [4/7]

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

Definition at line 788 of file DimensionedField.C.

References checkFieldOperation, and DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions().

Here is the call graph for this function:

◆ operator=() [5/7]

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

Definition at line 802 of file DimensionedField.C.

References checkFieldOperation, and DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions().

Here is the call graph for this function:

◆ operator=() [6/7]

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

Definition at line 818 of file DimensionedField.C.

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

Here is the call graph for this function:

◆ operator=() [7/7]

void operator= ( const zero )

Definition at line 829 of file DimensionedField.C.

References Foam::Zero.

◆ operator==() [1/4]

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

Definition at line 837 of file DimensionedField.C.

◆ operator==() [2/4]

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

Definition at line 848 of file DimensionedField.C.

◆ operator==() [3/4]

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

Definition at line 858 of file DimensionedField.C.

◆ operator==() [4/4]

void operator== ( const zero )

Definition at line 868 of file DimensionedField.C.

References Foam::Zero.

◆ operator+=() [1/3]

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

Definition at line 910 of file DimensionedField.C.

◆ operator+=() [2/3]

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

Definition at line 910 of file DimensionedField.C.

◆ operator+=() [3/3]

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

Definition at line 910 of file DimensionedField.C.

◆ operator-=() [1/3]

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

Definition at line 911 of file DimensionedField.C.

◆ operator-=() [2/3]

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

Definition at line 911 of file DimensionedField.C.

◆ operator-=() [3/3]

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

Definition at line 911 of file DimensionedField.C.

◆ operator*=() [1/3]

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

Definition at line 912 of file DimensionedField.C.

◆ operator*=() [2/3]

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

Definition at line 912 of file DimensionedField.C.

◆ operator*=() [3/3]

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

Definition at line 912 of file DimensionedField.C.

◆ operator/=() [1/3]

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

Definition at line 913 of file DimensionedField.C.

◆ operator/=() [2/3]

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

Definition at line 913 of file DimensionedField.C.

◆ operator/=() [3/3]

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

Definition at line 913 of file DimensionedField.C.

◆ New() [6/6]

Foam::tmp<Foam::DimensionedField<Type, GeoMesh, PrimitiveField> > New ( const word newName,
const DimensionedField< Type, GeoMesh, PrimitiveField2 > &  df 
)

Definition at line 459 of file DimensionedField.C.

◆ replace() [3/4]

void replace ( const direction  d,
const DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &  df 
)

Definition at line 573 of file DimensionedField.C.

◆ replace() [4/4]

void replace ( const direction  d,
const tmp< DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &  tdf 
)

Definition at line 590 of file DimensionedField.C.

Friends And Related Function Documentation

◆ DimensionedField

friend class DimensionedField
friend

Declare friendship with other dimensioned fields.

Definition at line 125 of file DimensionedField.H.

◆ operator [1/2]

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

◆ operator [2/2]

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

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