FreeFOAM The Cross-Platform CFD Toolkit
faceToCellStencil Class Reference

baseclass for extended cell centred addressing. Contains per cell a list of neighbouring faces in global addressing. More...

#include <finiteVolume/faceToCellStencil.H>


Detailed Description

baseclass for extended cell centred addressing. Contains per cell a list of neighbouring faces in global addressing.

Source files

Definition at line 55 of file faceToCellStencil.H.

+ Inheritance diagram for faceToCellStencil:
+ Collaboration diagram for faceToCellStencil:

List of all members.

Public Member Functions

 faceToCellStencil (const polyMesh &)
 Construct from mesh.
const polyMeshmesh () const
const globalIndexglobalNumbering () const
 Global numbering for faces.
const faceToCellStencilby_ref () const
 Work-around for C++ Standard Core Language Defect 391.
- Public Member Functions inherited from List< labelList >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const labelList &)
 Construct with given size and value for all elements.
 List (const List< labelList > &)
 Copy constructor.
 List (const Xfer< List< labelList > > &)
 Construct by transferring the parameter contents.
 List (List< labelList > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< labelList > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< labelList, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< labelList > &)
 Construct as copy of PtrList<T>
 List (const SLList< labelList > &)
 Construct as copy of SLList<T>
 List (const IndirectList< labelList > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< labelList > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< labelList > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< labelList > > clone () const
 Clone.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const labelList &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const labelList &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< labelList > &)
 Append a List at the end of this list.
void append (const UIndirectList< labelList > &)
 Append a UIndirectList at the end of this list.
void transfer (List< labelList > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< labelList, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< labelList > &)
 Transfer the contents of the argument List into this list.
Xfer< List< labelList > > xfer ()
 Transfer contents to the Xfer container.
labelListnewElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< labelList > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< labelList > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< labelList > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< labelList > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< labelList > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< labelList > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const labelList &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< labelList >
 UList ()
 Null constructor.
 UList (labelList *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const labelListcdata () const
 Return a const pointer to the first data element,.
labelListdata ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< labelList > &)
 Assign elements to those from UList.
labelListoperator[] (const label)
 Return element of UList.
const labelListoperator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< labelList > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< labelList > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< labelList > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< labelList > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< labelList > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< labelList > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< labelList > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< labelList > &) const
 Return true if !(a < b). Takes linear time.

Additional Inherited Members

- Public Types inherited from List< labelList >
typedef SubList< labelListsubList
 Declare type of subList.
- Public Types inherited from UList< labelList >
typedef labelList value_type
 Type of values the UList contains.
typedef labelListreference
 Type that can be used for storing into.
typedef const labelListconst_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef labelListiterator
 Random access iterator for traversing UList.
typedef const labelListconst_iterator
 Random access iterator for traversing UList.
typedef labelListreverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const labelListconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.
- Static Public Member Functions inherited from List< labelList >
static const List< labelList > & null ()
 Return a null List.
- Protected Member Functions inherited from List< labelList >
void size (const label)
 Override size to be inconsistent with allocated storage.

Constructor & Destructor Documentation

faceToCellStencil ( const polyMesh mesh)
explicit

Construct from mesh.

Definition at line 33 of file faceToCellStencil.C.


Member Function Documentation

const polyMesh& mesh ( ) const
inline
const globalIndex& globalNumbering ( ) const
inline

Global numbering for faces.

Definition at line 91 of file faceToCellStencil.H.

Referenced by extendedCentredFaceToCellStencil::extendedCentredFaceToCellStencil().

const faceToCellStencil& by_ref ( ) const
inline

Work-around for C++ Standard Core Language Defect 391.

Definition at line 97 of file faceToCellStencil.H.


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