README 2.07 KB
Newer Older
Franjo's avatar
Franjo committed
1
2
#                            -*- mode: org; -*-
#
Franjo's avatar
Franjo committed
3
#+TITLE:                       *cfMesh README*
Franjo's avatar
Franjo committed
4
#+AUTHOR:                      Franjo Juretic.
Franjo's avatar
Franjo committed
5
#+DATE:                           May 2015
Franjo's avatar
Franjo committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#+LINK:                  http://www.c-fields.com
#+OPTIONS:

cfMesh is a library for mesh generation built on OpenFOAM.

* License
  cfMesh 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.

* System requirements
  cfMesh is developed and tested on Linux and MS Windows.

* Installation
Franjo's avatar
Franjo committed
21
  Binaries and the source code can be downloaded from http://sourceforge.net/projects/cfmesh/
Franjo's avatar
Franjo committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

* Building from Sources (Optional)

  cfMesh can be built with recent versions of OpenFOAM and foam-extend. In order to build the library, a working OpenFOAM environment is needed. The build started by the Allwmake script located in this folder. It can be built with gcc and mingw compilers which support OpenMP (gcc-4.2.4 and above). Other compilers are not tested.

* Getting Started

  Copy the 'tutorials' examples directory in the cfMesh distribution to the
  'run' directory.  If the OpenFOAM environment variables are set correctly,
  then the following command will work correctly:

  + cp -r tutorials $FOAM_RUN

  Run the first example case of a simplified car body:

  + cd $FOAM_RUN/tutorials/asmoOctree
  + cartesianMesh

Franjo's avatar
Franjo committed
40
  All cases have Allrun and Allclean scripts guiding you through the meshing process.
Franjo's avatar
Franjo committed
41

Franjo's avatar
Franjo committed
42
* Documentation
Franjo's avatar
Franjo committed
43
44
45
46
47
48
49
50
51
52
53
54
55
  http://www.c-fields.com and in the userGuide folder.

* List of contributors
  Franjo Juretic
  Philippose Rajan
  Ivor Clifford
  Nebojsa Gavrilov
  
* How to contribute

  It you are interested in contributing to cfMesh please send an e-mail at: info@c-fields.com
  We gladly accept contributions, whether they are the code, validation data, documentation, promotional material, etc.
  cfMesh development process follows the git-flow branching model, described in http://nvie.com/posts/a-successful-git-branching-model/.