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