solidParticleCloud.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
    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::solidParticleCloud
 
Description
    A Cloud of solid particles
 
SourceFiles
    solidParticleCloud.C
    solidParticleCloudIO.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_solidParticleCloud_H
#define Foam_solidParticleCloud_H
 
#include "Cloud.H"
#include "solidParticle.H"
#include "IOdictionary.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class fvMesh;
 
/*---------------------------------------------------------------------------*\
                           Class solidParticleCloud Declaration
\*---------------------------------------------------------------------------*/
 
class solidParticleCloud
:
    public Cloud<solidParticle>
{
    // Private Data
 
        const fvMesh& mesh_;
 
        IOdictionary particleProperties_;
 
        scalar rhop_;
        scalar e_;
        scalar mu_;
 
 
public:
 
    //- Type of parcel within the cloud
    typedef solidParticle parcelType;
 
    //- No copy construct
    solidParticleCloud(const solidParticleCloud&) = delete;
 
    //- No copy assignment
    void operator=(const solidParticleCloud&) = delete;
 
 
    // Constructors
 
        //- Read construct
        explicit solidParticleCloud
        (
            const fvMesh& mesh,
            const word& cloudName = cloud::defaultName,
            bool readFields = true
        );
 
 
    // Member Functions
 
    // Access
 
        const fvMesh& mesh() const { return mesh_; }
 
        scalar rhop() const noexcept { return rhop_; }
        scalar e() const noexcept { return e_; }
        scalar mu() const noexcept { return mu_; }
 
 
    // Edit
 
        //- Move the particles under the influence of the given
        //-  gravitational acceleration
        void move(const dimensionedVector& g);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //