kinematicCloud.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-2016 OpenFOAM Foundation
    Copyright (C) 2019 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::kinematicCloud
 
Description
    Virtual abstract base class for templated KinematicCloud
 
SourceFiles
    kinematicCloud.H
 
\*---------------------------------------------------------------------------*/
 
#ifndef kinematicCloud_H
#define kinematicCloud_H
 
#include "typeInfo.H"
#include "volFieldsFwd.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class kinematicCloud Declaration
\*---------------------------------------------------------------------------*/
 
class kinematicCloud
{
public:
 
    //- Runtime type information
    TypeName("kinematicCloud");
 
 
    // Constructors
 
        //- Null constructor
        kinematicCloud() = default;
 
 
    //- Destructor
    virtual ~kinematicCloud() = default;
 
 
    // Member Functions
 
        // Check
 
            //- Number of parcels
            virtual label nParcels() const = 0;
 
            //- Total mass in system
            virtual scalar massInSystem() const = 0;
 
            //- Total linear momentum of the system
            virtual vector linearMomentumOfSystem() const = 0;
 
            //- Total linear kinetic energy in the system
            virtual scalar linearKineticEnergyOfSystem() const = 0;
 
            //- Mean diameter Dij
            virtual scalar Dij(const label i, const label j) const = 0;
 
            //- Max diameter
            virtual scalar Dmax() const = 0;
 
 
        // Fields
 
            //- Volume swept rate of parcels per cell
            virtual const tmp<volScalarField> vDotSweep() const = 0;
 
            //- Return the particle volume fraction field
            //  Note: for particles belonging to this cloud only
            virtual const tmp<volScalarField> theta() const = 0;
 
            //- Return the particle mass fraction field
            //  Note: for particles belonging to this cloud only
            virtual const tmp<volScalarField> alpha() const = 0;
 
            //- Return the particle effective density field
            //  Note: for particles belonging to this cloud only
            virtual const tmp<volScalarField> rhoEff() const = 0;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //