A fvBoundaryMesh is a fvPatch list with a reference to the associated fvMesh, with additional search methods etc. More...

#include <fvBoundaryMesh.H>

Inheritance diagram for fvBoundaryMesh:

[legend]

Collaboration diagram for fvBoundaryMesh:

[legend]

Public Member Functions
	fvBoundaryMesh (const fvBoundaryMesh &)=delete
	No copy construct.
void	operator= (const fvBoundaryMesh &)=delete
	No copy assignment.
	fvBoundaryMesh (const fvMesh &)
	Construct zero size with mesh reference.
	fvBoundaryMesh (const fvMesh &, const polyBoundaryMesh &)
	Construct from polyBoundaryMesh.
const fvMesh &	mesh () const noexcept
	Return the mesh reference.
UPtrList< const labelUList >	faceCells () const
	Return a list of faceCells for each patch.
lduInterfacePtrsList	interfaces () const
	Return a list of pointers for each patch with only those pointing to interfaces being set.
labelList	indices (const wordRe &matcher, const bool useGroups) const
	The (sorted) patch indices for all matches, optionally matching patch groups.
labelList	indices (const wordRes &matcher, const bool useGroups) const
	The (sorted) patch indices for all matches, optionally matching patch groups.
labelList	indices (const wordRes &allow, const wordRes &deny, const bool useGroups) const
	The (sorted) patch indices: logic as per Foam::wordRes::filter, optionally matching patch groups.
label	findPatchID (const word &patchName) const
	Find patch index given a name.
const fvPatch *	cfindPatch (const word &patchName) const
	Find patch by name and return const pointer.
void	movePoints ()
	Correct patches after moving points.
const fvPatch &	operator[] (const word &patchName) const
	Return const reference to fvPatch by name.
fvPatch &	operator[] (const word &patchName)
	Return reference to fvPatch by name.
labelList	findIndices (const wordRe &key, bool useGroups) const
	Identical to the indices() method (AUG-2018).
Public Member Functions inherited from PtrList< fvPatch >
constexpr	PtrList () noexcept
	Default construct.
	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr.
	PtrList (const PtrList< fvPatch > &list)
	Copy construct using 'clone()' method on each element.
	PtrList (PtrList< fvPatch > &&list) noexcept
	Move construct.
	PtrList (UList< fvPatch * > &list)
	Take ownership of pointers in the list, set old pointers to null.
	PtrList (const PtrList< fvPatch > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element.
	PtrList (PtrList< fvPatch > &list, bool reuse)
	Construct as copy or re-use as specified.
	PtrList (const SLPtrList< fvPatch > &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< fvPatch >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements.
const fvPatch *	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.
fvPatch &	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 (fvPatch *ptr)
	Append an element to the end of the list.
void	push_back (std::unique_ptr< fvPatch > &&ptr)
	Move append an element to the end of the list.
void	push_back (autoPtr< fvPatch > &&ptr)
	Move append an element to the end of the list.
void	push_back (const refPtr< fvPatch > &ptr)
	Move or clone append a refPtr to the end of the list.
void	push_back (const tmp< fvPatch > &ptr)
	Move or clone append a tmp to the end of the list.
void	push_back (PtrList< fvPatch > &&other)
	Move append another list to the end of this list.
fvPatch &	emplace_set (const label i, Args &&... args)
	Construct and set a new element at given position, (discard old element at that location).
fvPatch &	emplace (const label i, Args &&... args)
	Same as emplace_set().
fvPatch &	try_emplace (const label i, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location.
autoPtr< fvPatch >	set (const label i, fvPatch *ptr)
	Set element to given pointer and return old element (can be null).
autoPtr< fvPatch >	set (const label i, std::unique_ptr< fvPatch > &&ptr)
	Set element to given unique_ptr and return old element.
autoPtr< fvPatch >	set (const label i, autoPtr< fvPatch > &&ptr)
	Set element to given autoPtr and return old element.
autoPtr< fvPatch >	set (const label i, const refPtr< fvPatch > &ptr)
	Set element to given refPtr and return old element.
autoPtr< fvPatch >	set (const label i, const tmp< fvPatch > &ptr)
	Set element to given tmp and return old element.
autoPtr< fvPatch >	release (const label i)
	Release ownership of the pointer at the given position.
void	transfer (PtrList< fvPatch > &list)
	Transfer into this list and annul the argument list.
void	operator= (const UPtrList< fvPatch > &list)
	Copy assignment.
void	operator= (const PtrList< fvPatch > &list)
	Copy assignment.
void	operator= (PtrList< fvPatch > &&list)
	Move assignment.
void	push_back (autoPtr< fvPatch > &ptr)=delete
	Disallow push_back with autoPtr without std::move.
autoPtr< fvPatch >	set (const label i, autoPtr< fvPatch > &ptr)
	Set element to given autoPtr and return old element.
void	setSize (const label n)
	Same as resize().
void	append (autoPtr< fvPatch > &ptr)
	Move append an element to the end of the list.
void	append (fvPatch *ptr)
	Append an element to the end of the list.
void	append (std::unique_ptr< fvPatch > &&ptr)
	Move append an element to the end of the list.
void	append (autoPtr< fvPatch > &&ptr)
	Move append an element to the end of the list.
void	append (const refPtr< fvPatch > &ptr)
	Move or clone append a tmp to the end of the list.
void	append (const tmp< fvPatch > &ptr)
	Move or clone append a tmp to the end of the list.
void	append (PtrList< fvPatch > &&other)
	Move append another list to the end of this list.
Foam::PtrList< fvPatch >	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.

Protected Member Functions
void	readUpdate (const polyBoundaryMesh &)
	Update boundary based on new polyBoundaryMesh.
Protected Member Functions inherited from PtrList< fvPatch >
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.

Friends
class	fvMesh
	Declare friendship with fvMesh.

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.
Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers.

Detailed Description

A fvBoundaryMesh is a fvPatch list with a reference to the associated fvMesh, with additional search methods etc.

Source files

Definition at line 55 of file fvBoundaryMesh.H.

Constructor & Destructor Documentation

◆ fvBoundaryMesh() [1/3]

fvBoundaryMesh ( const fvBoundaryMesh & )

delete

No copy construct.

References fvBoundaryMesh().

Referenced by fvBoundaryMesh(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvBoundaryMesh() [2/3]

fvBoundaryMesh ( const fvMesh & m )

explicit

Construct zero size with mesh reference.

Definition at line 44 of file fvBoundaryMesh.C.

References fvMesh.

Here is the call graph for this function:

◆ fvBoundaryMesh() [3/3]

fvBoundaryMesh	(	const fvMesh &	m,
		const polyBoundaryMesh &	pbm )

Construct from polyBoundaryMesh.

Definition at line 54 of file fvBoundaryMesh.C.

References fvMesh, and pbm.

Here is the call graph for this function:

Member Function Documentation

◆ readUpdate()

void readUpdate ( const polyBoundaryMesh & pbm )

protected

Update boundary based on new polyBoundaryMesh.

Definition at line 179 of file fvBoundaryMesh.C.

References pbm.

◆ operator=()

void operator= ( const fvBoundaryMesh & )

delete

No copy assignment.

References fvBoundaryMesh(), and fvMesh.

Here is the call graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const

inlinenoexcept

Return the mesh reference.

Definition at line 121 of file fvBoundaryMesh.H.

References fvMesh, and Foam::noexcept.

Referenced by cyclicAMIFvPatch::coupled(), fvPatch::lookupPatchField(), waWallFunctionFvPatchScalarField::manipulateMatrix(), and lduPrimitiveMeshAssembly::update().

Here is the call graph for this function:

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 142 of file fvBoundaryMesh.C.

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

Referenced by faceCells().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interfaces()

Foam::lduInterfacePtrsList interfaces ( ) const

Return a list of pointers for each patch with only those pointing to interfaces being set.

Definition at line 157 of file fvBoundaryMesh.C.

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

Here is the call graph for this function:

◆ indices() [1/3]

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

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

Returns: an empty list for an empty matcher

Definition at line 69 of file fvBoundaryMesh.C.

References polyMesh::boundaryMesh(), polyBoundaryMesh::indices(), and mesh.

Referenced by findIndices().

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

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

Returns: an empty list for an empty matcher

Definition at line 79 of file fvBoundaryMesh.C.

References polyMesh::boundaryMesh(), polyBoundaryMesh::indices(), and mesh.

Here is the call graph for this function:

◆ indices() [3/3]

Foam::labelList indices	(	const wordRes &	allow,
		const wordRes &	deny,
		const bool	useGroups ) 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.