FreeFOAM programmer's C++ documentation

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

A pointPatch based on a polyPatch. More...

#include <OpenFOAM/facePointPatch.H>

Detailed Description

A pointPatch based on a polyPatch.

Source files

src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.H
src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.C
src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatchM.C
src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/newPointPatch.C

Definition at line 56 of file facePointPatch.H.

Inheritance diagram for facePointPatch:

Collaboration diagram for facePointPatch:

List of all members.

Public Member Functions
	TypeName (polyPatch::typeName_())
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, facePointPatch, polyPatch,(const polyPatch &patch, const pointBoundaryMesh &bm),(patch, bm))
	facePointPatch (const polyPatch &, const pointBoundaryMesh &)
	Construct from polyPatch.
virtual	~facePointPatch ()
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.
	pointPatch (const pointBoundaryMesh &bm)
virtual	~pointPatch ()
const pointBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference.
virtual bool	coupled () const
	Return true if this patch field is coupled.
virtual void	applyConstraint (const label pointi, pointConstraint &) const
	Accumulate the effect of constraint direction of this patch.

Static Public Member Functions
static autoPtr< facePointPatch >	New (const polyPatch &, const pointBoundaryMesh &)
	Return a pointer to a new patch created on freestore from polyPatch.

Protected Member Functions
virtual void	initGeometry ()
	Initialise the calculation of the patch geometry.
virtual void	calcGeometry ()
	Calculate the patch geometry.
virtual void	initMovePoints (const pointField &)
	Initialise the patches for moving points.
virtual void	movePoints (const pointField &)
	Correct patches after moving points.
virtual void	initUpdateMesh ()
	Initialise the update of the patch topology.
virtual void	updateMesh ()
	Update of the patch topology.

Protected Attributes
const polyPatch &	polyPatch_
	Reference to the underlying polyPatch.
labelList	meshPoints_
pointField	localPoints_
vectorField	pointNormals_

Friends
class	processorPointPatch
class	cyclicPointPatch

Constructor & Destructor Documentation

facePointPatch	(	const polyPatch &	p,
		const pointBoundaryMesh &	bm
	)

Construct from polyPatch.

Definition at line 86 of file facePointPatch.C.

virtual ~facePointPatch ( )

inlinevirtual

Definition at line 153 of file facePointPatch.H.

Member Function Documentation

void initGeometry ( )

protectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented from pointPatch.

Definition at line 53 of file facePointPatch.C.

References facePointPatch::localPoints_, facePointPatch::meshPoints_, facePointPatch::pointNormals_, and List< T >::setSize().

Referenced by facePointPatch::initUpdateMesh().

void calcGeometry ( )

protectedvirtual

Calculate the patch geometry.

Reimplemented from pointPatch.

Reimplemented in coupledFacePointPatch.

Definition at line 61 of file facePointPatch.C.

void initMovePoints ( const pointField & )

protectedvirtual

Initialise the patches for moving points.

Reimplemented from pointPatch.

Definition at line 65 of file facePointPatch.C.

void movePoints ( const pointField & )

protectedvirtual

Correct patches after moving points.

Reimplemented from pointPatch.

Definition at line 69 of file facePointPatch.C.

void initUpdateMesh ( )

protectedvirtual

Initialise the update of the patch topology.

Reimplemented from pointPatch.

Definition at line 73 of file facePointPatch.C.

References facePointPatch::initGeometry().

void updateMesh ( )

protectedvirtual

Update of the patch topology.

Reimplemented from pointPatch.

Definition at line 79 of file facePointPatch.C.

TypeName ( polyPatch:: typeName_() )

Runtime type information.

declareRunTimeSelectionTable	(	autoPtr	,
		facePointPatch	,
		polyPatch	,
		(const polyPatch &patch, const pointBoundaryMesh &bm)	,
		(patch, bm)
	)

autoPtr< facePointPatch > New	(	const polyPatch &	patch,
		const pointBoundaryMesh &	bm
	)

static

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

Definition at line 36 of file newFacePointPatch.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and Foam::Info.

const polyPatch& patch ( ) const

inline

Return the polyPatch.

Definition at line 160 of file facePointPatch.H.

References facePointPatch::polyPatch_.

virtual const word& name ( ) const

inlinevirtual

Return name.

Implements pointPatch.

Definition at line 166 of file facePointPatch.H.

References patchIdentifier::name(), and facePointPatch::polyPatch_.

virtual label size ( ) const

inlinevirtual

Return size.

Implements pointPatch.

Definition at line 172 of file facePointPatch.H.

References facePointPatch::meshPoints(), and List< T >::size().

virtual label index ( ) const

inlinevirtual

Return the index of this patch in the pointBoundaryMesh.

Implements pointPatch.

Definition at line 178 of file facePointPatch.H.

References patchIdentifier::index(), and facePointPatch::polyPatch_.

const labelList & meshPoints ( ) const

virtual

Return mesh points.

Implements pointPatch.

Definition at line 98 of file facePointPatch.C.

References PrimitivePatch< Face, FaceList, PointField, PointType >::meshPoints(), facePointPatch::meshPoints_, facePointPatch::polyPatch_, and List< T >::size().

Referenced by facePointPatch::localPoints(), and facePointPatch::size().

const pointField & localPoints ( ) const

virtual

Return pointField of points in patch.

Implements pointPatch.

Definition at line 111 of file facePointPatch.C.

References forAll, PrimitivePatch< Face, FaceList, PointField, PointType >::localPoints(), facePointPatch::localPoints_, facePointPatch::meshPoints(), facePointPatch::meshPoints_, points, PrimitivePatch< Face, FaceList, PointField, PointType >::points(), facePointPatch::polyPatch_, List< T >::setSize(), and List< T >::size().

const vectorField & pointNormals ( ) const

virtual

Return point unit normals.

Implements pointPatch.

Reimplemented in coupledFacePointPatch.

Definition at line 137 of file facePointPatch.C.

References PrimitivePatch< Face, FaceList, PointField, PointType >::pointNormals(), facePointPatch::pointNormals_, facePointPatch::polyPatch_, and List< T >::size().

Friends And Related Function Documentation

friend class processorPointPatch

friend

Definition at line 111 of file facePointPatch.H.

friend class cyclicPointPatch

friend

Definition at line 112 of file facePointPatch.H.

Member Data Documentation

const polyPatch& polyPatch_

protected

Reference to the underlying polyPatch.

Definition at line 65 of file facePointPatch.H.

Referenced by facePointPatch::index(), facePointPatch::localPoints(), facePointPatch::meshPoints(), facePointPatch::name(), facePointPatch::patch(), and facePointPatch::pointNormals().

labelList meshPoints_

mutableprotected

Definition at line 70 of file facePointPatch.H.

Referenced by facePointPatch::initGeometry(), facePointPatch::localPoints(), and facePointPatch::meshPoints().

pointField localPoints_

mutableprotected

Definition at line 71 of file facePointPatch.H.

Referenced by facePointPatch::initGeometry(), and facePointPatch::localPoints().

vectorField pointNormals_

mutableprotected

Definition at line 72 of file facePointPatch.H.

Referenced by facePointPatch::initGeometry(), and facePointPatch::pointNormals().

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

src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.H
src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/facePointPatch.C
src/OpenFOAM/meshes/pointMesh/pointPatches/facePointPatch/newFacePointPatch.C