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
    solidParticleCloudI.H
    solidParticleCloud.C
    solidParticleCloudIO.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef solidParticleCloud_H
#define 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_;
 
 
    // Private Member Functions
 
        //- No copy construct
        solidParticleCloud(const solidParticleCloud&) = delete;
 
        //- No copy assignment
        void operator=(const solidParticleCloud&) = delete;
 
 
public:
 
    // Constructors
 
        //- Construct given mesh
        explicit solidParticleCloud
        (
            const fvMesh& mesh,
            const word& cloudName = cloud::defaultName,
            bool readFields = true
        );
 
 
    // Member Functions
 
        // Access
 
            inline const fvMesh& mesh() const;
 
            inline scalar rhop() const;
            inline scalar e() const;
            inline scalar mu() const;
 
 
        // Edit
 
            //- Move the particles under the influence of the given
            //  gravitational acceleration
            void move(const dimensionedVector& g);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "solidParticleCloudI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //