CFDEMcoupling  2.4
 All Classes
momCoupleModel.H
1 /*---------------------------------------------------------------------------*\
2  CFDEMcoupling - Open Source CFD-DEM coupling
3 
4  CFDEMcoupling is part of the CFDEMproject
5  www.cfdem.com
6  Christoph Goniva, christoph.goniva@cfdem.com
7  Copyright 2009-2012 JKU Linz
8  Copyright 2012- DCS Computing GmbH, Linz
9 -------------------------------------------------------------------------------
10 License
11  This file is part of CFDEMcoupling.
12 
13  CFDEMcoupling is free software; you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by the
15  Free Software Foundation; either version 3 of the License, or (at your
16  option) any later version.
17 
18  CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with CFDEMcoupling; if not, write to the Free Software Foundation,
25  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 
27 Description
28  This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
29  and OpenFOAM(R). Note: this code is not part of OpenFOAM(R) (see DISCLAIMER).
30 
31 Class
32  momCoupleModel
33 
34 SourceFiles
35  momCoupleModel.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef momCoupleModel_H
40 #define momCoupleModel_H
41 
42 #include "fvCFD.H"
43 #include "cfdemCloud.H"
44 #include "dataExchangeModel.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class momCoupleModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 {
56 
57 protected:
58 
59  // Protected data
60  const dictionary& dict_;
61 
62  cfdemCloud& particleCloud_;
63 
64  scalar maxAlpha_; // max fluid volume fraction to calculate exchange field
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("momCoupleModel");
70 
71  // Declare runtime constructor selection table
72 
73  declareRunTimeSelectionTable
74  (
75  autoPtr,
77  dictionary,
78  (
79  const dictionary& dict,
80  cfdemCloud& sm
81  ),
82  (dict,sm)
83  );
84 
85 
86  // Constructors
87 
88  //- Construct from components
90  (
91  const dictionary& dict,
92  cfdemCloud& sm
93  );
94 
95 
96  // Destructor
97 
98  virtual ~momCoupleModel();
99 
100 
101  // Selector
102 
103  static autoPtr<momCoupleModel> New
104  (
105  const dictionary& dict,
106  cfdemCloud& sm,
107  word momCoupleType
108  );
109 
110 
111  // Member Functions
112 
113  // implicit momentum source field
114  virtual tmp<volScalarField> impMomSource() const;
115 
116  // explicit momentum source field
117  virtual tmp<volVectorField> expMomSource() const;
118 
119  virtual void resetMomSourceField() const=0;
120 
121  virtual void setSourceField(volVectorField &) const;
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
Definition: momCoupleModel.H:54
Definition: cfdemCloud.H:81