A polyBoundaryMesh is a polyPatch list with registered IO, a reference to the associated polyMesh, with additional search methods etc. More...

#include <polyBoundaryMesh.H>

Inheritance diagram for polyBoundaryMesh:

[legend]

Collaboration diagram for polyBoundaryMesh:

[legend]

Public Member Functions
	TypeName ("polyBoundaryMesh")
	Runtime type information.
	polyBoundaryMesh (const polyBoundaryMesh &)=delete
	No copy construct.
void	operator= (const polyBoundaryMesh &)=delete
	No copy assignment.
	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh)
	Read construct given IOobject and a mesh reference. It will only read for MUST_READ variants (not READ_IF_PRESENT).
	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, Foam::zero)
	Construct empty with IOobject properties and a mesh reference. Does not read.
	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const label size)
	Construct with specified size. Does not read.
	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const polyPatchList &list)
	Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning).
	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, PtrList< entry > &&entries)
	Read construct (mandatory, optional) based on IOobject properties or fallback to constructing from a list of dictionary entries.
	~polyBoundaryMesh ()=default
	Destructor.
void	clear ()
	Clear the patch list and all demand-driven data.
void	clearGeom ()
	Clear geometry at this level and at patches.
void	clearAddressing ()
	Clear addressing at this level and at patches.
const polyMesh &	mesh () const noexcept
	Return the mesh reference.
const faceList::subList	faces () const
	Return mesh faces for the entire boundary.
const labelList::subList	faceOwner () const
	Return face owner for the entire boundary.
UPtrList< const labelUList >	faceCells () const
	Return a list of faceCells for each patch.
const List< labelPairList > &	neighbourEdges () const
	Per patch the edges on the neighbouring patch.
label	nNonProcessor () const
	The number of patches before the first processor patch.
label	nProcessorPatches () const
	The number of processorPolyPatch patches.
label	nNonProcessorFaces () const
	The number of boundary faces before the first processor patch.
wordList	names () const
	Return a list of patch names.
wordList	types () const
	Return a list of patch types.
wordList	physicalTypes () const
	Return a list of physical types.
labelList	patchStarts () const
	Return a list of patch start face indices.
labelList	patchSizes () const
	Return a list of patch sizes.
List< labelRange >	patchRanges () const
	Return a list of patch ranges.
wordList	groupNames () const
	A list of the group names (if any).
label	start () const noexcept
	The start label of boundary faces in the polyMesh face list.
label	nFaces () const noexcept
	The number of boundary faces in the underlying mesh.
template<class UnaryPredicate>
label	nFaces_if (UnaryPredicate pred) const
	The number of boundary faces with patches that match the given predicate.
labelRange	range () const noexcept
	The face range for all boundary faces.
labelRange	range (const label patchi) const
	Return the range used for boundary faces on patchi.
labelList	indices (const wordRe &matcher, const bool useGroups=true) const
	The (sorted) patch indices for all matches, optionally matching patch groups.
labelList	indices (const wordRes &matcher, const bool useGroups=true) const
	The (sorted) patch indices for all matches, optionally matching patch groups.
labelList	indices (const wordRes &allow, const wordRes &deny, const bool useGroups=true) const
	The (sorted) patch indices: logic as per Foam::wordRes::filter, optionally matching patch groups.
template<class PatchType>
labelList	indices_if () const
	Return (sorted) patch indices for patches that match the given polyPatch type (uses `isA` test). Can be used as a direct alternative to findPatchIDs.
template<class UnaryPredicate>
labelList	indices_if (UnaryPredicate pred) const
	Return (sorted) patch indices for patches that match the given predicate. Can be used as an alternative to findPatchIDs.
label	findIndex (const wordRe &key) const
	Return patch index for the first match, return -1 if not found.
label	findPatchID (const word &patchName, const bool allowNotFound=true) const
	Find patch index given a name, return -1 if not found.
const polyPatch *	cfindPatch (const word &patchName) const
	Find patch by name and return const pointer.
template<class PatchType>
labelHashSet	findPatchIDs () const
	Find patch indices for a given polyPatch type (uses `isA` test).
labelPair	whichPatchFace (const label meshFacei) const
	Lookup mesh face index and return (patchi, patchFacei) tuple or (-1, meshFacei) for internal faces.
labelPairList	whichPatchFace (const labelUList &meshFaceIndices) const
	Lookup mesh face indices and return (patchi, patchFacei) tuples.
label	whichPatch (const label meshFacei) const
	Return patch index for a given mesh face index. Uses binary search.
const labelList &	patchID () const
	Per boundary face label the patch index.
label	patchID (const label meshFacei) const
	Return patch index for a given mesh face index. Uses direct lookup into patchID() list. Returns -1 for internal or out-of-range faces.
labelList	patchID (const labelUList &meshFaceIndices) const
	Lookup mesh face indices and return patch indices. Uses direct lookup into patchID() list. Returns values of -1 for internal or out-of-range faces.
const HashTable< labelList > &	groupPatchIDs () const
	The patch indices per patch group.
void	setGroup (const word &groupName, const labelUList &patchIDs)
	Set/add group with patches.
labelHashSet	patchSet (const UList< wordRe > &select, const bool warnNotFound=true, const bool useGroups=true) const
	Return the set of patch IDs corresponding to the given names.
void	matchGroups (const labelUList &patchIDs, wordList &groups, labelHashSet &nonGroupPatches) const
	Match the patches to groups.
bool	checkParallelSync (const bool report=false) const
	Check whether all procs have all patches and in same order.
bool	checkDefinition (const bool report=false) const
	Check boundary definition.
void	movePoints (const pointField &p)
	Correct polyBoundaryMesh after moving points.
void	updateMesh ()
	Correct polyBoundaryMesh after topology update.
void	reorder (const labelUList &oldToNew, const bool validBoundary)
	Reorders patches. Ordering does not have to be done in.
void	writeEntry (Ostream &os) const
	Write as a plain list of entries.
void	writeEntry (const word &keyword, Ostream &os) const
	Write as a primitive entry with given name. If the keyword is empty, revert to a plain list.
virtual bool	writeData (Ostream &os) const
	The writeData member function required by regIOobject.
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc=true) const
	Write using stream options, but always UNCOMPRESSED.
const polyPatch &	operator[] (const word &patchName) const
	Return const reference to polyPatch by name.
polyPatch &	operator[] (const word &patchName)
	Return reference to polyPatch by name.
labelList	findIndices (const wordRe &key, bool useGroups=true) const
	Identical to the indices() method (AUG-2018).
Public Member Functions inherited from PtrList< polyPatch >
constexpr	PtrList () noexcept
	Default construct.
	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr.
	PtrList (const PtrList< polyPatch > &list)
	Copy construct using 'clone()' method on each element.
	PtrList (PtrList< polyPatch > &&list) noexcept
	Move construct.
	PtrList (UList< polyPatch * > &list)
	Take ownership of pointers in the list, set old pointers to null.
	PtrList (const PtrList< polyPatch > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element.
	PtrList (PtrList< polyPatch > &list, bool reuse)
	Construct as copy or re-use as specified.
	PtrList (const SLPtrList< polyPatch > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T>.
	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class.
	PtrList (Istream &is)
	Construct from Istream using default Istream constructor class.
	~PtrList ()
	Destructor. Frees all pointers.
PtrList< polyPatch >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements.
const polyPatch *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero.
void	free ()
	Free memory and nullify all entries. Does not change the list size.
void	resize (const label newLen)
	Adjust size of PtrList.
void	resize_null (const label newLen)
	Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all `nullptr` entries.
polyPatch &	emplace_back (Args &&... args)
	Construct and append an element to the end of the list, return reference to the new list element.
void	push_back (polyPatch *ptr)
	Append an element to the end of the list.
void	push_back (std::unique_ptr< polyPatch > &&ptr)
	Move append an element to the end of the list.
void	push_back (autoPtr< polyPatch > &&ptr)
	Move append an element to the end of the list.
void	push_back (const refPtr< polyPatch > &ptr)
	Move or clone append a refPtr to the end of the list.
void	push_back (const tmp< polyPatch > &ptr)
	Move or clone append a tmp to the end of the list.
void	push_back (PtrList< polyPatch > &&other)
	Move append another list to the end of this list.
polyPatch &	emplace_set (const label i, Args &&... args)
	Construct and set a new element at given position, (discard old element at that location).
polyPatch &	emplace (const label i, Args &&... args)
	Same as emplace_set().
polyPatch &	try_emplace (const label i, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location.
autoPtr< polyPatch >	set (const label i, polyPatch *ptr)
	Set element to given pointer and return old element (can be null).
autoPtr< polyPatch >	set (const label i, std::unique_ptr< polyPatch > &&ptr)
	Set element to given unique_ptr and return old element.
autoPtr< polyPatch >	set (const label i, autoPtr< polyPatch > &&ptr)
	Set element to given autoPtr and return old element.
autoPtr< polyPatch >	set (const label i, const refPtr< polyPatch > &ptr)
	Set element to given refPtr and return old element.
autoPtr< polyPatch >	set (const label i, const tmp< polyPatch > &ptr)
	Set element to given tmp and return old element.
autoPtr< polyPatch >	release (const label i)
	Release ownership of the pointer at the given position.
void	transfer (PtrList< polyPatch > &list)
	Transfer into this list and annul the argument list.
void	operator= (const UPtrList< polyPatch > &list)
	Copy assignment.
void	operator= (const PtrList< polyPatch > &list)
	Copy assignment.
void	operator= (PtrList< polyPatch > &&list)
	Move assignment.
void	push_back (autoPtr< polyPatch > &ptr)=delete
	Disallow push_back with autoPtr without std::move.
autoPtr< polyPatch >	set (const label i, autoPtr< polyPatch > &ptr)
	Set element to given autoPtr and return old element.
void	setSize (const label n)
	Same as resize().
void	append (autoPtr< polyPatch > &ptr)
	Move append an element to the end of the list.
void	append (polyPatch *ptr)
	Append an element to the end of the list.
void	append (std::unique_ptr< polyPatch > &&ptr)
	Move append an element to the end of the list.
void	append (autoPtr< polyPatch > &&ptr)
	Move append an element to the end of the list.
void	append (const refPtr< polyPatch > &ptr)
	Move or clone append a tmp to the end of the list.
void	append (const tmp< polyPatch > &ptr)
	Move or clone append a tmp to the end of the list.
void	append (PtrList< polyPatch > &&other)
	Move append another list to the end of this list.
Foam::PtrList< polyPatch >	clone (Args &&... args) const
Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept=default
	Default construct.
	UPtrList (const label len)
	Construct with specified size and set all entries to `nullptr`.
	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses).
	UPtrList (UPtrList< T > &&list) noexcept
	Move construct.
	UPtrList (UPtrList< T > &list, bool reuse)
	Construct as shallow copy or re-use as specified.
	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList.
	UPtrList (const UList< T * > &list)
	Construct from UList of pointers (shallow copy).
	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element.
bool	empty () const noexcept
	True if the list is empty (ie, size() is zero).
label	size () const noexcept
	The number of entries in the list.
label	capacity () const noexcept
	Size of the underlying storage.
label	count_nonnull () const noexcept
	The number of non-nullptr entries in the list.
T &	front ()
	Reference to the first element of the list.
const T &	front () const
	Reference to first element of the list.
T &	back ()
	Reference to the last element of the list.
const T &	back () const
	Reference to the last element of the list.
const T *	test (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
const T *	get (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
T *	get (const label i)
	Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
const T *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
void	clear ()
	Set list size to zero.
void	free ()
	Nullify all entries. Does not change the list size.
void	resize (const label newLen)
	Change the size of the list. Any new entries are `nullptr`.
void	resize_null (const label newLen)
	Set the list to the given size and set all entries to `nullptr`.
label	squeezeNull ()
	Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list.
void	push_back (T *ptr)
	Append an element to the end of the list.
void	push_back (UPtrList< T > &&other)
	Move append another list to the end of this list.
void	swap (UPtrList< T > &list) noexcept
	Swap content.
void	transfer (UPtrList< T > &list)
	Transfer contents into this list and annul the argument.
T *	set (const label i, T *ptr)
	Set element to specified pointer and return the old list element, which can be a nullptr.
void	reorder (const labelUList &oldToNew, const bool check=false)
	Reorder elements. Reordering must be unique (ie, shuffle).
void	sortOrder (const labelUList &order, const bool check=false)
	Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle).
void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list.
const T &	at (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr.
T &	at (const label i)
	Return reference to the element at given position. FatalError for bounds problem or nullptr.
const T &	operator[] (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at().
T &	operator[] (const label i)
	Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at().
	FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const
	Deprecated(2022-09) - same as get().
void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses).
void	operator= (UPtrList< T > &&list)
	Move assignment.
Ostream &	printAddresses (Ostream &os) const
	Print pointer addresses to Ostream (debugging only).
Ostream &	writeList (Ostream &os, const bool trimNull=false) const
	Write UPtrList to Ostream, optionally ignoring null entries.
T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution).
T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution).
iterator	begin ()
	Return iterator to begin traversal of non-nullptr entries.
iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal.
const_iterator	cbegin () const
	Return const_iterator to begin traversal of non-nullptr entries.
const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal.
const_iterator	begin () const
	Return const_iterator to begin traversal of non-nullptr entries.
const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal.
void	setSize (const label n)
	Alias for resize().
T &	first ()
	Reference to the first element of the list.
const T &	first () const
	Return reference to first element of the list.
T &	last ()
	Return reference to the last element of the list.
const T &	last () const
	Return reference to the last element of the list.
void	append (T *ptr)
	Append an element to the end of the list.
void	append (UPtrList< T > &&other)
	Move append another list to the end of this list.
label	count () const noexcept
	The number of non-nullptr entries in the list.
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 bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
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	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.

Friends
class	polyMesh
	Declare friendship with polyMesh.
Ostream &	operator<< (Ostream &os, const polyBoundaryMesh &pbm)

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the list contains.
typedef T &	reference
	A non-const reference to the value_type.
typedef const T &	const_reference
	A const reference to the value_type.
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 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.
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 PtrList< polyPatch >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class.
Protected Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size.
label	find_next (label pos) const
	The next non-null entry after the specified position.
	UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept
	Low-level move construct.
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.
Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

A polyBoundaryMesh is a polyPatch list with registered IO, a reference to the associated polyMesh, with additional search methods etc.

Source files

Definition at line 61 of file polyBoundaryMesh.H.

Constructor & Destructor Documentation

◆ polyBoundaryMesh() [1/6]

polyBoundaryMesh ( const polyBoundaryMesh & )

delete

No copy construct.

References polyBoundaryMesh().

Referenced by checkDefinition(), checkParallelSync(), operator<<, operator=(), and polyBoundaryMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ polyBoundaryMesh() [2/6]

polyBoundaryMesh	(	const IOobject &	io,
		const polyMesh &	mesh )

Read construct given IOobject and a mesh reference. It will only read for MUST_READ variants (not READ_IF_PRESENT).

Definition at line 170 of file polyBoundaryMesh.C.

References io, mesh(), polyMesh, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ polyBoundaryMesh() [3/6]

polyBoundaryMesh	(	const IOobject &	io,
		const polyMesh &	mesh,
		Foam::zero	)

Construct empty with IOobject properties and a mesh reference. Does not read.

Definition at line 184 of file polyBoundaryMesh.C.

References io, polyMesh, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ polyBoundaryMesh() [4/6]

polyBoundaryMesh	(	const IOobject &	io,
		const polyMesh &	mesh,
		const label	size )

Construct with specified size. Does not read.

Definition at line 197 of file polyBoundaryMesh.C.

References io, polyMesh, regIOobject::regIOobject(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ polyBoundaryMesh() [5/6]

polyBoundaryMesh	(	const IOobject &	io,
		const polyMesh &	mesh,
		const polyPatchList &	list )

Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning).

Definition at line 210 of file polyBoundaryMesh.C.

References IOobject::clone(), forAll, io, patches, polyMesh, regIOobject::regIOobject(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ polyBoundaryMesh() [6/6]

polyBoundaryMesh	(	const IOobject &	io,
		const polyMesh &	mesh,
		PtrList< entry > &&	entries )

Read construct (mandatory, optional) based on IOobject properties or fallback to constructing from a list of dictionary entries.

Definition at line 235 of file polyBoundaryMesh.C.

References io, polyMesh, PtrList< polyPatch >::PtrList(), and regIOobject::regIOobject().

Here is the call graph for this function:

◆ ~polyBoundaryMesh()

~polyBoundaryMesh ( )

default

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polyBoundaryMesh" )

Runtime type information.

◆ operator=()

void operator= ( const polyBoundaryMesh & )

delete

No copy assignment.

References io, mesh(), polyBoundaryMesh(), polyMesh, PtrList< polyPatch >::PtrList(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ clear()

void clear ( )

Clear the patch list and all demand-driven data.

Definition at line 256 of file polyBoundaryMesh.C.

References PtrList< polyPatch >::clear(), and clearAddressing().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

Clear geometry at this level and at patches.

Definition at line 263 of file polyBoundaryMesh.C.

References p, and patches.

◆ clearAddressing()

void clearAddressing ( )

Clear addressing at this level and at patches.

Definition at line 283 of file polyBoundaryMesh.C.

References p, and patches.

Referenced by clear().

Here is the caller graph for this function:

◆ mesh()

const polyMesh & mesh ( ) const

inlinenoexcept

Return the mesh reference.

Definition at line 230 of file polyBoundaryMesh.H.

References Foam::noexcept, and polyMesh.

Referenced by cyclicAMIPolyPatch::canResetAMI(), processorPolyPatch::comm(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), operator=(), polyBoundaryMesh(), and cyclicACMIPolyPatch::updateAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faces()

const Foam::faceList::subList faces ( ) const

Return mesh faces for the entire boundary.

Definition at line 350 of file polyBoundaryMesh.C.

◆ faceOwner()

const Foam::labelList::subList faceOwner ( ) const

Return face owner for the entire boundary.

Definition at line 361 of file polyBoundaryMesh.C.

◆ faceCells()

Foam::UPtrList< const Foam::labelUList > faceCells ( ) const

Return a list of faceCells for each patch.

Definition at line 379 of file polyBoundaryMesh.C.

References faceCells(), forAll, patches, and UPtrList< T >::set().

Referenced by faceCells(), thermoSingleLayer::Sh(), thermoSingleLayer::Srho(), and thermoSingleLayer::Srho().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ neighbourEdges()

const Foam::List< Foam::labelPairList > & neighbourEdges ( ) const

Per patch the edges on the neighbouring patch.

Is for every external edge the neighbouring patch and neighbouring (external) patch edge label. Note that edge indices are offset by nInternalEdges to keep it as much as possible consistent with coupled patch addressing (where coupling is by local patch face index). Only valid for singly connected polyBoundaryMesh and not parallel

Definition at line 395 of file polyBoundaryMesh.C.

References Foam::abort(), e, Foam::endl(), HashTable< T, Key, Hash >::erase(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::find(), forAll, HashTable< T, Key, Hash >::insert(), neighbourEdges(), Foam::nl, operator[](), UPstream::parRun(), pp(), HashTable< T, Key, Hash >::size(), UList< T >::size(), UPtrList< T >::size(), and WarningInFunction.

Referenced by neighbourEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nNonProcessor()

Foam::label nNonProcessor ( ) const

The number of patches before the first processor patch.

Definition at line 618 of file polyBoundaryMesh.C.

References UPtrList< T >::count(), Foam::isA(), p, and patches.

Referenced by fvMeshSubset::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nProcessorPatches()

Foam::label nProcessorPatches ( ) const

The number of processorPolyPatch patches.

Definition at line 638 of file polyBoundaryMesh.C.

References UPtrList< T >::count(), Foam::isA(), p, and patches.

Here is the call graph for this function:

◆ nNonProcessorFaces()

Foam::label nNonProcessorFaces ( ) const

The number of boundary faces before the first processor patch.

Definition at line 656 of file polyBoundaryMesh.C.

References UPtrList< T >::count(), Foam::isA(), p, and patches.

Here is the call graph for this function:

◆ names()

Foam::wordList names ( ) const

Return a list of patch names.

Definition at line 676 of file polyBoundaryMesh.C.

References Foam::PtrListOps::get().

Referenced by fvMeshSubset::reset(), and mappedPatchBase::samplePolyPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ types()

Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 682 of file polyBoundaryMesh.C.

References Foam::PtrListOps::get().

Here is the call graph for this function:

◆ physicalTypes()

Foam::wordList physicalTypes ( ) const

Return a list of physical types.

Definition at line 688 of file polyBoundaryMesh.C.

References Foam::PtrListOps::get(), and p.

Here is the call graph for this function:

◆ patchStarts()

Foam::labelList patchStarts ( ) const

Return a list of patch start face indices.

Definition at line 699 of file polyBoundaryMesh.C.

References Foam::PtrListOps::get(), and p.

Referenced by polyMeshAdder::add(), and polyMeshAdder::add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchSizes()

Foam::labelList patchSizes ( ) const

Return a list of patch sizes.

Definition at line 710 of file polyBoundaryMesh.C.

References Foam::PtrListOps::get(), and p.

Referenced by polyMeshAdder::add(), and polyMeshAdder::add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchRanges()

Foam::List< Foam::labelRange > patchRanges ( ) const

Return a list of patch ranges.

Definition at line 721 of file polyBoundaryMesh.C.

References Foam::PtrListOps::get(), and p.

Here is the call graph for this function:

◆ groupNames()

Foam::wordList groupNames ( ) const

A list of the group names (if any).

Definition at line 732 of file polyBoundaryMesh.C.

References groupPatchIDs().

Here is the call graph for this function:

◆ start()

Foam::label start ( ) const

noexcept

The start label of boundary faces in the polyMesh face list.

Same as polyMesh::nInternalFaces()

Definition at line 738 of file polyBoundaryMesh.C.

References Foam::noexcept.

Referenced by attachPolyTopoChanger::attach(), checkDefinition(), dynamicRefineFvMesh::mapNewInternalFaces(), patchID(), and whichPatchFace().

Here is the caller graph for this function:

◆ nFaces()

Foam::label nFaces ( ) const

noexcept

The number of boundary faces in the underlying mesh.

Same as polyMesh::nBoundaryFaces()

Definition at line 744 of file polyBoundaryMesh.C.

References Foam::noexcept.

Referenced by whichPatchFace().

Here is the caller graph for this function:

◆ nFaces_if()

template<class UnaryPredicate>

label nFaces_if ( UnaryPredicate pred ) const

The number of boundary faces with patches that match the given predicate.

References indices(), nFaces_if(), Foam::noexcept, and range().

Referenced by nFaces_if().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ range() [1/2]

Foam::labelRange range ( ) const

noexcept

The face range for all boundary faces.

Spans [nInternalFaces, nFaces) of the underlying mesh

Definition at line 750 of file polyBoundaryMesh.C.

References Foam::noexcept.

Referenced by nFaces_if().

Here is the caller graph for this function:

◆ range() [2/2]

Foam::labelRange range ( const label patchi ) const

Return the range used for boundary faces on patchi.

Always returns an empty range for negative values of patchi, which allows safe use with findIndex or findPatchID.

Definition at line 756 of file polyBoundaryMesh.C.

◆ indices() [1/3]

Foam::labelList indices	(	const wordRe &	matcher,
		const bool	useGroups = true ) const

The (sorted) patch indices for all matches, optionally matching patch groups.

Returns: an empty list for an empty matcher

Definition at line 768 of file polyBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), forAllConstIters, groupPatchIDs(), HashSet< Key, Hash >::insert(), wordRe::isPattern(), patchId(), and HashTable< T, Key, Hash >::sortedToc().

Referenced by findIndices(), fvBoundaryMesh::indices(), fvBoundaryMesh::indices(), fvBoundaryMesh::indices(), indices(), nFaces_if(), and processorCyclicPolyPatch::patchIDs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indices() [2/3]

Foam::labelList indices	(	const wordRes &	matcher,
		const bool	useGroups = true ) const

The (sorted) patch indices for all matches, optionally matching patch groups.

Returns: an empty list for an empty matcher

Parameters

useGroups Match patch groups

Definition at line 835 of file polyBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), forAllConstIters, UList< T >::front(), groupPatchIDs(), indices(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::reserve(), UList< T >::size(), UPtrList< T >::size(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ indices() [3/3]

Foam::labelList indices	(	const wordRes &	allow,
		const wordRes &	deny,
		const bool	useGroups = true ) const

The (sorted) patch indices: logic as per Foam::wordRes::filter, optionally matching patch groups.

An empty allow accepts everything not in deny. A literal allow match has higher priority than any deny. A regex allow match has lower priority than any deny.

Returns: identity list when allow/deny are both empty.

Parameters

useGroups Match patch groups

Definition at line 881 of file polyBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), forAllConstIters, groupPatchIDs(), Foam::identity(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::reserve(), UPtrList< T >::size(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ indices_if() [1/2]

template<class PatchType>

labelList indices_if ( ) const

Return (sorted) patch indices for patches that match the given polyPatch type (uses isA test). Can be used as a direct alternative to findPatchIDs.

References indices_if().

Referenced by indices_if(), and indices_if().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indices_if() [2/2]

template<class UnaryPredicate>

labelList indices_if ( UnaryPredicate pred ) const

Return (sorted) patch indices for patches that match the given predicate. Can be used as an alternative to findPatchIDs.

References cfindPatch(), findIndex(), findPatchID(), and indices_if().

Here is the call graph for this function:

◆ findIndex()

Foam::label findIndex ( const wordRe & key ) const

Return patch index for the first match, return -1 if not found.

A no-op (returns -1) for an empty key

Definition at line 927 of file polyBoundaryMesh.C.

References Foam::PtrListOps::firstMatching().

Referenced by indices_if().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findPatchID()

Foam::label findPatchID	(	const word &	patchName,
		const bool	allowNotFound = true ) const

Find patch index given a name, return -1 if not found.

A no-op (returns -1) for an empty patchName

Definition at line 937 of file polyBoundaryMesh.C.

References polyMesh::defaultRegion, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::firstMatching(), names, patchId(), and Foam::Pout.

Referenced by fvMeshTools::addPatch(), meshRefinement::addPatch(), inverseFaceDistanceDiffusivity::correct(), indices_if(), marchingCells::initialise(), mappedPatchBase::lookupPatch(), mappedPatchFieldBase< Type >::mappedField(), operator[](), operator[](), fvMeshSubset::reset(), mappedPatchBase::samplePolyPatch(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), and Sampled< Type >::value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cfindPatch()

const Foam::polyPatch * cfindPatch ( const word & patchName ) const

Find patch by name and return const pointer.

Returns: nullptr on error or for an empty patchName

Definition at line 986 of file polyBoundaryMesh.C.

References Foam::PtrListOps::firstMatching(), and patches.

Referenced by indices_if().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findPatchIDs()

template<class PatchType>

labelHashSet findPatchIDs ( ) const

Find patch indices for a given polyPatch type (uses isA test).

References findPatchIDs(), and whichPatchFace().

Referenced by findPatchIDs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ whichPatchFace() [1/2]

Foam::labelPair whichPatchFace ( const label meshFacei ) const

Lookup mesh face index and return (patchi, patchFacei) tuple or (-1, meshFacei) for internal faces.

Definition at line 1001 of file polyBoundaryMesh.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::findLower(), Foam::flatOutput(), mesh, names, nFaces(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), Foam::nl, p, patches, patchID, range, and start().

Referenced by findPatchIDs(), whichPatch(), and whichPatchFace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ whichPatchFace() [2/2]

Foam::labelPairList whichPatchFace ( const labelUList & meshFaceIndices ) const

Lookup mesh face indices and return (patchi, patchFacei) tuples.

Definition at line 1067 of file polyBoundaryMesh.C.

References forAll, UList< T >::size(), and whichPatchFace().

Here is the call graph for this function:

◆ whichPatch()

label whichPatch ( const label meshFacei ) const

inline

Return patch index for a given mesh face index. Uses binary search.

Definition at line 451 of file polyBoundaryMesh.H.

References Pair< T >::first(), whichPatch(), and whichPatchFace().

Referenced by faceZone::checkParallelSync(), patchFieldProbe::findElements(), volPointInterpolationAdjoint::interpolateBoundaryField(), cellPointWeightWallModified::onWall(), sampledFaceZone::update(), and whichPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchID() [1/3]

const Foam::labelList & patchID ( ) const

Per boundary face label the patch index.

Definition at line 524 of file polyBoundaryMesh.C.

References forAll, patches, UPtrList< T >::size(), and start().

Here is the call graph for this function:

◆ patchID() [2/3]

Foam::label patchID ( const label meshFacei ) const

Return patch index for a given mesh face index. Uses direct lookup into patchID() list. Returns -1 for internal or out-of-range faces.

Definition at line 548 of file polyBoundaryMesh.C.

◆ patchID() [3/3]

Foam::labelList patchID ( const labelUList & meshFaceIndices ) const

Lookup mesh face indices and return patch indices. Uses direct lookup into patchID() list. Returns values of -1 for internal or out-of-range faces.

Definition at line 562 of file polyBoundaryMesh.C.

References forAll, patchID, and UList< T >::size().

Here is the call graph for this function:

◆ groupPatchIDs()

const Foam::HashTable< Foam::labelList > & groupPatchIDs ( ) const

The patch indices per patch group.

Definition at line 574 of file polyBoundaryMesh.C.

Referenced by groupNames(), indices(), indices(), indices(), matchGroups(), and patchSet().

Here is the caller graph for this function:

◆ setGroup()

void setGroup	(	const word &	groupName,
		const labelUList &	patchIDs )

Set/add group with patches.

Definition at line 585 of file polyBoundaryMesh.C.

References forAll, IOobject::groupName(), patches, patchIDs, UList< T >::test(), and UList< T >::unset().

Here is the call graph for this function:

◆ patchSet()

Foam::labelHashSet patchSet	(	const UList< wordRe > &	select,
		const bool	warnNotFound = true,
		const bool	useGroups = true ) const

Return the set of patch IDs corresponding to the given names.

By default warns if given names are not found. Optionally matches to patchGroups as well as patchNames.

Definition at line 1078 of file polyBoundaryMesh.C.

References UList< T >::empty(), Foam::endl(), forAllConstIters, groupPatchIDs(), HashSet< Key, Hash >::insert(), name, patches, HashTable< T, Key, Hash >::reserve(), and WarningInFunction.

Referenced by inversePointDistanceDiffusivity::correct(), patchFieldProbe::findElements(), and cellDistFuncs::getPatchIDs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ matchGroups()

void matchGroups	(	const labelUList &	patchIDs,
		wordList &	groups,
		labelHashSet &	nonGroupPatches ) const

Match the patches to groups.

Returns all the (fully matched) groups and any remaining unmatched patches.

Definition at line 1162 of file polyBoundaryMesh.C.

References HashTable< T, Key, Hash >::erase(), forAllConstIters, groupPatchIDs(), patchIDs, DynamicList< T, SizeMin >::push_back(), HashTable< T, Key, Hash >::size(), HashTable< T, Key, Hash >::transfer(), and List< T >::transfer().

Here is the call graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool report = false ) const

Check whether all procs have all patches and in same order.

Returns: True if in error.

Definition at line 1202 of file polyBoundaryMesh.C.

References Foam::endl(), forAll, Foam::Info, Foam::isA(), IOobject::name(), UPstream::parRun(), polyBoundaryMesh(), Foam::Pout, List< T >::resize(), Foam::returnReduceOr(), UPtrList< T >::size(), and UList< T >::slice().

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

Check boundary definition.

Returns: True if in error.

Definition at line 1284 of file polyBoundaryMesh.C.

References Foam::endl(), forAll, Foam::Info, mesh, IOobject::name(), primitiveMesh::nInternalFaces(), patchNames(), polyBoundaryMesh(), Foam::Pout, UPstream::reduceOr(), UPtrList< T >::size(), and start().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const pointField & p )

Correct polyBoundaryMesh after moving points.

Definition at line 1341 of file polyBoundaryMesh.C.

References UPstream::buffered, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, operator[](), p, globalMeshData::patchSchedule(), and UPstream::scheduled.

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( )

Correct polyBoundaryMesh after topology update.

Definition at line 1387 of file polyBoundaryMesh.C.

References UPstream::buffered, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, operator[](), globalMeshData::patchSchedule(), and UPstream::scheduled.

Referenced by snappyLayerDriver::determineSidePatches(), and reorder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reorder()

void reorder	(	const labelUList &	oldToNew,
		const bool	validBoundary )

Reorders patches. Ordering does not have to be done in.

ascending or descending order. Reordering has to be unique. (is shuffle) If validBoundary calls updateMesh() after reordering to recalculate data (so call needs to be parallel sync in that case)

Definition at line 1437 of file polyBoundaryMesh.C.

References forAll, patches, UPtrList< T >::reorder(), and updateMesh().

Referenced by meshRefinement::addPatch().

Here is the call graph for this function: