OpenFOAM logo
Open Source CFD Toolkit

octreeDataFaceList Class Reference

Collaboration diagram for octreeDataFaceList:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ClassName ("octreeDataFaceList")
 octreeDataFaceList (const bMesh &mesh)
 Construct from all faces in bMesh.
 octreeDataFaceList (const bMesh &mesh, const labelList &faceLabels)
 Construct from selected faces in bMesh.
 octreeDataFaceList (const octreeDataFaceList &)
 Construct as copy.
 ~octreeDataFaceList ()
const bMeshmesh () const
const labelListfaceLabels () const
const treeBoundBoxListallBb () const
label size () const
label getSampleType (const octree< octreeDataFaceList > &, const point &) const
 Get type of sample.
bool overlaps (const label index, const treeBoundBox &sampleBb) const
 Does (bb of) shape at index overlap bb.
bool contains (const label index, const point &sample) const
 Does shape at index contain sample.
bool intersects (const label index, const point &start, const point &end, point &intersectionPoint) const
 Segment (from start to end) intersection with shape.
bool findTightest (const label index, const point &sample, treeBoundBox &tightest) const
 Sets newTightest to bounding box (and returns true) if.
scalar calcSign (const label index, const point &sample, vector &n) const
 Given index get unit normal and calculate (numerical) sign.
scalar calcNearest (const label index, const point &sample, point &nearest) const
 Calculates nearest (to sample) point in shape.
void write (Ostream &os, const label index) const
 Write shape at index.

Constructor & Destructor Documentation

octreeDataFaceList const bMesh mesh  ) 
 

Construct from all faces in bMesh.

octreeDataFaceList const bMesh mesh,
const labelList faceLabels
 

Construct from selected faces in bMesh.

octreeDataFaceList const octreeDataFaceList  ) 
 

Construct as copy.

~octreeDataFaceList  ) 
 


Member Function Documentation

const treeBoundBoxList& allBb  )  const [inline]
 

Definition at line 135 of file octreeDataFaceList.H.

scalar calcNearest const label  index,
const point sample,
point nearest
const
 

Calculates nearest (to sample) point in shape.

Returns point and mag(nearest - sample). Returns GREAT if sample does not project onto (triangle decomposition) of face.

scalar calcSign const label  index,
const point sample,
vector n
const
 

Given index get unit normal and calculate (numerical) sign.

of sample. Used to determine accuracy of calcNearest or inside/outside.

ClassName "octreeDataFaceList"   ) 
 

bool contains const label  index,
const point sample
const
 

Does shape at index contain sample.

const labelList& faceLabels  )  const [inline]
 

Definition at line 130 of file octreeDataFaceList.H.

bool findTightest const label  index,
const point sample,
treeBoundBox tightest
const
 

Sets newTightest to bounding box (and returns true) if.

nearer to sample than tightest bounding box. Otherwise returns false.

label getSampleType const octree< octreeDataFaceList > &  ,
const point
const
 

Get type of sample.

bool intersects const label  index,
const point start,
const point end,
point intersectionPoint
const
 

Segment (from start to end) intersection with shape.

at index. If intersects returns true and sets intersectionPoint

const bMesh& mesh  )  const [inline]
 

Definition at line 125 of file octreeDataFaceList.H.

bool overlaps const label  index,
const treeBoundBox sampleBb
const
 

Does (bb of) shape at index overlap bb.

label size  )  const [inline]
 

Definition at line 140 of file octreeDataFaceList.H.

References Foam::label, Foam::point, and Foam::vector.

void write Ostream os,
const label  index
const
 

Write shape at index.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org