FreeFOAM The Cross-Platform CFD Toolkit
cyclicFvPatch Class Reference

Cyclic-plane patch. More...

#include <finiteVolume/cyclicFvPatch.H>


Detailed Description

+ Inheritance diagram for cyclicFvPatch:
+ Collaboration diagram for cyclicFvPatch:

List of all members.

Public Member Functions

 TypeName (cyclicPolyPatch::typeName_())
 Runtime type information.
 cyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch.
const tensorFieldforwardT () const
 Return face transformation tensor.
const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor.
tmp< vectorFielddelta () const
 Return delta (P to N) vectors across coupled patch.
virtual tmp< labelFieldinterfaceInternalField (const unallocLabelList &internalData) const
 Return the values of the given internal data adjacent to.
virtual tmp< labelFieldtransfer (const Pstream::commsTypes commsType, const unallocLabelList &interfaceData) const
 Transfer and return neighbour field.
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const unallocLabelList &internalData) const
 Return neighbour field.
- Public Member Functions inherited from coupledFvPatch
 TypeName (coupledPolyPatch::typeName_())
 Runtime type information.
 coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch.
virtual ~coupledFvPatch ()
virtual bool coupled () const
 Return true because this patch is coupled.
bool parallel () const
 Are the cyclic planes parallel.
virtual const unallocLabelListfaceCells () const
 Return faceCell addressing.
virtual void initTransfer (const Pstream::commsTypes commsType, const unallocLabelList &interfaceData) const
 Initialise interface data transfer.
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, unallocLabelList &iF) const
 Initialise neighbour field transfer.
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information.
 lduInterface ()
 Construct null.
virtual ~lduInterface ()
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const unallocLabelList &iF) const
 Initialise transfer of internal field adjacent to the interface.
- Public Member Functions inherited from fvPatch
 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.
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 vectorFieldCf () const
 Return face centres.
tmp< vectorFieldCn () const
 Return neighbour cell centres.
const vectorFieldSf () const
 Return face area vectors.
const scalarFieldmagSf () const
 Return face area magnitudes.
tmp< vectorFieldnf () const
 Return face normals.
const scalarFieldweights () const
 Return patch weighting factors.
const scalarFielddeltaCoeffs () const
 Return the face - cell distance coeffient.
template<class Type >
tmp< Field< Type > > patchInternalField (const UList< Type > &) const
 Return given internal field next to patch as patch field.
template<class GeometricField , class Type >
const
GeometricField::PatchFieldType
patchField (const GeometricField &) const
 Return the corresponding patchField of the named field.
template<class GeometricField , class Type >
const
GeometricField::PatchFieldType
lookupPatchField (const word &name, const GeometricField *=NULL, const Type *=NULL) const
 Lookup and return the patchField of the named field from the.
- Public Member Functions inherited from cyclicLduInterface
 TypeName ("cyclicLduInterface")
 Runtime type information.
virtual ~cyclicLduInterface ()

Protected Member Functions

void makeWeights (scalarField &) const
 Make patch weighting factors.
void makeDeltaCoeffs (scalarField &) const
 Make patch face - neighbour cell distances.

Constructor & Destructor Documentation

cyclicFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 81 of file cyclicFvPatch.H.


Member Function Documentation

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Implements coupledFvPatch.

Definition at line 44 of file cyclicFvPatch.C.

References Foam::abort(), cyclicFvPatch::delta(), e, Foam::FatalError, FatalErrorIn, Foam::mag(), fvPatch::magSf(), fvPatch::nf(), and List< T >::size().

void makeDeltaCoeffs ( scalarField dc) const
protectedvirtual

Make patch face - neighbour cell distances.

Implements coupledFvPatch.

Definition at line 75 of file cyclicFvPatch.C.

References cyclicFvPatch::delta(), fvPatch::nf(), and List< T >::size().

TypeName ( cyclicPolyPatch::  typeName_())

Runtime type information.

const tensorField& forwardT ( ) const
inline

Return face transformation tensor.

Reimplemented from coupledFvPatch.

Definition at line 93 of file cyclicFvPatch.H.

Referenced by cyclicFvPatch::delta(), and cyclicFvPatchField< Type >::forwardT().

const tensorField& reverseT ( ) const
inline

Return neighbour-cell transformation tensor.

Reimplemented from coupledFvPatch.

Definition at line 99 of file cyclicFvPatch.H.

Referenced by cyclicFvPatch::delta(), and cyclicFvPatchField< Type >::reverseT().

tmp< vectorField > delta ( ) const
virtual

Return delta (P to N) vectors across coupled patch.

Implements coupledFvPatch.

Definition at line 92 of file cyclicFvPatch.C.

References cyclicFvPatch::forwardT(), coupledFvPatch::parallel(), cyclicFvPatch::reverseT(), List< T >::size(), and Foam::transform().

Referenced by cyclicFvPatch::makeDeltaCoeffs(), and cyclicFvPatch::makeWeights().

tmp< labelField > interfaceInternalField ( const unallocLabelList internalData) const
virtual

Return the values of the given internal data adjacent to.

the interface as a field

Implements coupledFvPatch.

Definition at line 129 of file cyclicFvPatch.C.

tmp< labelField > transfer ( const Pstream::commsTypes  commsType,
const unallocLabelList interfaceData 
) const
virtual

Transfer and return neighbour field.

Implements coupledFvPatch.

Definition at line 138 of file cyclicFvPatch.C.

tmp< labelField > internalFieldTransfer ( const Pstream::commsTypes  commsType,
const unallocLabelList internalData 
) const
virtual

Return neighbour field.

Implements coupledFvPatch.

Definition at line 159 of file cyclicFvPatch.C.


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