NoDamping.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) 2013-2016 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::DampingModels::NoDamping
 
Group
    grpLagrangianIntermediateMPPICDampingSubModels
 
Description
    Place holder for the 'none' option
 
SourceFiles
    NoDamping.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef NoDamping_H
#define NoDamping_H
 
#include "DampingModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace DampingModels
{
 
/*---------------------------------------------------------------------------*\
                         Class NoDamping Declaration
\*---------------------------------------------------------------------------*/
 
template<class CloudType>
class NoDamping
:
    public DampingModel<CloudType>
{
public:
 
    //- Runtime type information
    TypeName("none");
 
    // Constructors
 
        //- Construct from components
        NoDamping(const dictionary& dict, CloudType& owner);
 
        //- Construct copy
        NoDamping(const NoDamping<CloudType>& cm);
 
        //- Construct and return a clone
        virtual autoPtr<DampingModel<CloudType>> clone() const
        {
            return autoPtr<DampingModel<CloudType>>
            (
                new NoDamping<CloudType>(*this)
            );
        }
 
 
    //- Destructor
    virtual ~NoDamping();
 
 
    //- Member Functions
 
        //- Calculate the velocity correction
        virtual vector velocityCorrection
        (
            typename CloudType::parcelType& p,
            const scalar deltaT
        ) const;
 
        //- Return the model 'active' status
        virtual bool active() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace DampingModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "NoDamping.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //