OpenFOAM logo
Open Source CFD Toolkit

fvPatch Class Reference

Inheritance diagram for fvPatch:

Inheritance graph
[legend]
Collaboration diagram for fvPatch:

Collaboration graph
[legend]
List of all members.

Public Types

typedef fvBoundaryMesh BoundaryMesh

Public Member Functions

 TypeName (polyPatch::typeName_())
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))
 fvPatch (const polyPatch &, const fvBoundaryMesh &)
 Construct from polyPatch.
virtual ~fvPatch ()
const polyPatchpatch () const
 Return the polyPatch.
const wordname () const
 Return name.
virtual label size () const
 Return size.
bool coupled () const
 Return true if this patch is coupled.
label index () const
 Return the index of this patch in the fvBoundaryMesh.
const fvBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference.
template<class T>
const List< T >::subList patchSlice (const List< T > &l) const
 Slice list to patch.
const labelList::subList faceCells () const
 Return faceCells.
const vectorField::subField Cf () const
 Return face centres.
tmp< vectorFieldCn () const
 Return neighbour cell centres.
virtual const vectorFieldnf () const
 Return face normals.
const vectorField::subField Sf () const
 Return face area vectors.
const scalarFieldmagSf () const
 Return face area magnitudes.
virtual tmp< vectorFielddelta () const
 Return cell-centre to face-centre vector.
const scalarFieldweights () const
 Return patch weighting factors.
const scalarFielddeltaCoeffs () const
 Return the face - cell distance coeffient.

Static Public Member Functions

autoPtr< fvPatchNew (const polyPatch &, const fvBoundaryMesh &)
 Return a pointer to a new patch created on freestore from polyPatch.
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

virtual void makeWeights (scalarField &) const
 Make patch weighting factors.
virtual void makeDeltaCoeffs (scalarField &) const
 Make patch face - neighbour cell distances.
virtual void initMovePoints ()
 Initialise the patches for moving points.
virtual void movePoints ()
 Correct patches after moving points.

Friends

class fvBoundaryMesh
class surfaceInterpolation

Member Typedef Documentation

typedef fvBoundaryMesh BoundaryMesh
 

Definition at line 108 of file fvPatch.H.


Constructor & Destructor Documentation

fvPatch const polyPatch ,
const fvBoundaryMesh
 

Construct from polyPatch.

virtual ~fvPatch  )  [virtual]
 


Member Function Documentation

const fvBoundaryMesh& boundaryMesh  )  const [inline]
 

Return boundaryMesh reference.

Definition at line 185 of file fvPatch.H.

References Foam::size().

Here is the call graph for this function:

const vectorField::subField Cf  )  const
 

Return face centres.

tmp<vectorField> Cn  )  const
 

Return neighbour cell centres.

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.

bool coupled  )  const [inline]
 

Return true if this patch is coupled.

Reimplemented in coupledFvPatch, and processorFvPatch.

Definition at line 167 of file fvPatch.H.

References Foam::label, and Foam::wordList.

declareRunTimeSelectionTable autoPtr  ,
fvPatch  ,
polyPatch  ,
(const polyPatch &patch, const fvBoundaryMesh &bm)  ,
(patch, 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 coupledFvPatch, cyclicFvPatch, and processorFvPatch.

const scalarField& deltaCoeffs  )  const
 

Return the face - cell distance coeffient.

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

const labelList::subList faceCells  )  const
 

Return faceCells.

label index  )  const [inline]
 

Return the index of this patch in the fvBoundaryMesh.

Definition at line 179 of file fvPatch.H.

virtual void initMovePoints  )  [protected, virtual]
 

Initialise the patches for moving points.

const scalarField& magSf  )  const
 

Return face area magnitudes.

virtual void makeDeltaCoeffs scalarField  )  const [protected, virtual]
 

Make patch face - neighbour cell distances.

Reimplemented in coupledFvPatch, cyclicFvPatch, and processorFvPatch.

virtual void makeWeights scalarField  )  const [protected, virtual]
 

Make patch weighting factors.

Reimplemented in coupledFvPatch, cyclicFvPatch, and processorFvPatch.

virtual void movePoints  )  [protected, virtual]
 

Correct patches after moving points.

const word& name  )  const [inline]
 

Return name.

Definition at line 155 of file fvPatch.H.

autoPtr<fvPatch> New const polyPatch ,
const fvBoundaryMesh
[static]
 

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

virtual const vectorField& nf  )  const [virtual]
 

Return face normals.

Virtual because of re-use of primitive patch data (see emptyFvPatch)

Reimplemented in emptyFvPatch.

const polyPatch& patch  )  const [inline]
 

Return the polyPatch.

Definition at line 149 of file fvPatch.H.

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

Slice list to patch.

Definition at line 192 of file fvPatch.H.

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

const vectorField::subField Sf  )  const
 

Return face area vectors.

virtual label size  )  const [inline, virtual]
 

Return size.

Reimplemented in emptyFvPatch.

Definition at line 161 of file fvPatch.H.

TypeName polyPatch::  typeName_()  ) 
 

Runtime type information.

const scalarField& weights  )  const
 

Return patch weighting factors.


Friends And Related Function Documentation

friend class fvBoundaryMesh [friend]
 

Definition at line 110 of file fvPatch.H.

friend class surfaceInterpolation [friend]
 

Reimplemented in coupledFvPatch.

Definition at line 111 of file fvPatch.H.


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