Creation of OpenFOAM-dev repository 15/04/2008

applications/utilities/postProcessing/sampling/sample/sampleSets/sampleSet/sampleSet.H

@@ -0,0 +1,296 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2007 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 2 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, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Class
+    Foam::sampleSet
+
+Description
+    Holds list of sampling points which is filled at construction time.
+    Various implementations of this base class to e.g. get sampling points
+    at uniform distance along a line (uniformSet) or directly specified
+    (cloudSet)
+
+    Each 'sampleSet' has a name and a specifier of how the axis should be
+    write (x/y/z component or all 3 components)
+
+SourceFiles
+    sampleSet.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef sampleSet_H
+#define sampleSet_H
+
+#include "pointField.H"
+#include "word.H"
+#include "labelList.H"
+#include "typeInfo.H"
+#include "runTimeSelectionTables.H"
+#include "autoPtr.H"
+#include "coordSet.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+// Forward declaration of classes
+class polyMesh;
+class meshSearch;
+
+/*---------------------------------------------------------------------------*\
+                           Class sampleSet Declaration
+\*---------------------------------------------------------------------------*/
+
+class sampleSet
+:
+    public coordSet
+{
+    // Private data
+
+        //- Reference to mesh
+        const polyMesh& mesh_;
+
+        //- Reference to mesh searching class
+        meshSearch& searchEngine_;
+
+protected:
+
+        //- Segment numbers
+        labelList segments_;
+
+        //- Parameter along sample curve. Uniquely identifies position
+        //  along sampling. Used for combining parallel results.
+        scalarList curveDist_;
+
+        //- Cell numbers
+        labelList cells_;
+
+        //- Face numbers (-1 if not known)
+        labelList faces_;
+
+    // Protected Member Functions
+
+        //- Returns cell next to boundary face
+        label getBoundaryCell(const label) const;
+
+        //- Returns cell using face and containing sample
+        label getCell
+        (
+            const label faceI,
+            const point& sample
+        ) const;
+
+        //- Calculates inproduct of face normal and vector sample-face centre
+        //  <0 if sample inside.
+        scalar calcSign(const label faceI, const point& sample) const;
+
+        //- Returns face label (or -1) of face which is close to sample
+        label findNearFace
+        (
+            const label cellI,
+            const point& sample,
+            const scalar smallDist
+        ) const;
+
+        //- Moves sample in direction of -n to it is 'inside' of faceI
+        point pushIn
+        (
+            const point& sample,
+            const label faceI
+        ) const;
+
+        //- Calculates start of tracking given samplePt and first boundary
+        //  intersection
+        //  (bPoint, bFaceI) (bFaceI == -1 if no boundary intersection)
+        //  Returns true if trackPt is valid sampling point. Sets trackPt,
+        //  trackFaceI, trackCellI (-1 if no tracking point found)
+        bool getTrackingPoint
+        (
+            const vector& offset,
+            const point& samplePt,
+            const point& bPoint,
+            const label bFaceI,
+
+            point& trackPt,
+            label& trackCellI,
+            label& trackFaceI
+        ) const;
+
+        //- Sets sample data
+        void setSamples
+        (
+            const List<point>& samplingPts,
+            const labelList& samplingCells,
+            const labelList& samplingFaces,
+            const labelList& samplingSegments,
+            const scalarList& samplingCurveDist
+        );
+
+public:
+
+    //- Runtime type information
+    TypeName("sampleSet");
+
+
+    // Declare run-time constructor selection table
+
+        declareRunTimeSelectionTable
+        (
+            autoPtr,
+            sampleSet,
+            word,
+            (
+                const polyMesh& mesh,
+                meshSearch& searchEngine,
+                const dictionary& dict
+            ),
+            (mesh, searchEngine, dict)
+        );
+
+
+        //- Class used for the read-construction of
+        //  PtrLists of sampleSet
+        class iNew
+        {
+            const polyMesh& mesh_;
+            meshSearch& searchEngine_;
+
+        public:
+
+            iNew(const polyMesh& mesh, meshSearch& searchEngine)
+            :
+                mesh_(mesh),
+                searchEngine_(searchEngine)
+            {}
+
+            autoPtr<sampleSet> operator()(Istream& is) const
+            {
+                word sampleType(is);
+                dictionary dict(is);                    
+                return sampleSet::New(sampleType, mesh_, searchEngine_, dict);
+            }
+        };
+
+
+    // Static data
+
+        //- Tolerance when comparing points. Usually relative to difference
+        //  between start_ and end_
+        const static scalar tol;
+
+
+    // Constructors
+
+        //- Construct from mesh, name
+        sampleSet
+        (
+            const polyMesh& mesh,
+            meshSearch& searchEngine,
+            const word& name,
+            const word& axis
+        );
+
+        //- Construct from dictionary
+        sampleSet
+        (
+            const polyMesh& mesh,
+            meshSearch& searchEngine,
+            const dictionary& dict
+        );
+
+        //- Clone
+        autoPtr<sampleSet> clone() const
+        {
+            notImplemented("autoPtr<sampleSet> clone() const");
+            return autoPtr<sampleSet>(NULL);
+        }
+
+
+    // Selectors
+
+        //- Return a reference to the selected sampleSet
+        static autoPtr<sampleSet> New
+        (
+            const word& sampleType,
+            const polyMesh& mesh,
+            meshSearch& searchEngine,
+            const dictionary& dict
+        );
+
+
+    // Destructor
+
+        virtual ~sampleSet();
+
+
+    // Member Functions
+
+        const polyMesh& mesh() const
+        {
+            return mesh_;
+        }
+
+        meshSearch& searchEngine() const
+        {
+            return searchEngine_;
+        }
+
+        const labelList& segments() const
+        {
+            return segments_;
+        }
+
+        const scalarList& curveDist() const
+        {
+            return curveDist_;
+        }
+
+        const labelList& cells() const
+        {
+            return cells_;
+        }
+
+        const labelList& faces() const
+        {
+            return faces_;
+        }
+
+        //- Given all sampling points (on all processors) return reference point
+        virtual point getRefPoint(const List<point>&) const = 0;
+
+        //- Output for debugging
+        Ostream& write(Ostream&) const;
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //