Public Types | Public Member Functions | List of all members
cellClassification Class Reference

'Cuts' a mesh with a surface. More...

Inheritance diagram for cellClassification:
Inheritance graph
[legend]
Collaboration diagram for cellClassification:
Collaboration graph
[legend]

Public Types

enum  cType { NOTSET, INSIDE, OUTSIDE, CUT }
 Type of cell. More...
 
enum  pointStatus { UNSET, MESH, NONMESH, MIXED }
 Enumeration defining the whether points are use by cells of. More...
 
- Public Types inherited from List< T >
typedef SubList< TsubList
 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 Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 

Public Member Functions

 ClassName ("cellClassification")
 
 cellClassification (const polyMesh &mesh, const meshSearch &meshQuery, const triSurfaceSearch &surfQuery, const pointField &outsidePoints)
 Construct from mesh and surface and point(s) on outside. More...
 
 cellClassification (const polyMesh &mesh, const labelList &cellType)
 Construct from mesh and type for every cell. More...
 
 cellClassification (const cellClassification &)
 Construct as copy. More...
 
const polyMeshmesh () const
 
label trimCutCells (const label nLayers, const label meshType, const label fillType)
 
label growSurface (const label meshType, const label fillType)
 Sets vertex neighbours of meshType cells to fillType. More...
 
label fillHangingCells (const label meshType, const label fillType, const label maxIter)
 Find hanging cells (cells with all points on outside) and set their. More...
 
label fillRegionEdges (const label meshType, const label fillType, const label maxIter)
 Find regionEdges and fill one neighbour. Iterate until nothing. More...
 
label fillRegionPoints (const label meshType, const label fillType, const label maxIter)
 Find regionPoints and fill all neighbours. Iterate until nothing. More...
 
void writeStats (Ostream &os) const
 Write statistics on cell types to Ostream. More...
 
void operator= (const cellClassification &)
 
- Public Member Functions inherited from List< T >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const T &)
 Construct with given size and value for all elements. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< T > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
label size () const
 Return the number of elements in the UList. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const T &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const T &)
 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 T &)
 Append an element at the end of the list. More...
 
void append (const UList< T > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< T > &)
 Transfer the contents of the argument List into this list. More...
 
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from 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...
 
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...
 
template<>
const bool & operator[] (const label i) const
 

Additional Inherited Members

- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Protected Member Functions inherited from List< T >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

'Cuts' a mesh with a surface.

Divides cells into three types

Used in various meshing programs.

Has various utility functions to deal with 'features' on this level where the mesh still has all inside and outside cells.

Concepts

Seen from above:

Ok:
     A | A
       |
     --+---
       |
     B | B

Not ok:
     A | B
       |
    ---+---
       |
     B | A

because this latter situation would cause the surface after subsetting type A or B to be multiply connected across this edge. And also when snapping the edge end points to the surface it might cause some twisted faces if the surface is normal to the edge (and smoothing the surface would not help since the points on the edge would be 'pulled' from two different sides)

Source files

Definition at line 115 of file cellClassification.H.

Member Enumeration Documentation

enum cType

Type of cell.

Enumerator
NOTSET 
INSIDE 
OUTSIDE 
CUT 

Definition at line 125 of file cellClassification.H.

Enumeration defining the whether points are use by cells of.

a certain type.

Enumerator
UNSET 
MESH 
NONMESH 
MIXED 

Definition at line 136 of file cellClassification.H.

Constructor & Destructor Documentation

cellClassification ( const polyMesh mesh,
const meshSearch meshQuery,
const triSurfaceSearch surfQuery,
const pointField outsidePoints 
)

Construct from mesh and surface and point(s) on outside.

Definition at line 485 of file cellClassification.C.

cellClassification ( const polyMesh mesh,
const labelList cellType 
)

Construct from mesh and type for every cell.

Used to be able to reuse filling routines below.

Definition at line 506 of file cellClassification.C.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

Construct as copy.

Definition at line 527 of file cellClassification.C.

References cellClassification::trimCutCells().

Here is the call graph for this function:

Member Function Documentation

ClassName ( "cellClassification"  )
const polyMesh& mesh ( ) const
inline
Foam::label trimCutCells ( const label  nLayers,
const label  meshType,
const label  fillType 
)
Foam::label growSurface ( const label  meshType,
const label  fillType 
)

Sets vertex neighbours of meshType cells to fillType.

Definition at line 626 of file cellClassification.C.

References cellClassification::fillHangingCells(), forAll, primitiveMesh::nPoints(), UList< T >::operator[](), and primitiveMesh::pointCells().

Referenced by cellClassification::mesh(), and cellClassification::trimCutCells().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label fillHangingCells ( const label  meshType,
const label  fillType,
const label  maxIter 
)

Find hanging cells (cells with all points on outside) and set their.

type to fillType. Iterate until nothing changed. Returns total number of cells changed (in all iterations)

Definition at line 683 of file cellClassification.C.

References Foam::endl(), cellClassification::fillRegionEdges(), forAll, cellClassification::MIXED, primitiveMesh::nPoints(), UList< T >::operator[](), primitiveMesh::pointCells(), and Foam::Pout.

Referenced by cellClassification::growSurface(), and cellClassification::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label fillRegionEdges ( const label  meshType,
const label  fillType,
const label  maxIter 
)

Find regionEdges and fill one neighbour. Iterate until nothing.

changes. Returns total number of cells changed.

Definition at line 740 of file cellClassification.C.

References Foam::endl(), cellClassification::fillRegionPoints(), forAll, UList< T >::operator[](), polyMesh::points(), Foam::Pout, and List< T >::size().

Referenced by cellClassification::fillHangingCells(), and cellClassification::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label fillRegionPoints ( const label  meshType,
const label  fillType,
const label  maxIter 
)

Find regionPoints and fill all neighbours. Iterate until nothing.

changes. Returns total number of cells changed.

Definition at line 809 of file cellClassification.C.

References Foam::endl(), forAll, forAllConstIter(), UList< T >::operator[](), pFaces, polyMesh::points(), and Foam::Pout.

Referenced by cellClassification::fillRegionEdges(), and cellClassification::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeStats ( Ostream os) const

Write statistics on cell types to Ostream.

Definition at line 878 of file cellClassification.C.

References cellClassification::CUT, Foam::endl(), cellClassification::INSIDE, cellClassification::NOTSET, cellClassification::OUTSIDE, and List< T >::size().

Referenced by cellClassification::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const cellClassification rhs)

Definition at line 890 of file cellClassification.C.

References List< label >::operator=().

Referenced by cellClassification::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:


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