From b6a248b27626d626e00342cfd60e44350a21ab33 Mon Sep 17 00:00:00 2001 From: Derek Stucki Date: Tue, 25 Jul 2017 09:17:09 -0600 Subject: [PATCH 1/4] Changed to markdown formatting. Markdown is the standard for github project READMEs. This should improve the appearance of the project's github page significantly. --- README | 160 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 80 insertions(+), 80 deletions(-) diff --git a/README b/README index 816c6c1af..3edeeb629 100755 --- a/README +++ b/README @@ -1,65 +1,65 @@ -/*---------------------------------------------------------------------------*\ - CFDEMcoupling - Open Source CFD-DEM coupling - - CFD-DEM coupling toolbox, released by - DCS Computing GmbH, Linz, Austria - www.dcs-computing.com, office@dcs-computing.com - - 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, christoph.goniva@dcs-computing.com - - 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. -\*---------------------------------------------------------------------------*/ +# CFDEMcoupling - Open Source CFD-DEM coupling + +CFD-DEM coupling toolbox, released by +DCS Computing GmbH, Linz, Austria +www.dcs-computing.com, office@dcs-computing.com + +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, christoph.goniva@dcs-computing.com + +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 @@ -75,33 +75,33 @@ 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 +* 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 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 +* "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. +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. -\*---------------------------------------------------------------------------*/ +the producer of the OpenFOAM software and +owner of the OPENFOAM® and OpenCFD® trade marks. +--- From e4f107570e307d02fe27e9ece3d09d552f006267 Mon Sep 17 00:00:00 2001 From: Derek Stucki Date: Tue, 25 Jul 2017 09:19:38 -0600 Subject: [PATCH 2/4] Changed filename to enable markdown. --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 1f49c70897d42c5498c152019989da4306be05c9 Mon Sep 17 00:00:00 2001 From: Derek Stucki Date: Tue, 25 Jul 2017 09:23:00 -0600 Subject: [PATCH 3/4] fixed whitespace for proper markdown --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3edeeb629..a16ba4298 100755 --- a/README.md +++ b/README.md @@ -21,7 +21,9 @@ Christoph Goniva, christoph.goniva@dcs-computing.com 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 @@ -32,7 +34,9 @@ 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. @@ -50,7 +54,9 @@ 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. @@ -59,8 +65,8 @@ 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 @@ -101,7 +107,9 @@ 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. + --- From d27446e1971cc14350ac06951a95ba0ff8f257e6 Mon Sep 17 00:00:00 2001 From: Derek Stucki Date: Tue, 25 Jul 2017 09:26:54 -0600 Subject: [PATCH 4/4] Changed internal reference to name to match file rename. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a16ba4298..d1cf36852 100755 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ Features are: The CFDEM®coupling distribution includes the following files and directories: -* "README" file (this file) +* "README.md" 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