cuttingPlane Class Reference

Constructs plane through mesh. More...

#include <sampling/cuttingPlane.H>

---

Detailed Description

Constructs plane through mesh.

No attempt at resolving degenerate cases. Since the cut faces are usually quite ugly, they will always be triangulated.

Note:

When the cutting plane coincides with a mesh face, the cell edge on the positive side of the plane is taken.

Source files

• src/sampling/cuttingPlane/cuttingPlane.H
• src/sampling/cuttingPlane/cuttingPlane.C

Definition at line 61 of file cuttingPlane.H.

Inheritance diagram for cuttingPlane:

Collaboration diagram for cuttingPlane:

List of all members.

Public Member Functions
	cuttingPlane (const plane &, const primitiveMesh &, const UList< label > &cellIdLabels=UList< label >::null())
	Construct from plane and mesh reference,.
const plane &	planeDesc () const
	Return plane used.
const labelList &	cutCells () const
	Return List of cells cut by the plane.
bool	cut () const
	Return true or false to question: have any cells been cut?
template<class Type >
tmp< Field< Type > >	sample (const Field< Type > &) const
	Sample the cell field.
template<class Type >
tmp< Field< Type > >	sample (const tmp< Field< Type > > &) const
void	operator= (const cuttingPlane &)
Protected Member Functions
	cuttingPlane (const plane &)
	Construct plane description without cutting.
void	reCut (const primitiveMesh &, const UList< label > &cellIdLabels=UList< label >::null())
	recut mesh with existing planeDesc, restricted to a list of cells
virtual void	remapFaces (const UList< label > &faceMap)
	remap action on triangulation or cleanup

---

Constructor & Destructor Documentation

cuttingPlane

(

const plane &

pln  )

[protected]

Construct plane description without cutting.

Definition at line 337 of file cuttingPlane.C.

cuttingPlane	(	const plane &	pln,
		const primitiveMesh &	mesh,
		const UList< label > &	cellIdLabels = UList<label>::null()
	)

Construct from plane and mesh reference,.

possibly restricted to a list of cells

Definition at line 345 of file cuttingPlane.C.

---

Member Function Documentation

void reCut	(	const primitiveMesh &	mesh,
		const UList< label > &	cellIdLabels = UList<label>::null()
	)		[protected]

recut mesh with existing planeDesc, restricted to a list of cells

Definition at line 362 of file cuttingPlane.C.

References clear(), and primitiveMesh::points().

void remapFaces

(

const UList< label > &

faceMap  )

[protected, virtual]

remap action on triangulation or cleanup

Reimplemented from MeshedSurface< face >.

Definition at line 387 of file cuttingPlane.C.

References forAll, and UList< T >::size().

const plane& planeDesc

(

)

const [inline]

Return plane used.

Definition at line 147 of file cuttingPlane.H.

const labelList& cutCells

(

)

const [inline]

Return List of cells cut by the plane.

Definition at line 153 of file cuttingPlane.H.

Referenced by sampledPlane::meshCells(), and cuttingPlane::operator=().

bool cut

(

)

const [inline]

Return true or false to question: have any cells been cut?

Definition at line 159 of file cuttingPlane.H.

References List< T >::size().

Foam::tmp< Foam::Field< Type > > sample

(

const Field< Type > &

fld  )

const

Sample the cell field.

Definition at line 37 of file cuttingPlaneTemplates.C.

Foam::tmp< Foam::Field< Type > > sample

(

const tmp< Field< Type > > &

tfld  )

const

Definition at line 47 of file cuttingPlaneTemplates.C.

void operator=

(

const cuttingPlane &

rhs  )

Definition at line 407 of file cuttingPlane.C.

References Foam::abort(), cuttingPlane::cutCells(), Foam::FatalError, and FatalErrorIn.

---

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

• src/sampling/cuttingPlane/cuttingPlane.H
• src/sampling/cuttingPlane/cuttingPlane.C
• src/sampling/cuttingPlane/cuttingPlaneTemplates.C