Classes | Public Member Functions | Friends | List of all members
refinementHistory Class Reference

All refinement history. Used in unrefinement. More...

Inheritance diagram for refinementHistory:
Inheritance graph
[legend]
Collaboration diagram for refinementHistory:
Collaboration graph
[legend]

Classes

class  splitCell8
 

Public Member Functions

 TypeName ("refinementHistory")
 
 refinementHistory (const IOobject &)
 Construct (read) given an IOobject. More...
 
 refinementHistory (const IOobject &, const List< splitCell8 > &splitCells, const labelList &visibleCells)
 Construct (read) or construct null. More...
 
 refinementHistory (const IOobject &, const label nCells)
 Construct (read) or construct from initial number of cells. More...
 
 refinementHistory (const IOobject &, const refinementHistory &)
 Construct as copy. More...
 
 refinementHistory (const IOobject &, Istream &)
 Construct from Istream. More...
 
const labelListvisibleCells () const
 Per cell in the current mesh (i.e. visible) either -1 (unrefined) More...
 
const DynamicList< splitCell8 > & splitCells () const
 Storage for splitCell8s. More...
 
const DynamicList< label > & freeSplitCells () const
 Cache of unused indices in splitCells. More...
 
bool active () const
 Is there unrefinement history. Note that this will fall over if. More...
 
label parentIndex (const label cellI) const
 Get parent of cell. More...
 
void storeSplit (const label cellI, const labelList &addedCells)
 Store splitting of cell into 8. More...
 
void combineCells (const label masterCellI, const labelList &combinedCells)
 Store combining 8 cells into master. More...
 
void updateMesh (const mapPolyMesh &)
 Update numbering for mesh changes. More...
 
void subset (const labelList &pointMap, const labelList &faceMap, const labelList &cellMap)
 Update numbering for subsetting. More...
 
void distribute (const mapDistributePolyMesh &)
 Update local numbering for mesh redistribution. More...
 
void compact ()
 Compact splitCells_. Removes all freeSplitCells_ elements. More...
 
void resize (const label nCells)
 Extend/shrink storage. additional visibleCells_ elements get. More...
 
void writeDebug () const
 Debug write. 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...
 
- 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 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...
 
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)
 

Friends

Istreamoperator>> (Istream &, refinementHistory &)
 
Ostreamoperator<< (Ostream &, const refinementHistory &)
 

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 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

All refinement history. Used in unrefinement.

- visibleCells: valid for the current mesh and contains per cell -1 (cell unrefined) or an index into splitCells_.

E.g. 2 cells, cell 1 gets refined so end up with 9 cells:

    // splitCells
    9
    (
    -1 (1 2 3 4 5 6 7 8)
    0 0()
    0 0()
    0 0()
    0 0()
    0 0()
    0 0()
    0 0()
    0 0()
    )

    // visibleCells
    9(-1 1 2 3 4 5 6 7 8)

So cell0 (visibleCells=-1) is unrefined. Cells 1-8 have all valid splitCells entries which are:

The parent 0 refers back to the splitcell entries.

Source files

Definition at line 93 of file refinementHistory.H.

Constructor & Destructor Documentation

refinementHistory ( const IOobject io)
refinementHistory ( const IOobject io,
const List< splitCell8 > &  splitCells,
const labelList visibleCells 
)
refinementHistory ( const IOobject io,
const label  nCells 
)
refinementHistory ( const IOobject io,
const refinementHistory rh 
)

Construct as copy.

Definition at line 477 of file refinementHistory.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

refinementHistory ( const IOobject io,
Istream is 
)

Construct from Istream.

Definition at line 496 of file refinementHistory.C.

References Foam::endl(), Foam::Pout, and List< T >::size().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "refinementHistory"  )

Referenced by refinementHistory::splitCell8::operator!=().

Here is the caller graph for this function:

const labelList& visibleCells ( ) const
inline

Per cell in the current mesh (i.e. visible) either -1 (unrefined)

or an index into splitCells.

Definition at line 263 of file refinementHistory.H.

Referenced by hexRef8::getSplitPoints(), hexRef8::hexRef8(), and refinementHistory::splitCell8::operator!=().

Here is the caller graph for this function:

const DynamicList<splitCell8>& splitCells ( ) const
inline

Storage for splitCell8s.

Definition at line 269 of file refinementHistory.H.

Referenced by refinementHistory::splitCell8::operator!=().

Here is the caller graph for this function:

const DynamicList<label>& freeSplitCells ( ) const
inline

Cache of unused indices in splitCells.

Definition at line 275 of file refinementHistory.H.

References refinementHistory::active(), and List< T >::size().

Here is the call graph for this function:

bool active ( ) const
inline

Is there unrefinement history. Note that this will fall over if.

there are 0 cells in the mesh. But this gives problems with lots of other programs anyway.

Definition at line 283 of file refinementHistory.H.

Referenced by refinementHistory::distribute(), hexRef8::distribute(), refinementHistory::freeSplitCells(), hexRef8::getSplitPoints(), hexRef8::hexRef8(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), refinementHistory::subset(), hexRef8::subset(), refinementHistory::updateMesh(), hexRef8::updateMesh(), and hexRef8::write().

Here is the caller graph for this function:

label parentIndex ( const label  cellI) const
inline
void storeSplit ( const label  cellI,
const labelList addedCells 
)

Store splitting of cell into 8.

Definition at line 1102 of file refinementHistory.C.

References refinementHistory::combineCells(), forAll, and refinementHistory::parentIndex().

Referenced by refinementHistory::parentIndex(), hexRef8::setRefinement(), and refinementHistory::writeDebug().

Here is the call graph for this function:

Here is the caller graph for this function:

void combineCells ( const label  masterCellI,
const labelList combinedCells 
)

Store combining 8 cells into master.

Definition at line 1140 of file refinementHistory.C.

References refinementHistory::splitCell8::addedCellsPtr_, forAll, and refinementHistory::parentIndex().

Referenced by refinementHistory::parentIndex(), hexRef8::setUnrefinement(), and refinementHistory::storeSplit().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh map)

Update numbering for mesh changes.

Definition at line 539 of file refinementHistory.C.

References Foam::abort(), refinementHistory::active(), mapPolyMesh::cellMap(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, Foam::Pout, mapPolyMesh::reverseCellMap(), List< T >::size(), refinementHistory::subset(), and List< T >::transfer().

Referenced by refinementHistory::parentIndex(), and hexRef8::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void subset ( const labelList pointMap,
const labelList faceMap,
const labelList cellMap 
)

Update numbering for subsetting.

Definition at line 588 of file refinementHistory.C.

References Foam::abort(), refinementHistory::active(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, UPstream::myProcNo(), Foam::Pout, List< T >::size(), and List< T >::transfer().

Referenced by refinementHistory::parentIndex(), hexRef8::subset(), and refinementHistory::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void distribute ( const mapDistributePolyMesh map)
void compact ( )

Compact splitCells_. Removes all freeSplitCells_ elements.

Definition at line 939 of file refinementHistory.C.

References Foam::abort(), refinementHistory::splitCell8::addedCellsPtr_, DynamicList< T, SizeInc, SizeMult, SizeDiv >::clearStorage(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, refinementHistory::splitCell8::parent_, Foam::Pout, and List< T >::size().

Referenced by refinementHistory::distribute(), refinementHistory::parentIndex(), and refinementHistory::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

void resize ( const label  nCells)

Extend/shrink storage. additional visibleCells_ elements get.

set to -1.

Definition at line 519 of file refinementHistory.C.

References Foam::endl(), Foam::Pout, List< T >::setSize(), and List< T >::size().

Referenced by refinementHistory::parentIndex(), and hexRef8::setRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeDebug ( ) const

Debug write.

Definition at line 1095 of file refinementHistory.C.

References refinementHistory::storeSplit().

Referenced by refinementHistory::splitCell8::operator!=(), and refinementHistory::parentIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

bool readData ( Istream is)
virtual

ReadData function required for regIOobject read operation.

Reimplemented from regIOobject.

Definition at line 1163 of file refinementHistory.C.

References IOstream::bad().

Referenced by refinementHistory::parentIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

bool writeData ( Ostream os) const
virtual

WriteData function required for regIOobject write operation.

Implements regIOobject.

Definition at line 1170 of file refinementHistory.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::clearStorage(), refinementHistory::compact(), IOstream::good(), Foam::nl, Foam::operator<<(), and Foam::operator>>().

Referenced by refinementHistory::parentIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

Istream& operator>> ( Istream ,
refinementHistory  
)
friend
Ostream& operator<< ( Ostream ,
const refinementHistory  
)
friend

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