fvBoundaryMesh Class Reference

Foam::fvBoundaryMesh. More...

Inheritance diagram for fvBoundaryMesh:
Collaboration diagram for fvBoundaryMesh:

Public Member Functions

 fvBoundaryMesh (const fvMesh &)
 Construct with zero size. More...
 
 fvBoundaryMesh (const fvMesh &, const polyBoundaryMesh &)
 Construct from polyBoundaryMesh. More...
 
 fvBoundaryMesh (fvBoundaryMesh &&)=default
 Move constructor. More...
 
 fvBoundaryMesh (const fvBoundaryMesh &)=delete
 Disallow default bitwise copy construction. More...
 
const fvMeshmesh () const
 Return the mesh reference. More...
 
lduInterfacePtrsList interfaces () const
 Return a list of pointers for each patch. More...
 
label findIndex (const word &patchName) const
 Find patch index given a name. More...
 
labelList findIndices (const wordRe &, const bool useGroups) const
 Find patch indices given a name. More...
 
void shuffle (const labelUList &newToOld, const bool validBoundary)
 Reorders patches. Ordering does not have to be done in. More...
 
const fvPatchoperator[] (const word &) const
 Return const reference to fvPatch by name. More...
 
fvPatchoperator[] (const word &)
 Return reference to fvPatch by name. More...
 
void operator= (const fvBoundaryMesh &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from PtrList< T >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< T > &)
 Copy constructor. More...
 
template<class CloneArg >
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (PtrList< T > &&)
 Move constructor. More...
 
 PtrList (PtrList< T > &, bool reuse)
 Construct as copy or reuse as specified. More...
 
 PtrList (const SLPtrList< T > &)
 Construct as copy of SLPtrList<T> More...
 
template<class INew >
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void shrink ()
 Shrink the allocated space to the number of elements used. More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (T *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< T > &)
 Append an element at the end of the list. More...
 
void append (const tmp< T > &)
 Append an element at the end of the list. More...
 
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Tset (const label, T *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< Tset (const label, const autoPtr< T > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< Tset (const label, const tmp< T > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< T > &)
 Assignment operator. More...
 
void operator= (PtrList< T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (UPtrList< T > &, bool reuse)
 Construct as copy or reuse as specified. More...
 
label size () const
 Return the number of elements in the UPtrList. More...
 
bool empty () const
 Return true if the UPtrList is empty (ie, size() is zero) More...
 
Tfirst ()
 Return 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 setSize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void resize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void clear ()
 Clear the UPtrList, i.e. set size to zero. More...
 
void append (T *)
 Append an element at the end of the list. More...
 
void transfer (UPtrList< T > &)
 Transfer the contents of the argument UPtrList into this. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be nullptr). More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
template<class T2 >
UPtrList< T2 > convert ()
 Convert to list of different pointer type. More...
 
template<class T2 >
UPtrList< const T2 > convert () const
 Convert to list of different pointer type. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
Toperator() (const label)
 Return element const pointer. More...
 
iterator begin ()
 Return an iterator to begin traversing the UPtrList. More...
 
iterator end ()
 Return an iterator to end traversing the UPtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the UPtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the UPtrList. More...
 
template<class T2 >
Foam::UPtrList< T2 > convert ()
 
template<class T2 >
Foam::UPtrList< const T2 > convert () const
 

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 read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Friends

class fvMesh
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the UPtrList contains. More...
 
typedef Treference
 Type that can be used for storing into UPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant UPtrList::value_type. More...
 

Detailed Description

Foam::fvBoundaryMesh.

Source files

Definition at line 52 of file fvBoundaryMesh.H.

Constructor & Destructor Documentation

◆ fvBoundaryMesh() [1/4]

fvBoundaryMesh ( const fvMesh m)

Construct with zero size.

Definition at line 48 of file fvBoundaryMesh.C.

◆ fvBoundaryMesh() [2/4]

fvBoundaryMesh ( const fvMesh m,
const polyBoundaryMesh basicBdry 
)

Construct from polyBoundaryMesh.

Definition at line 58 of file fvBoundaryMesh.C.

◆ fvBoundaryMesh() [3/4]

fvBoundaryMesh ( fvBoundaryMesh &&  )
default

Move constructor.

◆ fvBoundaryMesh() [4/4]

fvBoundaryMesh ( const fvBoundaryMesh )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ readUpdate()

void readUpdate ( const polyBoundaryMesh basicBdry)
protected

Update boundary based on new polyBoundaryMesh.

Definition at line 133 of file fvBoundaryMesh.C.

References clear().

Here is the call graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const
inline

Return the mesh reference.

Definition at line 99 of file fvBoundaryMesh.H.

Referenced by filmFvPatch::deltaCoeffs(), nonConformalMappedFvPatchBase::fromNeighbour(), Foam::fvMeshStitcherTools::origNcMagSfb(), and timeVaryingMappedFvPatchField< Type >::time().

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

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

Here is the call graph for this function:

◆ findIndex()

Foam::label findIndex ( const word patchName) const

Find patch index given a name.

Definition at line 73 of file fvBoundaryMesh.C.

References forAll, Foam::name(), patches, and patchi.

Here is the call graph for this function:

◆ findIndices()

Foam::labelList findIndices ( const wordRe key,
const bool  useGroups 
) const

Find patch indices given a name.

Definition at line 90 of file fvBoundaryMesh.C.

◆ shuffle()

void shuffle ( const labelUList newToOld,
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 call needs to be parallel sync

Definition at line 100 of file fvBoundaryMesh.C.

References patches, and PtrList< T >::shuffle().

Here is the call graph for this function:

◆ operator[]() [1/2]

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

Return const reference to fvPatch by name.

Definition at line 142 of file fvBoundaryMesh.C.

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

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

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const fvBoundaryMesh )
delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ fvMesh

friend class fvMesh
friend

Definition at line 76 of file fvBoundaryMesh.H.


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