View source for Contrib/swak4Foam/README 1.x

This is a copy of the README that comes with the 1.x-Version (for OF 1.7 and 1.6-ext) of swak4Foam. It was produced by the experimental MediaWiki-export (not everything was converted correctly)

== Description ==
  A collection of libraries and tools that let the user handle
  OpenFOAM-data based on expressions


== About this document ==


=== Scope ===
   This file gives an overview of <tt>swak4Foam</tt> and a history of the
   features. It is not a canonical documentation.


=== Technical ===
   This file is written in the mighty <tt>org-mode</tt> (see
   [http://orgmode.org/ http://orgmode.org/]) a markup/outline-mode for (X)Emacs. Using this
   mode it can be easily (using 3 keystrokes ... it's Emacs) to PDF or
   HTML to make it more readable (and add a table of contents).

   Please don't try to "beautify" it with any other text editor as
   this will surly mess up the markup (and keeping the file
   ''org-compatible'' outside of the <tt>org-mode</tt> is a pain in the neck.


== Contributors etc ==


=== Original Author ===
   Bernhard Gschaider (bgschaid@ice-sf.at)


=== Current Maintainer ===
   Bernhard Gschaider (bgschaid@ice-sf.at)


=== Contributors ===
   In alphabetical order of the surname
#Peter Keller <tt>sprinklerInlet</tt>-case
#Andreas Otto fixed the <tt>circulatingSplash</tt>-case
#Alexey Petrov <tt>pythonFlu</tt>-integration
#Bruno Santos Compilation with Intel compiler and Mingw
#Martin Becker The <tt>potentialPitzDaily</tt>-case (demonstrating a problem with <tt>groovyBC</tt>)

</
   If anyone is forgotten: let me know

   Contributors to <tt>simpleFunctionObjects</tt> are listed separately in
   the <tt>README</tt> of that library


=== Documentation ===
   See: [http://openfoamwiki.net/index.php/contrib/swak4Foam http://openfoamwiki.net/index.php/contrib/swak4Foam]


== Installation/Compilation ==


=== Requirements ===
* Version 1.7 or 1.6-ext of OpenFOAM (1.6 should work, too)
** The <tt>finiteArea</tt>-stuff will only work with version 1.6-ext

* the compiler generators <tt>bison</tt> and <tt>flex</tt>
** <tt>swak4Foam</tt> is known to work with <tt>bison</tt> version 2.3 and higher. Lower versions '''may''' work. If it works with a lower version please report it


</


=== Building ===
: wmake all 
   at the base directory should build all the libraries and
   tools.

  The main library <tt>swak4FoamParsers</tt> can't be built in parallel (no
  values of <tt>WM_NCOMPPROCS</tt> bigger than 1)


==== Additional configuration ====
    Some features (currently only the <tt>Python</tt>-integration may need
    third party software. The paths to these packages can be configured
    in a file <tt>swakConfiguration</tt> (an example file
    <tt>swakConfiguration.example</tt> is provided). If that file is not
    present these unconfigured features will not be compiled.


=== Global installation ===
   If the libraries and utilities are considered stable and the should
   be available to everyone (without having to recompile them) the
   script <tt>copySwakFilesToSite.sh</tt> can be used to copy them to the
   global site-specific directories.

   The script <tt>removeSwakFilesFromSite.sh</tt> removes all these files
   from the global directories. The <tt>removeSwakFilesFromLocal.sh</tt> does
   the same for the user directories (this makes sure that no
   self-compiled version ''shadows'' the global version (which would
   lead to strange results)

   There is a <tt>Makefile</tt> attached. <tt>make install</tt> compiles <tt>swak4Foam</tt>
   and installs it into the global directories

   '''Note:''' Due to the order in which library direcories are searched
   for with <tt>-L</tt> a global installation might break the compilation


=== Packaging ===


==== Debian ====
    The command <tt>build dpkg</tt> builds a Debian/Ubuntu package for 
    the '''currently enabled''' OpenFOAM-package. Note:
* it is assumed that the currently used OF-version was also installed by the package manager
* the <tt>dev</tt> package is built but poorly maintained

</
    Changes in the packaging should be done in the branch
      <tt>debianPackaging</tt> of the Mercurial-repository

    '''Note:''' Due to the problem described with the global installation
    it might be necessary to deinstall a previously installed package
    to successfully build a new package


== Contents ==


=== Libraries ===
   Collection of Libraries


==== =swak4FoamParsers= ====
    The basis of <tt>swak4Foam</tt>: the expression parsers with the logic to
    access the ''OpenFOAM'' data-structures.

    None of the other software pieces compile without it


==== =simpleFunctionObjects= ====
    A collection of function objects that was previously separately
    available at
    [http://openfoamwiki.net/index.php/Contrib_simpleFunctionObjects http://openfoamwiki.net/index.php/Contrib\_simpleFunctionObjects].

    Provides consistent output of values (on patches and fields) and
    more.


==== =groovyBC= ====
    Implements the infamous <tt>groovyBC</tt>. A boundary condition that
    allows arbitrary expressions in the field-file


==== =swakFunctionObjects= ====
    Function objects that have no additional requirements. Mainly used
    for manipulating and creating fields with expressions
#addGlobalVariable Adds a variable to a global swak-namespace. Mainly used for debugging and resolving issues where a variable is needed in a BC before it is defined.
#expressionField Create a new field from an expression
#clearExpressionField Erase a field created with <tt>expressionField</tt>
#manipulateField Modify a field in memory
#createSampledSet Create a sampled set that can be used by other swak-entities (mainly boundary conditions)
#createSampledSurface Create a sampled surface that can be used by other swak-entities (mainly boundary conditions)
#solveLaplacianPDE Solve the Poisson equation

</
\begin{equation}
\frac{\partial \rho T}{\partial t} - \nabla \lambda \nabla T =
S_{expl} + S_{impl} T  
\end{equation}
         for $T$ where $\rho$, $\lambda$ and $S$ can be specified
#solveTransportPDE Solve the transport equation

</
\begin{equation}
\frac{\partial \rho T}{\partial t} + \div(\phi,T) - \nabla \lambda \nabla T =
S_{expl} + S_{impl} T  
\end{equation}
         for $T$ where $\rho$, $\lambda$ and $S$ can be
         specified. Plus the name of the field $\phi$


==== =simpleSwakFunctionObjects= ====
    Function objects based on the <tt>simpleFunctionObjects</tt>-library
    (which is a prerequisite for compiling it).

    Evaluate expressions and output the results


==== =swakSourceFields= ====
    These classes allow to manipulate the solution. To use these the
    solver has to be modified.
#expressionSource Field that is calculated from an expression. To be used as source-term or coefficient in some solver
#forceEquation force an equation to fixed values in selected locations. Has to be used after constructing the equation and before solving

</


==== =swakTopoSources= ====
    <tt>topoSources</tt> for <tt>cellSet</tt> and <tt>faceSet</tt>. Can be used with the
    <tt>cellSet</tt> and <tt>faceSet</tt>-utilities 


==== =swakFiniteArea= ====
    Implements parsers for the <tt>finiteArea</tt>-stuff in 1.6-ext. Also
    implements <tt>groovyBC</tt> for <tt>areaField</tt> and <tt>expressionField</tt> and
    other function objects


==== =groovyStandardBCs= ====
    Collection of boundary conditions that give standard boundary
    conditions the possibility to use expression for the coefficients

    Contributions to this library are explicitly encouraged. Please
    use the Mercurial-branch <tt>groovyStandardBCs</tt> to ''groovyify''
    standard boundary conditions.


==== =pythonIntegration= ====
    Embeds a <tt>Python</tt>-interpreter.

#<tt>pythonIntegrationFunctionObject</tt> Executes <tt>Python</tt>-code at the usual execution times of functionObjects. The interpreter keeps its state

</

    This library is only compiled if the paths to the Python-Headers
    are configured in the <tt>swakConfiguration</tt>-file (see above)


==== =fluFunctionObjectDriver= ====
    Driver for <tt>functionObjects</tt> that implemented entirely in <tt>Python</tt>
    using the <tt>pythonFlu</tt>-library


=== Utilities ===


==== =funkySetFields= ====
    Utility that allows creation and manipulation of files with
    expressions 


==== =funkySetAreaFields= ====
    Utility like <tt>funkySetFields</tt> for <tt>areaFields</tt> (only works with
    1.6-ext) 


==== =funkySetBoundaryField= ====
    Sets any field on a boundary to a non-uniform value based on an
    expression. 

    Acts without deeper understanding of the underlying boundary condition


==== =replayTransientBC= ====
    Utility to quickly test whether a groovyBC gives the expected
    results. Writes the specified fields with the applied boundary
    condition but doesn't do anything else.

    Can be used for other BCs as well


==== =funkyDoCalc= ====
    Evaluates expressions that are listed in a dictionary using data
    that is found on the disc and prints summarized data (min, max,
    average, sum) to the screen


=== Examples ===
   If not otherwise noted cases are prepared by a simple
   <tt>blockMesh</tt>-call.

   '''Note''': All the cases here are strictly for demonstration purposes and
   resemble nothing from the 'real world'


==== groovyBC ====
    The old <tt>groovyBC</tt>-Demos


===== pulsedPitzDaily =====
#Solver pisoFoam
#Also demonstrates <tt>manipulateField</tt>, <tt>expressionField</tt> and <tt>clearField</tt> from the <tt>swakFunctionObjects</tt>. <tt>patchExpression</tt> from <tt>simpleSwakFunctionObjects</tt>. <tt>solveLaplacianPDE</tt> and <tt>solveTransportPDE</tt> for solving equations

</


===== wobbler =====
#Solver solidDisplacementFoam

</


===== circulatingSplash =====
#Solver interDyMFoam

</


===== movingConeDistorted =====
#Solver pimpleDyMFoam
#Also demonstrates <tt>swakExpression</tt> with <tt>surface</tt>. Due to a problem described below this currently doesn't work

</


===== average-t-junction =====
#Solver pimpleFoam

</


===== multiRegionHeaterFeedback =====
#Solver chtMultiRegionFoam
#Mesh preparation Execute the script <tt>prepare.sh</tt> in that directory
#Also demonstrated <tt>patchExpression</tt> and <tt>swakExpression</tt> from <tt>simpleSwakFunctionObjects</tt>.

</


===== fillingTheDam =====
#Solver interFoam
#Also demonstrates Usage of a <tt>sampledSet</tt> defined in the <tt>controlDict</tt> do determine the average filling height. Also stored variables for not switching back once the criterion is reached. Global variables defined by a function object

</


===== sprinklingInlet =====
#Solver interFoam
#Description Winner of the <tt>swak4Foam</tt>-competition at the 6th OpenFOAM-Workshop (2011). By Peter Keller

</


===== potentialPitzDaily =====
#Solver potentialFoam
#Description Demonstrates the use of <tt>groovyB</tt> with <tt>potentialFoam</tt> (also a problem connected with that). Provided by Martin Backer

</


==== FunkySetFields ====
    Example dictionary for <tt>funkySetFields</tt>


==== FunkySetBoundaryFields ====
    Example dictionary for <tt>funkySetBoundaryFields</tt>. Sets nonsense
    boundary conditions for the world famous <tt>damBreak</tt>-case


==== InterFoamWithSources ====
    Demonstrates usage of <tt>expressionSource</tt>

    Due to differences in the original <tt>interFoam</tt>-solver this doesn't
    work on certain OpenFOAM-versions (most specifically
    <tt>1.6-ext</tt>).

    The only modifications to the original solver are found at the end
    of <tt>createFields.H</tt> and in <tt>UEqn.H</tt> (the added source terms).


==== InterFoamWithFixed ====
    Demonstrates usage of <tt>forceEquation</tt>

    Due to differences in the original <tt>interFoam</tt>-solver this doesn't
    work on certain OpenFOAM-versions (most specifically
    <tt>1.6-ext</tt>).

    The only modifications to the original solver are found at the end
    of <tt>createFields.H</tt> and in <tt>UEqn.H</tt> (the fixing of the velocities).


===== =interFoamWithSources= =====
     Slightly modified version of <tt>interFoam</tt>. Adds a source term to
     the momentum equation. The source term is an expression that is
     defined at run-time


===== =mixingThing= =====
     Demonstration case for it.
#Preparation Run the script <tt>prepare.sh</tt> to prepare the case

</


==== FiniteArea ====
    Demonstration of the <tt>finiteArea</tt>-stuff that works with 1.6-ext


===== =swakSurfactantFoam= =====
     Variation of <tt>surfactantFoam</tt> that adds an <tt>expressionSource</tt>


===== =planeTransport= =====
     Demonstration case
#Preparation Use <tt>blockMesh</tt> and <tt>makeFaMesh</tt>
#Solver <tt>surfactantFoam</tt> (without source term) or <tt>swakSurfactantFoam</tt>
#Demonstrates FAM-specific <tt>swakExpressions</tt> and <tt>groovyBC</tt> (as well as the <tt>expressionSource</tt>)

</


==== other ====
    Cases that don't have a <tt>groovyBC</tt>


===== =angledDuctImplicit= =====
#Solver rhoPorousSimpleFoam
#Mesh preparation Execute the <tt>makeMesh.sh</tt>-script in that directory. If you want to run in parallel call the <tt>decomposeMesh.sh</tt>-script with the number of processors as an argument
#Demonstrates Usage of the <tt>swakTopoSources</tt>. Compares different approaches to evaluating with the <tt>swakExpression</tt>-functionObject. Also an example dictionary that demonstrates the use of <tt>funkyDoCalc</tt>

</


===== =capillaryRise= =====
#Solver interFoam
#Case preparation run the supplied script <tt>prepareCase.sh</tt>
#Demonstrates Usage of a sampled surface to track the interface in a VOF-simulation

</


==== PythonIntegration ====
    Demonstrate the integration of <tt>Python</tt>. Mostly using <tt>PyFoam</tt> but
    also with <tt>pythonFlu</tt>


===== =manipulatedPitzDaily= =====
#Solver simpleFoam
#Demonstrates Usage of <tt>PyFoam</tt> to manipulate the <tt>fvSolution</tt>-file during the run (possible application: unphysical initial conditions cause the run to fail during startup with "normal" relaxation values)

</


===== =findPointPitzDaily= =====
#Solver simpleFoam
#Demonstrates Usage of the <tt>pythonFlu</tt>-integration to find the point where the recirculation behind the step ends. Also tries to plot the result using the <tt>matplotlib</tt>-library

</


===== =bed2OfPisa= =====
#Solver twoPhaseEulerFoam
#Demonstrates Usage of <tt>PyFoam</tt> to read the direction of gravity and feeding it into a <tt>goovyBC</tt> via global variables
#Case preparation Just call <tt>funkySetFields -time 0</tt>

</


==== solvePDE ====
    Examples for the <tt>functionObjects</tt> that can solve ''Partial
    Differential equations''


===== flangeWithPDE =====
#Solver laplacianFoam
#Demonstrates The usage of the <tt>functionObject</tt> that solves the laplacian (Poisson) equation and (hopefully) that it gets the same result as the native solver
#Case preparation <tt>Allrun</tt>-script is provided

</


===== pitzDailyWithPDE =====
#Solver scalarTransportFoam
#Demonstrates Solving additional transport equations

</


==== tests ====
    Simple test cases for specific features


===== =randomCavity= =====
     Testing of different seeds for the <tt>rand</tt>-function. Also tests
     the <tt>randFixed</tt>-function


=== =maintainanceScripts= ===
   Undocumented scripts used for maintaining <tt>swak4Foam</tt>. '''If you
   don't understand them, don't use them'''


== Bug reporting and Development ==


=== Bug reports ===
   The preferred place for bug reports is
   [http://sourceforge.net/apps/mantisbt/openfoam-extend/search.php?project_id=10&sticky_issues=on&sortby=last_updated&dir=DESC&hide_status_id=90 http://sourceforge.net/apps/mantisbt/openfoam-extend/search.php?project\_id=10&sticky\_issues=on&sortby=last\_updated&dir=DESC&hide\_status\_id=90] 
   
   A sourceforge-account is required for reporting


=== Development ===
   Contributions to to <tt>swak4Foam</tt> are most welcome. If you want to
   contribute clone the Mercurial archive of the sources
: hg clone http://openfoam-extend.hg.sourceforge.net:8000/hgroot/openfoam-extend/swak4Foam
   Change to the branch that you want to improve (usually <tt>default</tt>)
   and create a new branch
: hg branch <branchName>
   where <tt><branchname></tt> is an easily identifiable name that makes the
   purpose of the branch clear (for instance
   <tt>bugfixWrongRandomFunction</tt> or <tt>featureHyperbolicFunctions</tt>). Don't
   work on the <tt>default</tt> branch or any other branches that are not
   "yours". Such contributions will not be merged

   Once development on the branch is finished export the relevant
   changesets with 
: hg export <nodeID>
   (<tt>nodeID</tt> being the ids of "your" changesets) and send them to the
   maintainer (or attach them to a bug report on Manits). The changes
   will be reviewed and merged into the <tt>default</tt> branch (do not
   attempt to do this yourself). Patches generated with <tt>hg export</tt>
   make sure that all changes are attributed to the original developer
   (you).

   An alternative would be the <tt>bundle</tt> command. Just do
: hg bundle <bundlefile>
   and then send the <tt>bundlefile</tt>. This will include '''all''' commits
   that are not in the upstream repository and will allow similar
   inclusion in the upstream as <tt>export</tt>.

   Once you have proven by successfully submitting changesets via <tt>hg
   export</tt> you can ask for write access to the mercurial repository.


==== Suggest reading ====
    These topics may be "new" for the average OF-developer:
#Mercurial A short tutorial on this can be found at [http://mercurial.selenic.com/guide/ http://mercurial.selenic.com/guide/]. If you already know <tt>git</tt> the [http://mercurial.selenic.com/wiki/GitConcepts http://mercurial.selenic.com/wiki/GitConcepts] may be enough for you
#bison/flex This pair of compiler generator tools generate the parsers for the expressions. Google for a tutorial that looks promising to you.
 For a short example that shows how a new function was added to two parsers have a look at this changeset that added the <tt>cpu()</tt>-function to the field and the the patch-parser (usually you'll have to write a new method for the driver too):

</
: hg diff -c 8604e865cce6


==== Special branches ====
    Currently the main branches are:
#default The '''main''' branch. This is the brancht that the general public will receive. It compiles under 1.7 and 1.6-ext
#<tt>port_2.0.x</tt> The branch that compiles under OpenFOAM 2.0. This will eventually become the <tt>default</tt>-branch
#debianPackaging Branch for generating new Debian-packages of <tt>swak4Foam</tt>. If somebody wants to "inherit" this: contact the maintainer
#finiteArea In this branch the things for the <tt>finiteArea</tt>-discretization (only present in <tt>1.6-ext</tt>) is developed. Usually gets merged back into the <tt>default</tt>-branch once a feature is completed

</


==== Distributed bug-tracking ====
    As an experimental feature distributed bug-tracking was introduced
    using the ''Artemis''-extension for ''Mercurial'' (see
    <tt>http://hg.mrzv.org/Artemis/</tt>). An up-to-date version can be
    installed by 
: hg clone http://hg.mrzv.org/Artemis/
    somewhere and installing the plugin by editing <tt>.hgrc</tt>.

    This is '''not''' the official bug-tracker for <tt>swak4Foam</tt>. It is used
    for keeping track of new features that are to be introduced to
    <tt>swak4Foam</tt> and may be discontinued if the experiment proves to be
    unsuccessful.


== Copyright ==
  <tt>swak4Foam</tt> 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 2 of the License, or (at your
  option) any later version.  See the file COPYING in this directory,
  for a description of the GNU General Public License terms under which 
  you can copy the files.


== Known bugs ==
  The following list is not complete. If the Artemis extension (see
  above) is installed then
: hg ilist
  gives a more up-to-date list


=== Moving meshes and =sampledSurfaces= ===
   It seems that with moving meshes <tt>sampledSurfaces</tt> don't get
   updated. This seems to be a problem with OpenFOAM itself (the
   regular <tt>surfaces</tt>-functionObject doesn't get updated. This is
   currently investigated


=== Missing support for interpolation and point-Fields ===
   Apart from patches and internal fields the support for
   interpolation from cells to faces (and vice versa) is incomplete as
   well as point fields (although they are supported in the grammar)


=== Caching of loaded fields not working ===
   This is especially evident for the <tt>funkyDoCalc</tt>-example


=== Possible enhancements of the code ===
   Not really bugs, but stuff that bugs me


==== Pointers in the driver code ====
    This is necessary because of <tt>bison</tt>. Investigate possibilities to
    replace these by <tt>tmp</tt> and <tt>autoPtr</tt> 


=== Possible memory loss ===
   <tt>valgrind</tt> reports some lost memory for stuff that is not directly
   allocated by <tt>swak4Foam</tt> (in OpenFOAM-sources)

   Will investigate. Relevant places are marked by comments in the
   code. Also the construction of <tt>sampledSet</tt> seems to loose memory


== History ==


=== 2010-09-13 ===
   First Release


=== 2010-12-18 ===
   New release
   Most important changes


==== Parser for =sampledSurfaces= ====
    Now expressions for the field on a sampled surface can be
    evaluated. All <tt>sampledSurfaces</tt> offered by OpenFOAM now can be
    used 


==== Multiline =variables= ====
    The <tt>variables</tt> entry (most notably used in <tt>groovyBC</tt> and
    <tt>swakExpression</tt>) now can be a list of strings. This allows some
    kind of "formatting" (one expression per line) and should improve
    readability


==== Two maintainance-scripts were added ====
    These can copy the libraries and utilities to the global
    installation (for those who think that the swak4Foam-stuff is
    stable enough and want to 'bless' all users at their site with
    it). Note that any local installation still takes precedence
    (because <tt>$FOAM_USER_APPBIN</tt> is before <tt>$FOAM_APPBIN</tt> in the
    <tt>$PATH</tt> 


==== Parsers using 'external variables' are now run-time selectable ====
    This allows the inclusion of other parsers with the regular
    <tt>swak4Foam</tt> parsers and include them seamlessly with the
    <tt>variables</tt>-mechanism for 'externals' (in other words: you can add
    your own parser in a separate library without having to change
    anything about the overall <tt>swak4Foam</tt>, but it behaves as if it
    was part of it)


=== 2011-01-30 ===


==== Support for /Finite Area/-stuff ====
    Now there is support for the <tt>finiteArea</tt>-library found in
    1.6-dev. The support is found in a separate library
    <tt>swakFiniteArea</tt>. It has
* a parser <tt>faField</tt> for <tt>areaFields</tt>
* a parser <tt>faPatch</tt> for patches of <tt>areaFields</tt>
* a variant of <tt>groovyBC</tt> for these patches
* a computed source <tt>faExpressionSource</tt>
* Function-object-variants for <tt>areaFields</tt>: <tt>clearExpression</tt>, <tt>expressionField</tt> and <tt>manipulateField</tt>. These work the same as their <tt>volField</tt>-counterparts

</


==== Bugfix for compiling in single precision ====
    See [https://sourceforge.net/apps/mantisbt/openfoam-extend/view.php?id=49 https://sourceforge.net/apps/mantisbt/openfoam-extend/view.php?id=49]


==== New function =nearDist= ====
    See [https://sourceforge.net/apps/mantisbt/openfoam-extend/view.php?id=44 https://sourceforge.net/apps/mantisbt/openfoam-extend/view.php?id=44]


=== 2011-04-20 ===
   New features and changes are (this list is not complete):


==== New utility =funkySetAreaField= ====
    Like <tt>funkySetFields</tt> for ''finiteArea''. Also writes out a volume
    field for easier post-processing


==== Refactoring of =groovyBC= and groovified boundary conditions ====
    Makes it easier to use the <tt>groovyBC</tt>-machinery for other boundary
    conditions. Two standard boundary conditions were
    ''groovified''. Others may follow


==== Easier deployment ====
    If no <tt>simpleFunctionObjects</tt> are present they can be downloaded
    by a script.
    Also scripts to handle global installations of <tt>swak4Foam</tt>


==== Force equations ====
    A class to force equations to certain values according to
    expressions


==== New utility =funkyDoCalc= ====
    Utility does calculations on saved results and outputs single
    numbers (min, max, sum, average) to the terminal. Can be used for
    reporting or validity checks


==== Debian packaging ====
    Crude packaging for Debian


==== Lookup-tables ====
    A single-argument function can be specified as a piecewise linear
    function. Basically works like timelines but the argument can be
    something else (not only the time)


==== Stored variables ====
    Variables that store their values between time-steps. Applications
    are statistics or switches


==== Sampled sets ====
    Sampled sets can now also be used as en entity on which
    calculation is possible.


=== 2011-07-26 ===


==== New features: ====


===== Rewrite of =rand= and =randNormal= =====
* These two functions now can receive an integer seed that determines the pseudo-randooom sequence generated by  these functions
* Two functions <tt>randFixed</tt> and <tt>randNormalFixed</tt> were added. While the usual <tt>rand</tt> functions generate a different result at every time-steps for these functions the pseudo-random sequence is determined '''only''' by the seed (not by the timestep)

</


===== Binary =min= and =max= =====
     Take the bigger/smaller of two fields. Helps avoid <tt>?:</tt>-operations


===== Allow writing of only volume-fields in =funkySetAreaFields= =====
     Application: If the results of the calculation are only needed in
     ParaView


===== Internal changes =====
* Use <tt>autoPtr</tt> for sets
* Update sets that change in memory or on disc

</


==== Bug-fixes ====


===== =funkySetAreaFields= did not check for the correct fields =====
     Fixed by Petr Vita


===== =surfaceProxy= uses the wrong geometric data =====


===== Avoid floating point exceptions with division of fields =====
     Calculated boundaries were $0$ and caused a division by zero


==== Packaging ====


===== Update Debian packaging =====
* Packaging information for the currently used OF-version is generated (allows a separate <tt>swak</tt>-package for every OF-version
* Submission to launchpad added

</


===== Deployment scripts =====
     Now install to <tt>FOAM_SITE_APPBIN/LIBBIN</tt>


=== 2011-10-03 ===


==== New features ====


===== =replayTransientBC= now supports multiple regions =====
     Uses the usual <tt>-region</tt>-option. Looks for a separate dictionary
     in the <tt>system</tt>-directory of that region


===== =replayTransientBC= allows execution of functionObjects =====
     This can be switched on using the <tt>allowFunctionObjects</tt>-option


===== =Python=-embedding =====
     Allows the execution of Python-Code in a functionObject

     This feature is still experimental and the organization of the
     libraries is subject to change


===== Global variables =====
     It is now possible to define variables that are 'global': They
     can be read in any entity. 

     Currently these variables can only be uniform.

     To access global variables the specification-dictionary has to
     have a <tt>wordList</tt> named <tt>globalScopes</tt>. The scopes are searched
     in that order for the names of global variables. Having scopes
     allows some kind of separation of the variables


===== Simplified boundary condition =groovyBCFixedValue= =====
     Added a boundary condition than allows to only fix the
     values. This should help to avoid problems with cases that don't
     like <tt>mixed</tt> (on which the regular <tt>groovyBC</tt> is based)


===== Function objects to solve PDEs =====
     Two function objects that solve ''Partial Differential Equations''
     during a run have been added:
* one that solves a laplacian (Poisson) equation
* one that solves the transport equation for a scalar

</
     The relevant coefficients (including explicit and implicit source
     terms) can be specified using expressions


==== Administrative and packaging ====


===== Inject =swak4Foam= into a distro =====
     Added a script that takes the current sources, copies them into
     the appropriate places of a <tt>OpenFOAM</tt>-installation and slightly
     rewrites them to compile in this place. What happens then
     (committing them into the repository or just plain compilation)
     is up to the maintainer


===== Absorb =simpleFunctionObjects= =====
     As many parts of <tt>swak4Foam</tt> depend on it the
     <tt>simpleFunctionObjects</tt> have now been absorbed into
     <tt>swak4Foam</tt>. They can still be compiled on their own


==== Bugfixes ====


===== Variables not working for parallel computations =====
     If a variable is defined and the patch which it is defined on
     doesn't have any faces the variable is reported on that processor
     as ''not existing'' and the whole run fails


=== 2012-01-04 ===


==== Cases changed ====


===== =circulatingSplash= =====
     Fixed according to a suggestion by Andreas Otto. Now runs again
     (used to crash some time-steps into the beginning)


==== Infrastructure ====


===== Check for correct =bison=-version =====
     The <tt>Allwmake</tt>-script now checks for the correct bison-version
     (and the existence of <tt>bison</tt>) and fails if it doesn't seem to be
     the right one


===== Supply a header with preprocessor-symbols about the used OF-version =====
     To allow distinguishing different OF-versions as discussed in the
     bug report
     [http://sourceforge.net/apps/mantisbt/openfoam-extend/view.php?id=114 http://sourceforge.net/apps/mantisbt/openfoam-extend/view.php?id=114]
     the <tt>Allwmake</tt>-script now generates a header file
     <tt>foamVersion4swak.H</tt> that defines the symbols
     <tt>FOAM_VERSION4SWAK_MAJOR</tt>, <tt>FOAM_VERSION4SWAK_MINOR</tt> and
     <tt>FOAM_VERSION4SWAK_PATCH</tt> 


==== Technical ====


===== Refactoring of the FieldDriver =====
* now can also produce surfaceFields
* full support of <tt>tensor</tt>, <tt>symmTensor</tt> and <tt>sphericalTensor</tt>

</


===== Refactoring of the FaFieldDriver =====
* now can also produce edgeFields

</
     No support for tensors yet


===== Writing of =storedVariables= =====
     If necessary (for instance <tt>swakExpression</tt>-functionObject) the
     <tt>storedVariables</tt> are written to disc (into a subdirectory
     <tt>swak4Foam</tt> of the timestep) and are reread at the start. This
     allows consistent restarts (for instance if a flow was summed
     using the variable) '''if the expressions stay the same'''.


===== =simpleFunctionObjects= now write vectors and tensors without brackets =====
     Data files can now be written without brackets but each component on
     its own. The number of entries in the header is not adjusted


==== New features ====


===== General =phi= in =solveTransportPDE= =====
     Due to the refactoring of the <tt>FieldDriver</tt> now <tt>phi</tt> can be
     specified by a general expression (instead of 'only' a
     field-name) 


===== =funkySetFields= now also writes surfaceFields =====
     Can write <tt>surfaceVector</tt> and <tt>surfaceScalar</tt>-Fields. Condition
     has to be consistent


===== Function objects now =surfaceField=-aware =====
     <tt>expressionField</tt> and <tt>manipulateField</tt> now can create or modify
     <tt>surfaceFields</tt> 


===== =funkySetFields= and function objects support tensors =====
     <tt>funkySetFields</tt> and the function objects <tt>expressionField</tt> and
     <tt>manipulateField</tt>  now also work with the three tensor-types


===== Extension of the =expressionToFace= =topoSet= =====
     If the expression evaluates to a <tt>surfaceField</tt> then this is used
     as a flag whether or not the face is in the <tt>faceSet</tt>. If the
     expression evaluates to a <tt>volScalarField</tt> then the old semantic
     applies (faces are in the set if one cell is <tt>true</tt> and the other
     is <tt>false</tt>).
     
     This only works for internal faces


===== =addGlobalVariable= allows setting more than one value =====
     If there is an entry <tt>globalVariables</tt> then this dictionary is
     used to set the variables


===== Function object =calculateGlobalVariables= =====
     Calculates variables and then pushes them to a global namespace


===== Generate a dummy =phi= in =replayTransientBC= =====
     New option added that generates a <tt>phi</tt> field with value $0$ to
     keep boundary conditions like <tt>inletOutlet</tt> happy


===== Function object to dump expression results =====
     The functionObject <tt>dumpSwakExpression</tt> dumps the complete
     results of a swakExpression to file at each timestep. This
     produces huge files and is therefor not endorsed


===== Additional options for =funkySetFields= =====
     Add the options <tt>allowFunctionObjects</tt> and <tt>addDummyPhi</tt> to
     execute functionObjects and add a <tt>phi</tt>-field (for fields that
     require these)


===== =simpleFunctionObjects= write CSV-files =====
     Setting the option <tt>outputFileMode</tt> to <tt>csv</tt> writes
     CSV-files. The option-value <tt>foam</tt> is the default (old style). The
     option-value <tt>raw</tt> writes the values delimited by spaces (no
     brackets for vectors and tensors)


===== Submeshes automatically read if =searchOnDisc= specified =====
     If a submesh is not yet in memory and the option <tt>searchOnDisc</tt>
     is set, the mesh is automatically read into memory and kept there


===== Conditional =functionObjects= =====
     The <tt>simpleFunctionObjects</tt>-library now has a number of
     functionObjects that allow the conditional execution of a list of
     function objects.

     These are
#executeIfExecutableFits if the name of the executable fits a regular expression the function objects are executed
#executeIfObjectExists if a named object exists (or alternatively: doesn't exist) in the registry execute the function objects. Type checking also implemented
#executeIfEnvironmentVariable execute if an environment variable satisfies a certain condition (exists, doesn't exist, fits a regular expression)
#executeIfFunctionObjectPresent execute if a specific functionObject is present. This can help prevent failures if a functionObject is missing for technical reasons

</
     In addition the <tt>simpleSwakFunctionObjects</tt>-library has
#executeIfSwakObject Evaluates a logical swak-expression. The results are either accumulated using logical ''or'' (if '''one''' value is true the result will be true) or logical ''and'' (all values have to be true)

</
     The <tt>pythonIntegration</tt>-library has
#executeIfPython Evaluates a Python-code-snipplet that returns a value. If this value is "true" in Pythons standards then the functionObjects are executed

</


===== =functionObject= that reads gravitation =====
     <tt>simpleFunctionObjects</tt> has an additional function object that
     reads the direction of gravitation. The purpose is to assist
     boundary conditions like <tt>buoyantPressure</tt> that rely on it to
     work. Best used together with conditional function objects ("If
     <tt>g</tt> is missing ....")


===== PDE-functionObjects for =finiteArea= =====
     Solve transport and laplacian equation


===== =funkySetAreaField= now also writes edgeFields =====
     Similar to the <tt>surfaceFields</tt> in <tt>funkySetFields</tt>


==== Bug fixes ====


===== Compilation with Intel-Compiler possible =====
     The <tt>Utilities</tt> failed with the Intel-compiler. Compilation now
     falls back to good old <tt>g++</tt>


===== Access to tensor-components not working =====
     Because the tokens were not defined in the <tt>flex</tt>-files getting
     tensor components with <tt>tensor.xx</tt> did not work. Fixed


===== Constants for surfaceFields not working =====
     Because surfaceFields know no <tt>zeroGradient</tt> the template
     <tt>makeConstant</tt> did not work


===== =snGrad= does not work for patches if the file is on disc =====
     Change so that the field gets temporarily loaded to calculate the
     gradient on the patch. Same for <tt>internalField</tt> and
     <tt>neighbourField</tt>


===== =potentialFoam= does not correctly use a =groovyBC= =====
     The reason is that <tt>groovyBC</tt> usually doesn't get evaluated
     during construction. The reason is that it is hard to tell
     whether all required fields are already in memory. The current
     fix is a workaround: setting <tt>evaluateDuringConstruction</tt> to
     <tt>true</tt> forces the BC to be evaluated during construction


===== Extra evaluation of boundary conditions causes failure =====
     Extra evaluation of boundary condition that should fix the
     problem with <tt>calculated</tt> patches causes <tt>funkySetFields</tt> to fail
     with stock boundary conditions if not all fields are present in
     memory 


=== Next release ===