sungsingsong / cfdemcoupling-public Goto Github PK

/*---------------------------------------------------------------------------*\
    CFDEMcoupling - Open Source CFD-DEM coupling

    CFDEMcoupling is part of the CFDEMproject
    www.cfdem.com
                                Christoph Goniva, [email protected]
                                Copyright 2009-2012 JKU Linz
                                Copyright 2012-     DCS Computing GmbH, Linz
-------------------------------------------------------------------------------
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.
    Note: this code is not part of OpenFOAM (see DISCLAIMER).
\*---------------------------------------------------------------------------*/


CFDEM(R) coupling provides an open source parallel coupled CFD-DEM framework 
combining the strengths of LIGGGHTS(R) DEM code and the Open Source 
CFD package OpenFOAM(R)(*). The CFDEM(R)coupling toolbox allows to expand 
standard CFD solvers of OpenFOAM(R)(*) to include a coupling to the DEM 
code LIGGGHTS(R). 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"_lws 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 file structure:

- "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(R)coupling
- "tutorials" directory including basic tutorial cases showing the functionality



Details on installation are given on the "www.cfdem.com"

The functionality of this CFD-DEM framwork is described via "tutorial cases" showing 
how to use different solvers and models.

CFDEM(R)coupling stands for Computational Fluid Dynamics (CFD) -
Discrete Element Method (DEM) coupling.

CFDEM(R)coupling is an open-source code, distributed freely under the terms of the 
GNU Public License (GPL).

Core development of CFDEM(R)coupling is done by 
Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012


\*---------------------------------------------------------------------------*/
(*) "OpenFOAM(R)"_of is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group.
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.
\*---------------------------------------------------------------------------*/