fvBoundaryMesh Class Reference

Foam::fvBoundaryMesh. More...

Inheritance diagram for fvBoundaryMesh:
Collaboration diagram for fvBoundaryMesh:

Public Member Functions

 fvBoundaryMesh (const fvBoundaryMesh &)=delete
 No copy construct. More...
 
void operator= (const fvBoundaryMesh &)=delete
 No copy assignment. More...
 
 fvBoundaryMesh (const fvMesh &)
 Construct zero size with mesh reference. More...
 
 fvBoundaryMesh (const fvMesh &, const polyBoundaryMesh &)
 Construct from polyBoundaryMesh. More...
 
const fvMeshmesh () const noexcept
 Return the mesh reference. More...
 
UPtrList< const labelUListfaceCells () const
 Return a list of faceCells for each patch. More...
 
lduInterfacePtrsList interfaces () const
 Return a list of pointers for each patch with only those pointing to interfaces being set. More...
 
labelList indices (const wordRe &matcher, const bool useGroups) const
 Return (sorted) patch indices for all matches. More...
 
labelList indices (const wordRes &matcher, const bool useGroups) const
 Return (sorted) patch indices for all matches. More...
 
labelList indices (const wordRes &select, const wordRes &ignore, const bool useGroups) const
 Return (sorted) patch indices for all selected matches that are not ignored. The selection logic as per Foam::wordRes::filter. More...
 
label findPatchID (const word &patchName) const
 Find patch index given a name. More...
 
void movePoints ()
 Correct patches after moving points. More...
 
const fvPatchoperator[] (const word &patchName) const
 Return const reference to fvPatch by name. More...
 
fvPatchoperator[] (const word &patchName)
 Return reference to fvPatch by name. More...
 
labelList findIndices (const wordRe &key, bool useGroups) const
 Identical to the indices() method (AUG-2018) More...
 
- 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) noexcept
 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. Frees all pointers. More...
 
template<class... Args>
PtrList< Tclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
const Tset (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void free ()
 Free memory and nullify all entries. Does not change the list size. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
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. More...
 
template<class... Args>
Templace_back (Args &&... args)
 Construct and append an element to the end of the list, return reference to the new list element. More...
 
void push_back (T *ptr)
 Append an element to the end of the list. More...
 
void push_back (std::unique_ptr< T > &&ptr)
 Move append an element to the end of the list. More...
 
void push_back (autoPtr< T > &&ptr)
 Move append an element to the end of the list. More...
 
void push_back (const refPtr< T > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void push_back (const tmp< T > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void push_back (PtrList< T > &&other)
 Move append another list to the end of this list. More...
 
template<class... Args>
Templace_set (const label i, Args &&... args)
 Construct and set a new element at given position, (discard old element at that location). More...
 
template<class... Args>
Templace (const label i, Args &&... args)
 Same as emplace_set() More...
 
template<class... Args>
Ttry_emplace (const label i, Args &&... args)
 Like emplace_set() but will not overwrite an occupied (non-null) location. More...
 
autoPtr< Tset (const label i, T *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< Tset (const label i, std::unique_ptr< T > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< Tset (const label i, autoPtr< T > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Tset (const label i, const refPtr< T > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< Tset (const label i, const tmp< T > &ptr)
 Set element to given tmp and return old element. More...
 
autoPtr< Trelease (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...
 
void push_back (autoPtr< T > &ptr)=delete
 Disallow push_back with autoPtr without std::move. More...
 
autoPtr< Tset (const label i, autoPtr< T > &ptr)
 Set element to given autoPtr and return old element. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void append (autoPtr< T > &ptr)
 Move 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 (std::unique_ptr< 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 (const refPtr< T > &ptr)
 Move or clone append a tmp 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...
 
void append (PtrList< T > &&other)
 Move append another list to the end of this list. More...
 
template<class... Args>
Foam::PtrList< Tclone (Args &&... args) const
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept=default
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size and set all entries to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list) noexcept
 Move construct. More...
 
 UPtrList (UPtrList< T > &list, bool reuse)
 Construct as shallow copy or re-use as specified. More...
 
 UPtrList (PtrList< T > &list)
 Shallow copy from PtrList. More...
 
 UPtrList (const UList< T *> &list)
 Construct from UList of pointers (shallow copy) More...
 
 UPtrList (UList< T > &list)
 Construct from UList, taking the address of each list element. More...
 
bool empty () const noexcept
 True if the list is empty (ie, size() is zero) More...
 
label size () const noexcept
 The number of entries in the list. More...
 
label capacity () const noexcept
 Size of the underlying storage. More...
 
label count () const noexcept
 The number of non-null entries in the list. More...
 
Tfront ()
 Reference to the first element of the list. More...
 
const Tfront () const
 Reference to first element of the list. More...
 
Tback ()
 Reference to the last element of the list. More...
 
const Tback () const
 Reference to the last element of the list. More...
 
const Ttest (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
const Tget (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
Tget (const label i)
 Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
const Tset (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
void clear ()
 Set list size to zero. More...
 
void free ()
 Nullify all entries. Does not change the list size. More...
 
void resize (const label newLen)
 Change the size of the list. Any new entries are nullptr. More...
 
void resize_null (const label newLen)
 Set the list to the given size and set all entries to nullptr. More...
 
label squeezeNull ()
 Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More...
 
void trimTrailingNull ()
 Reduce addressable list size to ignore any trailing null pointers. More...
 
void push_back (T *ptr)
 Append an element to the end of the list. More...
 
void push_back (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 
void swap (UPtrList< T > &list) noexcept
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (const label i, T *ptr)
 Set element to specified pointer and return the old list element, which can be a nullptr. More...
 
void reorder (const labelUList &oldToNew, const bool check=false)
 Reorder elements. Reordering must be unique (ie, shuffle). More...
 
void sortOrder (const labelUList &order, const bool check=false)
 Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More...
 
void checkNonNull () const
 Check and raise FatalError if any nullptr exists in the list. More...
 
const Tat (const label i) const
 Return const reference to the element at given position. FatalError for bounds problem or nullptr. More...
 
Tat (const label i)
 Return reference to the element at given position. FatalError for bounds problem or nullptr. More...
 
const Toperator[] (const label i) const
 Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...
 
Toperator[] (const label i)
 Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...
 
 FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const
 Deprecated(2022-09) - same as get() More...
 
void operator= (const UPtrList< T > &list)
 Copy assignment (shallow copies addresses) More...
 
void operator= (UPtrList< T > &&list)
 Move assignment. More...
 
T ** begin_ptr () noexcept
 Iterator to begin of raw pointers traversal (use with caution) More...
 
T ** end_ptr () noexcept
 Iterator beyond end of raw pointers traversal (use with caution) More...
 
iterator begin ()
 Return iterator to begin traversal of non-nullptr entries. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversal of non-nullptr entries. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const
 Return const_iterator to begin traversal of non-nullptr entries. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
void setSize (const label n)
 Alias for resize() More...
 
Tfirst ()
 Reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void append (T *ptr)
 Append an element to the end of the list. More...
 
void append (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 

Protected Member Functions

void readUpdate (const polyBoundaryMesh &)
 Update boundary based on new polyBoundaryMesh. 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...
 
- Protected Member Functions inherited from UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
label find_next (label pos) const
 The next non-null entry after the specified position. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept
 Low-level move construct. More...
 

Friends

class fvMesh
 Declare friendship with fvMesh. More...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the list contains. More...
 
typedef Treference
 A non-const reference to the value_type. More...
 
typedef const Tconst_reference
 A const reference to the value_type. More...
 
- Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< Tptrs_
 The list of pointers. More...
 

Detailed Description

Foam::fvBoundaryMesh.

Source files

Definition at line 53 of file fvBoundaryMesh.H.

Constructor & Destructor Documentation

◆ fvBoundaryMesh() [1/3]

fvBoundaryMesh ( const fvBoundaryMesh )
delete

No copy construct.

◆ fvBoundaryMesh() [2/3]

fvBoundaryMesh ( const fvMesh m)
explicit

Construct zero size with mesh reference.

Definition at line 45 of file fvBoundaryMesh.C.

◆ fvBoundaryMesh() [3/3]

fvBoundaryMesh ( const fvMesh m,
const polyBoundaryMesh pbm 
)

Construct from polyBoundaryMesh.

Definition at line 55 of file fvBoundaryMesh.C.

References pbm.

Member Function Documentation

◆ readUpdate()

void readUpdate ( const polyBoundaryMesh pbm)
protected

Update boundary based on new polyBoundaryMesh.

Definition at line 164 of file fvBoundaryMesh.C.

References pbm.

◆ operator=()

void operator= ( const fvBoundaryMesh )
delete

No copy assignment.

◆ mesh()

const fvMesh& mesh ( ) const
inlinenoexcept

◆ faceCells()

Return a list of faceCells for each patch.

Definition at line 127 of file fvBoundaryMesh.C.

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

Referenced by outletStabilised< Type >::correction(), cellCellStencil::setUpFrontOnOversetPatch(), and outletStabilised< Type >::weights().

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

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

Here is the call graph for this function:

◆ indices() [1/3]

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

Return (sorted) patch indices for all matches.

A no-op (returns empty list) for an empty matcher

Definition at line 70 of file fvBoundaryMesh.C.

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

Referenced by fvBoundaryMesh::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

Return (sorted) patch indices for all matches.

A no-op (returns empty list) for an empty matcher

Definition at line 80 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 select,
const wordRes ignore,
const bool  useGroups 
) const

Return (sorted) patch indices for all selected matches that are not ignored. The selection logic as per Foam::wordRes::filter.

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

Definition at line 90 of file fvBoundaryMesh.C.

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

Here is the call graph for this function:

◆ findPatchID()

Foam::label findPatchID ( const word patchName) const

Find patch index given a name.

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

Definition at line 100 of file fvBoundaryMesh.C.

References Foam::PtrListOps::firstMatching().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( )

Correct patches after moving points.

Definition at line 110 of file fvBoundaryMesh.C.

References p, and patches.

◆ operator[]() [1/2]

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

Return const reference to fvPatch by name.

Definition at line 173 of file fvBoundaryMesh.C.

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

Here is the call graph for this function:

◆ operator[]() [2/2]

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

Return reference to fvPatch by name.

Definition at line 191 of file fvBoundaryMesh.C.

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

Here is the call graph for this function:

◆ findIndices()

labelList findIndices ( const wordRe key,
bool  useGroups 
) const
inline

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

Definition at line 198 of file fvBoundaryMesh.H.

References fvBoundaryMesh::indices(), and Foam::glTF::key().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ fvMesh

friend class fvMesh
friend

Declare friendship with fvMesh.

Definition at line 85 of file fvBoundaryMesh.H.


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