points Class Reference

Specified point samples. Optionally ordered into a continuous path. Ordering is an optimisation; it enables tracking from one point to the next. If ordering is off, each point is searched for individually. More...

Inheritance diagram for points:
Collaboration diagram for points:

Public Member Functions

 TypeName ("points")
 Runtime type information. More...
 
 points (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~points ()
 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 wordname () const
 Access the name. More...
 
const polyMeshmesh () const
 Access the mesh. More...
 
const meshSearchsearchEngine () const
 Access the search engine. More...
 
const pointFieldpositions () const
 Access the positions. More...
 
const labelListcells () const
 Access the cells. More...
 
const labelListfaces () const
 Access the faces. More...
 
- Public Member Functions inherited from coordSet
 coordSet ()
 Construct null. More...
 
 coordSet (const labelList &segments, const word &positionName=word::null, const pointField &positions=pointField::null(), const word &distanceName=word::null, const scalarField &distances=scalarField::null(), const word &axis=axisTypeNames_[axisType::DEFAULT])
 Construct from components. More...
 
 coordSet (const bool contiguous, const word &positionName, const pointField &positions, const word &axis=axisTypeNames_[axisType::DEFAULT])
 Construct from positions. More...
 
 coordSet (const bool contiguous, const word &distanceName, const scalarField &distances, const word &axis=axisTypeNames_[axisType::DEFAULT])
 Construct from distances. More...
 
label size () const
 Return the size. More...
 
const labelListsegments () const
 Return the segments. More...
 
word axis () const
 Return the axis name. More...
 
bool hasScalarAxis () const
 Is the coordinate axis a scalar? More...
 
bool hasPointAxis () const
 Is the coordinate axis a point? More...
 
scalar scalarCoord (const label index) const
 Get scalar coordinate (axis is x, y, z or distance) More...
 
tmp< scalarFieldscalarCoords () const
 Get scalar coordinates (axis is x, y, z or distance) More...
 
word scalarName () const
 Return the name of the scalar coordinates. More...
 
point pointCoord (const label index) const
 Get vector coordinate (axis is xyz) More...
 
tmp< pointFieldpointCoords () const
 Get vector coordinate (axis is xyz) More...
 
word pointName () const
 Return the name of the point coordinates. More...
 
labelList vertices () const
 Return a list of isolated vertices. These are the points that are. More...
 
labelPairList edges () const
 Return a list of edges. These are adjacent pairs of points which. More...
 
labelListList lines () const
 Return a list of lines. These are lists of points which are in the. More...
 
Tuple2< coordSet, labelListgather () const
 Combine coordinate sets onto the master. Return both the combined. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > gather (const Field< Type > &values, const labelList &order)
 

Static Public Member Functions

static void calcSamples (const polyMesh &mesh, const meshSearch &searchEngine, const pointField &points, DynamicList< point > &samplingPositons, DynamicList< scalar > &samplingDistances, DynamicList< label > &samplingSegments, DynamicList< label > &samplingCells, DynamicList< label > &samplingFaces)
 Calculate all the sampling points. 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 Member Functions inherited from coordSet
template<class Type >
static tmp< Field< Type > > gather (const Field< Type > &values, const labelList &order)
 Combine a field using the ordering obtained from the coordinate set. More...
 

Additional Inherited Members

- Public Types inherited from coordSet
enum class  axisType {
  XYZ , X , Y , Z ,
  DISTANCE , DEFAULT
}
 Enumeration defining the output format for coordinates. More...
 
- Static Public Attributes inherited from coordSet
static const NamedEnum< axisType, 6 > axisTypeNames_
 String representation of axis enums. More...
 
- Protected Member Functions inherited from sampledSet
void setSamples (const List< point > &samplingPositions, const labelList &samplingSegments, const labelList &samplingCells, const labelList &samplingFaces)
 Sets sample data. More...
 
void setSamples (const List< point > &samplingPositions, const List< scalar > &samplingDistances, const labelList &samplingSegments, const labelList &samplingCells, const labelList &samplingFaces)
 Sets sample data. More...
 
- Protected Attributes inherited from sampledSet
labelList cells_
 Cell numbers. More...
 
labelList faces_
 Face numbers (-1 if not known) More...
 
- Protected Attributes inherited from coordSet
labelList segments_
 Connected segments. More...
 
word positionName_
 Name of the positions. More...
 
autoPtr< pointFieldpositions_
 Point positions. More...
 
word distanceName_
 Name of the distances. More...
 
autoPtr< scalarFielddistances_
 Scalar distances. More...
 
axisType axis_
 Axis. More...
 

Detailed Description

Specified point samples. Optionally ordered into a continuous path. Ordering is an optimisation; it enables tracking from one point to the next. If ordering is off, each point is searched for individually.

Usage
Property Description Req'd? Default
points The points to sample yes
ordered Are the points in order? yes
axis The coordinate axis that is written yes

Example specification:

    {
        type        points;
        points
        (
            (0.95 0 0.25)
            (0.951251 0 0.250119)
            (0.952468 0 0.250473)
            (0.953618 0 0.251057)
            (0.954669 0 0.251859)
            (0.95559 0 0.252865)
            (0.956353 0 0.254057)
            (0.956931 0 0.255413)
            (0.9573 0 0.256908)
            (0.957441 0 0.258513)
        );
        ordered     yes;
        axis        x;
    }
Source files

Definition at line 103 of file points.H.

Constructor & Destructor Documentation

◆ points()

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

Construct from dictionary.

Definition at line 282 of file points.C.

◆ ~points()

~points ( )
virtual

Destructor.

Definition at line 300 of file points.C.

Member Function Documentation

◆ TypeName()

TypeName ( "points"  )

Runtime type information.

◆ calcSamples()

void calcSamples ( const polyMesh mesh,
const meshSearch searchEngine,
const pointField points,
DynamicList< point > &  samplingPositons,
DynamicList< scalar > &  samplingDistances,
DynamicList< label > &  samplingSegments,
DynamicList< label > &  samplingCells,
DynamicList< label > &  samplingFaces 
)
static

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