OpenFOAM logo
Open Source CFD Toolkit

octreeDataFace Class Reference

Collaboration diagram for octreeDataFace:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ClassName ("octreeDataFace")
 octreeDataFace (const primitiveMesh &, const labelList &meshFaces, const treeBoundBoxList &)
 Construct from selected mesh faces.
 octreeDataFace (const primitiveMesh &, const labelList &meshFaces)
 Construct from selected mesh faces. Tight fitting bounding boxes.
 octreeDataFace (const primitiveMesh &, const List< const labelList * > &, const List< const treeBoundBoxList * > &)
 Construct from selected mesh faces.
 octreeDataFace (const primitiveMesh &, const List< const labelList * > &)
 Construct from selected mesh faces. Tight fitting bounding boxes.
 octreeDataFace (const polyPatch &patch)
 Construct from alll faces in patch. Tight fitting bounding boxes.
 octreeDataFace (const primitiveMesh &)
 Construct from all boundary faces. Tight fitting bounding boxes.
 octreeDataFace (const octreeDataFace &)
 Construct as copy.
 ~octreeDataFace ()
const primitiveMeshmesh () const
const labelListmeshFaces () const
const treeBoundBoxListallBb () const
label size () const
label getSampleType (const octree< octreeDataFace > &, 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.
scalar calcNearest (const label index, const linePointRef &ln, point &linePt, point &shapePt) const
 Calculates nearest (to line segment) point in shape.
void write (Ostream &os, const label index) const
 Write shape at index.

Constructor & Destructor Documentation

octreeDataFace const primitiveMesh ,
const labelList meshFaces,
const treeBoundBoxList
 

Construct from selected mesh faces.

octreeDataFace const primitiveMesh ,
const labelList meshFaces
 

Construct from selected mesh faces. Tight fitting bounding boxes.

generated internally.

octreeDataFace const primitiveMesh ,
const List< const labelList * > &  ,
const List< const treeBoundBoxList * > & 
 

Construct from selected mesh faces.

octreeDataFace const primitiveMesh ,
const List< const labelList * > & 
 

Construct from selected mesh faces. Tight fitting bounding boxes.

generated internally.

octreeDataFace const polyPatch patch  ) 
 

Construct from alll faces in patch. Tight fitting bounding boxes.

generated internally.

octreeDataFace const primitiveMesh  ) 
 

Construct from all boundary faces. Tight fitting bounding boxes.

generated internally.

octreeDataFace const octreeDataFace  ) 
 

Construct as copy.

~octreeDataFace  ) 
 


Member Function Documentation

const treeBoundBoxList& allBb  )  const [inline]
 

Definition at line 166 of file octreeDataFace.H.

References Foam::point.

scalar calcNearest const label  index,
const linePointRef ln,
point linePt,
point shapePt
const
 

Calculates nearest (to line segment) point in shape.

Returns distance and both point.

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 "octreeDataFace"   ) 
 

bool contains const label  index,
const point sample
const
 

Does shape at index contain sample.

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< octreeDataFace > &  ,
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 primitiveMesh& mesh  )  const [inline]
 

Definition at line 156 of file octreeDataFace.H.

References Foam::label, and UList::size().

Here is the call graph for this function:

const labelList& meshFaces  )  const [inline]
 

Definition at line 161 of file octreeDataFace.H.

References Foam::label.

bool overlaps const label  index,
const treeBoundBox sampleBb
const
 

Does (bb of) shape at index overlap bb.

label size  )  const [inline]
 

Definition at line 171 of file octreeDataFace.H.

References Foam::label, Foam::linePointRef, 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