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

#include <refinementHistory.H>

Inheritance diagram for refinementHistory:

Collaboration diagram for refinementHistory:

Classes
class	splitCell8

Public Member Functions
	TypeName ("refinementHistory")
	refinementHistory (const IOobject &)
	Construct (read) given an IOobject.
	refinementHistory (const IOobject &, const List< splitCell8 > &splitCells, const labelList &visibleCells, const bool active)
	Construct (read) or construct from components.
	refinementHistory (const IOobject &, const label nCells)
	Construct (read) or construct from initial number of cells (all visible).
	refinementHistory (const IOobject &, const label nCells, const bool active)
	Construct (read) or construct from initial number of cells (all visible) and active flag.
	refinementHistory (const IOobject &, const refinementHistory &)
	Construct as copy.
	refinementHistory (const IOobject &, const UPtrList< const labelList > &cellMaps, const UPtrList< const refinementHistory > &)
	Construct from multiple refinement histories.
	refinementHistory (const IOobject &, Istream &)
	Construct from Istream.
const labelList &	visibleCells () const
	Per cell in the current mesh (i.e. visible) either -1 (unrefined) or an index into splitCells.
const DynamicList< splitCell8 > &	splitCells () const
	Storage for splitCell8s.
const DynamicList< label > &	freeSplitCells () const
	Cache of unused indices in splitCells.
bool	active () const
	Is there unrefinement history?
bool &	active ()
	Is there unrefinement history?
label	parentIndex (const label celli) const
	Get parent of cell.
void	storeSplit (const label celli, const labelList &addedCells)
	Store splitting of cell into 8.
void	combineCells (const label masterCelli, const labelList &combinedCells)
	Store combining 8 cells into master.
autoPtr< refinementHistory >	clone (const IOobject &io, const labelList &decomposition, const labelList &splitCellProc, const labelList &splitCellNum, const label procI, labelList &oldToNewSplit) const
	Low level clone.
autoPtr< refinementHistory >	clone (const IOobject &io, const labelUList &cellMap) const
	Create clone from subset.
void	updateMesh (const mapPolyMesh &)
	Update numbering for mesh changes.
void	subset (const labelList &pointMap, const labelList &faceMap, const labelList &cellMap)
	Update numbering for subsetting.
void	distribute (const mapDistributePolyMesh &)
	Update local numbering for mesh redistribution.
void	compact ()
	Compact splitCells_. Removes all freeSplitCells_ elements.
void	resize (const label nCells)
	Extend/shrink storage. additional visibleCells_ elements get.
void	writeDebug () const
	Debug write.
virtual bool	read ()
	Read object. If global number of visible cells > 0 becomes active.
virtual bool	readData (Istream &)
	ReadData function required for regIOobject read operation. Note:
virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation.
void	add (boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const
	Add my decomposition constraints.
void	apply (const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &decomposition) const
	Apply any additional post-decomposition constraints.
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a `void` type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
template<class Type>
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. A `void` type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A `void` type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
template<class StringType>
Foam::word	groupName (StringType base, const word &group)
template<class Type>
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.

Static Public Member Functions
static void	removeFiles (const polyMesh &)
	Helper: remove all sets files from mesh instance.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.

Friends
Istream &	operator>> (Istream &, refinementHistory &)
	Istream operator. Note: does not do a reduction - does not set.
Ostream &	operator<< (Ostream &, const refinementHistory &)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp \| inotify) \| (all \| masterOnly). More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true). More...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information.
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

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_.
splitCells: for every split contains the parent (also index into splitCells) and optionally a subsplit as 8 indices into splitCells. Note that the numbers in splitCells are not cell labels, they are purely indices 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:

parent:0
subsplits:0()

The parent 0 refers back to the splitcell entries.

Source files

Definition at line 98 of file refinementHistory.H.

Constructor & Destructor Documentation

◆ refinementHistory() [1/7]

refinementHistory ( const IOobject & io )

explicit

Construct (read) given an IOobject.

If global number of visible cells > 0 becomes active

Definition at line 554 of file refinementHistory.C.

References Foam::endl(), io, Foam::Pout, regIOobject::regIOobject(), Foam::returnReduceOr(), and IOobject::warnNoRereading().

Referenced by clone(), clone(), operator<<, operator>>, refinementHistory(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refinementHistory() [2/7]

refinementHistory	(	const IOobject &	io,
		const List< splitCell8 > &	splitCells,
		const labelList &	visibleCells,
		const bool	active )

Construct (read) or construct from components.

Definition at line 581 of file refinementHistory.C.

References active(), Foam::endl(), io, Foam::Pout, regIOobject::regIOobject(), splitCells(), visibleCells(), and IOobject::warnNoRereading().

Here is the call graph for this function:

◆ refinementHistory() [3/7]

refinementHistory	(	const IOobject &	io,
		const label	nCells )

Construct (read) or construct from initial number of cells (all visible).

If global number of visible cells > 0 becomes active

Definition at line 615 of file refinementHistory.C.

References Foam::endl(), io, Foam::Pout, regIOobject::regIOobject(), Foam::returnReduceOr(), and IOobject::warnNoRereading().

Here is the call graph for this function:

◆ refinementHistory() [4/7]

refinementHistory	(	const IOobject &	io,
		const label	nCells,
		const bool	active )

Construct (read) or construct from initial number of cells (all visible) and active flag.

Definition at line 659 of file refinementHistory.C.

References active(), Foam::endl(), io, Foam::Pout, regIOobject::regIOobject(), and IOobject::warnNoRereading().

Here is the call graph for this function:

◆ refinementHistory() [5/7]

refinementHistory	(	const IOobject &	io,
		const refinementHistory &	rh )

Construct as copy.

Definition at line 700 of file refinementHistory.C.

References Foam::endl(), freeSplitCells(), io, Foam::Pout, refinementHistory(), regIOobject::regIOobject(), splitCells(), and visibleCells().

Here is the call graph for this function:

◆ refinementHistory() [6/7]

refinementHistory	(	const IOobject &	io,
		const UPtrList< const labelList > &	cellMaps,
		const UPtrList< const refinementHistory > &	refs )

Construct from multiple refinement histories.

If global number of visible cells > 0 becomes active

Definition at line 720 of file refinementHistory.C.

References active(), refinementHistory::splitCell8::addedCellsPtr_, IOobject::db(), Foam::endl(), forAll, io, UList< T >::last(), mesh, refinementHistory::splitCell8::parent_, Foam::Pout, regIOobject::regIOobject(), DynamicList< T, SizeMin >::setSize(), UList< T >::size(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ refinementHistory() [7/7]

refinementHistory	(	const IOobject &	io,
		Istream &	is )

explicit

Construct from Istream.

If global number of visible cells > 0 becomes active

Definition at line 830 of file refinementHistory.C.

References Foam::endl(), io, Foam::Pout, regIOobject::regIOobject(), and Foam::returnReduceOr().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "refinementHistory" )

References active(), refinementHistory(), splitCells(), and visibleCells().

Here is the call graph for this function:

◆ visibleCells()

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 326 of file refinementHistory.H.

Referenced by refinementHistory(), refinementHistory(), and TypeName().

Here is the caller graph for this function:

◆ splitCells()

const DynamicList< splitCell8 > & splitCells ( ) const

inline

Storage for splitCell8s.

Definition at line 334 of file refinementHistory.H.

Referenced by refinementHistory(), refinementHistory(), and TypeName().

Here is the caller graph for this function:

◆ freeSplitCells()

const DynamicList< label > & freeSplitCells ( ) const

inline

Cache of unused indices in splitCells.

Definition at line 342 of file refinementHistory.H.

Referenced by refinementHistory().

Here is the caller graph for this function:

◆ active() [1/2]

bool active ( ) const

inline

Is there unrefinement history?

Definition at line 350 of file refinementHistory.H.

Referenced by distribute(), refinementHistory(), refinementHistory(), refinementHistory(), subset(), TypeName(), and updateMesh().

Here is the caller graph for this function:

◆ active() [2/2]

bool & active ( )

inline

Is there unrefinement history?

Definition at line 358 of file refinementHistory.H.

◆ parentIndex()

label parentIndex ( const label celli ) const

inline

Get parent of cell.

Definition at line 366 of file refinementHistory.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by combineCells(), and storeSplit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeSplit()

void storeSplit	(	const label	celli,
		const labelList &	addedCells )

Store splitting of cell into 8.

Definition at line 1607 of file refinementHistory.C.

References forAll, and parentIndex().

Here is the call graph for this function:

◆ combineCells()

void combineCells	(	const label	masterCelli,
		const labelList &	combinedCells )

Store combining 8 cells into master.

Definition at line 1645 of file refinementHistory.C.

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

Here is the call graph for this function:

◆ clone() [1/2]

Foam::autoPtr< Foam::refinementHistory > clone	(	const IOobject &	io,
		const labelList &	decomposition,
		const labelList &	splitCellProc,
		const labelList &	splitCellNum,
		const label	procI,
		labelList &	oldToNewSplit ) const

Low level clone.

Definition at line 855 of file refinementHistory.C.

References DynamicList< T, SizeMin >::append(), forAll, io, refinementHistory(), List< T >::setSize(), DynamicList< T, SizeMin >::shrink(), UList< T >::size(), and split().

Referenced by clone(), and refinementHistory::splitCell8::splitCell8().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/2]

Foam::autoPtr< Foam::refinementHistory > clone	(	const IOobject &	io,
		const labelUList &	cellMap ) const

Create clone from subset.

Definition at line 976 of file refinementHistory.C.

References clone(), forAll, io, refinementHistory(), and Foam::Zero.

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh & map )

Update numbering for mesh changes.

Definition at line 1061 of file refinementHistory.C.

References Foam::abort(), active(), mapPolyMesh::cellMap(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Pout, mapPolyMesh::reverseCellMap(), and UList< T >::size().

Here is the call graph for this function:

◆ subset()

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

Update numbering for subsetting.

Definition at line 1106 of file refinementHistory.C.

References Foam::abort(), active(), Foam::endl(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Pout, and UList< T >::size().

Here is the call graph for this function:

◆ distribute()

void distribute ( const mapDistributePolyMesh & map )

Update local numbering for mesh redistribution.

Can only distribute clusters sent across in one go; cannot handle parts recombined in multiple passes.

Definition at line 1188 of file refinementHistory.C.

References Foam::abort(), active(), UPstream::allProcs(), DynamicList< T, SizeMin >::append(), mapDistributePolyMesh::cellMap(), compact(), mapDistributeBase::constructMap(), IOobject::db(), Foam::FatalError, FatalErrorInFunction, PstreamBuffers::finishedSends(), forAll, mesh, UPstream::parRun(), DynamicList< T, SizeMin >::shrink(), UList< T >::size(), split(), mapDistributeBase::subMap(), and Foam::Zero.

Here is the call graph for this function:

◆ compact()

void compact ( )

Compact splitCells_. Removes all freeSplitCells_ elements.

Definition at line 1445 of file refinementHistory.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Pout, UList< T >::size(), split(), and DynamicList< T, SizeMin >::transfer().

Referenced by distribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resize()

void resize ( const label nCells )

Extend/shrink storage. additional visibleCells_ elements get.

set to -1.

Definition at line 1041 of file refinementHistory.C.

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

Here is the call graph for this function:

◆ writeDebug()

void writeDebug ( ) const

Debug write.

Definition at line 1601 of file refinementHistory.C.

◆ read()

bool read ( )

virtual

Read object. If global number of visible cells > 0 becomes active.

Reimplemented from regIOobject.

Definition at line 1669 of file refinementHistory.C.

References regIOobject::close(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, readData(), and Foam::returnReduceOr().

Here is the call graph for this function:

◆ readData()

bool readData ( Istream & is )

virtual

ReadData function required for regIOobject read operation. Note:

does not do a reduction - does not set active_ flag

Reimplemented from regIOobject.

Definition at line 1680 of file refinementHistory.C.

References IOstream::bad().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

WriteData function required for regIOobject write operation.

Implements regIOobject.

Definition at line 1687 of file refinementHistory.C.

References os().

Here is the call graph for this function:

◆ add()

void add	(	boolList &	blockedFace,
		PtrList< labelList > &	specifiedProcessorFaces,
		labelList &	specifiedProcessor,
		List< labelPair > &	explicitConnections ) const

Add my decomposition constraints.

Definition at line 448 of file refinementHistory.C.

References IOobject::db(), Foam::endl(), forAll, Foam::Info, mesh, Foam::returnReduce(), List< T >::setSize(), syncTools::syncFaceList(), and Foam::type().

Here is the call graph for this function:

◆ apply()

void apply	(	const boolList &	blockedFace,
		const PtrList< labelList > &	specifiedProcessorFaces,
		const labelList &	specifiedProcessor,
		const List< labelPair > &	explicitConnections,
		labelList &	decomposition ) const

Apply any additional post-decomposition constraints.

Definition at line 494 of file refinementHistory.C.

References IOobject::db(), Foam::endl(), forAll, Foam::Info, mesh, Foam::returnReduce(), and Foam::type().

Here is the call graph for this function:

◆ removeFiles()

void removeFiles ( const polyMesh & mesh )

static

Helper: remove all sets files from mesh instance.

Definition at line 1695 of file refinementHistory.C.

References DebugVar, Foam::exists(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, io, mesh, polyMesh::meshSubDir, and Foam::rm().

Referenced by hexRef8::removeFiles(), and hexRef8::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator>>

Istream & operator>>	(	Istream &	,
		refinementHistory &	)

friend

Istream operator. Note: does not do a reduction - does not set.

active_ flag

References refinementHistory().

◆ operator<<

Ostream & operator<<	(	Ostream &	,
		const refinementHistory &	)

friend

References refinementHistory().

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

src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8/refinementHistory.H
src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8/refinementHistory.C

Classes

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ refinementHistory() [1/7]

◆ refinementHistory() [2/7]

◆ refinementHistory() [3/7]

◆ refinementHistory() [4/7]

◆ refinementHistory() [5/7]

◆ refinementHistory() [6/7]

◆ refinementHistory() [7/7]

Member Function Documentation

◆ TypeName()

◆ visibleCells()

◆ splitCells()

◆ freeSplitCells()

◆ active() [1/2]

◆ active() [2/2]

◆ parentIndex()

◆ storeSplit()

◆ combineCells()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateMesh()

◆ subset()

◆ distribute()

◆ compact()

◆ resize()

◆ writeDebug()

◆ read()

◆ readData()

◆ writeData()

◆ add()

◆ apply()

◆ removeFiles()

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<