FreeFOAM The Cross-Platform CFD Toolkit
cellLooper Class Reference

Abstract base class. Concrete implementations know how to cut a cell (i.e. determine a loop around the circumference). More...

#include <dynamicMesh/cellLooper.H>


Detailed Description

Abstract base class. Concrete implementations know how to cut a cell (i.e. determine a loop around the circumference).

Loop around the cell is given as the vertices to be cut and edges to be cut (and a weight between 0 and 1 giving where the cut is to be made). Main routine is 'cut' which gets called for every cell and gets the current cut situation and expects to return a loop on the cell circumference.

Calling function needs to determine whether cellLooper is compatible with existing set of cuts.

Also contains various utility functions which implementations might want to use.

Source files

Definition at line 70 of file cellLooper.H.

+ Inheritance diagram for cellLooper:
+ Collaboration diagram for cellLooper:

List of all members.

Public Member Functions

 TypeName ("cellLooper")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, cellLooper, word,(const polyMesh &mesh),(mesh))
 cellLooper (const polyMesh &mesh)
 Construct from components.
autoPtr< cellLooperclone () const
 Clone.
virtual ~cellLooper ()
virtual bool cut (const vector &refDir, const label cellI, const boolList &vertIsCut, const boolList &edgeIsCut, const scalarField &edgeWeight, labelList &loop, scalarField &loopWeights) const =0
 Create cut along circumference of cellI. Gets current mesh cuts.
virtual bool cut (const plane &cutPlane, const label cellI, const boolList &vertIsCut, const boolList &edgeIsCut, const scalarField &edgeWeight, labelList &loop, scalarField &loopWeights) const =0
 Same but now also base point of cut provided (instead of always.
- Public Member Functions inherited from edgeVertex
 edgeVertex (const polyMesh &mesh)
 Construct from mesh.
const polyMeshmesh () const
bool isEdge (const label eVert) const
label getEdge (const label eVert) const
label getVertex (const label eVert) const
label vertToEVert (const label vertI) const
label edgeToEVert (const label edgeI) const
point coord (const label cut, const scalar weight) const
label cutPairToEdge (const label cut0, const label cut1) const
OstreamwriteCut (Ostream &os, const label cut, const scalar) const
 Write cut description to Ostream.
OstreamwriteCuts (Ostream &os, const labelList &, const scalarField &) const
 Write cut descriptions to Ostream.

Static Public Member Functions

static autoPtr< cellLooperNew (const word &type, const polyMesh &mesh)
 Return a reference to the selected cellLooper.
- Static Public Member Functions inherited from edgeVertex
static void updateLabels (const labelList &map, List< refineCell > &)
 Update refine list from map. Used to update cell/face labels.
static void updateLabels (const labelList &map, Map< label > &)
 Update map from map. Used to update cell/face labels.
static void updateLabels (const labelList &map, labelHashSet &)
 Update map from map. Used to update cell/face labels.
static bool isEdge (const primitiveMesh &mesh, const label eVert)
 is eVert an edge?
static label getEdge (const primitiveMesh &mesh, const label eVert)
 convert eVert to edge label
static label getVertex (const primitiveMesh &mesh, const label eVert)
 convert eVert to vertex label
static label vertToEVert (const primitiveMesh &mesh, const label vertI)
 Convert pointI to eVert.
static label edgeToEVert (const primitiveMesh &mesh, const label edgeI)
 Convert edgeI to eVert.
static point coord (const primitiveMesh &, const label cut, const scalar weight)
 Return coordinate of cut (uses weight if edgeCut)
static label cutPairToEdge (const primitiveMesh &, const label cut0, const label cut1)
 Find mesh edge (or -1) between two cuts.

Protected Member Functions

labelList getVertFacesNonEdge (const label cellI, const label edgeI, const label vertI) const
 Get faces (on cell) connected to vertI which are not using edgeI.
label getFirstVertEdge (const label faceI, const label vertI) const
 Get first edge connected to vertI and on faceI.
labelList getVertEdgesNonFace (const label cellI, const label faceI, const label vertI) const
 Get edges (on cell) connected to vertI which are not on faceI.
label getMisAlignedEdge (const vector &refDir, const label cellI) const
 Return edge from cellEdges that is most perpendicular.

Constructor & Destructor Documentation

cellLooper ( const polyMesh mesh)

Construct from components.

Definition at line 211 of file cellLooper.C.

~cellLooper ( )
virtual

Definition at line 219 of file cellLooper.C.


Member Function Documentation

Foam::labelList getVertFacesNonEdge ( const label  cellI,
const label  edgeI,
const label  vertI 
) const
protected

Get faces (on cell) connected to vertI which are not using edgeI.

Definition at line 75 of file cellLooper.C.

References Foam::meshTools::faceOnCell(), forAll, Foam::meshTools::getEdgeFaces(), mesh, pFaces, List< T >::setSize(), and List< T >::size().

Foam::label getFirstVertEdge ( const label  faceI,
const label  vertI 
) const
protected

Get first edge connected to vertI and on faceI.

Definition at line 112 of file cellLooper.C.

References Foam::abort(), e, edge::end(), Foam::FatalError, FatalErrorIn, forAll, mesh, and edge::start().

Foam::labelList getVertEdgesNonFace ( const label  cellI,
const label  faceI,
const label  vertI 
) const
protected

Get edges (on cell) connected to vertI which are not on faceI.

Definition at line 144 of file cellLooper.C.

References Foam::meshTools::edgeOnCell(), Foam::findIndex(), forAll, mesh, List< T >::setSize(), and List< T >::size().

Foam::label getMisAlignedEdge ( const vector refDir,
const label  cellI 
) const
protected

Return edge from cellEdges that is most perpendicular.

to refinement direction.

Definition at line 180 of file cellLooper.C.

References forAll, Foam::mag(), mesh, and Foam::meshTools::normEdgeVec().

TypeName ( "cellLooper"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
cellLooper  ,
word  ,
(const polyMesh &mesh ,
(mesh  
)
autoPtr<cellLooper> clone ( ) const
inline

Clone.

Definition at line 146 of file cellLooper.H.

References notImplemented.

autoPtr< cellLooper > New ( const word type,
const polyMesh mesh 
)
static

Return a reference to the selected cellLooper.

Definition at line 45 of file cellLooper.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and mesh.

virtual bool cut ( const vector refDir,
const label  cellI,
const boolList vertIsCut,
const boolList edgeIsCut,
const scalarField edgeWeight,
labelList loop,
scalarField loopWeights 
) const
pure virtual

Create cut along circumference of cellI. Gets current mesh cuts.

vertIsCut, edgeIsCut, edgeWeight). Cut along circumference is expressed as cellVertCut, cellEdgeToWeight. Returns true if succesfull. Still might not be compatible with existing cuts but this should be handled by caller).

Implemented in topoCellLooper, geomCellLooper, and hexCellLooper.

virtual bool cut ( const plane cutPlane,
const label  cellI,
const boolList vertIsCut,
const boolList edgeIsCut,
const scalarField edgeWeight,
labelList loop,
scalarField loopWeights 
) const
pure virtual

Same but now also base point of cut provided (instead of always.

cell centre)

Implemented in topoCellLooper, geomCellLooper, and hexCellLooper.


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