Moment lagrangian averaging procedure. More...
Public Types | |
| typedef AveragingMethod< Type >::TypeGrad | TypeGrad |
| Public typedefs. 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, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, 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, LEGACY_REGISTER = 2 } |
| Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
| Public Types inherited from FieldField< Field, Type > | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type. More... | |
| Public Types inherited from UPtrList< T > | |
| typedef T | value_type |
| Type of values the list contains. More... | |
| typedef T & | reference |
| A non-const reference to the value_type. More... | |
| typedef const T & | const_reference |
| A const reference to the value_type. More... | |
Public Member Functions | |
| TypeName ("moment") | |
| Runtime type information. More... | |
| Moment (const IOobject &io, const dictionary &dict, const fvMesh &mesh) | |
| Constructors. More... | |
| Moment (const Moment< Type > &am) | |
| Construct a copy. More... | |
| virtual autoPtr< AveragingMethod< Type > > | clone () const |
| Construct and return a clone. More... | |
| virtual | ~Moment () |
| Destructor. More... | |
| void | add (const barycentric &coordinates, const tetIndices &tetIs, const Type &value) |
| Member Functions. More... | |
| Type | interpolate (const barycentric &coordinates, const tetIndices &tetIs) const |
| Interpolate. More... | |
| TypeGrad | interpolateGrad (const barycentric &coordinates, const tetIndices &tetIs) const |
| Interpolate gradient. More... | |
| tmp< Field< Type > > | primitiveField () const |
| Return an internal field of the average. More... | |
| tmp< Field< TypeGrad > > | internalFieldGrad () const |
| Return an internal field of the gradient. More... | |
| Public Member Functions inherited from AveragingMethod< Type > | |
| TypeName ("averagingMethod") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, AveragingMethod, dictionary,(const IOobject &io, const dictionary &dict, const fvMesh &mesh),(io, dict, mesh)) | |
| Declare runtime constructor selection table. More... | |
| AveragingMethod (const IOobject &io, const dictionary &dict, const fvMesh &mesh, const labelList &size) | |
| Constructors. More... | |
| AveragingMethod (const AveragingMethod< Type > &am) | |
| Construct a copy. More... | |
| virtual | ~AveragingMethod ()=default |
| Destructor. More... | |
| virtual void | average () |
| Calculate the average. More... | |
| virtual void | average (const AveragingMethod< scalar > &weight) |
| virtual bool | writeData (Ostream &) const |
| Dummy write. More... | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. More... | |
| void | operator= (const AveragingMethod< Type > &x) |
| Assign to another average. More... | |
| void | operator= (const Type &x) |
| Assign to value. More... | |
| void | operator= (tmp< FieldField< Field, Type >> x) |
| Assign to tmp. More... | |
| void | operator+= (tmp< FieldField< Field, Type >> x) |
| Add-equal tmp. More... | |
| void | operator*= (tmp< FieldField< Field, Type >> x) |
| Multiply-equal tmp. More... | |
| void | operator/= (tmp< FieldField< Field, scalar >> x) |
| Divide-equal tmp. More... | |
| Public Member Functions inherited from regIOobject | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. More... | |
| 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 if 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 readOnProc=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 writeOnProc) const |
| Write using stream options. 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 writeOnProc) 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... | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. 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 noexcept |
| 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... | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. 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 noexcept |
| Return the Time::rootPath() More... | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName() More... | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName() 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 for the object (with instance, local,...). More... | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...) More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | globalObjectPath () const |
| The complete global 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 (respects is_globalIOobject trait) and check its info. More... | |
| template<class Type > | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. 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 noexcept |
| 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) |
| template<class Type > | |
| Foam::fileName | typeFilePath (const bool search) const |
| 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 | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ) More... | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. 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 FieldField< Field, Type > | |
| constexpr | FieldField () noexcept |
| Construct null. More... | |
| FieldField (const label size) | |
| Construct given size. More... | |
| FieldField (const word &type, const FieldField< Field, Type > &ff) | |
| Clone construct with new type. More... | |
| FieldField (const FieldField< Field, Type > &ff) | |
| Copy construct, cloning each element. More... | |
| FieldField (FieldField< Field, Type > &&ff) | |
| Move construct. More... | |
| FieldField (FieldField< Field, Type > &ff, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| FieldField (const PtrList< Field< Type >> &list) | |
| Copy construct from PtrList. More... | |
| FieldField (PtrList< Field< Type >> &&list) | |
| Move construct from PtrList. More... | |
| FieldField (const tmp< FieldField< Field, Type >> &tf) | |
| Move/copy construct from tmp<FieldField> More... | |
| FieldField (Istream &is) | |
| Construct from Istream. More... | |
| tmp< FieldField< Field, Type > > | clone () const |
| Clone. More... | |
| void | negate () |
| Negate this field. See notes in Field. More... | |
| void | normalise () |
| Normalise this field. See notes in Field. More... | |
| tmp< FieldField< Field, cmptType > > | component (const direction) const |
| Return a component field of the field. More... | |
| void | replace (const direction, const FieldField< Field, cmptType > &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const cmptType &) |
| Replace a component field of the field. More... | |
| void | clamp_min (const Type &lower) |
| Impose lower (floor) clamp on the field values (in-place) More... | |
| void | clamp_max (const Type &upper) |
| Impose upper (ceiling) clamp on the field values (in-place) More... | |
| void | clamp_range (const Type &lower, const Type &upper) |
| Clamp field values (in-place) to the specified range. More... | |
| void | clamp_range (const MinMax< Type > &range) |
| Clamp field values (in-place) to the specified range. More... | |
| tmp< FieldField< Field, Type > > | T () const |
| Return the field transpose (only defined for second rank tensors) More... | |
| const Type & | operator[] (const labelPair &index) const |
| Const access to a single field element via (fieldi, elemi) More... | |
| Type & | operator[] (const labelPair &index) |
| Non-const access to a single field element via (fieldi, elemi) More... | |
| void | operator= (const FieldField< Field, Type > &) |
| Copy assignment. More... | |
| void | operator= (FieldField< Field, Type > &&) |
| Move assignment. More... | |
| void | operator= (const tmp< FieldField< Field, Type >> &) |
| Move or clone assignment. More... | |
| void | operator= (const Type &val) |
| Assign uniform value. More... | |
| void | operator= (const Foam::zero) |
| Assign uniform zero. More... | |
| void | operator+= (const FieldField< Field, Type > &) |
| void | operator+= (const tmp< FieldField< Field, Type >> &) |
| void | operator-= (const FieldField< Field, Type > &) |
| void | operator-= (const tmp< FieldField< Field, Type >> &) |
| void | operator*= (const FieldField< Field, scalar > &) |
| void | operator*= (const tmp< FieldField< Field, scalar >> &) |
| void | operator/= (const FieldField< Field, scalar > &) |
| void | operator/= (const tmp< FieldField< Field, scalar >> &) |
| void | operator+= (const Type &) |
| void | operator-= (const Type &) |
| void | operator*= (const scalar &) |
| void | operator/= (const scalar &) |
| Public Member Functions inherited from refCount | |
| constexpr | refCount () noexcept |
| Default construct, initializing count to 0. More... | |
| int | use_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 PtrList< Field< Type > > | |
| constexpr | PtrList () noexcept |
| Default construct. More... | |
| PtrList (const label len) | |
| Construct with specified size, each element initialized to nullptr. More... | |
| PtrList (const PtrList< Field< Type > > &list) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< Field< Type > > &&list) noexcept | |
| Move construct. More... | |
| PtrList (UList< Field< Type > * > &list) | |
| Take ownership of pointers in the list, set old pointers to null. More... | |
| PtrList (const PtrList< Field< Type > > &list, const CloneArg &cloneArgs) | |
| Copy construct using 'clone()' method on each element. More... | |
| PtrList (PtrList< Field< Type > > &list, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< Field< Type > > &list) | |
| Copy construct using 'clone()' on each element of SLPtrList<T> More... | |
| PtrList (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrList (Istream &is) | |
| Construct from Istream using default Istream constructor class. More... | |
| ~PtrList () | |
| Destructor. Frees all pointers. More... | |
| PtrList< Field< Type > > | clone (Args &&... args) const |
| Make a copy by cloning each of the list elements. More... | |
| Foam::PtrList< Field< Type > > | clone (Args &&... args) const |
| const Field< Type > * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| autoPtr< Field< Type > > | set (const label i, Field< Type > *ptr) |
| Set element to given pointer and return old element (can be null) More... | |
| autoPtr< Field< Type > > | set (const label i, std::unique_ptr< Field< Type > > &&ptr) |
| Set element to given unique_ptr and return old element. More... | |
| autoPtr< Field< Type > > | set (const label i, autoPtr< Field< Type > > &&ptr) |
| Set element to given autoPtr and return old element. More... | |
| autoPtr< Field< Type > > | set (const label i, const refPtr< Field< Type > > &ptr) |
| Set element to given refPtr and return old element. More... | |
| autoPtr< Field< Type > > | set (const label i, const tmp< Field< Type > > &ptr) |
| Set element to given tmp and return old element. More... | |
| autoPtr< Field< Type > > | set (const label i, autoPtr< Field< Type > > &ptr) |
| Set element to given autoPtr and return old element. More... | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. More... | |
| void | free () |
| Free memory and nullify all entries. Does not change the list size. More... | |
| void | resize (const label newLen) |
| Adjust size of PtrList. More... | |
| void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. More... | |
| Field< Type > & | emplace_back (Args &&... args) |
| Construct and append an element to the end of the list, return reference to the new list element. More... | |
| void | push_back (Field< Type > *ptr) |
| Append an element to the end of the list. More... | |
| void | push_back (std::unique_ptr< Field< Type > > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | push_back (autoPtr< Field< Type > > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | push_back (const refPtr< Field< Type > > &ptr) |
| Move or clone append a refPtr to the end of the list. More... | |
| void | push_back (const tmp< Field< Type > > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | push_back (PtrList< Field< Type > > &&other) |
| Move append another list to the end of this list. More... | |
| void | push_back (autoPtr< Field< Type > > &ptr)=delete |
| Disallow push_back with autoPtr without std::move. More... | |
| Field< Type > & | emplace_set (const label i, Args &&... args) |
| Construct and set a new element at given position, (discard old element at that location). More... | |
| Field< Type > & | emplace (const label i, Args &&... args) |
| Same as emplace_set() More... | |
| Field< Type > & | try_emplace (const label i, Args &&... args) |
| Like emplace_set() but will not overwrite an occupied (non-null) location. More... | |
| autoPtr< Field< Type > > | release (const label i) |
| Release ownership of the pointer at the given position. More... | |
| void | transfer (PtrList< Field< Type > > &list) |
| Transfer into this list and annul the argument list. More... | |
| void | operator= (const PtrList< Field< Type > > &list) |
| Copy assignment. More... | |
| void | operator= (PtrList< Field< Type > > &&list) |
| Move assignment. More... | |
| void | setSize (const label newLen) |
| Same as resize() More... | |
| void | append (autoPtr< Field< Type > > &ptr) |
| Move append an element to the end of the list. More... | |
| void | append (Field< Type > *ptr) |
| Append an element to the end of the list. More... | |
| void | append (std::unique_ptr< Field< Type > > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (autoPtr< Field< Type > > &&ptr) |
| Move append an element to the end of the list. More... | |
| void | append (const refPtr< Field< Type > > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | append (const tmp< Field< Type > > &ptr) |
| Move or clone append a tmp to the end of the list. More... | |
| void | append (PtrList< Field< Type > > &&other) |
| Move append another list to the end of this list. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| constexpr | UPtrList () noexcept=default |
| Default construct. More... | |
| UPtrList (const label len) | |
Construct with specified size and set all entries to nullptr. More... | |
| UPtrList (const UPtrList< T > &list) | |
| Copy construct (shallow copies addresses) More... | |
| UPtrList (UPtrList< T > &&list) noexcept | |
| Move construct. More... | |
| UPtrList (UPtrList< T > &list, bool reuse) | |
| Construct as shallow copy or re-use as specified. More... | |
| UPtrList (PtrList< T > &list) | |
| Shallow copy from PtrList. More... | |
| UPtrList (const UList< T *> &list) | |
| Construct from UList of pointers (shallow copy) More... | |
| UPtrList (UList< T > &list) | |
| Construct from UList, taking the address of each list element. More... | |
| bool | empty () const noexcept |
| True if the list is empty (ie, size() is zero) More... | |
| label | size () const noexcept |
| The number of entries in the list. More... | |
| label | capacity () const noexcept |
| Size of the underlying storage. More... | |
| label | count () const noexcept |
| The number of non-null entries in the list. More... | |
| T & | front () |
| Reference to the first element of the list. More... | |
| const T & | front () const |
| Reference to first element of the list. More... | |
| T & | back () |
| Reference to the last element of the list. More... | |
| const T & | back () const |
| Reference to the last element of the list. More... | |
| const T * | test (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| const T * | get (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| T * | get (const label i) |
| Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| const T * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
| void | clear () |
| Set list size to zero. More... | |
| void | free () |
| Nullify all entries. Does not change the list size. More... | |
| void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr. More... | |
| void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr. More... | |
| label | squeezeNull () |
| Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More... | |
| void | trimTrailingNull () |
| Reduce addressable list size to ignore any trailing null pointers. More... | |
| void | push_back (T *ptr) |
| Append an element to the end of the list. More... | |
| void | push_back (UPtrList< T > &&other) |
| Move append another list to the end of this list. More... | |
| void | swap (UPtrList< T > &list) noexcept |
| Swap content. More... | |
| void | transfer (UPtrList< T > &list) |
| Transfer contents into this list and annul the argument. More... | |
| T * | set (const label i, T *ptr) |
| Set element to specified pointer and return the old list element, which can be a nullptr. More... | |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| Reorder elements. Reordering must be unique (ie, shuffle). More... | |
| void | sortOrder (const labelUList &order, const bool check=false) |
| Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More... | |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. More... | |
| const T & | at (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
| T & | at (const label i) |
| Return reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
| const T & | operator[] (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
| T & | operator[] (const label i) |
| Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
| FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const | |
| Deprecated(2022-09) - same as get() More... | |
| void | operator= (const UPtrList< T > &list) |
| Copy assignment (shallow copies addresses) More... | |
| void | operator= (UPtrList< T > &&list) |
| Move assignment. More... | |
| T ** | begin_ptr () noexcept |
| Iterator to begin of raw pointers traversal (use with caution) More... | |
| T ** | end_ptr () noexcept |
| Iterator beyond end of raw pointers traversal (use with caution) More... | |
| iterator | begin () |
| Return iterator to begin traversal of non-nullptr entries. More... | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. More... | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversal of non-nullptr entries. More... | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversal of non-nullptr entries. More... | |
| const_iterator | end () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
| void | setSize (const label n) |
| Alias for resize() More... | |
| T & | first () |
| Reference to the first element of the list. More... | |
| const T & | first () const |
| Return reference to first element of the list. More... | |
| T & | last () |
| Return reference to the last element of the list. More... | |
| const T & | last () const |
| Return reference to the last element of the list. More... | |
| void | append (T *ptr) |
| Append an element to the end of the list. More... | |
| void | append (UPtrList< T > &&other) |
| Move append another list to the end of this list. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from AveragingMethod< Type > | |
| static autoPtr< AveragingMethod< Type > > | New (const IOobject &io, const dictionary &dict, const fvMesh &mesh) |
| Selector. 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 word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 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 | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ) More... | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
| Static Public Member Functions inherited from FieldField< Field, Type > | |
| template<class Type2 > | |
| static tmp< FieldField< Field, Type > > | NewCalculatedType (const FieldField< Field, Type2 > &ff) |
| Return a pointer to a new calculatedFvPatchFieldField created on. More... | |
| 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... | |
| Protected Types inherited from AveragingMethod< Type > | |
| typedef outerProduct< vector, Type >::type | TypeGrad |
| Protected typedefs. 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 PtrList< Field< Type > > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. More... | |
| Protected Member Functions inherited from UPtrList< T > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. More... | |
| label | find_next (label pos) const |
| The next non-null entry after the specified position. More... | |
| UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept | |
| Low-level move construct. 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... | |
| Protected Attributes inherited from AveragingMethod< Type > | |
| const dictionary & | dict_ |
| Protected data. More... | |
| const fvMesh & | mesh_ |
| The mesh on which the averaging is to be done. More... | |
| Protected Attributes inherited from UPtrList< T > | |
| Detail::PtrListDetail< T > | ptrs_ |
| The list of pointers. More... | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Moment lagrangian averaging procedure.
Point values and moments from the cell centroid are summed over computational cells. A linear function is generated which has the same integrated moment as that of the point data.
The computed linear function is used to interpolate values within a cell. The gradient is calculated from the coefficients of the function, and is assumed constant over the cell.
| typedef AveragingMethod<Type>::TypeGrad TypeGrad |
| Moment | ( | const IOobject & | io, |
| const dictionary & | dict, | ||
| const fvMesh & | mesh | ||
| ) |
Constructors.
Construct from components
Definition at line 28 of file Moment.C.
References A, Foam::constant::physicoChemical::b, Foam::constant::universal::c, tetIndices::faceTriIs(), forAll, Foam::inv(), tetrahedron< Point, PointRef >::mag(), mesh, Foam::sqr(), Foam::sum(), T, tetIndices::tet(), and Foam::Zero.
| TypeName | ( | "moment" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Implements AveragingMethod< Type >.
|
virtual |
Member Functions.
Add point value to interpolation
Implements AveragingMethod< Type >.
Definition at line 125 of file Moment.C.
References tetIndices::cell(), coordinates(), delta, and tetIndices::faceTriIs().
|
virtual |
Interpolate.
Implements AveragingMethod< Type >.
Definition at line 152 of file Moment.C.
References tetIndices::cell(), coordinates(), delta, and tetIndices::faceTriIs().
|
virtual |
Interpolate gradient.
Implements AveragingMethod< Type >.
Definition at line 183 of file Moment.C.
References tetIndices::cell().
|
virtual |
Return an internal field of the average.
Implements AveragingMethod< Type >.
1.8.14 