OpenFOAM logo
Open Source CFD Toolkit

faPatch Class Reference

Inheritance diagram for faPatch:

Inheritance graph
[legend]
Collaboration diagram for faPatch:

Collaboration graph
[legend]
List of all members.

Public Types

typedef faBoundaryMesh BoundaryMesh

Public Member Functions

 TypeName ("patch")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, faPatch, dictionary,(const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm),(name, dict, index, bm))
 faPatch (const word &name, const labelList &edgeLabels, const label index, const faBoundaryMesh &bm)
 Construct from components.
 faPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 Construct from dictionary.
 faPatch (const faPatch &, const faBoundaryMesh &)
 Construct as copy, resetting the boundary mesh.
virtual ~faPatch ()
label ngbPolyPatchIndex () const
 Return neighbour polyPatch index.
const faBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference.
label start () const
 Patch start in edge list.
virtual label size () const
 Patch size.
template<class T>
List< T >::subList patchSlice (const List< T > &l) const
 Slice list to patch.
virtual void movePoints (const pointField &)
 Correct patch after moving points.
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &) const
 Write dictionary.
labelList pointLabels () const
 Return patch point labels.
labelListList pointEdges () const
 Return patch point-edge addressing.
labelList ngbPolyPatchFaces () const
 Return edge neighbour polyPatch faces.
tmp< vectorFieldngbPolyPatchFaceNormals () const
 Return normals of neighbour polyPatch faces.
tmp< vectorFieldngbPolyPatchPointNormals () const
 Return normals of neighbour polyPatch joined points.
labelList::subList edgeFaces () const
 Return edge-face addressing.
const vectorFieldedgeCentres () const
 Return edge centres.
const vectorFieldedgeLengths () const
 Return edge length vectors.
const scalarFieldmagEdgeLengths () const
 Return edge length magnitudes.
tmp< vectorFieldedgeNormals () const
 Return edge normals.
tmp< vectorFieldedgeFaceCentres () const
 Return neighbour face centres.
virtual tmp< vectorFielddelta () const
 Return cell-centre to face-centre vector.
virtual void makeWeights (scalarField &) const
 Make patch weighting factors.
const scalarFieldweights () const
 Return patch weighting factors.
virtual void makeDeltaCoeffs (scalarField &) const
 Make patch edge - neighbour face distances.
const scalarFielddeltaCoeffs () const
 Return patch edge - neighbour face distances.

Static Public Member Functions

autoPtr< faPatchNew (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 Return a pointer to a new patch created on freestore from dictionary.

Protected Member Functions

virtual void initGeometry ()
 Initialise the calculation of the patch geometry.
virtual void calcGeometry ()
 Calculate the patch geometry.

Friends

class faBoundaryMesh
Ostreamoperator<< (Ostream &, const faPatch &)

Member Typedef Documentation

typedef faBoundaryMesh BoundaryMesh
 

Definition at line 105 of file faPatch.H.

Referenced by faPatch::initGeometry().


Constructor & Destructor Documentation

faPatch const word name,
const labelList edgeLabels,
const label  index,
const faBoundaryMesh bm
 

Construct from components.

faPatch const word name,
const dictionary dict,
const label  index,
const faBoundaryMesh bm
 

Construct from dictionary.

faPatch const faPatch ,
const faBoundaryMesh
 

Construct as copy, resetting the boundary mesh.

virtual ~faPatch  )  [virtual]
 


Member Function Documentation

const faBoundaryMesh& boundaryMesh  )  const
 

Return boundaryMesh reference.

virtual void calcGeometry  )  [inline, protected, virtual]
 

Calculate the patch geometry.

Reimplemented in coupledFaPatch, and processorFaPatch.

Definition at line 99 of file faPatch.H.

declareRunTimeSelectionTable autoPtr  ,
faPatch  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)  ,
(name, dict, index, bm) 
 

virtual tmp<vectorField> delta  )  const [virtual]
 

Return cell-centre to face-centre vector.

except for coupled patches for which the cell-centre to coupled-cell-centre vector is returned

Reimplemented in coupledFaPatch, and processorFaPatch.

const scalarField& deltaCoeffs  )  const
 

Return patch edge - neighbour face distances.

const vectorField& edgeCentres  )  const
 

Return edge centres.

tmp<vectorField> edgeFaceCentres  )  const
 

Return neighbour face centres.

labelList::subList edgeFaces  )  const
 

Return edge-face addressing.

const vectorField& edgeLengths  )  const
 

Return edge length vectors.

tmp<vectorField> edgeNormals  )  const
 

Return edge normals.

virtual void initGeometry  )  [inline, protected, virtual]
 

Initialise the calculation of the patch geometry.

Reimplemented in coupledFaPatch, and processorFaPatch.

Definition at line 95 of file faPatch.H.

References faPatch::BoundaryMesh.

const scalarField& magEdgeLengths  )  const
 

Return edge length magnitudes.

virtual void makeDeltaCoeffs scalarField  )  const [virtual]
 

Make patch edge - neighbour face distances.

Reimplemented in coupledFaPatch, and processorFaPatch.

virtual void makeWeights scalarField  )  const [virtual]
 

Make patch weighting factors.

Reimplemented in processorFaPatch.

virtual void movePoints const pointField  )  [virtual]
 

Correct patch after moving points.

Reimplemented in coupledFaPatch, and processorFaPatch.

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

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

tmp<vectorField> ngbPolyPatchFaceNormals  )  const
 

Return normals of neighbour polyPatch faces.

labelList ngbPolyPatchFaces  )  const
 

Return edge neighbour polyPatch faces.

label ngbPolyPatchIndex  )  const
 

Return neighbour polyPatch index.

tmp<vectorField> ngbPolyPatchPointNormals  )  const
 

Return normals of neighbour polyPatch joined points.

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

Slice list to patch.

Definition at line 188 of file faPatch.H.

References Foam::labelList, Foam::labelListList, Foam::scalarField, and Foam::vectorField.

labelListList pointEdges  )  const
 

Return patch point-edge addressing.

labelList pointLabels  )  const
 

Return patch point labels.

virtual label size  )  const [inline, virtual]
 

Patch size.

Reimplemented from UList.

Reimplemented in emptyFaPatch.

Definition at line 181 of file faPatch.H.

References Foam::size().

Here is the call graph for this function:

label start  )  const
 

Patch start in edge list.

TypeName "patch"   ) 
 

Runtime type information.

const scalarField& weights  )  const
 

Return patch weighting factors.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented from patchIdentifier.

virtual void writeDict Ostream  )  const [virtual]
 

Write dictionary.

Reimplemented from patchIdentifier.


Friends And Related Function Documentation

friend class faBoundaryMesh [friend]
 

Definition at line 92 of file faPatch.H.

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


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