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

Inheritance diagram for topoSet:

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 &obj, 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. More...

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

	topoSet (const polyMesh &mesh, const word &name, const labelHashSet &labels, writeOption w=NO_WRITE)
	Construct (no-read) with copy of labelHashSet. More...

	topoSet (const polyMesh &mesh, const word &name, labelHashSet &&labels, writeOption w=NO_WRITE)
	Construct (no-read) with moving labelHashSet. More...

	topoSet (const polyMesh &mesh, const word &name, const labelUList &labels, writeOption w=NO_WRITE)
	Construct (no-read) with copy of labels. More...

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

	topoSet (const IOobject &io, const labelHashSet &labels)
	Construct from IOobject and copy of labelHashSet. More...

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

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

virtual	~topoSet ()=default
	Destructor. More...

virtual bool	found (const label id) const
	Has the given index? More...

virtual bool	set (const label id)
	Set an index. More...

virtual bool	unset (const label id)
	Unset an index. More...

virtual void	set (const labelUList &labels)
	Set multiple indices. More...

virtual void	unset (const labelUList &labels)
	Unset multiple indices. More...

virtual void	invert (const label maxLen)
	Invert contents. 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	subtractSet (const topoSet &set)
	Subtract 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

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 void	distribute (const mapDistributePolyMesh &)=0
	Update any stored data for mesh redistribution. 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...

virtual void	deleteSet (const topoSet &set)
	Deprecated(2018-10) subtract elements present in set. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and 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...

bool	store ()

void	release (const bool unregister=false)
	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 as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=true)
	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...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	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, bool globalObject=false)
	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, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return name. More...

const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

const string &	note () const noexcept
	Return the optional note. More...

string &	note () noexcept
	Return non-constant access to the optional note. More...

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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 noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from HashSet< Key, Hash >
	HashSet ()
	Default construct with default (128) table capacity. More...

	HashSet (const this_type &rhs)
	Copy construct. More...

	HashSet (this_type &&rhs)
	Move construct. More...

	HashSet (const label size)
	Construct given initial table capacity. More...

	HashSet (Istream &is)
	Construct from Istream with default table capacity. More...

template<unsigned N>
	HashSet (const FixedList< Key, N > &list)
	Construct from FixedList of Key. More...

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

template<class Addr >
	HashSet (const IndirectListBase< Key, Addr > &list)
	Construct from an indirect list. More...

	HashSet (std::initializer_list< Key > list)
	Construct from an initializer list of Key. More...

template<class AnyType , class AnyHash >
	HashSet (const HashTable< AnyType, Key, AnyHash > &tbl)

bool	test (const Key &key) const noexcept
	Same as found() - return true if key exists in the set. More...

bool	insert (const Key &key)
	Insert a new entry, not overwriting existing entries. More...

bool	set (const Key &key)
	Same as insert (no value to overwrite) More...

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

template<class InputIter >
label	insert (InputIter first, InputIter last)
	Insert keys from the input iterator range. More...

label	insert (std::initializer_list< Key > list)
	Insert keys from a initializer list of Key. More...

template<unsigned N>
label	insert (const FixedList< Key, N > &list)
	Insert keys from the list of Key. More...

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

template<class Addr >
label	insert (const IndirectListBase< Key, Addr > &list)
	Insert keys from the list of Key. More...

template<class InputIter >
label	set (InputIter first, InputIter last)
	Same as insert (no value to overwrite) More...

label	set (std::initializer_list< Key > list)
	Same as insert (no value to overwrite) More...

template<unsigned N>
label	set (const FixedList< Key, N > &list)
	Same as insert (no value to overwrite) More...

label	set (const UList< Key > &list)
	Same as insert (no value to overwrite) More...

template<class Addr >
label	set (const IndirectListBase< Key, Addr > &list)
	Same as insert (no value to overwrite) More...

template<class InputIter >
label	setMany (InputIter first, InputIter last)
	Same as insert (no value to overwrite) More...

template<class InputIter >
label	unset (InputIter first, InputIter last)
	Unset the keys listed in the input iterator range. More...

label	unset (std::initializer_list< Key > list)
	Unset the listed keys - same as erase. More...

template<unsigned N>
label	unset (const FixedList< Key, N > &list)
	Unset the listed keys - same as erase. More...

label	unset (const UList< Key > &list)
	Unset the listed keys - same as erase. More...

template<class Addr >
label	unset (const IndirectListBase< Key, Addr > &list)
	Unset the listed keys - same as erase. More...

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

iterator	end () noexcept

const_iterator	end () const noexcept

constexpr const_iterator	cend () const noexcept

Ostream &	writeList (Ostream &os, const label shortLen=0) const

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

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

void	operator= (const this_type &rhs)
	Copy assign. More...

void	operator= (this_type &&rhs)
	Move assign. More...

bool	operator== (const this_type &rhs) const

bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...

void	operator= (const UList< Key > &rhs)
	Assignment from a UList of keys. More...

template<unsigned N>
void	operator= (const FixedList< Key, N > &rhs)
	Assignment from a FixedList of keys. More...

void	operator= (std::initializer_list< Key > rhs)
	Assignment from an initializer list of keys. More...

this_type &	operator\|= (const this_type &rhs)
	Add entries to this HashSet. More...

this_type &	operator&= (const this_type &rhs)
	Only retain entries found in both HashSets. More...

this_type &	operator^= (const this_type &rhs)
	Only retain unique entries (xor) More...

this_type &	operator+= (const this_type &rhs)
	Add entries to this HashSet. Same as the '\|=' operator. More...

this_type &	operator-= (const this_type &rhs)
	Remove entries from this HashSet. Uses erase() More...

template<class UnaryPredicate >
List< Key >	tocValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

template<class BinaryPredicate >
List< Key >	tocEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

template<class UnaryPredicate >
label	countValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

template<class BinaryPredicate >
label	countEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

template<class UnaryPredicate >
label	filterValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

template<class BinaryPredicate >
label	filterEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

template<class InputIter >
Foam::label	assignMany (const label nItems, InputIter first, InputIter last)

template<class InputIter>
Foam::label	insert (InputIter first, InputIter last)

template<unsigned N>
Foam::label	insert (const FixedList< Key, N > &list)

template<class Addr>
Foam::label	insert (const IndirectListBase< Key, Addr > &list)

template<class InputIter>
Foam::label	unset (InputIter first, InputIter last)

template<unsigned N>
Foam::label	unset (const FixedList< Key, N > &list)

template<class Addr>
Foam::label	unset (const IndirectListBase< Key, Addr > &list)

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

static IOobject	findIOobject (const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Find IOobject in the polyMesh/sets (used as constructor helper) More...

static IOobject	findIOobject (const Time &runTime, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Find IOobject in the polyMesh/sets (used as constructor helper) 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...

template<class Container >
static void	updateMesh (const fileName &instance, const mapPolyMesh &, Container &)
	Helper: call updateMesh on all sets in container (and. More...

template<class Container >
static void	setInstance (const fileName &instance, Container &)
	Helper: set instance on all sets in container. More...

static void	removeFiles (const polyMesh &)
	Helper: remove all sets files from mesh instance. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Attributes
static int	disallowGenericSets
	Debug switch to disallow the use of generic sets. More...

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Protected Member Functions
virtual void	updateLabels (const labelUList &map)
	Update map from map. More...

virtual void	check (const label maxSize)
	Check limits on addressable range. 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 &)=delete
	No copy construct. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from HashSet< Key, Hash >
typedef HashSet< Key, Hash >	this_type
	The template instance used for this HashSet. More...

typedef HashTable< zero::null, Key, Hash >	parent_type
	The template instance used for the parent HashTable. More...

using	iterator = typename parent_type::key_iterator
	An iterator, returning reference to the key. More...

using	const_iterator = typename parent_type::const_key_iterator
	A const_iterator, returning reference to the key. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

Source files

Definition at line 63 of file topoSet.H.

Constructor & Destructor Documentation

◆ topoSet() [1/10]

topoSet ( const topoSet & )

protecteddelete

No copy construct.

◆ topoSet() [2/10]

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 384 of file topoSet.C.

References regIOobject::close(), IOobject::good(), regIOobject::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/10]

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 the mesh.facesInstance().

Definition at line 406 of file topoSet.C.

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

◆ topoSet() [4/10]

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 the mesh.facesInstance().

Definition at line 434 of file topoSet.C.

◆ topoSet() [5/10]

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

Construct (no-read) with copy of labelHashSet.

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

Definition at line 447 of file topoSet.C.

◆ topoSet() [6/10]

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

Construct (no-read) with moving labelHashSet.

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

Definition at line 460 of file topoSet.C.

◆ topoSet() [7/10]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		const labelUList &	labels,
		writeOption	w = `NO_WRITE`
	)

Construct (no-read) with copy of labels.

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

Definition at line 473 of file topoSet.C.

◆ topoSet() [8/10]

topoSet	(	const IOobject &	io,
		const label	size
	)

Construct empty from IOobject and HashSet size.

Definition at line 485 of file topoSet.C.

◆ topoSet() [9/10]

topoSet	(	const IOobject &	io,
		const labelHashSet &	labels
	)

Construct from IOobject and copy of labelHashSet.

Definition at line 492 of file topoSet.C.

◆ topoSet() [10/10]

topoSet	(	const IOobject &	io,
		labelHashSet &&	labels
	)

Construct from IOobject and move labelHashSet.

Definition at line 499 of file topoSet.C.

◆ ~topoSet()

virtual ~topoSet ( )

virtualdefault

Destructor.

Member Function Documentation

◆ updateLabels()

void updateLabels ( const labelUList & map )

protectedvirtual

Update map from map.

Used to update cell/face labels after morphing

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 147 of file topoSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, IOobject::name(), Foam::nl, UList< T >::size(), and Foam::type().

Here is the call graph for this function:

◆ check()

void check ( const label maxSize )

protectedvirtual

Check limits on addressable range.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 203 of file topoSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, 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 224 of file topoSet.C.

References stdFoam::cend(), n, Foam::nl, and os().

Referenced by faceBitSet::writeDebug(), faceBoolSet::writeDebug(), pointBitSet::writeDebug(), cellBitSet::writeDebug(), pointSet::writeDebug(), faceSet::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 249 of file topoSet.C.

References stdFoam::cend(), n, Foam::nl, and os().

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 274 of file topoSet.C.

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

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 134 of file topoSet.C.

References mesh, and Foam::name().

Here is the call graph for this function:

◆ findIOobject() [1/2]

Foam::IOobject findIOobject	(	const polyMesh &	mesh,
		const word &	name,
		readOption	r = `MUST_READ`,
		writeOption	w = `NO_WRITE`
	)

static

Find IOobject in the polyMesh/sets (used as constructor helper)

Definition at line 318 of file topoSet.C.

References polyMesh::dbDir(), DebugInfo, Foam::endl(), polyMesh::facesInstance(), Time::findInstance(), mesh, polyMesh::meshSubDir, Foam::name(), IOobject::NO_READ, word::null, IOobject::READ_IF_PRESENT, IOobject::readOpt(), fvMesh::time(), and IOobject::typeHeaderOk().

Referenced by fvExprDriver::topoSetType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findIOobject() [2/2]

Foam::IOobject findIOobject	(	const Time &	runTime,
		const word &	name,
		readOption	r = `MUST_READ`,
		writeOption	w = `NO_WRITE`
	)

static

Find IOobject in the polyMesh/sets (used as constructor helper)

Definition at line 352 of file topoSet.C.

References Time::findInstance(), polyMesh::meshSubDir, IOobject::MUST_READ, Foam::name(), word::null, IOobject::READ_IF_PRESENT, and runTime.

Here is the call 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 265 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`
	)

static

Return a pointer to a toposet read from file.

Definition at line 55 of file topoSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and Foam::name().

Here is the call graph for this function:

◆ New() [2/3]

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

static

Return a pointer to a new toposet of given size.

Definition at line 81 of file topoSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and Foam::name().

Here is the call graph for this function:

◆ New() [3/3]

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

static

Return a pointer to a new toposet as copy of another toposet.

Definition at line 107 of file topoSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, Foam::name(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ found()

bool found ( const label id ) const

virtual

Has the given index?

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 508 of file topoSet.C.

Referenced by faceZoneToFaceZone::applyToSet(), setToCellZone::applyToSet(), setToPointZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setToFaceZone::applyToSet(), searchableSurfaceToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), and polyMeshFilter::filter().

Here is the caller graph for this function:

◆ set() [1/2]

bool set ( const label id )

virtual

Set an index.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 514 of file topoSet.C.

References HashSet< Key, Hash >::set().

Referenced by cellZoneSet::updateSet(), pointZoneSet::updateSet(), and faceZoneSet::updateSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unset() [1/2]

bool unset ( const label id )

virtual

Unset an index.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 520 of file topoSet.C.

References HashSet< Key, Hash >::unset().

Here is the call graph for this function:

◆ set() [2/2]

void set ( const labelUList & labels )

virtual

Set multiple indices.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 526 of file topoSet.C.

References HashSet< Key, Hash >::set().

Here is the call graph for this function:

◆ unset() [2/2]

void unset ( const labelUList & labels )

virtual

Unset multiple indices.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 532 of file topoSet.C.

References HashSet< Key, Hash >::unset().

Here is the call graph for this function:

◆ invert()

void invert ( const label maxLen )

virtual

Invert contents.

Insert all members [0,maxLen) which were not in set.

Reimplemented in topoBitSet, topoBoolSet, faceZoneSet, pointZoneSet, and cellZoneSet.

Definition at line 538 of file topoSet.C.

References clear(), Foam::max(), resize(), and Foam::BitOps::set().

Here is the call graph for this function:

◆ subset()

void subset ( const topoSet & set )

virtual

Subset contents. Only elements present in both sets remain.

Reimplemented in topoBitSet, topoBoolSet, faceZoneSet, pointZoneSet, and cellZoneSet.

Definition at line 559 of file topoSet.C.

References Foam::BitOps::set().

Here is the call graph for this function:

◆ addSet()

void addSet ( const topoSet & set )

virtual

Add elements present in set.

Reimplemented in topoBitSet, topoBoolSet, faceZoneSet, pointZoneSet, and cellZoneSet.

Definition at line 566 of file topoSet.C.

References Foam::BitOps::set().

Here is the call graph for this function:

◆ subtractSet()

void subtractSet ( const topoSet & set )

virtual

Subtract elements present in set.

Reimplemented in topoBitSet, topoBoolSet, faceZoneSet, pointZoneSet, and cellZoneSet.

Definition at line 573 of file topoSet.C.

References Foam::BitOps::set().

Here is the call graph for this function:

◆ sync()

void sync ( const polyMesh & mesh )

virtual

Sync set across coupled patches.

Reimplemented in cellSet, faceZoneSet, pointZoneSet, cellZoneSet, faceSet, pointSet, cellBitSet, faceBitSet, faceBoolSet, and pointBitSet.

Definition at line 586 of file topoSet.C.

References NotImplemented.

◆ writeDebug() [4/5]

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

virtual

Write labels columnwise to os. Truncate to maxLen.

Definition at line 592 of file topoSet.C.

References stdFoam::cbegin(), Foam::endl(), n, Foam::nl, and os().

Here is the call graph for this function:

◆ writeDebug() [5/5]

virtual void writeDebug	(	Ostream &	os,
		const primitiveMesh &	,
		const label	maxLen
	)		const

pure virtual

Like above but also writes mesh related quantity (usually coordinate).

Implemented in cellBitSet, faceBitSet, faceBoolSet, pointBitSet, cellSet, faceZoneSet, faceSet, pointSet, pointZoneSet, and cellZoneSet.

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write contents.

Implements regIOobject.

Definition at line 623 of file topoSet.C.

References os().

Here is the call graph for this function:

◆ updateMesh() [1/2]

void updateMesh ( const mapPolyMesh & morphMap )

virtual

Update any stored data for new labels. Not implemented.

Reimplemented in cellSet, faceZoneSet, pointZoneSet, cellZoneSet, faceSet, pointSet, cellBitSet, faceBitSet, faceBoolSet, and pointBitSet.

Definition at line 629 of file topoSet.C.

References NotImplemented.

◆ distribute()

virtual void distribute ( const mapDistributePolyMesh & )

pure virtual

Update any stored data for mesh redistribution.

Implemented in cellSet, faceSet, cellBitSet, faceBitSet, faceBoolSet, pointBitSet, and pointSet.

◆ maxSize()

virtual label maxSize ( const polyMesh & mesh ) const

pure virtual

Return max allowable index (+1). Not implemented.

Implemented in cellSet, faceZoneSet, pointZoneSet, cellZoneSet, faceSet, pointSet, cellBitSet, faceBitSet, faceBoolSet, and pointBitSet.

◆ updateMesh() [2/2]

void updateMesh	(	const fileName &	instance,
		const mapPolyMesh &	map,
		Container &	lst
	)

static

Helper: call updateMesh on all sets in container (and.

updates instance)

Definition at line 47 of file topoSetTemplates.C.

References forAll.

◆ setInstance()

void setInstance	(	const fileName &	instance,
		Container &	lst
	)

static

Helper: set instance on all sets in container.

Definition at line 33 of file topoSetTemplates.C.

References forAll.

◆ removeFiles()

void removeFiles ( const polyMesh & mesh )

static

Helper: remove all sets files from mesh instance.

Definition at line 635 of file topoSet.C.

References Foam::expressions::patchExpr::debug, DebugVar, polyMesh::facesInstance(), Foam::isDir(), mesh, polyMesh::meshSubDir, and Foam::rmDir().

Here is the call graph for this function:

◆ operator=()

void operator= ( const topoSet & rhs )

Copy labelHashSet part only.

Definition at line 657 of file topoSet.C.

References HashSet< label, Hash< label > >::operator=().

Here is the call graph for this function:

◆ deleteSet()

void deleteSet ( const topoSet & set )

virtual

Deprecated(2018-10) subtract elements present in set.

Deprecated:: (2018-10) - use subtractSet instead

Definition at line 580 of file topoSet.C.

References Foam::BitOps::set().

Here is the call graph for this function:

Member Data Documentation

◆ disallowGenericSets

int disallowGenericSets

static

Debug switch to disallow the use of generic sets.

Definition at line 120 of file topoSet.H.

Referenced by columnFvMeshInfo::columnFvMeshInfo().

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

src/meshTools/sets/topoSets/topoSet.H
src/meshTools/sets/topoSets/topoSet.C
src/meshTools/sets/topoSets/topoSetTemplates.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ topoSet() [1/10]

◆ topoSet() [2/10]

◆ topoSet() [3/10]

◆ topoSet() [4/10]

◆ topoSet() [5/10]

◆ topoSet() [6/10]

◆ topoSet() [7/10]

◆ topoSet() [8/10]

◆ topoSet() [9/10]

◆ topoSet() [10/10]

◆ ~topoSet()

Member Function Documentation

◆ updateLabels()

◆ check()

◆ writeDebug() [1/5]

◆ writeDebug() [2/5]

◆ writeDebug() [3/5]

◆ TypeName()

◆ localPath()

◆ findIOobject() [1/2]

◆ findIOobject() [2/2]

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ clone()

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ found()

◆ set() [1/2]

◆ unset() [1/2]

◆ set() [2/2]

◆ unset() [2/2]

◆ invert()

◆ subset()

◆ addSet()

◆ subtractSet()

◆ sync()

◆ writeDebug() [4/5]

◆ writeDebug() [5/5]

◆ writeData()

◆ updateMesh() [1/2]

◆ distribute()

◆ maxSize()

◆ updateMesh() [2/2]

◆ setInstance()

◆ removeFiles()

◆ operator=()

◆ deleteSet()

Member Data Documentation

◆ disallowGenericSets