OpenFOAM logo
Open Source CFD Toolkit

coupledFaPatch Class Reference

Inheritance diagram for coupledFaPatch:

Inheritance graph
[legend]
Collaboration diagram for coupledFaPatch:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("coupled")
 Runtime type information.
 coupledFaPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 Construct from dictionary.
virtual ~coupledFaPatch ()
virtual bool coupled () const
 Return true because this patch is coupled.
bool separated () const
 Are the coupled planes separated.
const vectorFieldseparation () const
 Return the offset (distance) vector from one side of the couple.
bool parallel () const
 Are the cyclic planes parallel.
const tensorFieldforwardT () const
 Return face transformation tensor.
const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor.
virtual void initGeometry ()=0
 Initialise the calculation of the patch geometry.
virtual void calcGeometry ()=0
 Calculate the patch geometry.
virtual void initMovePoints (const pointField &)=0
 Initialise the patches for moving points.
virtual void movePoints (const pointField &)=0
 Correct patches after moving points.
virtual void makeDeltaCoeffs (scalarField &) const =0
 Make patch face - neighbour cell distances.
virtual tmp< vectorFielddelta () const =0
 Return delta (P to N) vectors across coupled patch.

Protected Member Functions

void calcTransformTensors (const vector &Cf, const vector &Cr, const vector &nf, const vector &nr) const
 Calculate the uniform transformation tensors.
void calcTransformTensors (const vectorField &Cf, const vectorField &Cr, const vectorField &nf, const vectorField &nr) const
 Calculate the transformation tensors.

Constructor & Destructor Documentation

coupledFaPatch const word name,
const dictionary dict,
const label  index,
const faBoundaryMesh bm
[inline]
 

Construct from dictionary.

Definition at line 106 of file coupledFaPatch.H.

virtual ~coupledFaPatch  )  [virtual]
 


Member Function Documentation

virtual void calcGeometry  )  [pure virtual]
 

Calculate the patch geometry.

Reimplemented from faPatch.

Implemented in processorFaPatch.

void calcTransformTensors const vectorField Cf,
const vectorField Cr,
const vectorField nf,
const vectorField nr
const [protected]
 

Calculate the transformation tensors.

void calcTransformTensors const vector Cf,
const vector Cr,
const vector nf,
const vector nr
const [protected]
 

Calculate the uniform transformation tensors.

virtual bool coupled  )  const [inline, virtual]
 

Return true because this patch is coupled.

Reimplemented in processorFaPatch.

Definition at line 127 of file coupledFaPatch.H.

virtual tmp<vectorField> delta  )  const [pure virtual]
 

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

Reimplemented from faPatch.

Implemented in processorFaPatch.

const tensorField& forwardT  )  const [inline]
 

Return face transformation tensor.

Definition at line 163 of file coupledFaPatch.H.

virtual void initGeometry  )  [pure virtual]
 

Initialise the calculation of the patch geometry.

Reimplemented from faPatch.

Implemented in processorFaPatch.

virtual void initMovePoints const pointField  )  [pure virtual]
 

Initialise the patches for moving points.

Implemented in processorFaPatch.

virtual void makeDeltaCoeffs scalarField  )  const [pure virtual]
 

Make patch face - neighbour cell distances.

Reimplemented from faPatch.

Implemented in processorFaPatch.

virtual void movePoints const pointField  )  [pure virtual]
 

Correct patches after moving points.

Reimplemented from faPatch.

Implemented in processorFaPatch.

bool parallel  )  const [inline]
 

Are the cyclic planes parallel.

Definition at line 157 of file coupledFaPatch.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

const tensorField& reverseT  )  const [inline]
 

Return neighbour-cell transformation tensor.

Definition at line 176 of file coupledFaPatch.H.

bool separated  )  const [inline]
 

Are the coupled planes separated.

Definition at line 134 of file coupledFaPatch.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and Foam::vectorField.

Here is the call graph for this function:

const vectorField& separation  )  const [inline]
 

Return the offset (distance) vector from one side of the couple.

to the other

Definition at line 143 of file coupledFaPatch.H.

TypeName "coupled"   ) 
 

Runtime type information.


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