General set of labels of mesh quantity (points, cells, faces). More...

Inheritance diagram for topoSet:

[legend]

Collaboration diagram for topoSet:

Public Member Functions
	TypeName ("topoSet")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, topoSet, word,(const polyMesh &mesh, const word &name, readOption r, writeOption w),(mesh, name, r, w))

	declareRunTimeSelectionTable (autoPtr, topoSet, size,(const polyMesh &mesh, const word &name, const label size, writeOption w),(mesh, name, size, w))

	declareRunTimeSelectionTable (autoPtr, topoSet, set,(const polyMesh &mesh, const word &name, const topoSet &set, writeOption w),(mesh, name, set, w))

	topoSet (const IOobject &, const word &wantedType)
	Construct from IOobject as explicitly passed type. More...

	topoSet (const polyMesh &mesh, const word &wantedType, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Construct from polyMesh and name. Searches for a polyMesh/sets. More...

	topoSet (const polyMesh &mesh, const word &name, const label, writeOption w=NO_WRITE)
	Construct empty from additional size of labelHashSet. More...

	topoSet (const polyMesh &mesh, const word &name, const labelHashSet &, writeOption w=NO_WRITE)
	Construct empty from additional labelHashSet. More...

	topoSet (const IOobject &, const label size)
	Construct empty from IOobject and size. More...

	topoSet (const IOobject &, const labelHashSet &)
	Construct from IOobject and labelHashSet. More...

autoPtr< topoSet >	clone () const
	Clone. More...

virtual	~topoSet ()
	Destructor. More...

virtual void	invert (const label maxLen)
	Invert contents. (insert all members 0..maxLen-1 which were not in. More...

virtual void	subset (const topoSet &set)
	Subset contents. Only elements present in both sets remain. More...

virtual void	addSet (const topoSet &set)
	Add elements present in set. More...

virtual void	deleteSet (const topoSet &set)
	Delete elements present in set. More...

virtual void	sync (const polyMesh &mesh)
	Sync set across coupled patches. More...

virtual void	writeDebug (Ostream &os, const label maxLen) const
	Write labels columnwise to os. Truncate to maxLen. More...

virtual void	writeDebug (Ostream &os, const primitiveMesh &, const label maxLen) const =0
	Like above but also writes mesh related quantity. More...

virtual bool	writeData (Ostream &) const
	Write contents. More...

virtual void	updateMesh (const mapPolyMesh &morphMap)
	Update any stored data for new labels. Not implemented. More...

virtual label	maxSize (const polyMesh &mesh) const =0
	Return max allowable index (+1). Not implemented. More...

void	operator= (const topoSet &)
	Copy labelHashSet part only. 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...

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

Istream &	readStream (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...

label &	watchIndex ()
	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< IOobject >	clone () const
	Clone. 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...

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

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	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< IOobject >	info () 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 HashSet< Key, Hash >
	HashSet (const label size=128)
	Construct given initial size. More...

	HashSet (Istream &is)
	Construct from Istream. More...

	HashSet (const UList< Key > &)
	Construct from UList of Key. More...

	HashSet (const HashSet< Key, Hash > &hs)
	Construct as copy. More...

	HashSet (const Xfer< HashSet< Key, Hash > > &hs)
	Construct by transferring the parameter contents. More...

	HashSet (const Xfer< HashTable< nil, Key, Hash > > &hs)
	Construct by transferring the parameter contents. More...

template<class AnyType , class AnyHash >
	HashSet (const HashTable< AnyType, Key, AnyHash > &)
	Construct from the keys of another HashTable,. More...

bool	insert (const Key &key)
	Insert a new entry. More...

label	insert (const UList< Key > &)
	Insert keys from a UList of Key. More...

bool	set (const Key &key)
	Same as insert (cannot overwrite nil content) More...

label	set (const UList< Key > &lst)
	Same as insert (cannot overwrite nil content) More...

bool	unset (const Key &key)
	Unset the specified key - same as erase. More...

bool	operator[] (const Key &) const
	Return true if the entry exists, same as found() More...

bool	operator== (const HashSet< Key, Hash > &) const
	Equality. Two hashtables are equal when their contents are equal. More...

bool	operator!= (const HashSet< Key, Hash > &) const
	The opposite of the equality operation. More...

void	operator\|= (const HashSet< Key, Hash > &)
	Combine entries from HashSets. More...

void	operator&= (const HashSet< Key, Hash > &)
	Only retain entries found in both HashSets. More...

void	operator^= (const HashSet< Key, Hash > &)
	Only retain unique entries (xor) More...

void	operator+= (const HashSet< Key, Hash > &rhs)
	Add entries listed in the given HashSet to this HashSet. More...

void	operator-= (const HashSet< Key, Hash > &)
	Remove entries listed in the given HashSet from this HashSet. More...

Public Member Functions inherited from HashTable< nil, word, string::hash >
bool	set (const Key &, const T &newElmt)
	Assign a new hashedEntry, overwriting existing entries. More...

	HashTable (const label size=128)
	Construct given initial table size. More...

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const HashTable< T, Key, Hash > &)
	Construct as copy. More...

	HashTable (const Xfer< HashTable< T, Key, Hash > > &)
	Construct by transferring the parameter contents. More...

	~HashTable ()
	Destructor. More...

label	capacity () const
	The size of the underlying table. More...

label	size () const
	Return number of elements in table. More...

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const Key &) const
	Return true if hashedEntry is found in table. More...

iterator	find (const Key &)
	Find and return an iterator set at the hashedEntry. More...

const_iterator	find (const Key &) const
	Find and return an const_iterator set at the hashedEntry. More...

List< Key >	toc () const
	Return the table of contents. More...

List< Key >	sortedToc () const
	Return the table of contents as a sorted list. More...

Ostream &	printInfo (Ostream &) const
	Print information. More...

bool	insert (const Key &, const T &newElmt)
	Insert a new hashedEntry. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const Key &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< Key > &)
	Remove entries given by the listed keys from this HashTable. More...

label	erase (const HashTable< AnyType, Key, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &rhs)

void	resize (const label newSize)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

void	transfer (HashTable< T, Key, Hash > &)
	Transfer the contents of the argument table into this table. More...

Xfer< HashTable< T, Key, Hash > >	xfer ()
	Transfer contents to the Xfer container. More...

T &	operator[] (const Key &)
	Find and return a hashedEntry. More...

const T &	operator[] (const Key &) const
	Find and return a hashedEntry. More...

T &	operator() (const Key &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< T, Key, Hash > &)
	Assignment. More...

bool	operator== (const HashTable< T, Key, Hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< T, Key, Hash > &) const
	The opposite of the equality operation. Takes linear time. More...

iterator	begin ()
	Iterator set to the beginning of the HashTable. More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

Static Public Member Functions
static fileName	localPath (const polyMesh &mesh, const word &name)
	Name of file set will use. More...

static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Return a pointer to a toposet read from file. More...

static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, const label size, writeOption w=NO_WRITE)
	Return a pointer to a new toposet of given size. More...

static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, const topoSet &set, writeOption w=NO_WRITE)
	Return a pointer to a new toposet as copy of another toposet. 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)

Protected Member Functions
void	updateLabels (const labelList &map)
	Update map from map. Used to update cell/face labels. More...

void	check (const label maxLabel)
	Check validity of contents. More...

void	writeDebug (Ostream &os, const label maxElem, topoSet::const_iterator &iter, label &elemI) const
	Write part of contents nicely formatted. Prints labels only. More...

void	writeDebug (Ostream &os, const pointField &coords, const label maxElem, topoSet::const_iterator &iter, label &elemI) const
	Write part of contents nicely formatted. Prints label. More...

void	writeDebug (Ostream &os, const pointField &coords, const label maxLen) const
	Write labels and coordinates columnwise to os. Truncate to maxLen. More...

	topoSet (const topoSet &)
	Disallow default bitwise copy construct. More...

Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

void	setBad (const string &)
	Set the object state to bad. 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...

Public Types inherited from HashSet< Key, Hash >
typedef HashTable< nil, Key, Hash >::iterator	iterator

typedef HashTable< nil, Key, Hash >::const_iterator	const_iterator

Public Types inherited from HashTable< nil, word, string::hash >
typedef T	value_type
	Type of values the HashTable contains. More...

typedef T &	reference
	Type that can be used for storing into HashTable::value_type. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

Data Fields inherited from HashTable< nil, word, string::hash >
const typedef T &	const_reference
	Type that can be used for storing into constant. More...

Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

General set of labels of mesh quantity (points, cells, faces).

Contains various 'notImplemented' functions, but I do not want to make this class abstract since it is quite handy to work on topoSets.

Source files

Definition at line 61 of file topoSet.H.

Constructor & Destructor Documentation

◆ topoSet() [1/7]

topoSet ( const topoSet & )

protected

Disallow default bitwise copy construct.

◆ topoSet() [2/7]

topoSet	(	const IOobject &	obj,
		const word &	wantedType
	)

Construct from IOobject as explicitly passed type.

Can't use typeName info here since subclasses not yet instantiated

Definition at line 294 of file topoSet.C.

References regIOobject::close(), IOobject::good(), IOobject::headerOk(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().

Here is the call graph for this function:

◆ topoSet() [3/7]

topoSet	(	const polyMesh &	mesh,
		const word &	wantedType,
		const word &	name,
		readOption	r = `MUST_READ`,
		writeOption	w = `NO_WRITE`
	)

Construct from polyMesh and name. Searches for a polyMesh/sets.

directory but not beyond mesh.facesInstance.

Definition at line 319 of file topoSet.C.

References IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, and IOobject::READ_IF_PRESENT.

◆ topoSet() [4/7]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		const label	size,
		writeOption	w = `NO_WRITE`
	)

Construct empty from additional size of labelHashSet.

Searches for a polyMesh/sets directory but not beyond mesh.facesInstance.

Definition at line 367 of file topoSet.C.

◆ topoSet() [5/7]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		const labelHashSet &	set,
		writeOption	w = `NO_WRITE`
	)

Construct empty from additional labelHashSet.

Searches for a polyMesh/sets directory but not beyond mesh.facesInstance.

Definition at line 397 of file topoSet.C.

◆ topoSet() [6/7]

topoSet	(	const IOobject &	obj,
		const label	size
	)

Construct empty from IOobject and size.

Definition at line 426 of file topoSet.C.

◆ topoSet() [7/7]

topoSet	(	const IOobject &	obj,
		const labelHashSet &	set
	)

Construct from IOobject and labelHashSet.

Definition at line 433 of file topoSet.C.

◆ ~topoSet()

~topoSet ( )

virtual

Destructor.

Definition at line 443 of file topoSet.C.

Member Function Documentation

◆ updateLabels()

void updateLabels ( const labelList & map )

protected

Update map from map. Used to update cell/face labels.

after morphing

Definition at line 137 of file topoSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAllConstIter(), HashSet< Key, Hash >::insert(), IOobject::name(), List::size(), HashTable< nil, word, string::hash >::size(), HashTable< nil, word, string::hash >::transfer(), and Foam::type().

Referenced by faceSet::updateMesh(), pointSet::updateMesh(), and cellSet::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check()

void check ( const label maxLabel )

protected

Check validity of contents.

Definition at line 183 of file topoSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAllConstIter(), Foam::name(), and Foam::type().

Here is the call graph for this function:

◆ writeDebug() [1/5]

void writeDebug	(	Ostream &	os,
		const label	maxElem,
		topoSet::const_iterator &	iter,
		label &	elemI
	)		const

protected

Write part of contents nicely formatted. Prints labels only.

Definition at line 201 of file topoSet.C.

References Foam::endl(), HashTable::iteratorBase::key(), and n.

Referenced by doCommand(), faceSet::writeDebug(), pointSet::writeDebug(), and cellSet::writeDebug().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDebug() [2/5]

void writeDebug	(	Ostream &	os,
		const pointField &	coords,
		const label	maxElem,
		topoSet::const_iterator &	iter,
		label &	elemI
	)		const

protected

Write part of contents nicely formatted. Prints label.

and corresponding coordinate.

Definition at line 226 of file topoSet.C.

References Foam::endl(), HashTable::iteratorBase::key(), and n.

Here is the call graph for this function:

◆ writeDebug() [3/5]

void writeDebug	(	Ostream &	os,
		const pointField &	coords,
		const label	maxLen
	)		const

protected

Write labels and coordinates columnwise to os. Truncate to maxLen.

Definition at line 251 of file topoSet.C.

References Foam::endl(), boundBox::max(), boundBox::min(), n, and Foam::nl.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "topoSet" )

Runtime type information.

◆ localPath()

Foam::fileName localPath	(	const polyMesh &	mesh,
		const word &	name
	)

static

Name of file set will use.

Definition at line 124 of file topoSet.C.

References mesh, and Foam::name().

Referenced by cellToFace::combine().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable	(	autoPtr	,
		topoSet	,
		word	,
		(const polyMesh &mesh, const word &name, readOption r, writeOption w)	,
		(mesh, name, r, w)
	)

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	autoPtr	,
		topoSet	,
		size	,
		(const polyMesh &mesh, const word &name, const label size, writeOption w)	,
		(mesh, name, size, w)
	)

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable	(	autoPtr	,
		topoSet	,
		set	,
		(const polyMesh &mesh, const word &name, const topoSet &set, writeOption w)	,
		(mesh, name, set, w)
	)

◆ clone()

autoPtr<topoSet> clone ( ) const

inline

Clone.

Definition at line 219 of file topoSet.H.

References NotImplemented.

◆ New() [1/3]

Foam::autoPtr< Foam::topoSet > New	(	const word &	setType,
		const polyMesh &	mesh,
		const word &	name,
		readOption	r = `MUST_READ`,
		writeOption	w = `NO_WRITE`
	)