A face is a list of labels corresponding to mesh vertices. More...

Inheritance diagram for face:

[legend]

Collaboration diagram for face:

Public Types
enum	proxType { NONE, POINT, EDGE }
	Return types for classify. More...

Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. More...

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 Member Functions
	face ()
	Construct null. More...

	face (label)
	Construct given size. More...

	face (const labelUList &)
	Construct from list of labels. More...

	face (const labelList &)
	Construct from list of labels. More...

	face (labelList &&)
	Construct by transferring the parameter contents. More...

	face (const triFace &)
	Copy construct from triFace. More...

	face (Istream &)
	Construct from Istream. More...

label	collapse ()
	Collapse face by removing duplicate point labels. More...

void	flip ()
	Flip the face in-place. More...

pointField	points (const pointField &) const
	Return the points corresponding to this face. More...

point	centre (const pointField &) const
	Centre point of face. More...

template<class Type >
Type	average (const pointField &, const Field< Type > &) const
	Calculate average value at centroid of face. More...

vector	area (const pointField &) const
	Return vector area. More...

scalar	mag (const pointField &) const
	Return scalar magnitude. More...

vector	normal (const pointField &) const
	Return unit normal. More...

face	reverseFace () const
	Return face with reverse direction. More...

label	which (const label globalIndex) const
	Navigation through face vertices. More...

label	nextLabel (const label i) const
	Next vertex on face. More...

label	prevLabel (const label i) const
	Previous vertex on face. More...

scalar	sweptVol (const pointField &oldPoints, const pointField &newPoints) const
	Return the volume swept out by the face when its points move. More...

tensor	inertia (const pointField &, const point &refPt=vector::zero, scalar density=1.0) const
	Return the inertia tensor, with optional reference. More...

pointHit	ray (const point &p, const vector &n, const pointField &, const intersection::algorithm alg=intersection::algorithm::fullRay, const intersection::direction dir=intersection::direction::vector) const
	Return potential intersection with face with a ray starting. More...

pointHit	intersection (const point &p, const vector &q, const point &ctr, const pointField &, const intersection::algorithm alg, const scalar tol=0.0) const
	Fast intersection with a ray. More...

pointHit	nearestPoint (const point &p, const pointField &) const
	Return nearest point to face. More...

pointHit	nearestPointClassify (const point &p, const pointField &, label &nearType, label &nearLabel) const
	Return nearest point to face and classify it: More...

scalar	contactSphereDiameter (const point &p, const vector &n, const pointField &) const
	Return contact sphere diameter. More...

scalar	areaInContact (const pointField &, const scalarField &v) const
	Return area in contact, given the displacement in vertices. More...

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

edgeList	edges () const
	Return edges in face point ordering,. More...

edge	faceEdge (const label n) const
	Return n-th face edge. More...

int	edgeDirection (const edge &) const
	Return the edge direction on the face. More...

label	nTriangles () const
	Size of the face's triangulation. More...

void	operator= (labelList &&)
	Move assignment labelList. More...

template<class PointField >
Foam::point	centre (const PointField &ps)

template<class PointField >
Foam::vector	area (const PointField &ps)

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

	List (const label)
	Construct with given size. More...

	List (const label, const T &)
	Construct with given size and value for all elements. More...

	List (const label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< T > &)
	Copy constructor. More...

template<class T2 >
	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< T > &&)
	Move constructor. More...

	List (List< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &, const labelUList &mapAddressing)
	Construct as subset. More...

template<class InputIterator >
	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

template<unsigned Size>
	List (const FixedList< T, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< T > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< T > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< T > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< T > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< T >)
	Construct from an initialiser list. More...

	List (Istream &)
	Construct from Istream. More...

autoPtr< List< T > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

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

void	resize (const label)
	Alias for setSize(const label) More...

void	resize (const label, const T &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const T &)
	Reset size of List and value for new elements. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const T &)
	Append an element at the end of the list. More...

void	append (const UList< T > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...

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

template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

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

T &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< T > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< T > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< T > &)
	Assignment operator. Takes linear time. More...

void	operator= (List< T > &&)
	Move assignment operator. More...

void	operator= (const SLList< T > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< T > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< T > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< T >)
	Assignment to an initialiser 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...

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

template<>
const bool &	operator[] (const label i) const

Static Public Member Functions
template<class PointField >
static vector	centre (const PointField &ps)
	Return centre point given face points. More...

template<class PointField >
static vector	area (const PointField &ps)
	Return vector area given face points. More...

static int	compare (const face &, const face &)
	Compare faces. More...

static bool	sameVertices (const face &, const face &)
	Return true if the faces have the same vertices. More...

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

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

Static Public Attributes
static const char *const	typeName = "face"

Friends
bool	operator== (const face &a, const face &b)

bool	operator!= (const face &a, const face &b)

Istream &	operator>> (Istream &, face &)

Additional Inherited Members
Protected Member Functions inherited from List< T >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

A face is a list of labels corresponding to mesh vertices.

See also: Foam::triFace

Source files

Definition at line 75 of file face.H.

Member Enumeration Documentation

◆ proxType

enum proxType

Return types for classify.

Enumerator
NONE
POINT
EDGE

Definition at line 82 of file face.H.

Constructor & Destructor Documentation

◆ face() [1/7]

face ( )

inline

Construct null.

Definition at line 28 of file faceI.H.

Referenced by face::reverseFace().

Here is the caller graph for this function:

◆ face() [2/7]

face ( label s )

inlineexplicit

Construct given size.

Definition at line 32 of file faceI.H.

◆ face() [3/7]

face ( const labelUList & lst )

inlineexplicit

Construct from list of labels.

Definition at line 38 of file faceI.H.

◆ face() [4/7]

face ( const labelList & lst )

inlineexplicit

Construct from list of labels.

Definition at line 44 of file faceI.H.

◆ face() [5/7]

face ( labelList && lst )

inlineexplicit

Construct by transferring the parameter contents.

Definition at line 50 of file faceI.H.

◆ face() [6/7]

face ( const triFace & f )

Copy construct from triFace.

Definition at line 40 of file face.C.

◆ face() [7/7]

face ( Istream & is )

inline

Construct from Istream.

Definition at line 56 of file faceI.H.

Member Function Documentation

◆ centre() [1/3]

static vector centre ( const PointField & ps )

static

Return centre point given face points.

Referenced by searchableBox::boundingSpheres(), face::centre(), edgeCollapser::checkMeshQuality(), hexRef8::faceLevel(), AMIMethod::findTargetFace(), face::inertia(), cellCuts::nonAnchorPoints(), and face::sweptVol().

Here is the caller graph for this function:

◆ area() [1/3]

static vector area ( const PointField & ps )

static

Return vector area given face points.

Referenced by face::area(), hexRef8::faceLevel(), face::mag(), cellCuts::nonAnchorPoints(), face::normal(), snappySnapDriver::repatchToSurface(), MPLICface::Sf(), and polygonTriangulate::triangulate().

Here is the caller graph for this function:

◆ collapse()

Foam::label collapse ( )

Collapse face by removing duplicate point labels.

return the collapsed size

Definition at line 199 of file face.C.

References UList< T >::operator[](), List< T >::setSize(), and List< T >::size().

Referenced by STARCD::readCells().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flip()

void flip ( )

Flip the face in-place.

The starting points of the original and flipped face are identical.

Definition at line 224 of file face.C.

References n, List< T >::size(), and Foam::Swap().

Referenced by hexRef8::faceLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ points()

Foam::pointField points ( const pointField & meshPoints ) const

inline

Return the points corresponding to this face.

Definition at line 64 of file faceI.H.

References forAll, UList< T >::operator[](), p, and List< T >::size().

Referenced by face::edges(), coupledPolyPatch::initOrder(), and AMIMethod::writeIntersectionOBJ().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ centre() [2/3]

Foam::point centre ( const pointField & ps ) const

Centre point of face.

Definition at line 238 of file face.C.

References face::centre().

Here is the call graph for this function:

◆ average()

Type average	(	const pointField &	ps,
		const Field< Type > &	fld
	)		const

Calculate average value at centroid of face.

Definition at line 141 of file faceTemplates.C.

References f(), UList< T >::fcIndex(), forAll, Foam::normalised(), UList< T >::operator[](), p, Foam::constant::mathematical::pi(), List< T >::size(), and Foam::Zero.

Referenced by face::area().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ area() [2/3]

Foam::vector area ( const pointField & ps ) const

Return vector area.

Definition at line 244 of file face.C.

References face::area().

Here is the call graph for this function:

◆ mag()

Foam::scalar mag ( const pointField & points ) const

inline

Return scalar magnitude.

Definition at line 81 of file faceI.H.

References face::area(), and Foam::mag().

Referenced by face::areaInContact(), edgeCollapser::checkMeshQuality(), faceAreaWeightAMI::interArea(), and listPlusEqOp< T >::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normal()

Foam::vector normal ( const pointField & points ) const

Return unit normal.

Definition at line 250 of file face.C.

References face::area(), and Foam::normalised().

Here is the call graph for this function:

◆ reverseFace()

Foam::face reverseFace ( ) const

Return face with reverse direction.

The starting points of the original and reverse face are identical.

Definition at line 256 of file face.C.

References f(), face::face(), and List< T >::size().

Referenced by NamedEnum< compressibleField, 8 >::names(), ifEqEqOp< value >::operator()(), hexRef8::setInstance(), removeCells::setRefinement(), and createShellMesh::setRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ which()

Foam::label which ( const label globalIndex ) const

Navigation through face vertices.

Which vertex on face (face index given a global index)

returns -1 if not found

Definition at line 275 of file face.C.

References f(), forAll, and face::sweptVol().

Here is the call graph for this function:

◆ nextLabel()

Foam::label nextLabel ( const label i ) const

inline

Next vertex on face.

Definition at line 100 of file faceI.H.

References UList< T >::fcIndex(), and UList< T >::operator[]().

Referenced by Foam::polyMeshCheck::checkFaceFlatness(), Foam::polyMeshCheck::checkFaceTet(), polyMeshTetDecomposition::checkFaceTets(), Foam::polyMeshCheck::checkFaceTwist(), Foam::polyMeshCheck::checkTriangleTwist(), primitiveMesh::faceEdges(), combineFaces::getOutsideFace(), meshTriangulation::meshTriangulation(), NamedEnum< compressibleField, 8 >::names(), polyMesh::pointInCell(), edgeFaceCirculator::setCanonical(), boundaryCutter::setRefinement(), and tetDecomposer::setRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prevLabel()

Foam::label prevLabel ( const label i ) const

inline

Previous vertex on face.

Definition at line 106 of file faceI.H.

References UList< T >::operator[](), and UList< T >::rcIndex().

Referenced by edgeCollapser::checkMeshQuality(), and tetDecomposer::setRefinement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sweptVol()

Foam::scalar sweptVol	(	const pointField &	oldPoints,
		const pointField &	newPoints
	)		const

Return the volume swept out by the face when its points move.

Definition at line 292 of file face.C.

References face::centre(), face::inertia(), nPoints, Foam::constant::mathematical::pi(), and List< T >::size().

Referenced by face::which().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inertia()

Foam::tensor inertia	(	const pointField &	p,
		const point &	refPt = `vector::zero`,
		scalar	density = `1.0`
	)		const

Return the inertia tensor, with optional reference.

point and density specification

Definition at line 371 of file face.C.

References face::centre(), UList< T >::fcIndex(), forAll, List< T >::size(), and Foam::Zero.

Referenced by edgeCollapser::checkMeshQuality(), and face::sweptVol().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ray()

Foam::pointHit ray	(	const point &	p,
		const vector &	n,
		const pointField &	meshPoints,
		const intersection::algorithm	alg = `intersection::algorithm::fullRay`,
		const intersection::direction	dir = `intersection::direction::vector`
	)		const

Return potential intersection with face with a ray starting.

at p, direction n (does not need to be normalised) Does face-centre decomposition and returns triangle intersection point closest to p. Face-centre is calculated from point average. For a hit, the distance is signed. Positive number represents the point in front of triangle In case of miss the point is the nearest point on the face and the distance is the distance between the intersection point and the original point. The half-ray or full-ray intersection and the contact sphere adjustment of the projection vector is set by the intersection parameters

Definition at line 34 of file faceIntersection.C.

References Foam::average(), PointHit< Point >::distance(), PointHit< Point >::eligibleMiss(), f(), PointHit< Point >::hit(), PointHit< Point >::hitPoint(), face::intersection(), Foam::mag(), PointHit< Point >::missPoint(), nPoints, points, PointHit< Point >::setDistance(), PointHit< Point >::setHit(), PointHit< Point >::setMiss(), and PointHit< Point >::setPoint().

Referenced by treeDataCell::findIntersectOp::operator()(), AMIInterpolation::srcPointFace(), and AMIInterpolation::tgtPointFace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersection()

Foam::pointHit intersection	(	const point &	p,
		const vector &	q,
		const point &	ctr,
		const pointField &	meshPoints,
		const intersection::algorithm	alg,
		const scalar	tol = `0.0`
	)		const

Fast intersection with a ray.

Does face-centre decomposition and returns triangle intersection point closest to p. See triangle::intersection for details.

Definition at line 141 of file faceIntersection.C.

References PointHit< Point >::distance(), f(), forAll, PointHit< Point >::hit(), PointHit< Point >::hitPoint(), Foam::mag(), face::nearestPoint(), PointHit< Point >::setDistance(), PointHit< Point >::setHit(), and PointHit< Point >::setPoint().

Referenced by face::ray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nearestPoint()

Foam::pointHit nearestPoint	(	const point &	p,
		const pointField &	meshPoints
	)		const

Return nearest point to face.

Definition at line 199 of file faceIntersection.C.

References face::nearestPointClassify().

Referenced by meshSearch::findNearestBoundaryFace(), treeDataFace::getVolumeType(), face::intersection(), NamedEnum< compressibleField, 8 >::names(), findUniqueIntersectOp::operator()(), treeDataFace::findNearestOp::operator()(), treeDataPrimitivePatch< PatchType >::overlaps(), AMIInterpolation::srcPointFace(), and AMIInterpolation::tgtPointFace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nearestPointClassify()

Foam::pointHit nearestPointClassify	(	const point &	p,
		const pointField &	meshPoints,
		label &	nearType,
		label &	nearLabel
	)		const

Return nearest point to face and classify it:

+ near point (nearType=POINT, nearLabel=0, 1, 2) + near edge (nearType=EDGE, nearLabel=0, 1, 2) Note: edges are counted from starting vertex so e.g. edge n is from f[n] to f[0], where the face has n + 1 points

Definition at line 213 of file faceIntersection.C.

References PointHit< Point >::distance(), f(), PointHit< Point >::hit(), PointHit< Point >::hitPoint(), Foam::mag(), PointHit< Point >::missPoint(), triangle< Point, PointRef >::nearestPointClassify(), nPoints, PointHit< Point >::setDistance(), PointHit< Point >::setHit(), PointHit< Point >::setMiss(), PointHit< Point >::setPoint(), and List< T >::size().