|
| | TypeName ("List") |
| | Runtime type information. More...
|
| |
| | IOList (const IOobject &) |
| | Construct from IOobject. More...
|
| |
| | IOList (const IOobject &, const label) |
| | Construct from IOobject and size of IOList. More...
|
| |
| | IOList (const IOobject &, const List< T > &) |
| | Construct from IOobject and a List. More...
|
| |
| | IOList (const IOobject &, List< T > &&) |
| | Move construct by transferring the List contents. More...
|
| |
| | IOList (const IOList< T > &) |
| | Copy constructor. More...
|
| |
| | IOList (IOList< T > &&) |
| | Move constructor. More...
|
| |
| virtual | ~IOList () |
| | Destructor. More...
|
| |
| bool | writeData (Ostream &) const |
| | Pure virtual writaData function. More...
|
| |
| void | operator= (const IOList< T > &) |
| |
| void | operator= (IOList< T > &&) |
| |
| void | operator= (const List< T > &) |
| |
| void | operator= (List< T > &&) |
| |
| | TypeName ("regIOobject") |
| | Runtime type information. More...
|
| |
| | regIOobject (const IOobject &, const bool isTime=false) |
| | Construct from IOobject. Optional flag for if IOobject is the. More...
|
| |
| | regIOobject (const regIOobject &) |
| | Copy constructor. More...
|
| |
| | regIOobject (const regIOobject &, bool registerCopy) |
| | Copy constructor, transferring registry registration to copy. More...
|
| |
| | regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
| | Copy constructor with new name, transferring registry registration. More...
|
| |
| | regIOobject (const IOobject &, const regIOobject &) |
| | Copy constructor with new IO parameters. More...
|
| |
| virtual | ~regIOobject () |
| | Destructor. More...
|
| |
| bool | checkIn () |
| | Add object to registry. More...
|
| |
| bool | checkOut () |
| | Remove object from registry. More...
|
| |
| void | addWatch () |
| | Add file watch on object (if registered and READ_IF_MODIFIED) More...
|
| |
| bool | ownedByRegistry () const |
| | Is this object owned by the registry? More...
|
| |
| void | store () |
| | Transfer ownership of this object to its registry. More...
|
| |
| void | release () |
| | Release ownership of this object from its registry. More...
|
| |
| label | eventNo () const |
| | Event number at last update. More...
|
| |
| label & | eventNo () |
| | Event number at last update. More...
|
| |
| bool | upToDate (const regIOobject &) const |
| | Return true if up-to-date with respect to given object. More...
|
| |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects. More...
|
| |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects. More...
|
| |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| | Return true if up-to-date with respect to given objects. More...
|
| |
| void | setUpToDate () |
| | Set up to date (obviously) More...
|
| |
| virtual void | rename (const word &newName) |
| | Rename. More...
|
| |
| virtual fileName | filePath () const |
| | Return complete path + object name if the file exists. More...
|
| |
| bool | headerOk () |
| | Read and check header info. More...
|
| |
| Istream & | readStream (const word &, const bool read=true) |
| | Return Istream and check object type against that given. More...
|
| |
| void | close () |
| | Close Istream. More...
|
| |
| virtual bool | readData (Istream &) |
| | Virtual readData function. More...
|
| |
| virtual bool | read () |
| | Read object. More...
|
| |
| const labelList & | watchIndices () const |
| | Return file-monitoring handles. More...
|
| |
| labelList & | watchIndices () |
| | Return file-monitoring handles. More...
|
| |
| virtual bool | modified () const |
| | Return true if the object's file (or files for objectRegistry) More...
|
| |
| virtual bool | readIfModified () |
| | Read object if modified (as set by call to modified) More...
|
| |
| virtual bool | global () const |
| | Is object same for all processors. More...
|
| |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const |
| | Write using given format, version and compression. More...
|
| |
| virtual bool | write (const bool write=true) const |
| | Write using setting from DB. More...
|
| |
| void | operator= (const IOobject &) |
| |
| | TypeName ("IOobject") |
| | Runtime type information. More...
|
| |
| | IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) |
| | Construct from name, instance, registry, io options. More...
|
| |
| | IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) |
| | Construct from name, instance, local, registry, io options. More...
|
| |
| | IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) |
| | Construct from path, registry, io options. More...
|
| |
| | IOobject (const IOobject &io, const objectRegistry ®istry) |
| | Construct from copy resetting registry. More...
|
| |
| | IOobject (const IOobject &io, const word &name) |
| | Construct from copy resetting name. More...
|
| |
| | IOobject (const IOobject &io)=default |
| | Copy constructor. More...
|
| |
| autoPtr< IOobject > | clone () const |
| | Clone. More...
|
| |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| | Clone resetting registry. More...
|
| |
| virtual | ~IOobject () |
| | Destructor. More...
|
| |
| const Time & | time () const |
| | Return time. More...
|
| |
| const objectRegistry & | db () const |
| | Return the local objectRegistry. More...
|
| |
| const word & | name () const |
| | Return name. More...
|
| |
| const word & | headerClassName () const |
| | Return name of the class name read from header. More...
|
| |
| word & | headerClassName () |
| | Return name of the class name read from header. More...
|
| |
| string & | note () |
| | Return non-constant access to the optional note. More...
|
| |
| const string & | note () const |
| | Return the optional note. More...
|
| |
| bool & | registerObject () |
| | Register object created from this IOobject with registry if true. More...
|
| |
| bool | registerObject () const |
| | Register object created from this IOobject with registry if true. More...
|
| |
| readOption | readOpt () const |
| |
| readOption & | readOpt () |
| |
| writeOption | writeOpt () const |
| |
| writeOption & | writeOpt () |
| |
| word | group () const |
| | Return group (extension part of name) More...
|
| |
| word | member () const |
| | Return member (name without the extension) More...
|
| |
| word | modelName (const char *name) const |
| | Return the name of the object within this model. More...
|
| |
| const fileName & | rootPath () const |
| |
| const fileName & | caseName () const |
| |
| const fileName & | instance () const |
| |
| fileName & | instance () |
| |
| const fileName & | local () const |
| |
| fileName | path () const |
| | Return complete path. More...
|
| |
| fileName | path (const word &instance, const fileName &local="") const |
| | Return complete path with alternative instance and local. More...
|
| |
| fileName | localPath () const |
| | Return the path relative to the case. More...
|
| |
| fileName | objectPath () const |
| | Return complete path + object name. More...
|
| |
| fileName | localObjectPath () const |
| | Return complete localPath + object name. More...
|
| |
| fileName | localFilePath (const word &typeName) const |
| | Helper for filePath that searches locally. More...
|
| |
| fileName | globalFilePath (const word &typeName) const |
| | Helper for filePath that searches up if in parallel. More...
|
| |
| bool | readHeader (Istream &) |
| | Read header. More...
|
| |
| template<class Type > |
| bool | typeHeaderOk (const bool checkType=true) |
| | Read header (uses typeFilePath to find file) and check header. More...
|
| |
| template<class Type > |
| void | warnNoRereading () const |
| | Helper: warn that type does not support re-reading. More...
|
| |
| bool | writeHeader (Ostream &) const |
| | Write header. More...
|
| |
| bool | writeHeader (Ostream &, const word &objectType) const |
| | Write header. Allow override of type. More...
|
| |
| bool | good () const |
| |
| bool | bad () const |
| |
| InfoProxy< IOobject > | info () const |
| | Return info proxy. More...
|
| |
| void | operator= (const IOobject &) |
| |
| template<class Name > |
| Foam::word | groupName (Name name, const word &group) |
| |
| template<class Name > |
| Foam::word | modelName (Name name, const word &model) |
| |
| | List () |
| | Null constructor. More...
|
| |
| | List (const label) |
| | Construct with given size. More...
|
| |
| | List (const label, const T &) |
| | Construct with given size and value for all elements. More...
|
| |
| | List (const label, const zero) |
| | Construct with given size initialising all elements to zero. More...
|
| |
| | List (const List< T > &) |
| | Copy constructor. More...
|
| |
| template<class T2 > |
| | List (const List< T2 > &) |
| | Copy constructor from list containing another type. More...
|
| |
| | List (List< T > &&) |
| | Move constructor. More...
|
| |
| | List (List< T > &, bool reuse) |
| | Construct as copy or re-use as specified. More...
|
| |
| | List (const UList< T > &, const labelUList &mapAddressing) |
| | Construct as subset. More...
|
| |
| template<class InputIterator > |
| | List (InputIterator first, InputIterator last) |
| | Construct given start and end iterators. More...
|
| |
| template<unsigned Size> |
| | List (const FixedList< T, Size > &) |
| | Construct as copy of FixedList<T, Size> More...
|
| |
| | List (const PtrList< T > &) |
| | Construct as copy of PtrList<T> More...
|
| |
| | List (const SLList< T > &) |
| | Construct as copy of SLList<T> More...
|
| |
| | List (const UIndirectList< T > &) |
| | Construct as copy of UIndirectList<T> More...
|
| |
| | List (const BiIndirectList< T > &) |
| | Construct as copy of BiIndirectList<T> More...
|
| |
| | List (std::initializer_list< T >) |
| | Construct from an initialiser list. More...
|
| |
| | List (Istream &) |
| | Construct from Istream. More...
|
| |
| autoPtr< List< T > > | clone () const |
| | Clone. More...
|
| |
| | ~List () |
| | Destructor. More...
|
| |
| label | size () const |
| | Return the number of elements in the UList. More...
|
| |
| void | resize (const label) |
| | Alias for setSize(const label) More...
|
| |
| void | resize (const label, const T &) |
| | Alias for setSize(const label, const T&) More...
|
| |
| void | setSize (const label) |
| | Reset size of List. More...
|
| |
| void | setSize (const label, const T &) |
| | Reset size of List and value for new elements. More...
|
| |
| void | clear () |
| | Clear the list, i.e. set size to zero. More...
|
| |
| void | append (const T &) |
| | Append an element at the end of the list. More...
|
| |
| void | append (const UList< T > &) |
| | Append a List at the end of this list. More...
|
| |
| void | append (const UIndirectList< T > &) |
| | Append a UIndirectList at the end of this list. More...
|
| |
| void | transfer (List< T > &) |
| | Transfer the contents of the argument List into this list. More...
|
| |
| template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv> |
| void | transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &) |
| | Transfer the contents of the argument List into this list. More...
|
| |
| void | transfer (SortableList< T > &) |
| | Transfer the contents of the argument List into this list. More...
|
| |
| T & | newElmt (const label) |
| | Return subscript-checked element of UList. More...
|
| |
| void | shallowCopy (const UList< T > &)=delete |
| | Disallow implicit shallowCopy. More...
|
| |
| void | operator= (const UList< T > &) |
| | Assignment to UList operator. Takes linear time. More...
|
| |
| void | operator= (const List< T > &) |
| | Assignment operator. Takes linear time. More...
|
| |
| void | operator= (List< T > &&) |
| | Move assignment operator. More...
|
| |
| void | operator= (const SLList< T > &) |
| | Assignment to SLList operator. Takes linear time. More...
|
| |
| void | operator= (const UIndirectList< T > &) |
| | Assignment to UIndirectList operator. Takes linear time. More...
|
| |
| void | operator= (const BiIndirectList< T > &) |
| | Assignment to BiIndirectList operator. Takes linear time. More...
|
| |
| void | operator= (std::initializer_list< T >) |
| | Assignment to an initialiser list. More...
|
| |
| void | operator= (const T &) |
| | Assignment of all entries to the given value. More...
|
| |
| void | operator= (const zero) |
| | Assignment of all entries to zero. More...
|
| |
| | UList () |
| | Null constructor. More...
|
| |
| | UList (T *__restrict__ v, label size) |
| | Construct from components. More...
|
| |
| label | fcIndex (const label i) const |
| | Return the forward circular index, i.e. the next index. More...
|
| |
| label | rcIndex (const label i) const |
| | Return the reverse circular index, i.e. the previous index. More...
|
| |
| std::streamsize | byteSize () const |
| | Return the binary size in number of characters of the UList. More...
|
| |
| const T * | cdata () const |
| | Return a const pointer to the first data element,. More...
|
| |
| T * | data () |
| | Return a pointer to the first data element,. More...
|
| |
| T & | first () |
| | Return the first element of the list. More...
|
| |
| const T & | first () const |
| | Return first element of the list. More...
|
| |
| T & | last () |
| | Return the last element of the list. More...
|
| |
| const T & | last () const |
| | Return the last element of the list. More...
|
| |
| void | checkStart (const label start) const |
| | Check start is within valid range (0 ... size-1) More...
|
| |
| void | checkSize (const label size) const |
| | Check size is within valid range (0 ... size) More...
|
| |
| void | checkIndex (const label i) const |
| | Check index i is within valid range (0 ... size-1) More...
|
| |
| void | shallowCopy (const UList< T > &) |
| | Copy the pointer held by the given UList. More...
|
| |
| void | deepCopy (const UList< T > &) |
| | Copy elements of the given UList. More...
|
| |
| T & | operator[] (const label) |
| | Return element of UList. More...
|
| |
| const T & | operator[] (const label) const |
| | Return element of constant UList. More...
|
| |
| | operator const Foam::List< T > & () const |
| | Allow cast to a const List<T>&. More...
|
| |
| void | operator= (const T &) |
| | Assignment of all entries to the given value. More...
|
| |
| void | operator= (const zero) |
| | Assignment of all entries to zero. More...
|
| |
| iterator | begin () |
| | Return an iterator to begin traversing the UList. More...
|
| |
| iterator | end () |
| | Return an iterator to end traversing the UList. More...
|
| |
| const_iterator | cbegin () const |
| | Return const_iterator to begin traversing the constant UList. More...
|
| |
| const_iterator | cend () const |
| | Return const_iterator to end traversing the constant UList. More...
|
| |
| const_iterator | begin () const |
| | Return const_iterator to begin traversing the constant UList. More...
|
| |
| const_iterator | end () const |
| | Return const_iterator to end traversing the constant UList. More...
|
| |
| reverse_iterator | rbegin () |
| | Return reverse_iterator to begin reverse traversing the UList. More...
|
| |
| reverse_iterator | rend () |
| | Return reverse_iterator to end reverse traversing the UList. More...
|
| |
| const_reverse_iterator | crbegin () const |
| | Return const_reverse_iterator to begin reverse traversing the UList. More...
|
| |
| const_reverse_iterator | crend () const |
| | Return const_reverse_iterator to end reverse traversing the UList. More...
|
| |
| const_reverse_iterator | rbegin () const |
| | Return const_reverse_iterator to begin reverse traversing the UList. More...
|
| |
| const_reverse_iterator | rend () const |
| | Return const_reverse_iterator to end reverse traversing the UList. More...
|
| |
| label | size () const |
| | Return the number of elements in the UList. More...
|
| |
| label | max_size () const |
| | Return size of the largest possible UList. More...
|
| |
| bool | empty () const |
| | Return true if the UList is empty (ie, size() is zero) More...
|
| |
| void | swap (UList< T > &) |
| | Swap two ULists of the same type in constant time. More...
|
| |
| bool | operator== (const UList< T > &) const |
| | Equality operation on ULists of the same type. More...
|
| |
| bool | operator!= (const UList< T > &) const |
| | The opposite of the equality operation. Takes linear time. More...
|
| |
| bool | operator< (const UList< T > &) const |
| | Compare two ULists lexicographically. Takes linear time. More...
|
| |
| bool | operator> (const UList< T > &) const |
| | Compare two ULists lexicographically. Takes linear time. More...
|
| |
| bool | operator<= (const UList< T > &) const |
| | Return true if !(a > b). Takes linear time. More...
|
| |
| bool | operator>= (const UList< T > &) const |
| | Return true if !(a < b). Takes linear time. More...
|
| |
| template<> |
| const bool & | operator[] (const label i) const |
| |
|
| enum | objectState { GOOD,
BAD
} |
| | Enumeration defining the valid states of an IOobject. More...
|
| |
| enum | readOption { MUST_READ,
MUST_READ_IF_MODIFIED,
READ_IF_PRESENT,
NO_READ
} |
| | Enumeration defining the read options. More...
|
| |
| enum | writeOption { AUTO_WRITE = 0,
NO_WRITE = 1
} |
| | Enumeration defining the write options. More...
|
| |
| enum | fileCheckTypes { timeStamp,
timeStampMaster,
inotify,
inotifyMaster
} |
| | Enumeration defining the file checking options. More...
|
| |
| typedef SubList< T > | subList |
| | Declare type of subList. More...
|
| |
| typedef T | value_type |
| | Type of values the UList contains. More...
|
| |
| typedef T & | reference |
| | Type that can be used for storing into. More...
|
| |
| typedef const T & | const_reference |
| | Type that can be used for storing into. More...
|
| |
| typedef label | difference_type |
| | The type that can represent the difference between any two. More...
|
| |
| typedef label | size_type |
| | The type that can represent the size of a UList. More...
|
| |
| typedef T * | iterator |
| | Random access iterator for traversing UList. More...
|
| |
| typedef const T * | const_iterator |
| | Random access iterator for traversing UList. More...
|
| |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| | Reverse iterator for reverse traversal of UList. More...
|
| |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| | Reverse iterator for reverse traversal of constant UList. More...
|
| |
| template<class Type > |
| static Type & | store (Type *) |
| | Transfer ownership of the given object pointer to its registry. More...
|
| |
| template<class Type > |
| static Type & | store (autoPtr< Type > &) |
| | Transfer ownership of the given object pointer to its registry. More...
|
| |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| | Split path into instance, local, name components. More...
|
| |
| template<class Name > |
| static word | groupName (Name name, const word &group) |
| |
| static word | group (const word &name) |
| | Return group (extension part of name) More...
|
| |
| static word | member (const word &name) |
| | Return member (name without the extension) More...
|
| |
| template<class Name > |
| static word | modelName (Name name, const word &model) |
| | Return the name of the object within the given model. More...
|
| |
| template<class Stream > |
| static Stream & | writeBanner (Stream &os, bool noHint=false) |
| | Write the standard OpenFOAM file/dictionary banner. More...
|
| |
| template<class Stream > |
| static Stream & | writeDivider (Stream &os) |
| | Write the standard file section divider. More...
|
| |
| template<class Stream > |
| static Stream & | writeEndDivider (Stream &os) |
| | Write the standard end file divider. More...
|
| |
| static const List< T > & | null () |
| | Return a null List. More...
|
| |
| static const UList< T > & | null () |
| | Return a null UList. More...
|
| |
| static float | fileModificationSkew |
| |
| static constexpr const char * | foamFile = "FoamFile" |
| | Keyword for the FoamFile header sub-dictionary. More...
|
| |
| static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
| |
| static fileCheckTypes | fileModificationChecking |
| | Type of file modification checking. More...
|
| |
| bool | readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName) |
| | Read header, check readOpt flags and read data if necessary. More...
|
| |
| void | setBad (const string &) |
| | Set the object state to bad. More...
|
| |
| void | size (const label) |
| | Override size to be inconsistent with allocated storage. More...
|
| |
Public Member Functions inherited from regIOobject
1.8.13 
