Public Member Functions | |
TypeName ("featureEdgeMesh") | |
featureEdgeMesh (const IOobject &) | |
Construct (read) given an IOobject. More... | |
featureEdgeMesh (const IOobject &, const pointField &, const edgeList &) | |
Construct from featureEdgeMesh data. More... | |
featureEdgeMesh (const IOobject &, const featureEdgeMesh &) | |
Copy constructor. 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 &, 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... | |
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... | |
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... | |
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 | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. Return. 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 | 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 &) |
Public Member Functions inherited from 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) |
Public Member Functions inherited from edgeMesh | |
TypeName ("edgeMesh") | |
Runtime type information. More... | |
edgeMesh () | |
Construct null. More... | |
edgeMesh (const pointField &, const edgeList &) | |
Construct from components. More... | |
edgeMesh (pointField &&, edgeList &&) | |
Construct by transferring components (points, edges). More... | |
edgeMesh (const edgeMesh &) | |
Copy constructor. More... | |
edgeMesh (edgeMesh &&) | |
Move constructor. More... | |
edgeMesh (const fileName &) | |
Construct from file name (uses extension to determine type) More... | |
edgeMesh (const fileName &, const word &ext) | |
Construct from file name (uses extension to determine type) More... | |
edgeMesh (Istream &) | |
Construct from Istream. More... | |
declareRunTimeSelectionTable (autoPtr, edgeMesh, fileExtension,(const fileName &name),(name)) | |
virtual | ~edgeMesh () |
Destructor. More... | |
declareMemberFunctionSelectionTable (void, edgeMesh, write, fileExtension,(const fileName &name, const edgeMesh &mesh),(name, mesh)) | |
void | transfer (edgeMesh &) |
Transfer the contents of the argument and annul the argument. More... | |
bool | read (const fileName &, const word &ext) |
Read from file. Chooses reader based on explicit extension. More... | |
virtual bool | read (const fileName &) |
Read from file. Chooses reader based on detected extension. More... | |
const pointField & | points () const |
Return points. More... | |
const edgeList & | edges () const |
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 | reset (pointField &&points, edgeList &&edges) |
Reset primitive data (points, edges) More... | |
virtual void | scalePoints (const scalar) |
Scale points. A non-positive factor is ignored. More... | |
virtual void | mergePoints (const scalar mergeDist, labelList &) |
Merge common points (points within mergeDist). Return map from. More... | |
virtual void | mergeEdges () |
Merge duplicate edges. More... | |
virtual void | writeStats (Ostream &) const |
virtual void | write (const fileName &name) const |
Generic write routine. Chooses writer based on extension. More... | |
void | operator= (const edgeMesh &) |
void | operator= (edgeMesh &&) |
Public Member Functions inherited from edgeMeshFormatsCore | |
edgeMeshFormatsCore () | |
Construct null. More... | |
virtual | ~edgeMeshFormatsCore () |
Destructor. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &) |
Transfer ownership of the given object pointer to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class Name > | |
static word | groupName (Name name, const word &group) |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
template<class 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 Public Member Functions inherited from edgeMesh | |
static bool | canRead (const fileName &, const bool verbose=false) |
Can we read this file format? More... | |
static bool | canReadType (const word &ext, const bool verbose=false) |
Can we read this file format? More... | |
static bool | canWriteType (const word &ext, const bool verbose=false) |
Can we write this file format type? More... | |
static wordHashSet | readTypes () |
static wordHashSet | writeTypes () |
static autoPtr< edgeMesh > | New (const fileName &, const word &ext) |
Select constructed from filename (explicit extension) More... | |
static autoPtr< edgeMesh > | New (const fileName &) |
Select constructed from filename (implicit extension) More... | |
static void | write (const fileName &, const edgeMesh &) |
Write to file. More... | |
Static Public Member Functions inherited from edgeMeshFormatsCore | |
static bool | checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName) |
Static Public Attributes inherited from regIOobject | |
static float | fileModificationSkew |
Static Public Attributes inherited from IOobject | |
static constexpr const char * | foamFile = "FoamFile" |
Keyword for the FoamFile header sub-dictionary. More... | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
Static Public Attributes inherited from edgeMeshFormatsCore | |
static word | nativeExt |
The file extension corresponding to 'native' edge format. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Protected Member Functions inherited from edgeMesh | |
pointField & | storedPoints () |
Non-const access to global points. More... | |
edgeList & | storedEdges () |
Non-const access to the edges. More... | |
Static Protected Member Functions inherited from edgeMeshFormatsCore | |
static string | getLineNoComment (IFstream &) |
Read non-comment line. More... | |
edgeMesh + IO.
Definition at line 52 of file featureEdgeMesh.H.
featureEdgeMesh | ( | const IOobject & | io | ) |
Construct (read) given an IOobject.
Definition at line 38 of file featureEdgeMesh.C.
References regIOobject::close(), edgeMesh::edges(), Foam::endl(), regIOobject::headerOk(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, edgeMesh::points(), Foam::Pout, IOobject::READ_IF_PRESENT, IOobject::readOpt(), regIOobject::readStream(), and List< T >::size().
Referenced by featureEdgeMesh::featureEdgeMesh().
featureEdgeMesh | ( | const IOobject & | io, |
const pointField & | points, | ||
const edgeList & | edges | ||
) |
Construct from featureEdgeMesh data.
Definition at line 66 of file featureEdgeMesh.C.
References featureEdgeMesh::featureEdgeMesh().
featureEdgeMesh | ( | const IOobject & | io, |
const featureEdgeMesh & | em | ||
) |
Copy constructor.
Definition at line 79 of file featureEdgeMesh.C.
TypeName | ( | "featureEdgeMesh" | ) |
|
virtual |
ReadData function required for regIOobject read operation.
Reimplemented from regIOobject.
Definition at line 91 of file featureEdgeMesh.C.
References IOstream::bad().
|
virtual |
WriteData function required for regIOobject write operation.
Implements regIOobject.
Definition at line 98 of file featureEdgeMesh.C.
References IOstream::good().
|
inlinevirtual |
Is object global.
Reimplemented from regIOobject.
Definition at line 89 of file featureEdgeMesh.H.
References featureEdgeMesh::filePath(), IOobject::globalFilePath(), and Foam::type().
|
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 96 of file featureEdgeMesh.H.
Referenced by featureEdgeMesh::global().