A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO. More...

Inheritance diagram for polyBoundaryMesh:

Collaboration diagram for polyBoundaryMesh:

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

	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh)
	Read constructor given IOobject and a polyMesh reference. More...

	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const label size)
	Construct given size. More...

	polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const polyPatchList &ppl)
	Construct given polyPatchList. More...

	~polyBoundaryMesh ()=default
	Destructor. More...

void	clearGeom ()
	Clear geometry at this level and at patches. More...

void	clearAddressing ()
	Clear addressing at this level and at patches. More...

const polyMesh &	mesh () const noexcept
	Return the mesh reference. More...

UPtrList< const labelUList >	faceCells () const
	Return a list of faceCells for each patch. More...

const List< labelPairList > &	neighbourEdges () const
	Per patch the edges on the neighbouring patch. More...

label	nNonProcessor () const
	The number of patches before the first processor patch. More...

wordList	names () const
	Return a list of patch names. More...

wordList	types () const
	Return a list of patch types. More...

wordList	physicalTypes () const
	Return a list of physical types. More...

labelList	patchStarts () const
	Return a list of patch start face indices. More...

labelList	patchSizes () const
	Return a list of patch sizes. More...

List< labelRange >	patchRanges () const
	Return a list of patch ranges. More...

label	start () const
	The start label of the boundary faces in the polyMesh face list. More...

label	nFaces () const
	The number of boundary faces in the underlying mesh. More...

labelRange	range () const
	The face range for all boundary faces. More...

labelRange	range (const label patchi) const
	Return the range used for boundary faces on patchi. More...

labelList	indices (const wordRe &matcher, const bool useGroups=true) const
	Return (sorted) patch indices for all matches. More...

labelList	indices (const wordRes &matcher, const bool useGroups=true) const
	Return (sorted) patch indices for all matches. More...

label	findIndex (const wordRe &key) const
	Return patch index for the first match, return -1 if not found. More...

label	findPatchID (const word &patchName, const bool allowNotFound=true) const
	Find patch index given a name, return -1 if not found. More...

template<class Type >
labelHashSet	findPatchIDs () const
	Find patch indices for a given polyPatch type. More...

label	whichPatch (const label faceIndex) const
	Return patch index for a given face label. More...

const labelList &	patchID () const
	Per boundary face label the patch index. More...

const HashTable< labelList > &	groupPatchIDs () const
	The patch indices per patch group. More...

void	setGroup (const word &groupName, const labelUList &patchIDs)
	Set/add group with patches. More...

labelHashSet	patchSet (const UList< wordRe > &patchNames, const bool warnNotFound=true, const bool useGroups=true) const
	Return the set of patch IDs corresponding to the given names. More...

void	matchGroups (const labelUList &patchIDs, wordList &groups, labelHashSet &nonGroupPatches) const
	Match the patches to groups. More...

bool	checkParallelSync (const bool report=false) const
	Check whether all procs have all patches and in same order. Return. More...

bool	checkDefinition (const bool report=false) const
	Check boundary definition. Return true if in error. More...

void	movePoints (const pointField &p)
	Correct polyBoundaryMesh after moving points. More...

void	updateMesh ()
	Correct polyBoundaryMesh after topology update. More...

void	reorder (const labelUList &oldToNew, const bool validBoundary)
	Reorders patches. Ordering does not have to be done in. More...

virtual bool	writeData (Ostream &os) const
	writeData member function required by regIOobject More...

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

const polyPatch &	operator[] (const word &patchName) const
	Return const reference to polyPatch by name. More...

polyPatch &	operator[] (const word &patchName)
	Return reference to polyPatch by name. More...

labelList	findIndices (const wordRe &key, bool useGroups=true) const
	Identical to the indices() method (AUG-2018) More...

template<class Type >
Foam::labelHashSet	findPatchIDs () const

Public Member Functions inherited from PtrList< T >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< T > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< T > &&list)
	Move construct. More...

	PtrList (UList< T * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

template<class CloneArg >
	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< T > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< T > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

template<class INew >
	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &is)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

template<class... Args>
PtrList< T >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

const T *	set (const label i) const
	Return const pointer to element (can be nullptr),. More...

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

void	setSize (const label newLen)
	Same as resize() More...

template<class... Args>
void	emplace_append (Args &&... args)
	Construct and append an element to the end of the list. More...

void	append (T *ptr)
	Append an element to the end of the list. More...

void	append (autoPtr< T > &ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< T > &&ptr)
	Move append an element to the end of the list. More...

void	append (std::unique_ptr< T > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< T > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	append (const tmp< T > &ptr)
	Move or clone append a tmp to the end of the list. More...

template<class... Args>
autoPtr< T >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

autoPtr< T >	set (const label i, T *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< T >	set (const label i, autoPtr< T > &ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< T >	set (const label i, const refPtr< T > &ptr)
	Set element to given refPtr and return old element. More...

autoPtr< T >	set (const label i, const tmp< T > &ptr)
	Set element to given tmp and return old element. More...

autoPtr< T >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< T > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< T > &list)
	Copy assignment. More...

void	operator= (PtrList< T > &&list)
	Move assignment. More...

template<class... Args>
Foam::PtrList< T >	clone (Args &&... args) const

template<class... Args>
Foam::autoPtr< T >	emplace (const label i, Args &&... args)

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

Friends
class	polyMesh
	Declare friendship with polyMesh. More...

Ostream &	operator<< (Ostream &os, const polyBoundaryMesh &pbm)

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

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 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 inherited from PtrList< T >
template<class INew >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

void	free ()
	Delete the allocated entries, but retain the list size. 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...

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

A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO.

Source files

Definition at line 63 of file polyBoundaryMesh.H.

Constructor & Destructor Documentation

◆ polyBoundaryMesh() [1/3]

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

Read constructor given IOobject and a polyMesh reference.

Note point pointers are unset, only used in copying meshes

Definition at line 113 of file polyBoundaryMesh.C.

References IOstream::check(), dict, forAll, FUNCTION_NAME, IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, polyPatch::New(), patches, PtrList< T >::set(), and PtrList< T >::setSize().

Here is the call graph for this function:

◆ polyBoundaryMesh() [2/3]

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

Construct given size.

Definition at line 162 of file polyBoundaryMesh.C.

◆ polyBoundaryMesh() [3/3]

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

Construct given polyPatchList.

Definition at line 175 of file polyBoundaryMesh.C.

References IOstream::check(), dict, forAll, FUNCTION_NAME, IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, polyPatch::New(), patches, IOobject::READ_IF_PRESENT, PtrList< T >::set(), and PtrList< T >::setSize().

Here is the call graph for this function:

◆ ~polyBoundaryMesh()

~polyBoundaryMesh ( )

default

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polyBoundaryMesh" )

Runtime type information.

◆ clearGeom()

void clearGeom ( )

Clear geometry at this level and at patches.

Definition at line 236 of file polyBoundaryMesh.C.

References p, and patches.

◆ clearAddressing()

void clearAddressing ( )

Clear addressing at this level and at patches.

Definition at line 247 of file polyBoundaryMesh.C.

References p, and patches.

◆ mesh()

const polyMesh& mesh ( ) const

inlinenoexcept

Return the mesh reference.

Definition at line 152 of file polyBoundaryMesh.H.

Referenced by mappedPatchBase::addWorldConnection(), mappedPatchBase::AMI(), cyclicAMIPolyPatch::canResetAMI(), processorPolyPatch::comm(), patchPatchDist::correct(), mappedPatchBase::facePoints(), coupleGroupIdentifier::findOtherPatchID(), Sampled< Type >::haveSampleField(), interpolationCellPatchConstrained< Type >::interpolate(), mappedPatchBase::lookupMesh(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), mappedPatchBase::map(), mappedPatchFieldBase< scalar >::mappedField(), Sampled< Type >::sampleField(), mappedPatchFieldBase< scalar >::sampleField(), adjointBoundaryCondition< Type >::setBoundaryContributionPtr(), lumpedPointMovement::setPatchControl(), mappedPatchBase::surfPtr(), and cyclicACMIPolyPatch::updateAreas().

Here is the caller graph for this function:

◆ faceCells()

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

Return a list of faceCells for each patch.

Definition at line 311 of file polyBoundaryMesh.C.

References forAll, and patches.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::inject(), thermoSingleLayer::Sh(), and thermoSingleLayer::Srho().

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 327 of file polyBoundaryMesh.C.

References Foam::abort(), Foam::constant::electromagnetic::e, PrimitivePatch< FaceList, PointField >::edges(), Foam::endl(), HashTable< T, edge, Hash< edge > >::erase(), Foam::FatalError, FatalErrorInFunction, HashTable< T, edge, Hash< edge > >::find(), forAll, HashTable< T, edge, Hash< edge > >::insert(), PrimitivePatch< FaceList, PointField >::localPoints(), PrimitivePatch< FaceList, PointField >::meshPoints(), patchIdentifier::name(), PrimitivePatch< FaceList, PointField >::nEdges(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), Foam::nl, UPstream::parRun(), HashTable< T, edge, Hash< edge > >::size(), and WarningInFunction.

Here is the call graph for this function:

◆ nNonProcessor()

Foam::label nNonProcessor ( ) const

The number of patches before the first processor patch.

Definition at line 535 of file polyBoundaryMesh.C.

References p, and patches.

Referenced by fvMeshAdder::add(), Foam::nonProcessorPatchNames(), probes::prepare(), and polyMeshAdder::procPatchPairs().

Here is the caller graph for this function:

◆ names()

Foam::wordList names ( ) const

Return a list of patch names.

Definition at line 555 of file polyBoundaryMesh.C.

Referenced by curvatureSeparation::curvatureSeparation(), meshReader::mesh(), meshRefinement::meshedPatches(), Foam::nonProcessorPatchNames(), ParticleErosion< CloudType >::ParticleErosion(), PatchParticleHistogram< CloudType >::PatchParticleHistogram(), PatchPostProcessing< CloudType >::PatchPostProcessing(), polyMeshAdder::procPatchPairs(), polyMesh::readUpdate(), processorCyclicPolyPatch::referPatchID(), mappedPatchBase::samplePolyPatch(), and fvMeshSubset::setCellSubset().

Here is the caller graph for this function:

◆ types()

Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 561 of file polyBoundaryMesh.C.

Referenced by polyMesh::readUpdate().

Here is the caller graph for this function:

◆ physicalTypes()

Foam::wordList physicalTypes ( ) const

Return a list of physical types.

Definition at line 567 of file polyBoundaryMesh.C.

References p.

◆ patchStarts()

Foam::labelList patchStarts ( ) const

Return a list of patch start face indices.

Definition at line 578 of file polyBoundaryMesh.C.

References p.

◆ patchSizes()

Foam::labelList patchSizes ( ) const

Return a list of patch sizes.

Definition at line 589 of file polyBoundaryMesh.C.

References p.

◆ patchRanges()

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

Return a list of patch ranges.

Definition at line 600 of file polyBoundaryMesh.C.

References p.

◆ start()

Foam::label start ( ) const

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

Same as mesh.nInternalFaces()

Definition at line 611 of file polyBoundaryMesh.C.

Referenced by attachPolyTopoChanger::attach(), polyBoundaryMesh::checkDefinition(), faMeshDecomposition::decomposeMesh(), fvMeshDistribute::distribute(), fvFieldDecomposer::reset(), and Foam::ensightOutput::writeVolField().

Here is the caller graph for this function:

◆ nFaces()

Foam::label nFaces ( ) const

The number of boundary faces in the underlying mesh.

Same as mesh.nBoundaryFaces()

Definition at line 617 of file polyBoundaryMesh.C.

◆ range() [1/2]

Foam::labelRange range ( ) const

The face range for all boundary faces.

Spans [nInternalFaces, nFaces) of the underlying mesh

Definition at line 623 of file polyBoundaryMesh.C.

Referenced by lumpedPointMovement::writeZonesVTP().

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 629 of file polyBoundaryMesh.C.

◆ indices() [1/2]

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

Return (sorted) patch indices for all matches.

Optionally matches patch groups. A no-op (returns empty list) for an empty matcher

Definition at line 642 of file polyBoundaryMesh.C.

References Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), forAllConstIters(), HashSet< Key, Hash >::insert(), wordRe::isPattern(), wordRe::match(), and patchId().

Referenced by polyBoundaryMesh::findIndices(), fvBoundaryMesh::indices(), viewFactor::initialise(), processorCyclicPolyPatch::patchIDs(), and fieldExtents::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indices() [2/2]

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

Return (sorted) patch indices for all matches.

Optionally matches patch groups. A no-op (returns empty list) for an empty matcher

Definition at line 709 of file polyBoundaryMesh.C.

References Foam::PtrListOps::findMatching(), forAllConstIters(), HashSet< Key, Hash >::insert(), and wordRes::match().

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 754 of file polyBoundaryMesh.C.

References Foam::PtrListOps::firstMatching(), and Foam::glTF::key().

Here is the call 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 765 of file polyBoundaryMesh.C.

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

Referenced by fvMeshTools::addPatch(), meshRefinement::addPatch(), inverseFaceDistanceDiffusivity::correct(), directions::directions(), meshRefinement::getFaceZoneInfo(), mappedPatchBase::lookupPatch(), mappedPatchFieldBase< scalar >::mappedField(), meshRefinement::meshedPatches(), processorCyclicPolyPatch::referPatchID(), sampledCuttingPlane::sampledCuttingPlane(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), mappedPatchBase::samplePolyPatch(), fvMeshSubset::setCellSubset(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), and Sampled< Type >::value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findPatchIDs() [1/2]

labelHashSet findPatchIDs ( ) const

Find patch indices for a given polyPatch type.

◆ whichPatch()

Foam::label whichPatch ( const label faceIndex ) const

Return patch index for a given face label.

Definition at line 812 of file polyBoundaryMesh.C.

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

Referenced by meshRefinement::balance(), addPatchCellLayer::calcExtrudeInfo(), deltaBoundary::cellCenters_d(), cellPointWeightWallModified::cellPointWeightWallModified(), polyMeshGeometry::checkFaceDotProduct(), polyMeshGeometry::checkFaceSkewness(), polyMeshGeometry::checkFaceTets(), polyMeshGeometry::checkFaceTwist(), polyMeshGeometry::checkFaceWeights(), faceZone::checkParallelSync(), polyMeshGeometry::checkVolRatio(), localPointRegion::findDuplicateFacePairs(), patchProbes::findElements(), interpolationCellPointWallModified< Type >::interpolate(), volSurfaceMapping::mapInternalToSurface(), volSurfaceMapping::mapToField(), volSurfaceMapping::mapToSurface(), volSurfaceMapping::mapToVolume(), polyMeshAdder::mergePoints(), patchProbes::sample(), duplicatePoints::setRefinement(), perfectInterface::setRefinement(), combineFaces::setRefinement(), removeFaces::setRefinement(), meshCutAndRemove::setRefinement(), addPatchCellLayer::setRefinement(), and sampledFaceZone::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchID()

const Foam::labelList & patchID ( ) const

Per boundary face label the patch index.

Definition at line 456 of file polyBoundaryMesh.C.

References forAll, and patches.

Referenced by FacePostProcessing< CloudType >::FacePostProcessing(), interpolationCellPatchConstrained< Type >::interpolate(), and RemoveParcels< CloudType >::RemoveParcels().

Here is the caller graph for this function:

◆ groupPatchIDs()

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

The patch indices per patch group.

Definition at line 481 of file polyBoundaryMesh.C.

Referenced by meshRefinement::findRegions().

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 493 of file polyBoundaryMesh.C.

References forAll, patches, and List< T >::resize().

Here is the call graph for this function:

◆ patchSet()

Foam::labelHashSet patchSet	(	const UList< wordRe > &	patchNames,
		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 864 of file polyBoundaryMesh.C.

References Foam::endl(), Foam::findMatchingStrings(), forAllConstIters(), HashSet< Key, Hash >::insert(), wordRes::match(), Foam::PtrListOps::names(), patchNames(), and WarningInFunction.

Referenced by preservePatches::add(), preservePatches::apply(), inversePointDistanceDiffusivity::correct(), structuredDecomp::decompose(), patchProbes::findElements(), cellDistFuncs::getPatchIDs(), objectivePtLosses::initialize(), patchInjection::patchInjection(), wallHeatFlux::read(), wallShearStress::read(), structuredRenumber::renumber(), and Foam::selectPatchFaces().

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 933 of file polyBoundaryMesh.C.

References DynamicList< T, SizeMin >::append(), forAllConstIters(), 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. Return.

true if in error.

Definition at line 972 of file polyBoundaryMesh.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Pstream::gatherList(), Foam::Info, UPstream::master(), UPstream::myProcNo(), IOobject::name(), Foam::PtrListOps::names(), UPstream::nProcs(), UPstream::parRun(), Foam::Pout, Pstream::scatterList(), List< T >::setSize(), and UPstream::subProcs().

Referenced by fvMeshDistribute::distribute(), and Foam::nonProcessorPatchNames().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

Check boundary definition. Return true if in error.

Definition at line 1060 of file polyBoundaryMesh.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Info, mesh, IOobject::name(), primitiveMesh::nInternalFaces(), patchNames(), Foam::Pout, Foam::reduce(), and polyBoundaryMesh::start().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const pointField & p )

Correct polyBoundaryMesh after moving points.

Definition at line 1117 of file polyBoundaryMesh.C.

References UPstream::blocking, UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, p, ProcessorTopology< Container, ProcPatch >::patchSchedule(), and UPstream::scheduled.

Referenced by faBoundaryMesh::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( )

Correct polyBoundaryMesh after topology update.

Definition at line 1163 of file polyBoundaryMesh.C.

References UPstream::blocking, UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, ProcessorTopology< Container, ProcPatch >::patchSchedule(), and UPstream::scheduled.

Referenced by polyMesh::readUpdate(), faBoundaryMesh::updateMesh(), and polyMesh::updateMesh().

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 1214 of file polyBoundaryMesh.C.

References forAll, patches, and Foam::reorder().

Referenced by fvMeshTools::addPatch(), meshRefinement::addPatch(), and fvMeshTools::reorderPatches().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 1237 of file polyBoundaryMesh.C.

References token::BEGIN_LIST, Ostream::beginBlock(), IOstream::check(), Foam::decrIndent(), token::END_LIST, Ostream::endBlock(), FUNCTION_NAME, IOstream::good(), Foam::incrIndent(), Foam::nl, os(), and patches.

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeObject()

bool writeObject	(	IOstreamOption	streamOpt,
		const bool	valid
	)		const

virtual

Write using stream options.

Reimplemented from regIOobject.

Definition at line 1258 of file polyBoundaryMesh.C.

References IOstreamOption::compression(), IOstreamOption::UNCOMPRESSED, and regIOobject::writeObject().

Here is the call graph for this function:

◆ operator[]() [1/2]

const Foam::polyPatch & operator[] ( const word & patchName ) const

Return const reference to polyPatch by name.

Definition at line 1271 of file polyBoundaryMesh.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::names(), and Foam::nl.

Here is the call graph for this function:

◆ operator[]() [2/2]

Foam::polyPatch & operator[] ( const word & patchName )

Return reference to polyPatch by name.

Definition at line 1290 of file polyBoundaryMesh.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::names(), and Foam::nl.

Here is the call graph for this function:

◆ findIndices()

labelList findIndices	(	const wordRe &	key,
		bool	useGroups = `true`
	)		const

inline

Identical to the indices() method (AUG-2018)

Definition at line 326 of file polyBoundaryMesh.H.

References polyBoundaryMesh::indices().

Here is the call graph for this function:

◆ findPatchIDs() [2/2]

Foam::labelHashSet findPatchIDs ( ) const

Definition at line 31 of file polyBoundaryMeshTemplates.C.

References forAll, and patches.

Friends And Related Function Documentation

◆ polyMesh

friend class polyMesh

friend

Declare friendship with polyMesh.

Definition at line 104 of file polyBoundaryMesh.H.

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const polyBoundaryMesh &	pbm
	)

friend

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

src/OpenFOAM/meshes/polyMesh/polyBoundaryMesh/polyBoundaryMesh.H
src/OpenFOAM/meshes/polyMesh/polyBoundaryMesh/polyBoundaryMesh.C
src/OpenFOAM/meshes/polyMesh/polyBoundaryMesh/polyBoundaryMeshTemplates.C

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ polyBoundaryMesh() [1/3]

◆ polyBoundaryMesh() [2/3]

◆ polyBoundaryMesh() [3/3]

◆ ~polyBoundaryMesh()

Member Function Documentation

◆ TypeName()

◆ clearGeom()

◆ clearAddressing()

◆ mesh()

◆ faceCells()

◆ neighbourEdges()

◆ nNonProcessor()

◆ names()

◆ types()

◆ physicalTypes()

◆ patchStarts()

◆ patchSizes()

◆ patchRanges()

◆ start()

◆ nFaces()

◆ range() [1/2]

◆ range() [2/2]

◆ indices() [1/2]

◆ indices() [2/2]

◆ findIndex()

◆ findPatchID()

◆ findPatchIDs() [1/2]

◆ whichPatch()

◆ patchID()

◆ groupPatchIDs()

◆ setGroup()

◆ patchSet()

◆ matchGroups()

◆ checkParallelSync()

◆ checkDefinition()

◆ movePoints()

◆ updateMesh()

◆ reorder()

◆ writeData()

◆ writeObject()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ findIndices()

◆ findPatchIDs() [2/2]

Friends And Related Function Documentation

◆ polyMesh

◆ operator<<