OpenFOAM logo
Open Source CFD Toolkit

polyPatch Class Reference

Inheritance diagram for polyPatch:

Inheritance graph
[legend]
Collaboration diagram for polyPatch:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("patch")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm),(name, size, start, index, bm))
 declareRunTimeSelectionTable (autoPtr, polyPatch, Istream,(Istream &is, const label index, const polyBoundaryMesh &bm),(is, index, bm))
 declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm),(name, dict, index, bm))
 polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
 Construct from components.
 polyPatch (Istream &, const label index, const polyBoundaryMesh &)
 Construct from Istream.
 polyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
 Construct from dictionary.
 polyPatch (const polyPatch &, const polyBoundaryMesh &)
 Construct as copy, resetting the boundary mesh.
 polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
 Construct given the original patch and resetting the.
 polyPatch (const polyPatch &)
 Construct as copy.
virtual autoPtr< polyPatchclone (const polyBoundaryMesh &bm) const
 Construct and return a clone, resetting the boundary mesh.
virtual autoPtr< polyPatchclone (const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart) const
 Construct and return a clone, resetting the face list.
virtual ~polyPatch ()
label start () const
 Return start label of this patch in the polyMesh face list.
const polyBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference.
virtual bool coupled () const
 Return true if this patch field is coupled.
template<class T>
const List< T >::subList patchSlice (const List< T > &l) const
 Slice list to patch.
template<class T>
const Field< T >::subField patchSlice (const Field< T > &l) const
 Slice Field to patch.
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &) const
 Write dictionary.
const vectorField::subField faceCentres () const
 Return face centres.
const vectorField::subField faceAreas () const
 Return face normals.
tmp< vectorFieldfaceCellCentres () const
 Return face neighbour cell centres.
const labelList::subList faceCells () const
 Return face-cell addressing.
const labelListmeshEdges () const
 Return global edge index for local edges.
void clearAddressing ()
 Clear addressing.
label whichFace (const label l) const
 Return label of face in patch from global face label.
virtual void initOrder (const primitivePatch &) const
 Initialize ordering for primitivePatch. Does not.
virtual bool order (const primitivePatch &, labelList &faceMap, labelList &rotation) const
 Return new ordering for primitivePatch.
void operator= (const polyPatch &)
 Assignment.

Static Public Member Functions

autoPtr< polyPatchNew (const word &patchType, const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
 Return a pointer to a new patch created on freestore from.
autoPtr< polyPatchNew (Istream &, const label index, const polyBoundaryMesh &bm)
 Return a pointer to a new patch created on freestore from input.
autoPtr< polyPatchNew (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
 Return a pointer to a new patch created on freestore from.
bool constraintType (const word &pt)
 Return true if the given type is a constraint type.
wordList constraintTypes ()
 Return a list of all the constraint patch types.

Protected Member Functions

const pointFieldallPoints () const
 Return the polyMesh allPoints.
virtual void initGeometry ()
 Initialise the calculation of the patch geometry.
virtual void calcGeometry ()
 Calculate the patch geometry.
virtual void initMovePoints (const pointField &)
 Initialise the patches for moving points.
virtual void movePoints (const pointField &p)
 Correct patches after moving points.
virtual void initUpdateTopology ()
 Initialise the update of the patch topology.
virtual void updateMesh ()
 Update of the patch topology.

Friends

class polyBoundaryMesh
Ostreamoperator<< (Ostream &, const polyPatch &)

Constructor & Destructor Documentation

polyPatch const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm
 

Construct from components.

polyPatch Istream ,
const label  index,
const polyBoundaryMesh
 

Construct from Istream.

polyPatch const word name,
const dictionary dict,
const label  index,
const polyBoundaryMesh bm
 

Construct from dictionary.

polyPatch const polyPatch ,
const polyBoundaryMesh
 

Construct as copy, resetting the boundary mesh.

polyPatch const polyPatch pp,
const polyBoundaryMesh bm,
const label  index,
const label  newSize,
const label  newStart
 

Construct given the original patch and resetting the.

face list and boundary mesh information

polyPatch const polyPatch  ) 
 

Construct as copy.

virtual ~polyPatch  )  [virtual]
 


Member Function Documentation

const pointField& allPoints  )  const [protected]
 

Return the polyMesh allPoints.

const polyBoundaryMesh& boundaryMesh  )  const
 

Return boundaryMesh reference.

virtual void calcGeometry  )  [inline, protected, virtual]
 

Calculate the patch geometry.

Reimplemented in coupledPolyPatch, cyclicPolyPatch, and processorPolyPatch.

Definition at line 116 of file polyPatch.H.

References Foam::pointField.

void clearAddressing  ) 
 

Clear addressing.

virtual autoPtr<polyPatch> clone const polyBoundaryMesh bm,
const label  index,
const label  newSize,
const label  newStart
const [inline, virtual]
 

Construct and return a clone, resetting the face list.

and boundary mesh

Reimplemented in emptyPolyPatch, symmetryPolyPatch, wedgePolyPatch, cyclicPolyPatch, processorPolyPatch, and wallPolyPatch.

Definition at line 235 of file polyPatch.H.

virtual autoPtr<polyPatch> clone const polyBoundaryMesh bm  )  const [inline, virtual]
 

Construct and return a clone, resetting the boundary mesh.

Reimplemented in emptyPolyPatch, symmetryPolyPatch, wedgePolyPatch, cyclicPolyPatch, processorPolyPatch, and wallPolyPatch.

Definition at line 225 of file polyPatch.H.

References Foam::label.

bool constraintType const word pt  )  [static]
 

Return true if the given type is a constraint type.

wordList constraintTypes  )  [static]
 

Return a list of all the constraint patch types.

virtual bool coupled  )  const [inline, virtual]
 

Return true if this patch field is coupled.

Reimplemented in coupledPolyPatch.

Definition at line 303 of file polyPatch.H.

declareRunTimeSelectionTable autoPtr  ,
polyPatch  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)  ,
(name, dict, index, bm) 
 

declareRunTimeSelectionTable autoPtr  ,
polyPatch  ,
Istream  ,
(Istream &is, const label index, const polyBoundaryMesh &bm)  ,
(is, index, bm) 
 

declareRunTimeSelectionTable autoPtr  ,
polyPatch  ,
word  ,
(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)  ,
(name, size, start, index, bm) 
 

const vectorField::subField faceAreas  )  const
 

Return face normals.

tmp<vectorField> faceCellCentres  )  const
 

Return face neighbour cell centres.

const labelList::subList faceCells  )  const
 

Return face-cell addressing.

const vectorField::subField faceCentres  )  const
 

Return face centres.

virtual void initGeometry  )  [inline, protected, virtual]
 

Initialise the calculation of the patch geometry.

Reimplemented in coupledPolyPatch, cyclicPolyPatch, and processorPolyPatch.

Definition at line 112 of file polyPatch.H.

References Foam::pointField.

virtual void initMovePoints const pointField  )  [inline, protected, virtual]
 

Initialise the patches for moving points.

Reimplemented in coupledPolyPatch, cyclicPolyPatch, and processorPolyPatch.

Definition at line 120 of file polyPatch.H.

virtual void initOrder const primitivePatch  )  const [virtual]
 

Initialize ordering for primitivePatch. Does not.

refer to *this (except for name() and type() etc.)

Reimplemented in coupledPolyPatch, cyclicPolyPatch, and processorPolyPatch.

virtual void initUpdateTopology  )  [inline, protected, virtual]
 

Initialise the update of the patch topology.

Reimplemented in cyclicPolyPatch, and processorPolyPatch.

Definition at line 127 of file polyPatch.H.

References declareRunTimeSelectionTable, and Foam::label.

const labelList& meshEdges  )  const
 

Return global edge index for local edges.

virtual void movePoints const pointField p  )  [protected, virtual]
 

Correct patches after moving points.

Reimplemented from PrimitivePatch.

Reimplemented in coupledPolyPatch, cyclicPolyPatch, and processorPolyPatch.

autoPtr<polyPatch> New const word name,
const dictionary dict,
const label  index,
const polyBoundaryMesh bm
[static]
 

Return a pointer to a new patch created on freestore from.

dictionary

autoPtr<polyPatch> New Istream ,
const label  index,
const polyBoundaryMesh bm
[static]
 

Return a pointer to a new patch created on freestore from input.

autoPtr<polyPatch> New const word patchType,
const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm
[static]
 

Return a pointer to a new patch created on freestore from.

components

void operator= const polyPatch  ) 
 

Assignment.

virtual bool order const primitivePatch ,
labelList faceMap,
labelList rotation
const [virtual]
 

Return new ordering for primitivePatch.

Ordering is -faceMap: for every face index of the new face -rotation:for every new face the clockwise shift of the original face. Return false if nothing changes (faceMap is identity, rotation is 0), true otherwise.

Reimplemented in coupledPolyPatch, cyclicPolyPatch, and processorPolyPatch.

const Field<T>::subField patchSlice const Field< T > &  l  )  const [inline]
 

Slice Field to patch.

Definition at line 323 of file polyPatch.H.

References Foam::label, and Foam::labelList.

const List<T>::subList patchSlice const List< T > &  l  )  const [inline]
 

Slice list to patch.

Definition at line 316 of file polyPatch.H.

label start  )  const [inline]
 

Return start label of this patch in the polyMesh face list.

Definition at line 294 of file polyPatch.H.

References Foam::wordList.

TypeName "patch"   ) 
 

Runtime type information.

virtual void updateMesh  )  [protected, virtual]
 

Update of the patch topology.

Reimplemented in cyclicPolyPatch, and processorPolyPatch.

label whichFace const label  l  )  const [inline]
 

Return label of face in patch from global face label.

Definition at line 363 of file polyPatch.H.

References Foam::labelList, and Foam::primitivePatch.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented from patchIdentifier.

Reimplemented in processorPolyPatch.

virtual void writeDict Ostream  )  const [virtual]
 

Write dictionary.

Reimplemented from patchIdentifier.

Reimplemented in processorPolyPatch.


Friends And Related Function Documentation

Ostream& operator<< Ostream ,
const polyPatch
[friend]
 

friend class polyBoundaryMesh [friend]
 

Definition at line 109 of file polyPatch.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org