Non-conformal cyclic poly patch. As nonConformalCoupledPolyPatch, but the neighbouring patch is local and known and is made available by this class. More...

Inheritance diagram for nonConformalCyclicPolyPatch:

[legend]

Collaboration diagram for nonConformalCyclicPolyPatch:

[legend]

Public Types
enum class	moveUpdate { always , detect , never }
	Enumeration for the condition that triggers re-calculation of the. More...

Public Types inherited from PrimitivePatch< SubList< face >, const pointField & >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...

typedef SubList< face >	FaceListType

typedef std::remove_reference< SubList< face > >::type::value_type	FaceType

typedef const pointField &	PointFieldType

typedef std::remove_reference< const pointField & >::type::value_type	PointType

Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Public Types inherited from cyclicTransform
enum	transformTypes { UNSPECIFIED , NONE , ROTATIONAL , TRANSLATIONAL }

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

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

	nonConformalCyclicPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const word &nbrPatchName, const word &origPatchName, const cyclicTransform &transform=cyclicTransform(true))
	Construct from components. More...

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

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

	nonConformalCyclicPolyPatch (const nonConformalCyclicPolyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart, const word &nbrPatchName, const word &origPatchName)
	Construct given the original patch and resetting the. 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	~nonConformalCyclicPolyPatch ()
	Destructor. More...

const nonConformalCyclicPolyPatch &	nbrPatch () const
	Neighbour patch. More...

virtual bool	coupled () const
	Is this patch coupled? Returns false. For NCC patches the poly. More...

const patchToPatches::intersection &	intersection () const
	Access the intersection engine. More...

const patchToPatches::rays &	rays () const
	Access the rays engine. More...

remote	ray (const scalar fraction, const label origFacei, const vector &p, const vector &n, point &nbrP) const
	Compute a ray intersection across the coupling. More...

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

virtual bool	owner () const
	Inherit the cyclic owner method. More...

virtual bool	neighbour () const
	Inherit the cyclic neighbour method. More...

virtual const transformer &	transform () const
	Inherit the cyclic transform method. More...

Public Member Functions inherited from cyclicPolyPatch
	TypeName ("cyclic")
	Runtime type information. More...

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

	cyclicPolyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType, const word &nbrPatchName, const cyclicTransform &transform=cyclicTransform(false))
	Construct from components. More...

	cyclicPolyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType, const bool cyclicTransformDefaultIsNone=false)
	Construct from dictionary. More...

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

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

virtual	~cyclicPolyPatch ()
	Destructor. More...

const word &	nbrPatchName () const
	Neighbour patch name. More...

virtual label	nbrPatchIndex () const
	Neighbour patchID. More...

virtual bool	owner () const
	Does this side own the patch ? More...

virtual bool	neighbour () const
	Does the coupled side own the patch ? More...

const cyclicPolyPatch &	nbrPatch () const

const edgeList &	coupledPoints () const
	Return connected points (from patch local to neighbour patch local) More...

const edgeList &	coupledEdges () const
	Return connected edges (from patch local to neighbour patch local). More...

virtual const transformer &	transform () const
	Return transformation between the coupled patches. More...

label	transformGlobalFace (const label facei) const
	For a given patch face index, return the corresponding index of the. 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...

Public Member Functions inherited from coupledPolyPatch
	TypeName ("coupled")
	Runtime type information. More...

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

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

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

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

virtual	~coupledPolyPatch ()
	Destructor. More...

scalar	matchTolerance () const
	Return the matching tolerance. 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 &)
	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...

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...

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...

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< SubList< face >, const pointField & >
	PrimitivePatch (const SubList< face > &faces, const Field< PointType > &points)
	Construct from components. More...

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

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

	PrimitivePatch (const PrimitivePatch< SubList< face >, const pointField & > &)
	Copy constructor. More...

	PrimitivePatch (PrimitivePatch< SubList< face >, const pointField & > &&)
	Move constructor. More...

autoPtr< PrimitivePatch< SubList< face >, const pointField & > >	clone () const
	Construct and return a clone. More...

	~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...

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...

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

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...

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

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 ()

void	operator= (const PrimitivePatch< SubList< face >, const pointField & > &)
	Assignment operator. More...

void	operator= (PrimitivePatch< SubList< face >, const pointField & > &&)
	Move assignment operator. More...

Public Member Functions inherited from SubList< T >
	SubList (const UList< T > &list, const label subSize)
	Construct from UList and sub-list size. More...

	SubList (const UList< T > &list, const label subSize, const label startIndex)
	Construct from UList, sub-list size and start index. More...

	SubList (const SubList< T > &sl)=default
	Copy constructor. More...

void	transfer (UList< T > &)
	Transfer the contents of the argument List into this list. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const SubList< T > &)
	Assignment of all entries to the given sub-list. More...

void	operator= (const UList< T > &)
	Assignment of all entries to the given list. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

	UList (const UList< T > &)=default
	Copy construct. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

const bool &	operator[] (const label i) const

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

	cyclicTransform ()

	cyclicTransform (const bool defaultIsNone)

	cyclicTransform (const dictionary &dict, const bool defaultIsNone)

	cyclicTransform (const word &name, const vectorField &areas, const cyclicTransform &transform, const word &nbrName, const cyclicTransform &nbrTransform, const scalar matchTolerance, const bool global=false)
	Construct from coupled patch data. Copies from the supplied. More...

	cyclicTransform (const word &name, const pointField &ctrs, const vectorField &areas, const cyclicTransform &transform, const word &nbrName, const pointField &nbrCtrs, const vectorField &nbrAreas, const cyclicTransform &nbrTransform, const scalar matchTolerance, const bool global=false)
	Construct from coupled patch data. Copies from the supplied. More...

virtual	~cyclicTransform ()

transformTypes	transformType () const
	Type of transform. More...

bool	transformComplete () const
	Is the transform fully specified? More...

const transformer &	transform () const
	Return transformation between the coupled patches. More...

void	write (Ostream &os) const
	Write the data to a dictionary. More...

string	str () const
	Generate a string representation of the transform. More...

Public Member Functions inherited from nonConformalCoupledPolyPatch
	TypeName ("nonConformalCoupled")
	Runtime type information. More...

	nonConformalCoupledPolyPatch (const polyPatch &patch)
	Construct from a patch. More...

	nonConformalCoupledPolyPatch (const polyPatch &patch, const word &origPatchName)
	Construct from a patch and an original patch name. More...

	nonConformalCoupledPolyPatch (const polyPatch &patch, const dictionary &dict)
	Construct from a patch and a dictionary. More...

	nonConformalCoupledPolyPatch (const polyPatch &patch, const nonConformalCoupledPolyPatch &nccPatch)
	Construct from a patch and a non-conformal coupled patch. More...

virtual	~nonConformalCoupledPolyPatch ()
	Destructor. More...

bool	owner () const
	Does this side own the patch? More...

bool	neighbour () const
	Does the coupled side own the patch? More...

const transformer &	transform () const
	Return transformation between the coupled patches. More...

const word &	errorPatchName () const
	Error patch name. More...

label	errorPatchIndex () const
	Error patchID. More...

const nonConformalErrorPolyPatch &	errorPatch () const
	Error patch. More...

Public Member Functions inherited from nonConformalPolyPatch
	TypeName ("nonConformal")
	Runtime type information. More...

	nonConformalPolyPatch (const polyPatch &patch)
	Construct from a patch. More...

	nonConformalPolyPatch (const polyPatch &patch, const word &origPatchName)
	Construct from a patch and an original patch name. More...

	nonConformalPolyPatch (const polyPatch &patch, const dictionary &dict)
	Construct from a patch and a dictionary. More...

	nonConformalPolyPatch (const polyPatch &patch, const nonConformalPolyPatch &ncPatch)
	Construct from a patch and a non-conformal patch. More...

virtual	~nonConformalPolyPatch ()
	Destructor. More...

const polyPatch &	patch () const
	Reference to the polyPatch. More...

const word &	origPatchName () const
	Original patch name. More...

label	origPatchIndex () const
	Original patchID. More...

const polyPatch &	origPatch () const
	Original patch. More...

Static Public Attributes
static const NamedEnum< moveUpdate, 3 >	moveUpdateNames_
	Names of the move-update conditions. More...

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

Static Public Attributes inherited from cyclicTransform
static const NamedEnum< transformTypes, 4 >	transformTypeNames

static const wordList	keywords

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

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

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

virtual void	initTopoChange (PstreamBuffers &)
	Initialise the 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...

Protected Member Functions inherited from cyclicPolyPatch
virtual void	initCalcGeometry (const primitivePatch &referPatch, pointField &nbrCtrs, vectorField &nbrAreas, pointField &nbrCc)
	Initialise the calculation of the patch geometry. More...

virtual void	movePoints (PstreamBuffers &, const pointField &)
	Correct patches after moving points. More...

virtual void	topoChange (PstreamBuffers &)
	Update of the patch topology. More...

Protected Member Functions inherited from coupledPolyPatch
virtual void	initOrder (ownToNbrOrderData &ownToNbr, autoPtr< ownToNbrDebugOrderData > &ownToNbrDebugPtr, const primitivePatch &) const
	Initialise ordering for the given primitivePatch. Fills the. More...

virtual bool	order (const ownToNbrOrderData &ownToNbr, const autoPtr< ownToNbrDebugOrderData > &ownToNbrDebugPtr, const primitivePatch &, labelList &faceMap, labelList &rotation) const
	Return new ordering for the given primitivePatch. More...

Protected Member Functions inherited from polyPatch
virtual void	movePoints (const pointField &p)
	Correct patches after moving points. More...

Protected Attributes
label	intersectionIsValid_
	Is the intersection engine up to date? Zero if out of date. One if. More...

patchToPatches::intersection	intersection_
	Patch-to-patch intersection engine. More...

label	raysIsValid_
	Is the rays engine up to date? Zero if out of date. One if out of. More...

patchToPatches::rays	rays_
	Patch-to-patch rays engine. More...

const moveUpdate	moveUpdate_
	The condition that triggers re-calculation following motion. More...

Protected Attributes inherited from coupledPolyPatch
const scalar	matchTolerance_
	Local matching tolerance. More...

autoPtr< ownToOwnOrderData >	ownToOwnOrderDataPtr_
	Data to pass from owner.initOrder to owner.order. 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...

Additional Inherited Members
Static Public Member Functions inherited from coupledPolyPatch
static scalarField	calcFaceTol (const UList< face > &faces, const pointField &points, const pointField &faceCentres)
	Calculate typical tolerance per face. Is currently max distance. More...

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 Member Functions inherited from SubList< T >
static const SubList< T > &	null ()
	Return a null SubList. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a null UList. More...

Static Protected Member Functions inherited from coupledPolyPatch
static void	writeOBJ (const fileName &, const primitivePatch &)
	Write a patch in OBJ format. More...

static void	writeOBJ (const fileName &, const pointField &, const pointField &)
	Write lines between two lists of points in OBJ format. More...

static void	writeOBJ (const fileName &, const pointField &, const labelListList &)
	Write a set of paths in OBJ format. More...

Static Protected Attributes inherited from coupledPolyPatch
static const scalar	defaultMatchTol_ = 1e-4
	Default matching tolerance. More...

Detailed Description

Non-conformal cyclic poly patch. As nonConformalCoupledPolyPatch, but the neighbouring patch is local and known and is made available by this class.

See also: Foam::nonConformalCoupledPolyPatch

Source files

Definition at line 55 of file nonConformalCyclicPolyPatch.H.

Member Enumeration Documentation

◆ moveUpdate

enum moveUpdate

strong

Enumeration for the condition that triggers re-calculation of the.

intersection following mesh motion.

'always' will re-calculate the intersection, 'never' will not, and 'detect' will compare the new and old points and re-calculate if there is any difference.

The comparison that 'detect' does has an expense associated with it, so it should only really be used if the patch is both moving and static at different times. If the patch is always in motion or is fully stationary, then it is more efficient to specify 'always' or 'never'.

'always' is the default, as it is safest to assume that motion always affects the intersection. Most non-conformal interfaces are used for sliding interfaces that are in motion for the entirety of the simulation, so 'always' is also typically more efficient than 'detect'.

Enumerator
always
detect
never

Definition at line 82 of file nonConformalCyclicPolyPatch.H.

Constructor & Destructor Documentation

◆ nonConformalCyclicPolyPatch() [1/5]

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

Construct from components.

Definition at line 141 of file nonConformalCyclicPolyPatch.C.

Referenced by nonConformalCyclicPolyPatch::clone().

Here is the caller graph for this function:

◆ nonConformalCyclicPolyPatch() [2/5]

nonConformalCyclicPolyPatch	(	const word &	name,
		const label	size,
		const label	start,
		const label	index,
		const polyBoundaryMesh &	bm,
		const word &	patchType,
		const word &	nbrPatchName,
		const word &	origPatchName,
		const cyclicTransform &	transform = `cyclicTransform(true)`
	)

Construct from components.

Definition at line 161 of file nonConformalCyclicPolyPatch.C.

◆ nonConformalCyclicPolyPatch() [3/5]

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

Construct from dictionary.

Definition at line 194 of file nonConformalCyclicPolyPatch.C.

◆ nonConformalCyclicPolyPatch() [4/5]

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

Construct as copy, resetting the boundary mesh.

Definition at line 224 of file nonConformalCyclicPolyPatch.C.

◆ nonConformalCyclicPolyPatch() [5/5]

nonConformalCyclicPolyPatch	(	const nonConformalCyclicPolyPatch &	pp,
		const polyBoundaryMesh &	bm,
		const label	index,
		const label	newSize,
		const label	newStart,
		const word &	nbrPatchName,
		const word &	origPatchName
	)

Construct given the original patch and resetting the.

face list and boundary mesh information

Definition at line 240 of file nonConformalCyclicPolyPatch.C.

◆ ~nonConformalCyclicPolyPatch()

~nonConformalCyclicPolyPatch ( )

virtual

Destructor.

Definition at line 263 of file nonConformalCyclicPolyPatch.C.

Member Function Documentation

◆ initCalcGeometry()

void initCalcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented from cyclicPolyPatch.

Definition at line 61 of file nonConformalCyclicPolyPatch.C.

References cyclicPolyPatch::initCalcGeometry(), nonConformalCyclicPolyPatch::intersectionIsValid_, and nonConformalCyclicPolyPatch::raysIsValid_.

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( PstreamBuffers & pBufs )

protectedvirtual

Calculate the patch geometry.

Reimplemented from cyclicPolyPatch.

Definition at line 69 of file nonConformalCyclicPolyPatch.C.

References Foam::name().

Here is the call graph for this function:

◆ initMovePoints()

void initMovePoints	(	PstreamBuffers &	pBufs,
		const pointField &	p
	)

protectedvirtual

Initialise the patches for moving points.

Reimplemented from cyclicPolyPatch.

Definition at line 84 of file nonConformalCyclicPolyPatch.C.

References cyclicPolyPatch::initMovePoints(), Foam::min(), and p.

Here is the call graph for this function:

◆ initTopoChange()

void initTopoChange ( PstreamBuffers & pBufs )

protectedvirtual

Initialise the update of the patch topology.

Reimplemented from cyclicPolyPatch.

Definition at line 109 of file nonConformalCyclicPolyPatch.C.

References cyclicPolyPatch::initTopoChange().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

protectedvirtual

Clear geometry.

Reimplemented from polyPatch.

Definition at line 117 of file nonConformalCyclicPolyPatch.C.

References polyPatch::clearGeom().

Here is the call graph for this function:

◆ rename()

void rename ( const wordList & newNames )

protectedvirtual

Reset the patch name.

Reimplemented from nonConformalCoupledPolyPatch.

Definition at line 125 of file nonConformalCyclicPolyPatch.C.

References nonConformalCoupledPolyPatch::rename(), and cyclicPolyPatch::rename().

Here is the call graph for this function:

◆ reorder()

void reorder ( const labelUList & newToOldIndex )

protectedvirtual

Reset the patch index.

Reimplemented from nonConformalCoupledPolyPatch.

Definition at line 132 of file nonConformalCyclicPolyPatch.C.

References nonConformalCoupledPolyPatch::reorder(), and cyclicPolyPatch::reorder().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nonConformalCyclic" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented from cyclicPolyPatch.

Definition at line 205 of file nonConformalCyclicPolyPatch.H.

References nonConformalCyclicPolyPatch::nonConformalCyclicPolyPatch().

Here is the call graph for this function:

◆ clone() [2/2]

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 cyclicPolyPatch.

Definition at line 215 of file nonConformalCyclicPolyPatch.H.

◆ nbrPatch()

const Foam::nonConformalCyclicPolyPatch & nbrPatch ( ) const

Neighbour patch.

Definition at line 270 of file nonConformalCyclicPolyPatch.C.

References cyclicPolyPatch::nbrPatch().

Referenced by Foam::meshCheck::checkGeometry(), and particle::prepareForNonConformalCyclicTransfer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupled()

bool coupled ( ) const

virtual

Is this patch coupled? Returns false. For NCC patches the poly.

mesh is considered non-coupled whilst the finite volume mesh is considered coupled.

Reimplemented from coupledPolyPatch.

Definition at line 280 of file nonConformalCyclicPolyPatch.C.

◆ intersection()

const Foam::patchToPatches::intersection & intersection ( ) const

Access the intersection engine.

Definition at line 287 of file nonConformalCyclicPolyPatch.C.

References Foam::abort(), polyMesh::defaultRegion, Foam::FatalError, FatalErrorInFunction, fvMesh::mesh(), mesh, mappedPatchBaseBase::moving(), fvMesh::name(), DemandDrivenMeshObject< polyMesh, MoveableMeshObject, nonConformalBoundary >::New(), nonConformalBoundary::patchPointNormals(), cyclicTransform::str(), and Foam::transform().

Referenced by Foam::meshCheck::checkGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rays()

const Foam::patchToPatches::rays & rays ( ) const

Access the rays engine.

Definition at line 339 of file nonConformalCyclicPolyPatch.C.

References Foam::abort(), polyMesh::defaultRegion, Foam::FatalError, FatalErrorInFunction, fvMesh::mesh(), mesh, mappedPatchBaseBase::moving(), fvMesh::name(), DemandDrivenMeshObject< polyMesh, MoveableMeshObject, nonConformalBoundary >::New(), polyMesh::oldPoints(), nonConformalBoundary::patchPointNormals(), nonConformalBoundary::patchPointNormals0(), polyMesh::points(), cyclicTransform::str(), and Foam::transform().

Referenced by nonConformalCyclicPolyPatch::ray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ray()

Foam::remote ray	(	const scalar	fraction,
		const label	origFacei,
		const vector &	p,
		const vector &	n,
		point &	nbrP
	)		const

Compute a ray intersection across the coupling.

Definition at line 401 of file nonConformalCyclicPolyPatch.C.

References fvMesh::mesh(), mesh, n, polyMesh::oldPoints(), p, polyMesh::points(), nonConformalCyclicPolyPatch::rays(), rays::srcToTgtRay(), rays::tgtToSrcRay(), and Foam::transform().

Referenced by particle::hitNonConformalCyclicPatch(), and LagrangianMesh::track().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write the polyPatch data as a dictionary.

Reimplemented from nonConformalCoupledPolyPatch.

Definition at line 438 of file nonConformalCyclicPolyPatch.C.

References nonConformalCoupledPolyPatch::write(), and cyclicPolyPatch::write().

Here is the call graph for this function:

◆ owner()

virtual bool owner

inline

Inherit the cyclic owner method.

Definition at line 251 of file cyclicPolyPatch.H.

Referenced by Foam::meshCheck::checkGeometry().

Here is the caller graph for this function:

◆ neighbour()

virtual bool neighbour

inline

Inherit the cyclic neighbour method.

Definition at line 256 of file cyclicPolyPatch.H.

◆ transform()

virtual const transformer& transform

inline

Inherit the cyclic transform method.

Definition at line 278 of file cyclicPolyPatch.H.

Referenced by particle::prepareForNonConformalCyclicTransfer(), and nonConformalCyclicLagrangianPatch::transform().

Here is the caller graph for this function:

Member Data Documentation

◆ moveUpdateNames_

const Foam::NamedEnum< Foam::nonConformalCyclicPolyPatch::moveUpdate, 3 > moveUpdateNames_

static

Initial value:

{
    "always",
    "detect",
    "never"
}

Names of the move-update conditions.

Definition at line 90 of file nonConformalCyclicPolyPatch.H.

◆ intersectionIsValid_

label intersectionIsValid_

mutableprotected

Is the intersection engine up to date? Zero if out of date. One if.

out of date (or potentially not out of date) because of motion. Two if up to date.

Definition at line 100 of file nonConformalCyclicPolyPatch.H.

Referenced by nonConformalCyclicPolyPatch::initCalcGeometry().

◆ intersection_

patchToPatches::intersection intersection_

mutableprotected

Patch-to-patch intersection engine.

Definition at line 103 of file nonConformalCyclicPolyPatch.H.

◆ raysIsValid_

label raysIsValid_

mutableprotected

Is the rays engine up to date? Zero if out of date. One if out of.

date (or potentially not out of date) because of motion. Two if up to date.

Definition at line 108 of file nonConformalCyclicPolyPatch.H.

Referenced by nonConformalCyclicPolyPatch::initCalcGeometry().

◆ rays_

patchToPatches::rays rays_

mutableprotected

Patch-to-patch rays engine.

Definition at line 111 of file nonConformalCyclicPolyPatch.H.

◆ moveUpdate_

const moveUpdate moveUpdate_

protected

The condition that triggers re-calculation following motion.

Definition at line 114 of file nonConformalCyclicPolyPatch.H.

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

src/meshTools/nonConformal/polyPatches/nonConformalCyclic/nonConformalCyclicPolyPatch.H
src/meshTools/nonConformal/polyPatches/nonConformalCyclic/nonConformalCyclicPolyPatch.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ moveUpdate

Constructor & Destructor Documentation

◆ nonConformalCyclicPolyPatch() [1/5]

◆ nonConformalCyclicPolyPatch() [2/5]

◆ nonConformalCyclicPolyPatch() [3/5]

◆ nonConformalCyclicPolyPatch() [4/5]

◆ nonConformalCyclicPolyPatch() [5/5]

◆ ~nonConformalCyclicPolyPatch()

Member Function Documentation

◆ initCalcGeometry()

◆ calcGeometry()

◆ initMovePoints()

◆ initTopoChange()

◆ clearGeom()

◆ rename()

◆ reorder()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ nbrPatch()

◆ coupled()

◆ intersection()

◆ rays()

◆ ray()

◆ write()

◆ owner()

◆ neighbour()

◆ transform()

Member Data Documentation

◆ moveUpdateNames_

◆ intersectionIsValid_

◆ intersection_

◆ raysIsValid_

◆ rays_

◆ moveUpdate_