Public Member Functions
cellIOGraph Class Reference
Inheritance diagram for cellIOGraph:
Inheritance graph
[legend]
Collaboration diagram for cellIOGraph:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("cellIOGraph")
 Runtime type information. More...
 
 cellIOGraph (const IOobject &)
 Construct from IOobject. More...
 
 cellIOGraph (const IOobject &, const label)
 Construct from IOobject and size of cellIOGraph. More...
 
 cellIOGraph (const IOobject &, const VRWGraph &)
 Construct from IOobject and a VRWGraph. More...
 
bool writeData (Ostream &) const
 Pure virtual writaData function. More...
 
void operator= (const cellIOGraph &)
 
void operator= (const VRWGraph &)
 
- 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 &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. 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...
 
labeleventNo ()
 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...
 
IstreamreadStream (const word &)
 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...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. 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
 Write using given format, version and compression. More...
 
virtual bool write () 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 &registry, 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 &registry, 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct as copy resetting name. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () 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 objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from VRWGraph
 VRWGraph ()
 Construct null. More...
 
 VRWGraph (const label size)
 Construct given number of rows. More...
 
 VRWGraph (const label nRows, const label nColumnsInRow)
 Construct given number of rows and row size. More...
 
 VRWGraph (const label nRows, const label nColumnsInRow, const label t)
 Construct to given number of rows, row size and initialize. More...
 
 VRWGraph (const VRWGraph &)
 Copy contructor. More...
 
 ~VRWGraph ()
 
label size () const
 Returns the number of rows. More...
 
label sizeOfRow (const label rowI) const
 Returns the number of elements in the given row. More...
 
void setSize (const label)
 Reset the number of rows. More...
 
void setSizeAndColumnWidth (const label newNumRows, const label rcWidth)
 
template<class ListType >
void setSizeAndRowSize (const ListType &)
 Set the number of rows and the size of each row. More...
 
void setRowSize (const label rowI, const label newSize)
 Reset the size of the given row. More...
 
void clear ()
 Clear the graph. More...
 
template<class ListType >
void appendList (const ListType &l)
 Append a list as a row at the end of the graph. More...
 
void append (const label rowI, const label)
 Append an element to the given row. More...
 
void appendIfNotIn (const label rowI, const label)
 Append an element to the given row if it does not exist there. More...
 
template<class ListType >
void setRow (const label rowI, const ListType &l)
 Set row with the list. More...
 
void mergeGraphs (const List< VRWGraph > &graphParts)
 
template<class GraphType >
void reverseAddressing (const label nRows, const GraphType &origGraph)
 
template<class GraphType >
void reverseAddressing (const GraphType &origGraph)
 
void reverseAddressing (const label nRows, const VRWGraph &origGraph)
 
void reverseAddressing (const VRWGraph &origGraph)
 
void optimizeMemoryUsage ()
 optimize memory usage More...
 
bool contains (const label rowI, const label e) const
 check if the element is in the given row (takes linear time) More...
 
label containsAtPosition (const label rowI, const label e) const
 
label operator() (const label i, const label j) const
 get and set operators More...
 
labeloperator() (const label i, const label j)
 
constRow operator[] (const label i) const
 
row operator[] (const label i)
 
void operator= (const VRWGraph &)
 Assignment operator. More...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- 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...
 
- 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)
 
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 void replaceFileName (const word &from, const word &to)
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Definition at line 49 of file cellIOGraph.H.

Constructor & Destructor Documentation

◆ cellIOGraph() [1/3]

cellIOGraph ( const IOobject io)

Construct from IOobject.

Definition at line 38 of file cellIOGraph.C.

◆ cellIOGraph() [2/3]

cellIOGraph ( const IOobject io,
const label  size 
)

Construct from IOobject and size of cellIOGraph.

Definition at line 45 of file cellIOGraph.C.

◆ cellIOGraph() [3/3]

cellIOGraph ( const IOobject io,
const VRWGraph g 
)

Construct from IOobject and a VRWGraph.

Definition at line 55 of file cellIOGraph.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cellIOGraph"  )

Runtime type information.

◆ writeData()

bool writeData ( Ostream ) const
virtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 74 of file cellIOGraph.C.

◆ operator=() [1/2]

void operator= ( const cellIOGraph rhs)

Definition at line 64 of file cellIOGraph.C.

References VRWGraph::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const VRWGraph rhs)

Definition at line 69 of file cellIOGraph.C.

References VRWGraph::operator=().

Here is the call graph for this function:

The documentation for this class was generated from the following files: