FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

solidParticleCloud.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::solidParticleCloud
00026 
00027 Description
00028     A Cloud of solid particles
00029 
00030 SourceFiles
00031     solidParticleCloudI.H
00032     solidParticleCloud.C
00033     solidParticleCloudIO.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef solidParticleCloud_H
00038 #define solidParticleCloud_H
00039 
00040 #include <lagrangian/Cloud.H>
00041 #include "solidParticle.H"
00042 #include <OpenFOAM/IOdictionary.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 // Forward declaration of classes
00050 class fvMesh;
00051 
00052 /*---------------------------------------------------------------------------*\
00053                            Class solidParticleCloud Declaration
00054 \*---------------------------------------------------------------------------*/
00055 
00056 class solidParticleCloud
00057 :
00058     public Cloud<solidParticle>
00059 {
00060     // Private data
00061 
00062         const fvMesh& mesh_;
00063 
00064         IOdictionary particleProperties_;
00065 
00066         scalar rhop_;
00067         scalar e_;
00068         scalar mu_;
00069 
00070 
00071     // Private Member Functions
00072 
00073         //- Disallow default bitwise copy construct
00074         solidParticleCloud(const solidParticleCloud&);
00075 
00076         //- Disallow default bitwise assignment
00077         void operator=(const solidParticleCloud&);
00078 
00079 
00080 public:
00081 
00082     // Constructors
00083 
00084         //- Construct given mesh
00085         solidParticleCloud
00086         (
00087             const fvMesh&,
00088             const word& cloudName = "defaultCloud",
00089             bool readFields = true
00090         );
00091 
00092 
00093     // Member Functions
00094 
00095         // Access
00096 
00097             inline const fvMesh& mesh() const;
00098 
00099             inline scalar rhop() const;
00100             inline scalar e() const;
00101             inline scalar mu() const;
00102 
00103 
00104         // Edit
00105 
00106             //- Move the particles under the influence of the given
00107             //  gravitational acceleration
00108             void move(const dimensionedVector& g);
00109 };
00110 
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 } // End namespace Foam
00115 
00116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00117 
00118 #include <solidParticle/solidParticleCloudI.H>
00119 
00120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00121 
00122 #endif
00123 
00124 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines