CFDEMcoupling  2.4
 All Classes
meshMotionModel.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  meshMotionModel
33 
34 SourceFiles
35  meshMotionModel.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef meshMotionModel_H
40 #define meshMotionModel_H
41 
42 #include "fvCFD.H"
43 #include "cfdemCloud.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class meshMotionModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 {
55 
56 protected:
57 
58  // Protected data
59  const dictionary& dict_;
60 
61  cfdemCloud& particleCloud_;
62 
63  // Protected member functions
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("meshMotionModel");
69 
70  // Declare runtime constructor selection table
71 
72  declareRunTimeSelectionTable
73  (
74  autoPtr,
76  dictionary,
77  (
78  const dictionary& dict,
79  cfdemCloud& sm
80  ),
81  (dict,sm)
82  );
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const dictionary& dict,
91  cfdemCloud& sm
92  );
93 
94 
95  // Destructor
96 
97  virtual ~meshMotionModel();
98 
99 
100  // Selector
101 
102  static autoPtr<meshMotionModel> New
103  (
104  const dictionary& dict,
105  cfdemCloud& sm
106  );
107 
108 
109  // Member Function
110  virtual tmp<volVectorField> setMotion() const=0;
111 
112  virtual void correctF(volVectorField&) const {};
113 
114  virtual void correctUo(volVectorField&) const {};
115 
116  virtual volVectorField& f() const;
117 
118  virtual volScalarField& body() const;
119 
120  virtual volScalarField& inside() const;
121 
122  // Access
123 
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
Definition: meshMotionModel.H:53
Definition: cfdemCloud.H:81