tutorials/equationReader/README

   1                                      |---------------------.
   2                                      | David L. F. Gaden's |
   3                     .----------------|---------------------'
   4                     | equationReader |  Version:    0.6.0
   5                     '----------------|
   6
   7 Description
   8 ===========
   9 An extension to OpenFOAM that allows you to read equations from a dictionary
  10 file and (optionally) have them evaluated at every time step.
  11
  12 Original Author
  13 ===============
  14 David L. F. Gaden (dlfgaden@gmail.com)
  15
  16 Current Maintainer
  17 ==================
  18 David L. F. Gaden (dlfgaden@gmail.com)
  19
  20 Contributors
  21 ============
  22 David L. F. Gaden : base version
  23
  24 Documentation
  25 =============
  26 github.com/Marupio/equationReader/wiki
  27
  28 Installation/Compilation
  29 ========================
  30 Refer to the documentation.
  31
  32 Contents
  33 ========
  34  - src - the library source files
  35  - applications - a demo application that uses equationReader
  36  - tutorials - a sample case that runs the demo application
  37
  38 Required OpenFOAM-Version (Known to work with)
  39 ==============================================
  40 3.0
  41 2.1.x
  42 2.2.x
  43
  44 History
  45 =======
  46
  47  2010-07-21: Initial import
  48  2010-08-05: Differentiated versions for OpenFOAM 1.5.x/1.5-dev and
  49     OpenFOAM 1.6+
  50  2010-08-12:
  51     * Added IOobject support for automatic output - IOEquationReader
  52     * Removed need for pointers
  53     * Added support for scalarLists as a data source
  54     * Cleaned up available functions
  55  2010-10-16:
  56     * Added full support for fields - equationReader can now operate across the
  57         entire mesh.
  58     * Bug fixes:
  59         * Dimension-checking for min and max functions
  60         * Moved IOobjects to db directory
  61  2011-09-25: Version 0.5.0
  62     * Improved treatment of fields - now approximately 10x faster
  63     * Introduced version numbers to keep track of changes
  64  2012-10-25: Version 0.5.1
  65     * Moved to git
  66     * Bug fixes:
  67         * Circular reference detection now working
  68  2013-08-29: Version 0.6.0
  69     * Uploaded to github and OpenFOAM-extend
  70     * Restructured applications and tutorials directories for consistency
  71     * Made opening splash optional