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

#include <cyclicAMIPointPatch.H>

Inheritance diagram for cyclicAMIPointPatch:

Collaboration diagram for cyclicAMIPointPatch:

Public Member Functions
	TypeName (cyclicAMIPolyPatch::typeName_())
	Runtime type information.
	cyclicAMIPointPatch (const polyPatch &patch, const pointBoundaryMesh &bm)
	Construct from components.
virtual	~cyclicAMIPointPatch ()
	Destructor.
virtual bool	coupled () const
	Return true if this patch field is coupled.
virtual const word &	constraintType () const
	Return the constraint type this pointPatch implements.
const cyclicAMIPolyPatch &	cyclicAMIPatch () const
	Return the underlying cyclicAMIPolyPatch.
const cyclicAMIPointPatch &	neighbPatch () const
	Return neighbour point patch.
bool	parallel () const
	Are the cyclic planes parallel.
const tensorField &	forwardT () const
	Return face transformation tensor.
const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor.
Public Member Functions inherited from coupledFacePointPatch
	TypeName (coupledPolyPatch::typeName_())
	Runtime type information.
	coupledFacePointPatch (const polyPatch &patch, const pointBoundaryMesh &bm)
	Construct from components.
	coupledFacePointPatch (const coupledFacePointPatch &pp, const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap)
	Construct given the original patch and a map.
virtual	~coupledFacePointPatch ()=default
	Destructor.
Public Member Functions inherited from facePointPatch
	TypeName (polyPatch::typeName_())
	Runtime type information.
	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.
	facePointPatch (const facePointPatch &pp, const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap)
	Construct given the original patch and a map.
virtual autoPtr< pointPatch >	clone (const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap) const
	Construct and return a subset clone, resetting the point list and boundary mesh.
virtual	~facePointPatch ()=default
	Destructor.
virtual const polyPatch &	patch () const
	Return the polyPatch.
virtual const word &	name () const
	Return name.
virtual label	size () const
	Return size.
virtual label	index () const
	Return the index of this patch in the pointBoundaryMesh.
virtual const labelList &	meshPoints () const
	Return mesh points.
virtual const pointField &	localPoints () const
	Return pointField of points in patch.
virtual const vectorField &	pointNormals () const
	Return point unit normals.
Public Member Functions inherited from pointPatch
	TypeName ("basePatch")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, pointPatch, dictionary,(const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
	pointPatch (const word &name, const label index, const pointBoundaryMesh &bm, const word &physicalType, const wordList &inGroups)
	Construct from components.
	pointPatch (const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &bm)
	Construct from dictionary.
	pointPatch (const pointPatch &pp, const pointBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const labelUList &reversePointMap)
	Construct given the original patch and a map.
virtual	~pointPatch ()=default
	Destructor.
const pointBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference.
virtual void	applyConstraint (const label pointi, pointConstraint &) const
	Accumulate the effect of constraint direction of this patch.
virtual void	write (Ostream &) const
	Write the pointPatch data as a dictionary.
Public Member Functions inherited from patchIdentifier
	patchIdentifier (const patchIdentifier &)=default
	Copy construct.
	patchIdentifier (patchIdentifier &&)=default
	Move construct.
patchIdentifier &	operator= (const patchIdentifier &)=default
	Copy assignment.
patchIdentifier &	operator= (patchIdentifier &&)=default
	Move assignment.
virtual	~patchIdentifier ()=default
	Destructor.
	patchIdentifier ()
	Default construct: name="", index=0.
	patchIdentifier (const word &name, const label index)
	Construct from mandatory components.
	patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components.
	patchIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	patchIdentifier (const patchIdentifier &ident, const label newIndex)
	Copy construct, resetting the index (if non-negative).
	patchIdentifier (patchIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative).
const word &	name () const noexcept
	The patch name.
word &	name () noexcept
	Modifiable patch name.
label	index () const noexcept
	The index of this patch in the boundaryMesh.
label &	index () noexcept
	Modifiable index of this patch in the boundaryMesh.
const word &	physicalType () const noexcept
	The (optional) physical type of the patch.
word &	physicalType () noexcept
	Modifiable (optional) physical type of the patch.
const wordList &	inGroups () const noexcept
	The (optional) groups that the patch belongs to.
wordList &	inGroups () noexcept
	Modifiable (optional) groups that the patch belongs to.
bool	inGroup (const word &name) const
	True if given name is in a group.
void	addGroup (const word &name)
	Add (unique) group for the patch.
void	removeGroup (const word &name)
	Remove group for the patch.
void	write (Ostream &os) const
	Write (physicalType, inGroups) dictionary entries (without surrounding braces).
Public Member Functions inherited from coupledPointPatch
	TypeName (coupledPolyPatch::typeName_())
	Runtime type information.
	coupledPointPatch (const pointBoundaryMesh &bm)
	Construct from components.
virtual	~coupledPointPatch ()=default
	Destructor.

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

Additional Inherited Members
Static Public Member Functions inherited from facePointPatch
static autoPtr< facePointPatch >	New (const polyPatch &, const pointBoundaryMesh &)
	Return a pointer to a new patch created on freestore from polyPatch.
Static Public Member Functions inherited from pointPatch
static autoPtr< pointPatch >	New (const word &name, const dictionary &dict, const label index, const pointBoundaryMesh &)
	Return a pointer to a new patch created on freestore. Returns null if not found.
Static Public Member Functions inherited from patchIdentifier
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN".
Protected Attributes inherited from facePointPatch
const polyPatch &	polyPatch_
	Reference to the underlying polyPatch.

Detailed Description

Cyclic AMI point patch - place holder only.

Source files

Definition at line 48 of file cyclicAMIPointPatch.H.

Constructor & Destructor Documentation

◆ cyclicAMIPointPatch()

cyclicAMIPointPatch	(	const polyPatch &	patch,
		const pointBoundaryMesh &	bm )

Construct from components.

Definition at line 86 of file cyclicAMIPointPatch.C.

References coupledFacePointPatch::coupledFacePointPatch(), facePointPatch::patch(), and Foam::refCast().

Here is the call graph for this function:

◆ ~cyclicAMIPointPatch()

~cyclicAMIPointPatch ( )

virtual

Destructor.

Definition at line 99 of file cyclicAMIPointPatch.C.

Member Function Documentation

◆ initGeometry()

void initGeometry ( PstreamBuffers & )

protectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented from facePointPatch.

Definition at line 50 of file cyclicAMIPointPatch.C.

◆ calcGeometry()

void calcGeometry ( PstreamBuffers & )

protectedvirtual

Calculate the patch geometry.

Implements coupledFacePointPatch.

Definition at line 54 of file cyclicAMIPointPatch.C.

◆ initMovePoints()

void initMovePoints	(	PstreamBuffers &	,
		const pointField &	)

protectedvirtual

Initialise the patches for moving points.

Reimplemented from facePointPatch.

Definition at line 58 of file cyclicAMIPointPatch.C.

◆ movePoints()

void movePoints	(	PstreamBuffers &	,
		const pointField &	)

protectedvirtual

Correct patches after moving points.

Reimplemented from facePointPatch.

Definition at line 66 of file cyclicAMIPointPatch.C.

◆ initUpdateMesh()

void initUpdateMesh ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Reimplemented from facePointPatch.

Definition at line 70 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.

Reimplemented from facePointPatch.

Definition at line 77 of file cyclicAMIPointPatch.C.

References facePointPatch::updateMesh().

Here is the call graph for this function:

◆ TypeName()

TypeName ( cyclicAMIPolyPatch::typeName_() )

Runtime type information.

References facePointPatch::patch().

Here is the call graph for this function:

◆ coupled()

bool coupled ( ) const

virtual

Return true if this patch field is coupled.

Reimplemented from facePointPatch.

Definition at line 105 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 144 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 152 of file cyclicAMIPointPatch.H.

◆ neighbPatch()

const cyclicAMIPointPatch & neighbPatch ( ) const

inline

Return neighbour point patch.

Definition at line 160 of file cyclicAMIPointPatch.H.

References pointPatch::boundaryMesh(), pp(), and Foam::refCast().

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 170 of file cyclicAMIPointPatch.H.

◆ forwardT()

const tensorField & forwardT ( ) const

inline

Return face transformation tensor.

Definition at line 178 of file cyclicAMIPointPatch.H.

◆ reverseT()

const tensorField & reverseT ( ) const

inline

Return neighbour-cell transformation tensor.

Definition at line 186 of file cyclicAMIPointPatch.H.

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

src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPointPatch/cyclicAMIPointPatch.H
src/meshTools/AMIInterpolation/patches/cyclicAMI/cyclicAMIPointPatch/cyclicAMIPointPatch.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicAMIPointPatch()

◆ ~cyclicAMIPointPatch()

Member Function Documentation

◆ initGeometry()

◆ calcGeometry()

◆ initMovePoints()

◆ movePoints()

◆ initUpdateMesh()

◆ updateMesh()

◆ TypeName()

◆ coupled()

◆ constraintType()

◆ cyclicAMIPatch()

◆ neighbPatch()

◆ parallel()

◆ forwardT()

◆ reverseT()