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

LocalInteraction.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) 2008-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::LocalInteraction
00026 
00027 Description
00028     Patch interaction specified on a patch-by-patch basis
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef LocalInteraction_H
00033 #define LocalInteraction_H
00034 
00035 #include <lagrangianIntermediate/PatchInteractionModel.H>
00036 #include <lagrangianIntermediate/patchInteractionData.H>
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 /*---------------------------------------------------------------------------*\
00043                       Class LocalInteraction Declaration
00044 \*---------------------------------------------------------------------------*/
00045 
00046 template<class CloudType>
00047 class LocalInteraction
00048 :
00049     public PatchInteractionModel<CloudType>
00050 {
00051     // Private data
00052 
00053         //- List of participating patches
00054         const List<patchInteractionData> patchData_;
00055 
00056         //- List of participating patch ids
00057         List<label> patchIds_;
00058 
00059 
00060     // Private member functions
00061 
00062         //- Returns local patchI if patch is in patchIds_ list
00063         label applyToPatch(const label globalPatchI) const;
00064 
00065 
00066 
00067 public:
00068 
00069     //- Runtime type information
00070     TypeName("LocalInteraction");
00071 
00072 
00073     // Constructors
00074 
00075         //- Construct from dictionary
00076         LocalInteraction(const dictionary& dict, CloudType& cloud);
00077 
00078 
00079     //- Destructor
00080     virtual ~LocalInteraction();
00081 
00082 
00083     // Member Functions
00084 
00085         //- Flag to indicate whether model activates patch interaction model
00086         virtual bool active() const;
00087 
00088         //- Apply velocity correction
00089         //  Returns true if particle remains in same cell
00090         virtual bool correct
00091         (
00092             const polyPatch& pp,
00093             const label faceId,
00094             bool& keepParticle,
00095             bool& active,
00096             vector& U
00097         ) const;
00098 };
00099 
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 } // End namespace Foam
00104 
00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00106 
00107 #ifdef NoRepository
00108 #   include "LocalInteraction.C"
00109 #endif
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 #endif
00114 
00115 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines