Public Member Functions | |
| TypeName ("featureEdgeMesh") | |
| featureEdgeMesh (const IOobject &) | |
| Construct (read) given an IOobject. More... | |
| featureEdgeMesh (const IOobject &io, const pointField &points, const edgeList &edges) | |
| Construct from featureEdgeMesh data. More... | |
| featureEdgeMesh (const IOobject &io, const edgeMesh &em) | |
| Construct as copy. More... | |
| virtual bool | readData (Istream &) |
| ReadData function required for regIOobject read operation. More... | |
| virtual bool | writeData (Ostream &) const |
| WriteData function required for regIOobject write operation. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
 Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| 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 | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| 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 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... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | 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 |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=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, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| 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, 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, readOption, writeOption) | |
| Copy construct, resetting io options. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return Time associated with the objectRegistry. More... | |
| const word & | name () const noexcept |
| Return 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 |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const noexcept |
| Should object created with this IOobject be registered? More... | |
| bool | registerObject (bool on) noexcept |
| Change registration preference, return previous value. More... | |
| bool | globalObject () const noexcept |
| Is object same for all processors? More... | |
| bool | globalObject (bool on) noexcept |
| Change global-object status, return previous value. More... | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More... | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const noexcept |
| The read option. More... | |
| readOption | readOpt (readOption opt) noexcept |
| Change the read option, return previous value. More... | |
| writeOption | writeOpt () const noexcept |
| The write option. More... | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Change the write option, return previous value. 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 |
| const fileName & | caseName () const |
| const fileName & | instance () const noexcept |
| fileName & | instance () noexcept |
| const fileName & | local () const noexcept |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | objectRelPath () const |
| The object path relative to the root. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| bool | readHeader (Istream &is) |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type() More... | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More... | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| bool | good () const noexcept |
| bool | bad () const noexcept |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &io) |
| 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... | |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
| Public Member Functions inherited from edgeMesh | |
| edgeMesh (const faMesh &mesh) | |
| Construct finite-area edge mesh faMesh reference. More... | |
| label | size () const |
| Return size. Number of internal edges. More... | |
| const edgeVectorField & | C () const |
| Field of edge centres. More... | |
| TypeName ("edgeMesh") | |
| Runtime type information. More... | |
| edgeMesh () | |
| Default construct. More... | |
| edgeMesh (const edgeMesh &em) | |
| Copy construct. More... | |
| edgeMesh (edgeMesh &&em) | |
| Move construct. More... | |
| edgeMesh (const pointField &points, const edgeList &edges) | |
| Copy construct from components. More... | |
| edgeMesh (pointField &&pointLst, edgeList &&edgeLst) | |
| Move construct from components. More... | |
| edgeMesh (const fileName &name) | |
| Construct from file name (uses extension to determine type) More... | |
| edgeMesh (const fileName &name, const word &fileType) | |
| Construct from file name with specified type. More... | |
| declareRunTimeSelectionTable (autoPtr, edgeMesh, fileExtension,(const fileName &name),(name)) | |
| virtual | ~edgeMesh ()=default |
| Destructor. More... | |
| declareMemberFunctionSelectionTable (void, edgeMesh, write, fileExtension,(const fileName &name, const edgeMesh &mesh, IOstreamOption streamOpt, const dictionary &options),(name, mesh, streamOpt, options)) | |
| void | transfer (edgeMesh &mesh) |
| Transfer the contents of the argument and annul the argument. More... | |
| bool | read (const fileName &name, const word &fileType) |
| Read from file. Chooses reader based on explicit extension. More... | |
| virtual bool | read (const fileName &name) |
| Read from file. Chooses reader based on detected extension. More... | |
| const pointField & | points () const noexcept |
| Return points. More... | |
| const edgeList & | edges () const noexcept |
| Return edges. More... | |
| const labelListList & | pointEdges () const |
| Return edges. More... | |
| label | regions (labelList &edgeRegion) const |
| Find connected regions. Set region number per edge. More... | |
| virtual void | clear () |
| Clear all storage. More... | |
| virtual void | scalePoints (const scalar scaleFactor) |
| Scale points. A non-positive factor is ignored. More... | |
| virtual void | mergePoints (const scalar mergeDist) |
| Geometric merge points (points within mergeDist) prior to. More... | |
| virtual void | mergeEdges () |
| Merge duplicate edges and eliminate unused points. More... | |
| virtual void | writeStats (Ostream &) const |
| virtual void | write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
| Write to file, choosing writer based on the file extension. More... | |
| virtual void | write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
| Write to file with given format type. More... | |
| void | operator= (const edgeMesh &rhs) |
| Copy assignment. More... | |
| void | operator= (edgeMesh &&rhs) |
| Move assignment. More... | |
| Public Member Functions inherited from GeoMesh< faMesh > | |
| GeoMesh (const faMesh &mesh) | |
| Construct from mesh reference. More... | |
| bool | hasDb () const |
| Return true if thisDb() is a valid DB - here = false. More... | |
| const objectRegistry & | thisDb () const |
| Return the object registry. More... | |
| const faMesh & | operator() () const |
| Return reference to the underlying mesh. More... | |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Public Types inherited from GeoMesh< faMesh > | |
| typedef faMesh | Mesh |
| typedef faMesh ::BoundaryMesh | BoundaryMesh |
| 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 an output file banner. More... | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from edgeMesh | |
| static label | size (const Mesh &mesh) |
| Return size. Number of internal edges. More... | |
| static wordHashSet | readTypes () |
| Summary of supported read file types. More... | |
| static wordHashSet | writeTypes () |
| Summary of supported write file types. More... | |
| static bool | canReadType (const word &fileType, bool verbose=false) |
| Can we read this file format? More... | |
| static bool | canWriteType (const word &fileType, bool verbose=false) |
| Can we write this file format type? More... | |
| static bool | canRead (const fileName &name, bool verbose=false) |
| Can we read this file format? More... | |
| static autoPtr< edgeMesh > | New (const fileName &name, const word &fileType) |
| Read construct from filename with given format. More... | |
| static autoPtr< edgeMesh > | New (const fileName &name) |
| Select constructed from filename (implicit extension) More... | |
| static void | write (const fileName &name, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
| Write to file (format implicit in the extension) More... | |
| static void | write (const fileName &name, const word &fileType, const edgeMesh &mesh, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
| Write to file, with given format. 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 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 edgeMesh | |
| pointField & | storedPoints () noexcept |
| Non-const access to global points. More... | |
| edgeList & | storedEdges () noexcept |
| Non-const access to the edges. More... | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Protected Attributes inherited from GeoMesh< faMesh > | |
| const faMesh & | mesh_ |
| Reference to Mesh. More... | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
edgeMesh + IO.
Definition at line 54 of file featureEdgeMesh.H.
|
explicit |
Construct (read) given an IOobject.
Definition at line 40 of file featureEdgeMesh.C.
References regIOobject::close(), Foam::expressions::patchExpr::debug, edgeMesh::edges(), Foam::endl(), regIOobject::headerOk(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, edgeMesh::points(), Foam::Pout, IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().
| featureEdgeMesh | ( | const IOobject & | io, |
| const pointField & | points, | ||
| const edgeList & | edges | ||
| ) |
Construct from featureEdgeMesh data.
Definition at line 68 of file featureEdgeMesh.C.
| featureEdgeMesh | ( | const IOobject & | io, |
| const edgeMesh & | em | ||
| ) |
Construct as copy.
Definition at line 80 of file featureEdgeMesh.C.
| TypeName | ( | "featureEdgeMesh" | ) |
ReadData function required for regIOobject read operation.
Reimplemented from regIOobject.
Definition at line 92 of file featureEdgeMesh.C.
References IOstream::bad().
WriteData function required for regIOobject write operation.
Implements regIOobject.
Definition at line 99 of file featureEdgeMesh.C.
References IOstream::good(), and os().
|
inlinevirtual |
|
inlinevirtual |
Return complete path + object name if the file exists.
either in the case/processor or case otherwise null
Reimplemented from regIOobject.
Definition at line 97 of file featureEdgeMesh.H.
1.8.17 