tetIndices Class Reference | OpenFOAM Source Code Guide

OpenFOAM 6

The OpenFOAM Foundation

Storage and named access for the indices of a tet which is part of the decomposition of a cell. More...

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

	tetIndices (label celli, label facei, label tetPtI)
	Construct from components. More...

	~tetIndices ()
	Destructor. More...

label	cell () const
	Return the cell. More...

label &	cell ()
	Return non-const access to the cell. More...

label	face () const
	Return the face. More...

label &	face ()
	Return non-const access to the face. More...

label	tetPt () const
	Return the characterising tetPtI. More...

label &	tetPt ()
	Return non-const access to the characterising tetPtI. More...

triFace	faceTriIs (const polyMesh &mesh) const
	Return the indices corresponding to the tri on the face for. More...

tetPointRef	tet (const polyMesh &mesh) const
	Return the geometry corresponding to this tet. More...

triPointRef	faceTri (const polyMesh &mesh) const
	Return the geometry corresponding to the tri on the face for. More...

triPointRef	oldFaceTri (const polyMesh &mesh) const
	Return the geometry corresponding to the tri on the face for. More...

bool	operator== (const tetIndices &) const

bool	operator!= (const tetIndices &) const

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

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

Detailed Description

Storage and named access for the indices of a tet which is part of the decomposition of a cell.

Tets are designated by

cell (of course)
face on cell
three points on face (faceBasePt, facePtA, facePtB) When constructing from a mesh and index in the face (tetPtI):
- faceBasePt is the mesh.tetBasePtIs() base point
- facePtA is tetPtI away from faceBasePt
- facePtB is next one after/before facePtA e.g.:
  
  +—+ |2 /| | / | |/ 1| <- tetPt (so 1 for first triangle, 2 for second) +—+ ^ faceBasePt

Source files

Definition at line 81 of file tetIndices.H.

Constructor & Destructor Documentation

◆ tetIndices() [1/2]

tetIndices ( )

Construct null.

Definition at line 37 of file tetIndices.C.

◆ tetIndices() [2/2]

tetIndices	(	label	celli,
		label	facei,
		label	tetPtI
	)

Construct from components.

Definition at line 46 of file tetIndices.C.

◆ ~tetIndices()

~tetIndices ( )

Destructor.

Definition at line 60 of file tetIndices.C.

Member Function Documentation

◆ cell() [1/2]

Foam::label cell ( ) const

inline

Return the cell.

Definition at line 28 of file tetIndicesI.H.

Referenced by Basic< Type >::add(), Moment< Type >::add(), Dual< Type >::add(), tetIndices::faceTriIs(), polyMeshTetDecomposition::findTet(), interpolationCell< Type >::interpolate(), interpolationCellPatchConstrained< Type >::interpolate(), interpolationCellPoint< Foam::Vector >::interpolate(), Basic< Type >::interpolate(), interpolation< Foam::Vector >::interpolate(), Moment< Type >::interpolate(), Dual< Type >::interpolate(), Basic< Type >::interpolateGrad(), Moment< Type >::interpolateGrad(), Dual< Type >::interpolateGrad(), Foam::operator<<(), tetIndices::operator==(), Foam::operator>>(), and tetIndices::tet().

Here is the caller graph for this function:

◆ cell() [2/2]

Foam::label & cell ( )

inline

Return non-const access to the cell.

Definition at line 34 of file tetIndicesI.H.

◆ face() [1/2]

Foam::label face ( ) const

inline

Return the face.

Definition at line 40 of file tetIndicesI.H.

Referenced by tetIndices::faceTriIs(), polyMesh::findTetFacePt(), interpolationCellPoint< Foam::Vector >::interpolate(), Foam::operator<<(), tetIndices::operator==(), and Foam::operator>>().

Here is the caller graph for this function:

◆ face() [2/2]

Foam::label & face ( )

inline

Return non-const access to the face.

Definition at line 46 of file tetIndicesI.H.

◆ tetPt() [1/2]

Foam::label tetPt ( ) const

inline

Return the characterising tetPtI.

Definition at line 52 of file tetIndicesI.H.

Referenced by tetIndices::faceTriIs(), polyMesh::findTetFacePt(), Foam::operator<<(), tetIndices::operator==(), and Foam::operator>>().

Here is the caller graph for this function:

◆ tetPt() [2/2]

Foam::label & tetPt ( )

inline

Return non-const access to the characterising tetPtI.

Definition at line 58 of file tetIndicesI.H.

◆ faceTriIs()

Foam::triFace faceTriIs ( const polyMesh & mesh ) const

inline

Return the indices corresponding to the tri on the face for.

this tet. The normal of the tri points out of the cell.

Definition at line 64 of file tetIndicesI.H.

References tetIndices::cell(), Foam::endl(), f(), tetIndices::face(), polyMesh::faceOwner(), polyMesh::faces(), UList< T >::fcIndex(), List< T >::size(), Foam::Swap(), polyMesh::tetBasePtIs(), tetIndices::tetPt(), triFace(), Foam::Warning, and WarningInFunction.

Referenced by Moment< Type >::add(), Dual< Type >::add(), Dual< Type >::Dual(), tetIndices::faceTri(), cellPointWeight::findTetrahedron(), cellPointWeight::findTriangle(), interpolationCellPoint< Foam::Vector >::interpolate(), Moment< Type >::interpolate(), Dual< Type >::interpolate(), Dual< Type >::interpolateGrad(), Moment< Type >::Moment(), tetIndices::oldFaceTri(), tetIndices::tet(), and AveragingMethod< Foam::Vector >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tet()

Foam::tetPointRef tet ( const polyMesh & mesh ) const

inline

Return the geometry corresponding to this tet.

Definition at line 100 of file tetIndicesI.H.

References tetIndices::cell(), primitiveMesh::cellCentres(), tetIndices::faceTriIs(), and polyMesh::points().

Referenced by Dual< Type >::Dual(), polyMeshTetDecomposition::findTet(), cellPointWeight::findTetrahedron(), interpolation< Foam::Vector >::interpolate(), Moment< Type >::Moment(), and AveragingMethod< Foam::Vector >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faceTri()

Foam::triPointRef faceTri ( const polyMesh & mesh ) const

inline

Return the geometry corresponding to the tri on the face for.

this tet. The normal of the tri points out of the cell.

Definition at line 115 of file tetIndicesI.H.

References tetIndices::faceTriIs(), tetIndices::oldFaceTri(), and polyMesh::points().

Referenced by cellPointWeight::findTriangle(), FreeStream< CloudType >::inflow(), particle< Type >::normal(), and polyMesh::pointInCell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ oldFaceTri()

Foam::triPointRef oldFaceTri ( const polyMesh & mesh ) const

inline

Return the geometry corresponding to the tri on the face for.

this tet using the old positions.

Definition at line 130 of file tetIndicesI.H.

References tetIndices::faceTriIs(), and polyMesh::oldPoints().

Referenced by tetIndices::faceTri().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const tetIndices & rhs ) const

inline

Definition at line 148 of file tetIndicesI.H.

References tetIndices::cell(), tetIndices::face(), and tetIndices::tetPt().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const tetIndices & rhs ) const

inline

Definition at line 157 of file tetIndicesI.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	,
		tetIndices &
	)

friend

◆ operator<<

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

friend

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

src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H
src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.C
src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndicesI.H