cellToFaceStencil Class Reference

Base class for extended cell-to-face stencils (face values from neighbouring cells) More...

Inheritance diagram for cellToFaceStencil:
Collaboration diagram for cellToFaceStencil:

Classes

class  unionEqOp
 Combine operator for labelLists. More...
 

Public Member Functions

 cellToFaceStencil (const polyMesh &)
 Construct from mesh. More...
 
const polyMeshmesh () const
 
const globalIndexglobalNumbering () const
 Global numbering for cells and boundary faces. More...
 
- Public Member Functions inherited from List< labelList >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const labelList &)
 Construct with given size and value for all elements. More...
 
 List (const label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< labelList > &)
 Copy constructor. More...
 
 List (const UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< labelList > &&)
 Move constructor. More...
 
 List (List< labelList > &, bool reuse)
 Construct as copy or reuse as specified. More...
 
 List (const UList< labelList > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< labelList, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< labelList > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< labelList > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< labelList > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< labelList > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (std::initializer_list< labelList >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
label size () const
 Return the number of elements in the UList. More...
 
autoPtr< List< labelList > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const labelList &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const labelList &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const labelList &)
 Append an element at the end of the list. More...
 
void append (const UList< labelList > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< labelList > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< labelList > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< labelList, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< labelList > &)
 Transfer the contents of the argument List into this list. More...
 
labelListnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< labelList > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< labelList > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< labelList > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< labelList > &&)
 Move assignment operator. More...
 
void operator= (const SLList< labelList > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< labelList > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< labelList > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< labelList >)
 Assignment to an initialiser list. More...
 
void operator= (const labelList &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
 UList (const UList< T > &)=default
 Copy construct. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1) More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size) More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1) More...
 
void shallowCopy (const UList< T > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< T > &)
 Copy elements of the given UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
const bool & operator[] (const label i) const
 

Protected Member Functions

void validBoundaryFaces (boolList &isValidBFace) const
 Valid boundary faces (not empty and not coupled) More...
 
autoPtr< indirectPrimitivePatchallCoupledFacesPatch () const
 Return patch of all coupled faces. More...
 
void insertFaceCells (const label exclude0, const label exclude1, const boolList &nonEmptyFace, const labelList &faceLabels, labelHashSet &globals) const
 Collect cell neighbours of faces in global numbering. More...
 
labelList calcFaceCells (const boolList &nonEmptyFace, const labelList &faceLabels, labelHashSet &globals) const
 Collect cell neighbours of faces in global numbering. More...
 
void calcFaceStencil (const labelListList &globalCellCells, labelListList &faceStencil) const
 Collect cell neighbours into extended stencil. More...
 
- Protected Member Functions inherited from List< labelList >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Static Protected Member Functions

static void merge (const label global0, const label global1, const labelList &listA, labelList &listB)
 Merge two lists. More...
 
static void merge (const label globalI, const labelList &pGlobals, labelList &cCells)
 Merge two lists and guarantee globalI is first. More...
 

Additional Inherited Members

- Public Types inherited from List< labelList >
typedef SubList< labelListsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Member Functions inherited from List< labelList >
static const List< labelList > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 

Detailed Description

Base class for extended cell-to-face stencils (face values from neighbouring cells)

Source files

Definition at line 54 of file cellToFaceStencil.H.

Constructor & Destructor Documentation

◆ cellToFaceStencil()

cellToFaceStencil ( const polyMesh mesh)
explicit

Construct from mesh.

Definition at line 511 of file cellToFaceStencil.C.

Member Function Documentation

◆ merge() [1/2]

void merge ( const label  global0,
const label  global1,
const labelList listA,
labelList listB 
)
staticprotected

Merge two lists.

Guarantee global0, global1 are first.

Definition at line 34 of file cellToFaceStencil.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::findSortedIndex(), forAll, List< T >::size(), Foam::sort(), and List< T >::transfer().

Here is the call graph for this function:

◆ merge() [2/2]

void merge ( const label  globalI,
const labelList pGlobals,
labelList cCells 
)
staticprotected

Merge two lists and guarantee globalI is first.

Definition at line 134 of file cellToFaceStencil.C.

References forAll, forAllConstIter, HashSet< Key, Hash >::insert(), n, List< T >::setSize(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ validBoundaryFaces()

void validBoundaryFaces ( boolList isValidBFace) const
protected

Valid boundary faces (not empty and not coupled)

Definition at line 169 of file cellToFaceStencil.C.

References polyPatch::coupled(), forAll, patches, patchi, List< T >::setSize(), and polyPatch::start().

Here is the call graph for this function:

◆ allCoupledFacesPatch()

Foam::autoPtr< Foam::indirectPrimitivePatch > allCoupledFacesPatch ( ) const
protected

Return patch of all coupled faces.

Definition at line 192 of file cellToFaceStencil.C.

References polyPatch::coupled(), forAll, patches, patchi, points, UList< T >::size(), and polyPatch::start().

Here is the call graph for this function:

◆ insertFaceCells()

void insertFaceCells ( const label  exclude0,
const label  exclude1,
const boolList nonEmptyFace,
const labelList faceLabels,
labelHashSet globals 
) const
protected

Collect cell neighbours of faces in global numbering.

Definition at line 265 of file cellToFaceStencil.C.

References forAll, and HashSet< Key, Hash >::insert().

Here is the call graph for this function:

◆ calcFaceCells()

Foam::labelList calcFaceCells ( const boolList nonEmptyFace,
const labelList faceLabels,
labelHashSet globals 
) const
protected

Collect cell neighbours of faces in global numbering.

Definition at line 317 of file cellToFaceStencil.C.

References HashTable< T, Key, Hash >::clear(), and HashTable< T, Key, Hash >::toc().

Here is the call graph for this function:

◆ calcFaceStencil()

void calcFaceStencil ( const labelListList globalCellCells,
labelListList faceStencil 
) const
protected

◆ mesh()

◆ globalNumbering()

const globalIndex& globalNumbering ( ) const
inline

Global numbering for cells and boundary faces.

Definition at line 142 of file cellToFaceStencil.H.

Referenced by extendedUpwindCellToFaceStencil::extendedUpwindCellToFaceStencil().

Here is the caller graph for this function:

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