Symmetry-plane patch. More...

Inheritance diagram for symmetryPlanePolyPatch:

Collaboration diagram for symmetryPlanePolyPatch:

Public Member Functions
	TypeName ("symmetryPlane")
	Runtime type information. More...

	symmetryPlanePolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from components. More...

	symmetryPlanePolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary. More...

	symmetryPlanePolyPatch (const symmetryPlanePolyPatch &, const polyBoundaryMesh &)
	Construct as copy, resetting the boundary mesh. More...

	symmetryPlanePolyPatch (const symmetryPlanePolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the. More...

	symmetryPlanePolyPatch (const symmetryPlanePolyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map. More...

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm) const
	Construct and return a clone, resetting the boundary mesh. More...

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart) const
	Construct and return a clone, resetting the face list. More...

virtual autoPtr< polyPatch >	clone (const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart) const
	Construct and return a clone, resetting the face list. More...

const vector &	n () const
	Return symmetry plane normal. More...

Public Member Functions inherited from polyPatch
	TypeName ("patch")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, size, start, index, bm, patchType))

	declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))

	polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from components. More...

	polyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
	Construct from dictionary. More...

	polyPatch (const polyPatch &, const polyBoundaryMesh &)
	Copy constructor, resetting the boundary mesh. More...

	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
	Construct given the original patch and resetting the. More...

	polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
	Construct given the original patch and a map. More...

	polyPatch (const polyPatch &)
	Copy constructor. More...

virtual	~polyPatch ()
	Destructor. More...

label	start () const
	Return start label of this patch in the polyMesh face list. More...

const polyBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference. More...

virtual bool	coupled () const
	Return true if this patch is geometrically coupled (i.e. faces and. More...

template<class T >
const UIndirectList< T >	patchInternalList (const UList< T > &internalValues) const
	Extract face cell data. More...

template<class T >
const List< T >::subList	patchSlice (const UList< T > &l) const
	Slice list to patch. More...

template<class T >
const Field< T >::subField	patchSlice (const Field< T > &l) const
	Slice Field to patch. More...

virtual void	write (Ostream &) const
	Write the polyPatch data as a dictionary. More...

const vectorField::subField	faceCentres () const
	Return face centres. More...

const vectorField::subField	faceAreas () const
	Return face areas. More...

const scalarField::subField	magFaceAreas () const
	Return face area magnitudes. More...

tmp< vectorField >	faceCellCentres () const
	Return face cell centres. More...

const labelUList &	faceCells () const
	Return face-cell addressing. More...

const labelList &	meshEdges () const
	Return global edge index for local edges. More...

virtual void	clearAddressing ()
	Clear addressing. More...

label	whichFace (const label l) const
	Return label of face in patch from global face label. More...

virtual void	initOrder (PstreamBuffers &, const primitivePatch &) const
	Initialise ordering for primitivePatch. Does not. More...

virtual bool	order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const
	Return new ordering for primitivePatch. More...

void	operator= (const polyPatch &)
	Assignment. More...

Public Member Functions inherited from patchIdentifier
	patchIdentifier (const word &name, const label index, const word &physicalType=word::null, const wordList &inGroups=wordList())
	Construct from components. More...

	patchIdentifier (const word &name, const dictionary &, const label index)
	Construct from dictionary. More...

	patchIdentifier (const patchIdentifier &, const label index)
	Construct from geometric patch, resetting the index. More...

virtual	~patchIdentifier ()
	Destructor. More...

const word &	name () const
	Return name. More...

label	index () const
	Return the index of this patch in the boundaryMesh. More...

const word &	physicalType () const
	Return the optional physical type of the patch. More...

word &	physicalType ()
	Return the optional physical type of the patch for modification. More...

const wordList &	inGroups () const
	Return the optional groups patch belongs to. More...

wordList &	inGroups ()
	Return the optional groups patch belongs to for modification. More...

bool	inGroup (const word &) const
	Test if in group. More...

void	write (Ostream &) const
	Write patchIdentifier as a dictionary. More...

Public Member Functions inherited from PrimitivePatch< FaceList, PointField >
	PrimitivePatch (const FaceList &faces, const Field< PointType > &points)
	Construct from components. More...

	PrimitivePatch (FaceList &&faces, Field< PointType > &&points)
	Move constructor from components. More...

	PrimitivePatch (FaceList &&faces, List< PointType > &&points)
	Move constructor from components. More...

	PrimitivePatch (FaceList &faces, Field< PointType > &points, const bool reuse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< FaceList, PointField > &)
	Copy constructor. More...

	PrimitivePatch (PrimitivePatch< FaceList, PointField > &&)
	Move constructor. More...

virtual autoPtr< PrimitivePatch< FaceList, PointField > >	clone () const
	Construct and return a clone. More...

	PrimitivePatch (Istream &, const Field< PointType > &points)
	Construct from Istream. More...

virtual	~PrimitivePatch ()
	Destructor. More...

const Field< PointType > &	points () const
	Return reference to global points. More...

label	nPoints () const
	Return number of points supporting patch faces. More...

label	nEdges () const
	Return number of edges in patch. More...

const edgeList &	edges () const
	Return list of edges, address into LOCAL point list. More...

label	nInternalEdges () const
	Number of internal edges. More...

bool	isInternalEdge (const label edgeI) const
	Is internal edge? More...

const labelList &	boundaryPoints () const
	Return list of boundary points,. More...

const labelListList &	faceFaces () const
	Return face-face addressing. More...

const labelListList &	edgeFaces () const
	Return edge-face addressing. More...

const labelListList &	faceEdges () const
	Return face-edge addressing. More...

const labelListList &	pointEdges () const
	Return point-edge addressing. More...

const labelListList &	pointFaces () const
	Return point-face addressing. More...

const List< FaceType > &	localFaces () const
	Return patch faces addressing into local point list. More...

const labelList &	meshPoints () const
	Return labelList of mesh points in patch. They are constructed. More...

const Map< label > &	meshPointMap () const
	Mesh point map. Given the global point index find its. More...

const Field< PointType > &	localPoints () const
	Return pointField of points in patch. More...

const labelList &	localPointOrder () const
	Return orders the local points for most efficient search. More...

label	whichPoint (const label gp) const
	Given a global point index, return the local point index. More...

label	whichEdge (const edge &) const
	Given an edge in local point labels, return its. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges in the global edge list using. More...

const Field< PointType > &	faceCentres () const
	Return face centres for patch. More...

const Field< PointType > &	faceAreas () const
	Return face areas for patch. More...

const Field< PointType > &	faceNormals () const
	Return face normals for patch. More...

const Field< PointType > &	pointNormals () const
	Return point normals for patch. More...

template<class ToPatch >
List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::algorithm::fullRay, const intersection::direction=intersection::direction::vector) const
	Project vertices of patch onto another patch. More...

template<class ToPatch >
List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::algorithm::fullRay, const intersection::direction=intersection::direction::vector) const
	Project vertices of patch onto another patch. More...

const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices. More...

surfaceTopo	surfaceType () const
	Calculate surface type formed by patch. More...

bool	checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above). More...

bool	checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge. More...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

virtual void	movePoints (const Field< PointType > &)
	Correct patch after moving points. More...

void	operator= (const PrimitivePatch< FaceList, PointField > &)
	Assignment operator. More...

void	operator= (PrimitivePatch< FaceList, PointField > &&)
	Move assignment operator. More...

template<class ToPatch >
Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

template<class ToPatch >
Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

Protected Member Functions
virtual void	calcGeometry (PstreamBuffers &)
	Calculate the patch geometry. More...

Protected Member Functions inherited from polyPatch
virtual void	initCalcGeometry (PstreamBuffers &)
	Initialise the calculation of the patch geometry. More...

virtual void	initMovePoints (PstreamBuffers &, const pointField &)
	Initialise the patches for moving points. More...

virtual void	movePoints (PstreamBuffers &, const pointField &p)
	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...

virtual void	clearGeom ()
	Clear geometry. More...

virtual void	rename (const wordList &newNames)
	Reset the patch name. More...

virtual void	reorder (const labelUList &newToOldIndex)
	Reset the patch index. More...

Additional Inherited Members
Public Types inherited from PrimitivePatch< FaceList, PointField >
enum	surfaceTopo { MANIFOLD, OPEN, ILLEGAL }
	Enumeration defining the surface type. Used in check routines. More...

typedef FaceList	FaceListType

typedef std::remove_reference< FaceList >::type::value_type	FaceType

typedef PointField	PointFieldType

typedef std::remove_reference< PointField >::type::value_type	PointType

Static Public Member Functions inherited from polyPatch
static autoPtr< polyPatch >	New (const word &patchType, const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
	Return a pointer to a new patch created on freestore from. More...

static autoPtr< polyPatch >	New (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
	Return a pointer to a new patch created on freestore from. More...

static autoPtr< polyPatch >	New (const word &patchType, const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
	Return a pointer to a new patch created on freestore from. More...

static bool	constraintType (const word &pt)
	Return true if the given type is a constraint type. More...

static wordList	constraintTypes ()
	Return a list of all the constraint patch types. More...

Static Public Attributes inherited from polyPatch
static int	disallowGenericPolyPatch
	Debug switch to disallow the use of genericPolyPatch. More...

Protected Attributes inherited from patchIdentifier
word	name_
	Name of patch. More...

label	index_
	Index of patch in boundary. More...

word	physicalType_
	Optional physical type. More...

wordList	inGroups_
	Optional groups patch belongs to. More...

Detailed Description

Symmetry-plane patch.

Source files

Definition at line 48 of file symmetryPlanePolyPatch.H.

Constructor & Destructor Documentation

◆ symmetryPlanePolyPatch() [1/5]

symmetryPlanePolyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType
	)

Construct from components.

Definition at line 86 of file symmetryPlanePolyPatch.C.

Referenced by symmetryPlanePolyPatch::calcGeometry(), symmetryPlanePolyPatch::clone(), and symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the caller graph for this function:

◆ symmetryPlanePolyPatch() [2/5]

symmetryPlanePolyPatch	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType
	)

Construct from dictionary.

Definition at line 101 of file symmetryPlanePolyPatch.C.

References symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ symmetryPlanePolyPatch() [3/5]

symmetryPlanePolyPatch	(	const symmetryPlanePolyPatch &	pp,
		const polyBoundaryMesh &	bm
	)

Construct as copy, resetting the boundary mesh.

Definition at line 115 of file symmetryPlanePolyPatch.C.

References symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ symmetryPlanePolyPatch() [4/5]

symmetryPlanePolyPatch	(	const symmetryPlanePolyPatch &	pp,
		const polyBoundaryMesh &	bm,
		const label	index,
		const label	newSize,
		const label	newStart
	)

Construct given the original patch and resetting the.

face list and boundary mesh information

Definition at line 126 of file symmetryPlanePolyPatch.C.

References symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ symmetryPlanePolyPatch() [5/5]

symmetryPlanePolyPatch	(	const symmetryPlanePolyPatch &	pp,
		const polyBoundaryMesh &	bm,
		const label	index,
		const labelUList &	mapAddressing,
		const label	newStart
	)

Construct given the original patch and a map.

Definition at line 140 of file symmetryPlanePolyPatch.C.

Member Function Documentation

◆ calcGeometry()

void calcGeometry ( PstreamBuffers & )

protectedvirtual

Calculate the patch geometry.

Reimplemented from polyPatch.

Definition at line 43 of file symmetryPlanePolyPatch.C.

References Foam::endl(), Foam::exit(), PrimitivePatch< FaceList, PointField >::faceCentres(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::gAverage(), Foam::Info, Foam::magSqr(), Foam::name(), Foam::returnReduce(), VectorSpace< Vector< scalar >, scalar, 3 >::rootMax, and symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "symmetryPlane" )

Runtime type information.

◆ clone() [1/3]

virtual autoPtr<polyPatch> clone ( const polyBoundaryMesh & bm ) const

inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented from polyPatch.

Definition at line 124 of file symmetryPlanePolyPatch.H.

References PrimitivePatch< FaceList, PointField >::clone(), and symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ clone() [2/3]

virtual autoPtr<polyPatch> clone	(	const polyBoundaryMesh &	bm,
		const label	index,
		const label	newSize,
		const label	newStart
	)		const

inlinevirtual

Construct and return a clone, resetting the face list.

and boundary mesh

Reimplemented from polyPatch.

Definition at line 132 of file symmetryPlanePolyPatch.H.

References PrimitivePatch< FaceList, PointField >::clone(), and symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ clone() [3/3]

virtual autoPtr<polyPatch> clone	(	const polyBoundaryMesh &	bm,
		const label	index,
		const labelUList &	mapAddressing,
		const label	newStart
	)		const

inlinevirtual

Construct and return a clone, resetting the face list.

and boundary mesh

Reimplemented from polyPatch.

Definition at line 148 of file symmetryPlanePolyPatch.H.

References symmetryPlanePolyPatch::symmetryPlanePolyPatch().

Here is the call graph for this function:

◆ n()

const vector& n ( ) const

inline

Return symmetry plane normal.

Definition at line 172 of file symmetryPlanePolyPatch.H.

Referenced by symmetryPlaneFvPatch::n(), and symmetryPlanePointPatch::n().

Here is the caller graph for this function:

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

src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetryPlane/symmetryPlanePolyPatch.H
src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/symmetryPlane/symmetryPlanePolyPatch.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ symmetryPlanePolyPatch() [1/5]

◆ symmetryPlanePolyPatch() [2/5]

◆ symmetryPlanePolyPatch() [3/5]

◆ symmetryPlanePolyPatch() [4/5]

◆ symmetryPlanePolyPatch() [5/5]

Member Function Documentation

◆ calcGeometry()

◆ TypeName()

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ n()