cyclicAMIPointPatch Class Reference

Cyclic AMI point patch - place holder only. More...

Inheritance diagram for cyclicAMIPointPatch:
[legend]
Collaboration diagram for cyclicAMIPointPatch:
[legend]

Public Member Functions

 TypeName (cyclicAMIPolyPatch::typeName_())
 Runtime type information. More...
 
 cyclicAMIPointPatch (const polyPatch &patch, const pointBoundaryMesh &bm)
 Construct from components. More...
 
virtual ~cyclicAMIPointPatch ()
 Destructor. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual const wordconstraintType () const
 Return the constraint type this pointPatch implements. More...
 
const cyclicAMIPolyPatchcyclicAMIPatch () const
 Return the underlying cyclicAMIPolyPatch. More...
 
const cyclicAMIPointPatchneighbPatch () const
 Return neighbour point patch. More...
 
bool parallel () const
 Are the cyclic planes parallel. More...
 
const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
- Public Member Functions inherited from coupledFacePointPatch
 TypeName (coupledPolyPatch::typeName_())
 Runtime type information. More...
 
 coupledFacePointPatch (const polyPatch &patch, const pointBoundaryMesh &bm)
 Construct from components. More...
 
virtual ~coupledFacePointPatch ()=default
 Destructor. More...
 
- Public Member Functions inherited from facePointPatch
 TypeName (polyPatch::typeName_())
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, facePointPatch, polyPatch,(const polyPatch &patch, const pointBoundaryMesh &bm),(patch, bm))
 
 facePointPatch (const polyPatch &p, const pointBoundaryMesh &pm)
 Construct from polyPatch and boundary mesh. More...
 
virtual ~facePointPatch ()=default
 Destructor. More...
 
virtual const polyPatchpatch () const
 Return the polyPatch. More...
 
virtual const wordname () const
 Return name. More...
 
virtual label size () const
 Return size. More...
 
virtual label index () const
 Return the index of this patch in the pointBoundaryMesh. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual const labelListmeshPoints () const
 Return mesh points. More...
 
virtual const pointFieldlocalPoints () const
 Return pointField of points in patch. More...
 
virtual const vectorFieldpointNormals () const
 Return point unit normals. More...
 
- Public Member Functions inherited from pointPatch
 TypeName ("basePatch")
 Runtime type information. More...
 
 pointPatch (const pointBoundaryMesh &bm)
 Construct from boundary mesh. More...
 
virtual ~pointPatch ()=default
 Destructor. More...
 
virtual const wordname () const =0
 Return name. More...
 
virtual label size () const =0
 Return size. More...
 
virtual label index () const =0
 Return the index of this patch in the pointBoundaryMesh. More...
 
const pointBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual const labelListmeshPoints () const =0
 Return mesh points. More...
 
virtual const vectorFieldlocalPoints () const =0
 Return pointField of points in patch. More...
 
virtual const vectorFieldpointNormals () const =0
 Return point unit normals. More...
 
virtual const wordconstraintType () const
 Return the constraint type this pointPatch implements. More...
 
virtual void applyConstraint (const label pointi, pointConstraint &) const
 Accumulate the effect of constraint direction of this patch. More...
 
- Public Member Functions inherited from coupledPointPatch
 TypeName (coupledPolyPatch::typeName_())
 Runtime type information. More...
 
 coupledPointPatch (const pointBoundaryMesh &bm)
 Construct from components. More...
 
virtual ~coupledPointPatch ()=default
 Destructor. More...
 

Protected Member Functions

virtual void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)
 Update of the patch topology. More...
 
- Protected Member Functions inherited from coupledFacePointPatch
virtual void calcGeometry (PstreamBuffers &)=0
 Calculate mesh points. More...
 
 coupledFacePointPatch (const coupledFacePointPatch &)=delete
 No copy construct. More...
 
void operator= (const coupledFacePointPatch &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from facePointPatch
virtual void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)
 Update of the patch topology. More...
 
 facePointPatch (const facePointPatch &)=delete
 No copy construct. More...
 
void operator= (const facePointPatch &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from pointPatch
virtual void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)
 Update of the patch topology. More...
 
 pointPatch (const pointPatch &)=delete
 No copy construct. More...
 
void operator= (const pointPatch &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from coupledPointPatch
virtual void initGeometry (PstreamBuffers &)=0
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)=0
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)=0
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &)=0
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)=0
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)=0
 Update of the patch topology. More...
 
 coupledPointPatch (const coupledPointPatch &)=delete
 No copy construct. More...
 
void operator= (const coupledPointPatch &)=delete
 No copy assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from facePointPatch
static autoPtr< facePointPatchNew (const polyPatch &, const pointBoundaryMesh &)
 Return a pointer to a new patch created on freestore from polyPatch. More...
 
- Protected Attributes inherited from facePointPatch
const polyPatchpolyPatch_
 Reference to the underlying polyPatch. More...
 

Detailed Description

Cyclic AMI point patch - place holder only.

Source files

Definition at line 52 of file cyclicAMIPointPatch.H.

Constructor & Destructor Documentation

◆ cyclicAMIPointPatch()

cyclicAMIPointPatch ( const polyPatch patch,
const pointBoundaryMesh bm 
)

Construct from components.

Definition at line 93 of file cyclicAMIPointPatch.C.

◆ ~cyclicAMIPointPatch()

~cyclicAMIPointPatch ( )
virtual

Destructor.

Definition at line 106 of file cyclicAMIPointPatch.C.

Member Function Documentation

◆ initGeometry()

void initGeometry ( PstreamBuffers )
protectedvirtual

Initialise the calculation of the patch geometry.

Implements coupledPointPatch.

Definition at line 57 of file cyclicAMIPointPatch.C.

◆ calcGeometry()

void calcGeometry ( PstreamBuffers )
protectedvirtual

Calculate the patch geometry.

Implements coupledFacePointPatch.

Definition at line 61 of file cyclicAMIPointPatch.C.

◆ initMovePoints()

void initMovePoints ( PstreamBuffers ,
const pointField  
)
protectedvirtual

Initialise the patches for moving points.

Implements coupledPointPatch.

Definition at line 65 of file cyclicAMIPointPatch.C.

◆ movePoints()

void movePoints ( PstreamBuffers ,
const pointField  
)
protectedvirtual

Correct patches after moving points.

Implements coupledPointPatch.

Definition at line 73 of file cyclicAMIPointPatch.C.

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers pBufs)
protectedvirtual

Initialise the update of the patch topology.

Implements coupledPointPatch.

Definition at line 77 of file cyclicAMIPointPatch.C.

References facePointPatch::initUpdateMesh().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers pBufs)
protectedvirtual

Update of the patch topology.

Implements coupledPointPatch.

Definition at line 84 of file cyclicAMIPointPatch.C.

References motionSmootherAlgo::updateMesh().

Here is the call graph for this function:

◆ TypeName()

TypeName ( cyclicAMIPolyPatch::typeName_()  )

Runtime type information.

◆ coupled()

bool coupled ( ) const
virtual

Return true if this patch field is coupled.

Reimplemented from facePointPatch.

Definition at line 112 of file cyclicAMIPointPatch.C.

References boundaryMesh::mesh(), and UPstream::parRun().

Here is the call graph for this function:

◆ constraintType()

virtual const word & constraintType ( ) const
inlinevirtual

Return the constraint type this pointPatch implements.

Reimplemented from pointPatch.

Definition at line 120 of file cyclicAMIPointPatch.H.

References Foam::type().

Here is the call graph for this function:

◆ cyclicAMIPatch()

const cyclicAMIPolyPatch & cyclicAMIPatch ( ) const
inline

Return the underlying cyclicAMIPolyPatch.

Definition at line 126 of file cyclicAMIPointPatch.H.

◆ neighbPatch()

const cyclicAMIPointPatch & neighbPatch ( ) const
inline

Return neighbour point patch.

Definition at line 132 of file cyclicAMIPointPatch.H.

References cyclicAMIPolyPatch::neighbPatchID().

Referenced by cyclicAMIPointPatchField< Type >::swapAddSeparated().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parallel()

bool parallel ( ) const
inline

Are the cyclic planes parallel.

Definition at line 140 of file cyclicAMIPointPatch.H.

References coupledPolyPatch::parallel().

Referenced by cyclicAMIPointPatchField< Type >::doTransform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ forwardT()

const tensorField & forwardT ( ) const
inline

Return face transformation tensor.

Definition at line 146 of file cyclicAMIPointPatch.H.

References coupledPolyPatch::forwardT().

Referenced by cyclicAMIPointPatchField< Type >::forwardT().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reverseT()

const tensorField & reverseT ( ) const
inline

Return neighbour-cell transformation tensor.

Definition at line 152 of file cyclicAMIPointPatch.H.

References coupledPolyPatch::reverseT().

Referenced by cyclicAMIPointPatchField< Type >::reverseT().

Here is the call graph for this function:
Here is the caller graph for this function:

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