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 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 dictionary &dict),(name, mesh, dict))
 
 sampledSet (const word &name, const polyMesh &mesh, const word &axis)
 Construct from components. More...
 
 sampledSet (const word &name, const polyMesh &mesh, 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 coordSetcoords () const
 Access the coordinate set. More...
 
label size () const
 Return the size. More...
 
const labelListsegments () const
 Return the size. More...
 
const pointFieldpositions () const
 Access the positions. More...
 
const labelListcells () const
 Access the cells. More...
 
const labelListfaces () const
 Access the faces. More...
 
virtual void movePoints ()
 Update for mesh point-motion. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
 operator const coordSet & () const
 Cast to the coordinate set. More...
 

Static Public Member Functions

static void calcSamples (const polyMesh &mesh, 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 dictionary &dict)
 Return a reference to the selected sampledSet. 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 dictionary dict 
)

Construct from dictionary.

Definition at line 219 of file points.C.

◆ ~points()

~points ( )
virtual

Destructor.

Definition at line 234 of file points.C.

Member Function Documentation

◆ TypeName()

TypeName ( "points"  )

Runtime type information.

◆ calcSamples()

void calcSamples ( const polyMesh mesh,
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: