streamLineParticle.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2017 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::streamLineParticle
 
Description
    Particle class that samples fields as it passes through. Used in streamline
    calculation.
 
SourceFiles
    streamLineParticle.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef streamLineParticle_H
#define streamLineParticle_H
 
#include "particle.H"
#include "autoPtr.H"
#include "interpolation.H"
#include "vectorList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of friend functions and operators
 
class streamLineParticle;
class streamLineParticleCloud;
 
Ostream& operator<<(Ostream&, const streamLineParticle&);
 
/*---------------------------------------------------------------------------*\
                     Class streamLineParticle Declaration
\*---------------------------------------------------------------------------*/
 
class streamLineParticle
:
    public particle
{
public:
 
    class trackingData
    :
        public particle::trackingData
    {
    public:
 
        // Public data
 
            const PtrList<interpolation<scalar>>& vsInterp_;
 
            const PtrList<interpolation<vector>>& vvInterp_;
 
            const label UIndex_;
 
            const label nSubCycle_;
 
            const scalar trackLength_;
 
            DynamicList<vectorList>& allPositions_;
 
            List<DynamicList<scalarList>>& allScalars_;
 
            List<DynamicList<vectorList>>& allVectors_;
 
 
        // Constructors
 
            //- Construct from components
            trackingData
            (
                streamLineParticleCloud& cloud,
                const PtrList<interpolation<scalar>>& vsInterp,
                const PtrList<interpolation<vector>>& vvInterp,
                const label UIndex,
                const label nSubCycle,
                const scalar trackLength,
                DynamicList<List<point>>& allPositions,
                List<DynamicList<scalarList>>& allScalars,
                List<DynamicList<vectorList>>& allVectors
            )
            :
                particle::trackingData(cloud),
                vsInterp_(vsInterp),
                vvInterp_(vvInterp),
                UIndex_(UIndex),
                nSubCycle_(nSubCycle),
                trackLength_(trackLength),
                allPositions_(allPositions),
                allScalars_(allScalars),
                allVectors_(allVectors)
            {}
    };
 
 
private:
 
    // Private data
 
        //- Whether particle transports with +U or -U
        bool trackForward_;
 
        //- Lifetime of particle. Particle dies when reaches 0.
        label lifeTime_;
 
        //- Sampled positions
        DynamicList<point> sampledPositions_;
 
        //- Sampled scalars
        List<DynamicList<scalar>> sampledScalars_;
 
        //- Sampled vectors
        List<DynamicList<vector>> sampledVectors_;
 
 
    // Private Member Functions
 
        //- Interpolate all quantities; return interpolated velocity.
        vector interpolateFields
        (
            const trackingData&,
            const point&,
            const label celli,
            const label facei
        );
 
 
public:
 
    // Constructors
 
        //- Construct from components
        streamLineParticle
        (
            const polyMesh& c,
            const vector& position,
            const label celli,
            const bool trackForward,
            const label lifeTime
        );
 
        //- Construct from Istream
        streamLineParticle
        (
            const polyMesh& c,
            Istream& is,
            bool readFields = true,
            bool newFormat = true
        );
 
        //- Construct copy
        streamLineParticle(const streamLineParticle& p);
 
        //- Construct and return a clone
        autoPtr<particle> clone() const
        {
            return autoPtr<particle>(new streamLineParticle(*this));
        }
 
        //- Factory class to read-construct particles used for parallel transfer
        class iNew
        {
            const polyMesh& mesh_;
 
        public:
 
            iNew(const polyMesh& mesh)
            :
                mesh_(mesh)
            {}
 
            autoPtr<streamLineParticle> operator()(Istream& is) const
            {
                return autoPtr<streamLineParticle>
                (
                    new streamLineParticle(mesh_, is, true)
                );
            }
        };
 
 
    // Member Functions
 
        // Tracking
 
            //- Track all particles to their end point
            bool move(streamLineParticleCloud&, trackingData&, const scalar);
 
            //- Overridable function to handle the particle hitting a patch
            //  Executed before other patch-hitting functions
            bool hitPatch(streamLineParticleCloud&, trackingData&);
 
            //- Overridable function to handle the particle hitting a wedge
            void hitWedgePatch(streamLineParticleCloud&, trackingData&);
 
            //- Overridable function to handle the particle hitting a
            //  symmetry plane
            void hitSymmetryPlanePatch(streamLineParticleCloud&, trackingData&);
 
            //- Overridable function to handle the particle hitting a
            //  symmetry patch
            void hitSymmetryPatch(streamLineParticleCloud&, trackingData&);
 
            //- Overridable function to handle the particle hitting a cyclic
            void hitCyclicPatch(streamLineParticleCloud&, trackingData&);
 
            //- Overridable function to handle the particle hitting a
            //  cyclicAMIPatch
            void hitCyclicAMIPatch
            (
                streamLineParticleCloud&,
                trackingData&,
                const vector& direction
            );
 
            //- Overridable function to handle the particle hitting a
            //  cyclicACMIPatch
            void hitCyclicACMIPatch
            (
                streamLineParticleCloud&,
                trackingData&,
                const vector& direction
            );
 
            //- Overridable function to handle the particle hitting a
            //- processorPatch
            void hitProcessorPatch(streamLineParticleCloud&, trackingData&);
 
            //- Overridable function to handle the particle hitting a wallPatch
            void hitWallPatch(streamLineParticleCloud&, trackingData&);
 
 
        // I-O
 
            //- Read
            static void readFields(Cloud<streamLineParticle>&);
 
            //- Write
            static void writeFields(const Cloud<streamLineParticle>&);
 
 
    // Ostream Operator
 
        friend Ostream& operator<<(Ostream&, const streamLineParticle&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //