Storage for referred wall faces. Stores patch index, face and associated points. More...

Inheritance diagram for referredWallFace:

Collaboration diagram for referredWallFace:

Public Member Functions
	referredWallFace ()
	Construct null. More...

	referredWallFace (const face &f, const pointField &pts, label patchI)
	Construct from components. More...

	referredWallFace (const referredWallFace &)
	Construct as copy. More...

	~referredWallFace ()
	Destructor. More...

const pointField &	points () const
	Return access to the stored points. More...

pointField &	points ()
	Return non-const access to the stored points. More...

label	patchIndex () const
	Return access to the patch index. More...

label &	patchIndex ()
	Return non-const access to the patch index. More...

bool	operator== (const referredWallFace &) const

bool	operator!= (const referredWallFace &) const

Public Member Functions inherited from face
	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 (const Xfer< 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...

scalar	mag (const pointField &) const
	Magnitude of face area. More...

vector	normal (const pointField &) const
	Vector normal; magnitude is equal to area of face. 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::FULL_RAY, const intersection::direction dir=intersection::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
	Number of triangles after splitting. More...

label	nTriangles (const pointField &points) const
	Number of triangles after splitting. More...

label	triangles (const pointField &points, label &triI, faceList &triFaces) const
	Split into triangles using existing points. More...

template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
label	triangles (const pointField &points, DynamicList< face, SizeInc, SizeMult, SizeDiv > &triFaces) const
	Split into triangles using existing points. More...

label	nTrianglesQuads (const pointField &points, label &nTris, label &nQuads) const
	Number of triangles and quads after splitting. More...

label	trianglesQuads (const pointField &points, label &triI, label &quadI, faceList &triFaces, faceList &quadFaces) const
	Split into triangles and quads. More...

template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
Foam::label	triangles (const pointField &points, DynamicList< face, SizeInc, SizeMult, SizeDiv > &triFaces) const

Public Member Functions inherited from List
	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 List< T > &)
	Copy constructor. More...

	List (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. 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 (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...

Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container. More...

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

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

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

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

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

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

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

template<class T >
	List (const label s)

template<class T >
	List (const label s, const T &a)

template<class T >
	List (const List< T > &a)

template<class T >
	List (const Xfer< List< T > > &lst)

template<class T >
	List (List< T > &a, bool reUse)

template<class T >
	List (const UList< T > &a, const labelUList &map)

template<class T >
	List (const PtrList< T > &lst)

template<class T >
	List (const SLList< T > &lst)

template<class T >
	List (const UIndirectList< T > &lst)

template<class T >
	List (const BiIndirectList< T > &lst)

template<class T >
void	transfer (List< T > &a)

template<class T >
void	transfer (SortableList< T > &a)

template<class T >
	List ()

template<class T >
	List (Istream &is)

Private Attributes
pointField	pts_
	Points of face. More...

label	patchI_
	Index of originating patch. More...

Friends
Istream &	operator>> (Istream &, referredWallFace &)

Ostream &	operator<< (Ostream &, const referredWallFace &)

Additional Inherited Members
Public Types inherited from face
enum	proxType { NONE, POINT, EDGE }
	Return types for classify. More...

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

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

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

Protected Member Functions inherited from List
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

Storage for referred wall faces. Stores patch index, face and associated points.

Source files

Definition at line 61 of file referredWallFace.H.

Constructor & Destructor Documentation

◆ referredWallFace() [1/3]

referredWallFace ( )

Construct null.

Definition at line 30 of file referredWallFace.C.

◆ referredWallFace() [2/3]

referredWallFace	(	const face &	f,
		const pointField &	pts,
		label	patchI
	)

Construct from components.

Definition at line 39 of file referredWallFace.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ referredWallFace() [3/3]

referredWallFace ( const referredWallFace & rWF )

Construct as copy.

Definition at line 58 of file referredWallFace.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::nl, referredWallFace::pts_, and List::size().

Here is the call graph for this function:

◆ ~referredWallFace()

~referredWallFace ( )

Destructor.

Definition at line 75 of file referredWallFace.C.

Member Function Documentation

◆ points() [1/2]

Foam::pointField & points ( ) const

inline

Return access to the stored points.

Definition at line 30 of file referredWallFaceI.H.

References referredWallFace::pts_.

Referenced by PairCollision< CloudType >::wallInteraction(), and InteractionLists< typename CloudType::parcelType >::writeReferredWallFaces().

Here is the caller graph for this function:

◆ points() [2/2]

pointField& points ( )

inline

Return non-const access to the stored points.

◆ patchIndex() [1/2]

Foam::label & patchIndex ( ) const

inline

Return access to the patch index.

Definition at line 42 of file referredWallFaceI.H.

Referenced by PairCollision< CloudType >::wallInteraction().

Here is the caller graph for this function:

◆ patchIndex() [2/2]

label& patchIndex ( )

inline

Return non-const access to the patch index.

◆ operator==()

bool operator== ( const referredWallFace & rhs ) const

Definition at line 81 of file referredWallFace.C.

References referredWallFace::patchI_, and referredWallFace::pts_.

◆ operator!=()

bool operator!= ( const referredWallFace & rhs ) const

Definition at line 92 of file referredWallFace.C.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	,
		referredWallFace &
	)

friend

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const referredWallFace &
	)

friend

Field Documentation

◆ pts_

pointField pts_

private

Points of face.

Definition at line 68 of file referredWallFace.H.

Referenced by Foam::operator<<(), referredWallFace::operator==(), Foam::operator>>(), referredWallFace::points(), and referredWallFace::referredWallFace().

◆ patchI_

label patchI_

private

Index of originating patch.

Definition at line 71 of file referredWallFace.H.

Referenced by Foam::operator<<(), referredWallFace::operator==(), and Foam::operator>>().

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

src/lagrangian/basic/InteractionLists/referredWallFace/referredWallFace.H
src/lagrangian/basic/InteractionLists/referredWallFace/referredWallFace.C
src/lagrangian/basic/InteractionLists/referredWallFace/referredWallFaceI.H

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ referredWallFace() [1/3]

◆ referredWallFace() [2/3]

◆ referredWallFace() [3/3]

◆ ~referredWallFace()

Member Function Documentation

◆ points() [1/2]

◆ points() [2/2]

◆ patchIndex() [1/2]

◆ patchIndex() [2/2]

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Field Documentation

◆ pts_

◆ patchI_