forked from CFDEMproject/CFDEMcoupling-PUBLIC
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
executable file
·107 lines (84 loc) · 4.9 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*---------------------------------------------------------------------------*\
CFDEMcoupling - Open Source CFD-DEM coupling
CFD-DEM coupling toolbox, released by
DCS Computing GmbH, Linz, Austria
www.dcs-computing.com, [email protected]
CFDEMcoupling is part of the CFDEMproject
www.cfdem.com
CFDEMcoupling is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.
CFDEMcoupling is part of CFDEMproject:
www.liggghts.com | www.cfdem.com
Core developer and main author:
Christoph Goniva, [email protected]
LIGGGHTS® and CFDEM® are registered trade marks of DCS Computing GmbH,
the producer of the LIGGGHTS® software and the CFDEM®coupling software
See http://www.cfdem.com/terms-trademark-policy for details.
/*---------------------------------------------------------------------------*\
Copyright
Copyright 2012- DCS Computing GmbH, Linz
Copyright 2009-2015 JKU Linz
Some parts of CFDEMcoupling are based on OpenFOAM® and Copyright on these
parts is held by the OpenFOAM® Foundation (www.openFoam.org)
and potentially other parties.
Some parts of CFDEMcoupling are contributied by other parties, which are
holding the Copyright. This is listed in each file of the distribution.
/*---------------------------------------------------------------------------*\
License
This file is part of CFDEMcoupling.
CFDEMcoupling is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.
CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with CFDEMcoupling; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
/*---------------------------------------------------------------------------*\
Description
This code provides models and solvers to realize coupled CFD-DEM simulations
using LIGGGHTS and OpenFOAM® technology.
Note: this code is not part of OpenFOAM®.
This offering is not approved or endorsed by OpenCFD Limited,
the producer of the OpenFOAM® software and owner of the OPENFOAM®
and OpenCFD® trade marks.
\*---------------------------------------------------------------------------*/
CFDEM® coupling provides an open source parallel coupled CFD-DEM framework
combining the strengths of LIGGGHTS® DEM code and the Open Source
CFD package OpenFOAM®(*). The CFDEM®coupling toolbox allows to expand
standard CFD solvers of OpenFOAM®(*) to include a coupling to the DEM
code LIGGGHTS®. In this toolbox the particle representation within the
CFD solver is organized by "cloud" classes. Key functionalities are organised
in sub-models (e.g. force models, data exchange models, etc.), which can easily
be selected and combined by dictionary settings.
The coupled solvers run fully parallel on distributed-memory clusters.
Features are:
- its modular approach allows users to easily implement new models
- its MPI parallelization enables to use it for large scale problems
- the "forum" (www.cfdem.com) on CFD-DEM gives the possibility
to exchange with other users / developers
- the use of GIT allows to easily update to the latest version
- basic documentation is provided
The CFDEM®coupling distribution includes the following files and directories:
- "README" file (this file)
- "COPYING" file the GNU General Public License (GPL)
- "DISCLAIMER" file
- "src" directory including the source files of the coupling toolbox and models
- "applications" directory including the solver files for coupled CFD-DEM simulations
- "doc" directory including the documentation of CFDEM®coupling
- "tutorials" directory including basic tutorial cases showing the functionality
Details on installation are given on the "www.cfdem.com" website.
The functionality of this CFD-DEM framwork is described via "tutorial cases" showing
how to use different solvers and models.
CFDEM®coupling stands for Computational Fluid Dynamics (CFD) -
Discrete Element Method (DEM) coupling.
\*---------------------------------------------------------------------------*/
(*) This offering is not approved or endorsed by OpenCFD Limited,
the producer of the OpenFOAM software and
owner of the OPENFOAM® and OpenCFD® trade marks.
\*---------------------------------------------------------------------------*/