polyLineSet Class Reference

Sample along poly line defined by a list of points (knots) More...

Inheritance diagram for polyLineSet:
Collaboration diagram for polyLineSet:

Public Member Functions

 TypeName ("polyLine")
 Runtime type information. More...
 
 polyLineSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis, const List< point > &samplePoints)
 Construct from components. More...
 
 polyLineSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~polyLineSet ()
 Destructor. More...
 
- Public Member Functions inherited from sampledSet
 TypeName ("sampledSet")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, sampledSet, word,(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict),(name, mesh, searchEngine, dict))
 
 sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis)
 Construct from components. More...
 
 sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
 Construct from dictionary. More...
 
autoPtr< sampledSetclone () const
 Clone. More...
 
virtual ~sampledSet ()
 Destructor. More...
 
const polyMeshmesh () const
 
const meshSearchsearchEngine () const
 
const labelListsegments () const
 
const labelListcells () const
 
const labelListfaces () const
 
Ostreamwrite (Ostream &) const
 Output for debugging. More...
 
- Public Member Functions inherited from coordSet
 coordSet (const word &name, const word &axis)
 Construct from components. More...
 
 coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist)
 Construct from components. More...
 
const wordname () const
 
word axis () const
 
const scalarListcurveDist () const
 Cumulative distance. More...
 
bool hasVectorAxis () const
 Is axis specification a vector. More...
 
scalar scalarCoord (const label index) const
 Get coordinate of point according to axis specification. More...
 
vector vectorCoord (const label index) const
 Get point according to axis="xyz" specification. More...
 
Ostreamwrite (Ostream &os) const
 

Additional Inherited Members

- Public Types inherited from coordSet
enum  coordFormat {
  XYZ, X, Y, Z,
  DISTANCE
}
 Enumeration defining the output format for coordinates. More...
 
- Static Public Member Functions inherited from sampledSet
static autoPtr< sampledSetNew (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
 Return a reference to the selected sampledSet. More...
 
- Static Public Attributes inherited from sampledSet
static const scalar tol = 1e-6
 Tolerance when comparing points. Usually relative to difference. More...
 
- Protected Member Functions inherited from sampledSet
label getBoundaryCell (const label) const
 Returns cell next to boundary face. More...
 
label getCell (const label faceI, const point &sample) const
 Returns cell using face and containing sample. More...
 
scalar calcSign (const label faceI, const point &sample) const
 Calculates inproduct of face normal and vector sample-face centre. More...
 
label findNearFace (const label cellI, const point &sample, const scalar smallDist) const
 Returns face label (or -1) of face which is close to sample. More...
 
point pushIn (const point &sample, const label faceI) const
 Moves sample in direction of -n to it is 'inside' of faceI. More...
 
bool getTrackingPoint (const vector &offset, const point &samplePt, const point &bPoint, const label bFaceI, point &trackPt, label &trackCellI, label &trackFaceI) const
 Calculates start of tracking given samplePt and first boundary. More...
 
void setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist)
 Sets sample data. More...
 
- Protected Attributes inherited from sampledSet
labelList segments_
 Segment numbers. More...
 
labelList cells_
 Cell numbers. More...
 
labelList faces_
 Face numbers (-1 if not known) More...
 
- Protected Attributes inherited from coordSet
const word name_
 Name. More...
 
const coordFormat axis_
 Axis write type. More...
 
scalarList curveDist_
 Cumulative distance "distance" write specifier. More...
 

Detailed Description

Sample along poly line defined by a list of points (knots)

Source files

Definition at line 51 of file polyLineSet.H.

Constructor & Destructor Documentation

polyLineSet ( const word name,
const polyMesh mesh,
const meshSearch searchEngine,
const word axis,
const List< point > &  samplePoints 
)

Construct from components.

Definition at line 354 of file polyLineSet.C.

References Foam::Info, and write().

Here is the call graph for this function:

polyLineSet ( const word name,
const polyMesh mesh,
const meshSearch searchEngine,
const dictionary dict 
)

Construct from dictionary.

Definition at line 375 of file polyLineSet.C.

References Foam::Info, and write().

Here is the call graph for this function:

~polyLineSet ( )
virtual

Destructor.

Definition at line 396 of file polyLineSet.C.

Member Function Documentation

TypeName ( "polyLine"  )

Runtime type information.


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