ENH: Renamed curveSet to polyLineSet to better represent sampling method

src/sampling/sampledSet/polyLine/polyLineSet.H

@@ -0,0 +1,141 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::polyLineSet
+
+Description
+    Sample along poly line defined by a list of points (knots)
+
+SourceFiles
+    polyLineSet.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef polyLineSet_H
+#define polyLineSet_H
+
+#include "sampledSet.H"
+#include "DynamicList.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of classes
+class passiveParticle;
+template<class Type> class Particle;
+
+/*---------------------------------------------------------------------------*\
+                        Class polyLineSet Declaration
+\*---------------------------------------------------------------------------*/
+
+class polyLineSet
+:
+    public sampledSet
+{
+    // Private data
+
+        //- sampling points
+        List<point> sampleCoords_;
+
+
+    // Private Member Functions
+
+        //- Sample till hits boundary. Called with singleParticle at position
+        //  inbetween sampleCoords_[sampleI] and sampleCoords_[sampleI+1].
+        //  Returns false if end of samples reached.
+        bool trackToBoundary
+        (
+            Particle<passiveParticle>& singleParticle,
+            label& sampleI,
+            DynamicList<point>& samplingPts,
+            DynamicList<label>& samplingCells,
+            DynamicList<label>& samplingFaces,
+            DynamicList<scalar>& samplingPolyLineDist
+        ) const;
+
+        //- Samples all point in sampleCoords_
+        //  samplingSegments contains segmentNo for each sample.
+        void calcSamples
+        (
+            DynamicList<point>& samplingPts,
+            DynamicList<label>& samplingCells,
+            DynamicList<label>& samplingFaces,
+            DynamicList<label>& samplingSegments,
+            DynamicList<scalar>& samplingPolyLineDist
+        ) const;
+
+        //- Uses calcSamples to obtain samples. Copies them into *this.
+        void genSamples();
+
+
+public:
+
+    //- Runtime type information
+    TypeName("polyLine");
+
+
+    // Constructors
+
+        //- Construct from components
+        polyLineSet
+        (
+            const word& name,
+            const polyMesh& mesh,
+            meshSearch& searchEngine,
+            const word& axis,
+            const List<point>& samplePoints
+        );
+
+        //- Construct from dictionary
+        polyLineSet
+        (
+            const word& name,
+            const polyMesh& mesh,
+            meshSearch& searchEngine,
+            const dictionary& dict
+        );
+
+
+    // Destructor
+    virtual ~polyLineSet();
+
+
+    // Member Functions
+
+        //- Get reference point
+        virtual point getRefPoint(const List<point>&) const;
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //