A primitive field of type <T> with automated input and output. More...
#include <IOField.H>
Public Types | |
| typedef Field< Type > | content_type |
| The underlying content type. | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). 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... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Public Types inherited from Field< Type > | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type. | |
| typedef SubField< Type > | subField |
| Declare type of subField. | |
| Public Types inherited from List< Type > | |
| typedef SubList< Type > | subList |
| Declare type of subList. | |
| Public Types inherited from UList< Type > | |
| typedef Type | value_type |
| The value type the list contains. | |
| typedef Type * | pointer |
| The pointer type for non-const access to value_type items. | |
| typedef const Type * | const_pointer |
| The pointer type for const access to value_type items. | |
| typedef Type & | reference |
| The type used for storing into value_type objects. | |
| typedef const Type & | const_reference |
| The type used for reading from constant value_type objects. | |
| typedef Type * | iterator |
| Random access iterator for traversing a UList. | |
| typedef const Type * | const_iterator |
| Random access iterator for traversing a UList. | |
| typedef label | size_type |
| The type to represent the size of a UList. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access). | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access). | |
| using | is_List |
| Have unique tag. | |
Public Member Functions | |
| TypeName ("Field") | |
| Runtime type information. | |
| IOField (const IOField &)=default | |
| Default copy construct. | |
| IOField (const IOobject &io) | |
| Construct from IOobject. Will be zero size if not read. | |
| IOField (const IOobject &io, const bool readOnProc) | |
| Construct from IOobject, with local processor conditional reading. | |
| IOField (const IOobject &io, Foam::zero) | |
| Construct from IOobject and zero size (if not read). | |
| IOField (const IOobject &io, const label len) | |
| Construct from IOobject and field size (if not read). | |
| IOField (const IOobject &io, const UList< Type > &content) | |
| Construct from IOobject and copy of List/Field content. | |
| IOField (const IOobject &io, Field< Type > &&content) | |
| Construct by transferring the Field content. | |
| IOField (const IOobject &io, const tmp< Field< Type > > &tfld) | |
| Construct by copying/moving tmp content. | |
| virtual | ~IOField ()=default |
| Destructor. | |
| virtual bool | writeData (Ostream &os) const |
| The writeData method for regIOobject write operation. | |
| void | operator= (const IOField< Type > &rhs) |
| Copy assignment of entries. | |
| void | operator= (IOField< Type > &&rhs) |
| Move assignment of entries. | |
| Public Member Functions inherited from regIOobject | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| 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). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| 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. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | readData (Istream &) |
| Virtual readData function. | |
| virtual bool | read () |
| Read object. | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time). | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified). | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. | |
| virtual bool | global () const |
| Is object global. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| 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. | |
| 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. | |
| 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. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| 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. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| 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. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
| Public Member Functions inherited from Field< Type > | |
| constexpr | Field () noexcept |
| Default construct. | |
| Field (const label len) | |
| Construct given size. | |
| Field (const label len, const Type &val) | |
| Construct given size and initial value. | |
| Field (const label len, Foam::zero) | |
| Construct given size and initial values of zero. | |
| Field (Foam::one, const Type &val) | |
| Construct with length=1, copying the value as the only content. | |
| Field (Foam::one, Type &&val) | |
| Construct with length=1, moving the value as the only content. | |
| Field (Foam::one, Foam::zero) | |
| Construct with length=1, initializing content to zero. | |
| Field (const Field< Type > &fld) | |
| Copy construct. | |
| Field (const UList< Type > &list) | |
| Copy construct from UList<Type>. | |
| template<class Addr> | |
| Field (const IndirectListBase< Type, Addr > &list) | |
| Copy construct from IndirectList. | |
| Field (Field< Type > &&fld) noexcept | |
| Move construct from Field. | |
| Field (List< Type > &&list) noexcept | |
| Move construct from List. | |
| template<int SizeMin> | |
| Field (DynamicList< Type, SizeMin > &&list) | |
| Move construct from DynamicList. | |
| Field (const UList< Type > &mapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given field. | |
| Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given tmp field. | |
| Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given field. | |
| Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given tmp field. | |
| Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given field. | |
| Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) | |
| Construct by mapping from the given field. | |
| Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) | |
| Construct by mapping from the given field. | |
| Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. | |
| Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. | |
| Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. Uses supplied values for unmapped items. | |
| Field (Field< Type > &fld, bool reuse) | |
| Copy construct or re-use as specified. | |
| Field (const tmp< Field< Type > > &tfld) | |
| Copy or move construct from tmp. | |
| Field (Istream &is) | |
| Construct from Istream. | |
| Field (const entry &e, const label len) | |
| Construct from a dictionary (primitive) entry. | |
| Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) | |
| Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): | |
| tmp< Field< Type > > | clone () const |
| Clone. | |
| void | assign (const entry &e, const label len) |
| Assign from a primitive dictionary entry with the following behaviour: | |
| bool | assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ) |
| Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). | |
| void | map (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given field | |
| void | map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given tmp field | |
| void | map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given field. | |
| void | map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given tmp field. | |
| void | map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given field. | |
| void | map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given tmp field. | |
| void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
| Map from self. | |
| void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given field | |
| void | rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given tmp field | |
| void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given field. | |
| void | rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given tmp field. | |
| void | negate () |
| Inplace negate this field (negative). | |
| void | normalise () |
| Inplace normalise this field. Generally a no-op except for vector fields. | |
| tmp< Field< cmptType > > | component (const direction) const |
| Return a component field of the field. | |
| void | replace (const direction, const UList< cmptType > &) |
| Replace a component field of the field. | |
| void | replace (const direction, const tmp< Field< cmptType > > &) |
| Replace a component field of the field. | |
| void | replace (const direction, const cmptType &) |
| Replace a component field of the field. | |
| void | clamp_min (const Type &lower) |
| Impose lower (floor) clamp on the field values (in-place). | |
| void | clamp_min (const UList< Type > &lower) |
| Impose lower (floor) clamp on the field values (in-place). | |
| void | clamp_max (const Type &upper) |
| Impose upper (ceiling) clamp on the field values (in-place). | |
| void | clamp_max (const UList< Type > &upper) |
| Impose upper (ceiling) clamp on the field values (in-place). | |
| void | clamp_range (const Type &lower, const Type &upper) |
| Clamp field values (in-place) to the specified range. | |
| void | clamp_range (const MinMax< Type > &range) |
| Clamp field values (in-place) to the specified range. | |
| template<class VSForm> | |
| VSForm | block (const label start) const |
| tmp< Field< Type > > | T () const |
| Return the field transpose (only defined for second rank tensors). | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the field as a dictionary entry. | |
| SubField< Type > | slice (const label pos, label len=-1) |
| Return SubField slice (non-const access) - no range checking. | |
| const SubField< Type > | slice (const label pos, label len=-1) const |
| Return SubField slice (const access) - no range checking. | |
| SubField< Type > | slice (const labelRange &range) |
| Return SubField slice (non-const access) - with range checking. | |
| const SubField< Type > | slice (const labelRange &range) const |
| Return SubField slice (const access) - with range checking. | |
| void | operator= (const Field< Type > &) |
| Copy assignment. | |
| void | operator= (const tmp< Field< Type > > &) |
| void | operator= (const UList< Type > &rhs) |
| void | operator= (const SubField< Type > &rhs) |
| template<class Addr> | |
| void | operator= (const IndirectListBase< Type, Addr > &rhs) |
| Copy assign from IndirectList. | |
| void | operator= (Field< Type > &&rhs) |
| Move assignment. | |
| void | operator= (List< Type > &&rhs) |
| template<int SizeMin> | |
| void | operator= (DynamicList< Type, SizeMin > &&rhs) |
| void | operator= (const Type &val) |
| Assign entries to the given value. | |
| void | operator= (Foam::zero) |
| Assign entries to zero. | |
| template<class Form, class Cmpt, direction nCmpt> | |
| void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
| void | operator+= (const UList< Type > &) |
| void | operator+= (const tmp< Field< Type > > &) |
| void | operator-= (const UList< Type > &) |
| void | operator-= (const tmp< Field< Type > > &) |
| void | operator*= (const UList< scalar > &) |
| void | operator*= (const tmp< Field< scalar > > &) |
| void | operator/= (const UList< scalar > &) |
| void | operator/= (const tmp< Field< scalar > > &) |
| void | operator+= (const Type &) |
| void | operator-= (const Type &) |
| void | operator*= (const scalar &) |
| void | operator/= (const scalar &) |
| template<typename E> | |
| Field (const Expression::ListExpression< E > &expr) | |
| Construct from value expression. | |
| template<typename E> | |
| void | operator= (const Expression::ListExpression< E > &expr) |
| Assign values from expression. | |
| template<class Type> | |
| void | operator= (const tmp< Field > &rhs) |
| void | normalise () |
| void | normalise () |
| void | normalise () |
| Inplace normalise (float) vector field. | |
| void | normalise () |
| Inplace normalise (double) vector field. | |
| Public Member Functions inherited from FieldBase | |
| constexpr | FieldBase () noexcept |
| Default construct. | |
| Public Member Functions inherited from refCount | |
| constexpr | refCount () noexcept |
| Default construct, initializing count to 0. | |
| int | use_count () const noexcept |
| Return the current reference count. | |
| bool | unique () const noexcept |
| Return true if the reference count is zero. | |
| void | operator++ () noexcept |
| Increment the reference count. | |
| void | operator++ (int) noexcept |
| Increment the reference count. | |
| void | operator-- () noexcept |
| Decrement the reference count. | |
| void | operator-- (int) noexcept |
| Decrement the reference count. | |
| Public Member Functions inherited from List< Type > | |
| constexpr | List () noexcept |
| Default construct. | |
| List (const label len) | |
| Construct with given size. | |
| List (const label len, const Type &val) | |
| Construct with given size and value for all elements. | |
| List (const label len, Foam::zero) | |
| Construct with given size initializing all elements to zero. | |
| List (Foam::one, const Type &val) | |
| Construct with length=1, copying the value as the only content. | |
| List (Foam::one, Type &&val) | |
| Construct with length=1, moving the value as the only content. | |
| List (Foam::one, Foam::zero) | |
| Construct with length=1, initializing content to zero. | |
| List (const List< Type > &list) | |
| Copy construct from list. | |
| List (const UList< Type > &list) | |
| Copy construct contents from list. | |
| List (List< Type > &list, bool reuse) | |
| Construct as copy or re-use as specified. | |
| List (const UList< Type > &list, const labelUList &indices) | |
| Copy construct subset of list. | |
| List (const UList< Type > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. | |
| List (const FixedList< Type, N > &list) | |
| Construct as copy of FixedList<T, N>. | |
| List (const UPtrList< Type > &list) | |
| Construct as copy of UPtrList<T> content. | |
| List (const IndirectListBase< Type, Addr > &list) | |
| Construct as copy of IndirectList contents. | |
| List (std::initializer_list< Type > list) | |
| Construct from an initializer list. | |
| List (List< Type > &&list) noexcept | |
| Move construct from List. | |
| List (DynamicList< Type, SizeMin > &&list) | |
| Move construct from DynamicList. | |
| List (Istream &is) | |
| Construct from Istream. | |
| autoPtr< List< Type > > | clone () const |
| Clone. | |
| ~List () | |
| Destructor. | |
| void | clear () |
| Clear the list, i.e. set size to zero. | |
| void | resize (const label len) |
| Adjust allocated size of list. | |
| void | resize (const label len, const Type &val) |
| Adjust allocated size of list and set val for new elements. | |
| void | resize_copy (label count, const label len) |
| Change allocated size of list, retaining the first count elements. | |
| void | resize_fill (const label len, const Type &val) |
| Adjust allocated size of list and set val for all elements. | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. | |
| void | transfer (List< Type > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| void | transfer (DynamicList< Type, SizeMin > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| Type & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. | |
| Type & | emplace_back (Args &&... args) |
| Construct an element at the end of the list, return reference to the new list element. | |
| void | push_back (const Type &val) |
| Append an element at the end of the list. | |
| void | push_back (Type &&val) |
| Move append an element at the end of the list. | |
| void | push_back (const UList< Type > &list) |
| Append a List to the end of this list. | |
| void | push_back (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. | |
| label | push_uniq (const Type &val) |
| Append an element if not already in the list. | |
| void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. | |
| void | operator= (const UList< Type > &list) |
| Assignment to UList operator. Takes linear time. | |
| void | operator= (const List< Type > &list) |
| Assignment operator. Takes linear time. | |
| void | operator= (const IndirectListBase< Type, Addr > &list) |
| Assignment from IndirectList. Takes linear time. | |
| void | operator= (const FixedList< Type, N > &list) |
| Copy assignment from FixedList. | |
| void | operator= (std::initializer_list< Type > list) |
| Assignment to an initializer list. | |
| void | operator= (const Type &val) |
| Assignment of all entries to the given value. | |
| void | operator= (Foam::zero) |
| Assignment of all entries to zero. | |
| void | operator= (List< Type > &&list) |
| Move assignment. Takes constant time. | |
| void | operator= (DynamicList< Type, SizeMin > &&list) |
| Move assignment. Takes constant time. | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. | |
| void | shallowCopy (const UList< Type > &)=delete |
| No shallowCopy permitted. | |
| bool | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. | |
| void | append (const Type &val) |
| Append an element at the end of the list. | |
| void | append (Type &&val) |
| Move append an element at the end of the list. | |
| void | append (const UList< Type > &list) |
| Append a List to the end of this list. | |
| void | append (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. | |
| label | appendUniq (const Type &val) |
| Same as push_uniq(). | |
| void | setSize (label n) |
| Alias for resize(). | |
| void | setSize (label n, const Type &val) |
| Alias for resize(). | |
| List (const Expression::ListExpression< E > &expr) | |
| Construct from value expression. | |
| void | operator= (const Expression::ListExpression< E > &expr) |
| Assign values from expression. | |
| void | resize (const label len) |
| Public Member Functions inherited from UList< Type > | |
| UList (const UList< Type > &) noexcept=default | |
| Copy construct, shallow copy. | |
| UList< Type > & | operator= (const UList< Type > &)=delete |
| No copy assignment (default: shallow copy). | |
| label | fcIndex (const label i) const noexcept |
| The forward circular index. The next index in the list which returns to the first at the end of the list. | |
| label | rcIndex (const label i) const noexcept |
| The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. | |
| const Type & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list). | |
| const Type & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list). | |
| const Type * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. | |
| Type * | data () noexcept |
| Return pointer to the underlying array serving as data storage. | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| Type & | front () |
| Access first element of the list, position [0]. | |
| Type & | back () |
| Access last element of the list, position [size()-1]. | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. | |
| std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size). | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size). | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. | |
| bool | contains (const Type &val) const |
| True if the value is contained in the list. | |
| label | find (const Type &val) const |
| Find index of the first occurrence of the value. | |
| label | rfind (const Type &val, label pos=-1) const |
| Find index of the last occurrence of the value. | |
| void | moveFirst (const label i) |
| Move element to the first position. | |
| void | moveLast (const label i) |
| Move element to the last position. | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. | |
| void | shallowCopy (Type *__restrict__ ptr, const label len) noexcept |
| Copy the pointer and size. | |
| void | deepCopy (const UList< Type > &list) |
| Copy elements of the given UList. Sizes must match! | |
| SubList< Type > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. | |
| Type & | operator[] (const label i) |
| Return element of UList. | |
| operator const Foam::List< Type > & () const | |
| Allow cast to a const List<T>&. | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| bool | empty () const noexcept |
| True if List is empty (ie, size() is zero). | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| void | swap (UList< Type > &list) noexcept |
| Swap content with another UList of the same type in constant time. | |
| bool | operator== (const UList< Type > &list) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UList< Type > &list) const |
| The opposite of the equality operation. Takes linear time. | |
| bool | operator< (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator> (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator<= (const UList< Type > &list) const |
| Return true if !(a > b). Takes linear time. | |
| bool | operator>= (const UList< Type > &list) const |
| Return true if !(a < b). Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. | |
| bool | all () const |
| True if all entries are 'true' or if the list is empty. | |
| bool | any () const |
| True if any entries are 'true'. | |
| bool | none () const |
| True if no entries are 'true'. | |
| bool | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. | |
| bool | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. | |
| bool | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. | |
| std::string_view | view () const |
| Return a string_view of the charList. Content is non-modifiable. | |
| Type & | first () |
| Access first element of the list, position [0]. | |
| Type & | last () |
| Access last element of the list, position [size()-1]. | |
| bool | found (const Type &val, label pos=0) const |
| Same as contains(). | |
| auto | expr () const |
| Wrap value as expression. | |
Static Public Member Functions | |
| static label | readContentsSize (const IOobject &io) |
| Read and return content size, -1 if not read. | |
| static Field< Type > | readContents (const IOobject &io) |
| Read and return contents. The IOobject will not be registered. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Static Public Member Functions inherited from Field< Type > | |
| static const Field< Type > & | null () noexcept |
| Return a null Field (reference to a nullObject). Behaves like an empty Field. | |
| static autoPtr< Field< Type > > | New (Istream &is) |
| Return a pointer to a new Field created on freestore. | |
| template<class Type2> | |
| static tmp< Field< Type > > | NewCalculatedType (const Field< Type2 > &f) |
| Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. | |
| Static Public Member Functions inherited from FieldBase | |
| static void | warnLocalBoundaryConsistencyCompat (const dictionary &) |
| Warn about keyword changes for local boundary consistency checks. | |
| static int | localBoundaryConsistency () noexcept |
| Get flag for local boundary consistency checks. | |
| static int | localBoundaryConsistency (int val) noexcept |
| Set flag for local boundary consistency checks. | |
| Static Public Member Functions inherited from List< Type > | |
| static const List< Type > & | null () noexcept |
| Return a null List (reference to a nullObject). Behaves like an empty List. | |
| Static Public Member Functions inherited from UList< Type > | |
| static const UList< Type > & | null () noexcept |
| Return a null UList (reference to a nullObject). Behaves like an empty UList. | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. | |
Additional Inherited Members | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Static Public Attributes inherited from FieldBase | |
| static const char *const | typeName |
| Typename for Field. | |
| static bool | allowConstructFromLargerSize = false |
| Permit read construct from a larger size. | |
| static bool | unifiedGeometricField |
| GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField". | |
| static int | localBoundaryConsistency_ |
| Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency". | |
| static scalar | localBoundaryTolerance_ |
| Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance". | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Protected Member Functions inherited from UList< Type > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. | |
| void | size (const label n) |
| Older name for setAddressableSize. | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. | |
| labelRange | validateRange (const labelRange &requestedRange) const |
| Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. | |
| void | fill_uniform (const Type &val) |
| Assign all entries to the given value. | |
| 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. | |
| 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. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
A primitive field of type <T> with automated input and output.
| typedef Field<Type> content_type |
|
default |
Default copy construct.
Referenced by readContents(), and readContentsSize().
|
explicit |
Construct from IOobject. Will be zero size if not read.
Definition at line 81 of file IOField.C.
References io, regIOobject::regIOobject(), and IOobject::warnNoRereading().
| IOField | ( | const IOobject & | io, |
| const bool | readOnProc ) |
Construct from IOobject, with local processor conditional reading.
Definition at line 93 of file IOField.C.
References io, regIOobject::regIOobject(), and IOobject::warnNoRereading().
| IOField | ( | const IOobject & | io, |
| Foam::zero | ) |
Construct from IOobject and zero size (if not read).
Definition at line 105 of file IOField.C.
References io, regIOobject::regIOobject(), and IOobject::warnNoRereading().
| IOField | ( | const IOobject & | io, |
| const label | len ) |
Construct from IOobject and field size (if not read).
Definition at line 117 of file IOField.C.
References io, regIOobject::regIOobject(), List< Type >::resize(), and IOobject::warnNoRereading().
Construct from IOobject and copy of List/Field content.
Definition at line 132 of file IOField.C.
References io, Field< Type >::operator=(), regIOobject::regIOobject(), and IOobject::warnNoRereading().
Construct by transferring the Field content.
Definition at line 147 of file IOField.C.
References Field< Type >::Field(), io, regIOobject::regIOobject(), List< Type >::transfer(), and IOobject::warnNoRereading().
Construct by copying/moving tmp content.
Definition at line 161 of file IOField.C.
References Field< Type >::Field(), io, Field< Type >::operator=(), regIOobject::regIOobject(), and List< Type >::transfer().
|
virtualdefault |
Destructor.
| TypeName | ( | "Field" | ) |
Runtime type information.
|
static |
Read and return content size, -1 if not read.
The IOobject will not be registered
Definition at line 196 of file IOField.C.
References io, IOField(), IOobjectOption::MUST_READ, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::READ_MODIFIED, IOobjectOption::readOpt(), and IOobject::resetHeader().
|
static |
Read and return contents. The IOobject will not be registered.
Definition at line 216 of file IOField.C.
References Field< Type >::Field(), io, IOField(), IOobjectOption::MUST_READ, IOobjectOption::NO_REGISTER, IOobjectOption::READ_MODIFIED, IOobjectOption::readOpt(), and IOobject::resetHeader().
|
virtual |
The writeData method for regIOobject write operation.
Implements regIOobject.
Definition at line 234 of file IOField.C.
References os().
|
inline |
|
inline |
1.16.1 