ParticleErosion.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011-2013 OpenFOAM Foundation
     \\/     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::ParticleErosion
 
Description
    Creates particle erosion field, Q
 
SourceFiles
    ParticleErosion.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef ParticleErosion_H
#define ParticleErosion_H
 
#include "CloudFunctionObject.H"
#include "volFields.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class ParticleErosion Declaration
\*---------------------------------------------------------------------------*/
 
template<class CloudType>
class ParticleErosion
:
    public CloudFunctionObject<CloudType>
{
    // Private Data
 
        // Typedefs
 
            //- Convenience typedef for parcel type
            typedef typename CloudType::parcelType parcelType;
 
 
        //- Particle erosion field
        autoPtr<volScalarField> QPtr_;
 
        //- List of patch indices to post-process
        labelList patchIDs_;
 
        //- Plastic flow stress - typical metal value = 2.7 GPa
        scalar p_;
 
        //- Ratio between depth of contact and length of cut - default=2
        scalar psi_;
 
        //- Ratio of normal and tangential forces - default=2
        scalar K_;
 
 
protected:
 
    // Protected Member Functions
 
        //- Returns local patchI if patch is in patchIds_ list
        label applyToPatch(const label globalPatchI) const;
 
        //- Write post-processing info
        virtual void write();
 
 
public:
 
    //- Runtime type information
    TypeName("particleErosion");
 
 
    // Constructors
 
        //- Construct from dictionary
        ParticleErosion
        (
            const dictionary& dict,
            CloudType& owner,
            const word& modelName
        );
 
        //- Construct copy
        ParticleErosion(const ParticleErosion<CloudType>& pe);
 
        //- Construct and return a clone
        virtual autoPtr<CloudFunctionObject<CloudType> > clone() const
        {
            return autoPtr<CloudFunctionObject<CloudType> >
            (
                new ParticleErosion<CloudType>(*this)
            );
        }
 
 
    //- Destructor
    virtual ~ParticleErosion();
 
 
    // Member Functions
 
        // Evaluation
 
            //- Pre-evolve hook
            virtual void preEvolve();
 
            //- Post-patch hook
            virtual void postPatch
            (
                const parcelType& p,
                const polyPatch& pp,
                const scalar trackFraction,
                const tetIndices& tetIs,
                bool& keepParticle
            );
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "ParticleErosion.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //