CFDEMcoupling  2.4
 All Classes
runLiggghts.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  execute the liggghts command run $nrSteps
32 
33 Class
34  runLiggghts
35 
36 SourceFiles
37  runLiggghts.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef runLiggghts_H
42 #define runLiggghts_H
43 
44 #include "liggghtsCommandModel.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class runLiggghts Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
58 {
59 private:
60  dictionary propsDict_;
61 
62  word command_;
63 
64  bool preNo_;
65 
66  int stdInterval_;
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("runLiggghts");
72 
73 
74  // Constructors
75 
76  //- Construct from components
78  (
79  const dictionary& dict,
80  cfdemCloud& sm,
81  int i
82  );
83 
84  // Destructor
85 
86  ~runLiggghts();
87 
88 
89  // Member Functions
90 
91  const char* command(int);
92 
93  string createCommand(word="",int=0,word="",word="",word="",word="");
94 
95  bool runCommand(int);
96 
97  word name(){return "runLiggghts";};
98 
99  void set(int);
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
Definition: liggghtsCommandModel.H:54
Definition: runLiggghts.H:55
Definition: cfdemCloud.H:81