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

NoDispersion.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::NoDispersion
00026 
00027 Description
00028     Place holder for 'none' option
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef NoDispersion_H
00033 #define NoDispersion_H
00034 
00035 #include <lagrangianIntermediate/DispersionModel.H>
00036 
00037 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00038 
00039 namespace Foam
00040 {
00041 
00042 /*---------------------------------------------------------------------------*\
00043                        Class NoDispersion Declaration
00044 \*---------------------------------------------------------------------------*/
00045 
00046 template<class CloudType>
00047 class NoDispersion
00048 :
00049     public DispersionModel<CloudType>
00050 {
00051 public:
00052 
00053     //- Runtime type information
00054     TypeName("none");
00055 
00056 
00057     // Constructors
00058 
00059         //- Construct from components
00060         NoDispersion
00061         (
00062             const dictionary& dict,
00063             CloudType& owner
00064         );
00065 
00066 
00067     //- Destructor
00068     virtual ~NoDispersion();
00069 
00070 
00071     // Member Functions
00072 
00073         //- Flag to indicate whether model activates injection model
00074         virtual bool active() const;
00075 
00076         //- Cache carrier fields
00077         virtual void cacheFields(const bool store);
00078 
00079         //- Update (disperse particles)
00080         virtual vector update
00081         (
00082             const scalar dt,
00083             const label celli,
00084             const vector& U,
00085             const vector& Uc,
00086             vector& UTurb,
00087             scalar& tTurb
00088         );
00089 };
00090 
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 } // End namespace Foam
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 #ifdef NoRepository
00099 #   include <lagrangianIntermediate/NoDispersion.C>
00100 #endif
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 #endif
00105 
00106 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines