Tree [e6bb66] default release2010-12-18 version_0.1.1 /
 History

Read Only access


File Date Author Commit
 Examples 2010-12-18 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [2bad85] Merge in new examples
 Libraries 2010-12-14 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [4c533a] Otherwise it fails for older compilers
 Utilities 2010-10-29 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [c058b2] Clean everything
 .hgignore 2010-08-03 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [c60b6e] Vergiss die Daten
 .hgtags 2010-09-24 Bernhard Gschaider Bernhard Gschaider [26903f] Merge
 Allwclean 2010-10-29 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [c058b2] Clean everything
 Allwmake 2010-07-18 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [b86688] Uebernahme von funkySetFields (ohne Test)
 COPYING 2010-12-14 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [a26d85] Adding GPL
 Doxyfile 2010-12-13 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [631a5c] Merge sampledSurfaces into main tree
 README 2010-12-18 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [e6bb66] Added description of new features (this constit...
 copySwakFilesToGlobal.sh 2010-12-18 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [2bad85] Merge in new examples
 removeSwakFilesFromGlobal.sh 2010-12-18 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [2bad85] Merge in new examples
 theFiles.sh 2010-12-18 Bernhard F.W. Gschaider Bernhard F.W. Gschaider [2bad85] Merge in new examples

Read Me

# -*- mode: org -*-
* Description
  A collection of libraries and tools that let the user handle
  OpenFOAM-data based on expressions
* Contributors etc
** Original Author
   Bernhard Gschaider (bgschaid@ice-sf.at)
** Current Maintainer
   Bernhard Gschaider (bgschaid@ice-sf.at)
** Contributors
   /None yet/
** Documentation
   See: 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 compiler generators =bison= and =flex=
   - =simpleSwakFunctionObjects= needs the =simpleFunctionObjects=
     (see
     http://openfoamwiki.net/index.php/Contrib_simpleFunctionObjects)
     all other functionality has no additional requirements
     (=simpleSwakFunctionObjects= is only required by some examples)
     It is assumed that the sources are installed at
     =$WM_PROJECT_USER_DIR/Libraries/simpleFunctionObjects= 
** Building
  =wmake all= at the base directory should build all the libraries and
  tools.

  The main library =swak4FoamParsers= can't be built in parallel (no
  values of =WM_NCOMPPROCS= bigger than 1)
** Global installation
   If the libraries and utilities are considered stable and the should
   be available to everyone (without having to recompile them) the
   script =copySwakFilesToGlobal.sh= can be used to copy them to the
   global directories.

   The script =removeSwakFilesFromGlobal.sh= removes all these files
   from the global directories
* Contents
** Libraries
   Collection of Libraries
*** =swak4FoamParsers=
    The basis of =swak4Foam=: the expression parsers with the logic to
    access the /OpenFOAM/ data-structures.

    None of the other software pieces compile without it
*** =groovyBC=
    Implements the infamous =groovyBC=. 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
*** =simpleSwakFunctionObjects=
    Function objects based on the =simpleFunctionObjects=-library
    (which is a prerequisite for compiling it).

    Evaluate expressions and output the results
*** =swakSourceFields=
    Field that is calculated from an expression. To be used as
    source-term or coefficient in some solver
*** =swakTopoSources=
    =topoSources= for =cellSet= and =faceSet=. Can be used with the
    =cellSet= and =faceSet=-utilities 
** Utilities
*** =funkySetFields=
    Utility that allows creation and manipulation of files with
    expressions 
*** =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
** Examples
   If not otherwise noted cases are prepared by a simple
   =blockMesh=-call.

   *All the cases here are strictly for demonstration purposes and
    resemble nothing from the 'real world'*
*** groovyBC
    The old =groovyBC=-Demos
**** pulsedPitzDaily
    - Solver :: pisoFoam
    - Also demonstrates :: =manipulateField=, =expressionField= and
         =clearField= from the
         =swakFunctionObjects=. =patchExpression= from
         =simpleSwakFunctionObjects=. 
**** wobbler
    - Solver :: solidDisplacementFoam
**** circulatingSplash 
    - Solver :: interDyMFoam 
    - Remark :: this one crashes halfway through the calculation. If
                you can fix it: Be my guest
**** movingConeDistorted
    - Solver :: pimpleDyMFoam
    - Also demonstrates :: =swakExpression= with =surface=. Due to a
      problem described below this currently doesn't work
**** average-t-junction
    - Solver :: pimpleFoam
**** multiRegionHeaterFeedback
    - Solver :: chtMultiRegionFoam
    - Mesh preparation :: Execute the script =prepare.sh= in that
         directory 
    - Also demonstrated :: =patchExpression= and =swakExpression= from
         =simpleSwakFunctionObjects=. 
*** FunkySetFields
    Example dictionary for =funkySetFields=
*** FunkySetBoundaryFields
    Example dictionary for =funkySetBoundaryFields=. Sets nonsense
    boundary conditions for the world famous =damBreak=-case
*** InterFoamWithSources
    Demonstrates usage of =swakSourceFields=
**** =interFoamWithSources=
     Slightly modified version of =interFoam=. 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 =prepare.sh= to prepare the case
*** other
    Cases that don't have a =groovyBC=
**** =angledDuctImplicit=
     - Solver :: rhoPorousSimpleFoam
     - Mesh preparation :: Execute the =makeMesh.sh=-script in that
          directory. If you want to run in parallel call the
          =decomposeMesh.sh=-script with the number of processors as
          an argument
     - Demonstrates :: Usage of the =swakTopoSources=. Compares
          different approaches to evaluating with the
          =swakExpression=-functionObject
**** =capillaryRise=
     - Solver :: interFoam
     - Case preparation :: run the supplied script =prepareCase.sh=
     - Demonstrates :: Usage of a sampled surface to track the
                       interface in a VOF-simulation
* Copyright
  =swak4Foam= 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
** Moving meshes and =sampledSurfaces= 
   It seems that with moving meshes =sampledSurfaces= don't get
   updated. This seems to be a problem with OpenFOAM itself (the
   regular =surfaces=-functionObject doesn't get updated. This is
   currently investigated
* History
** 2010-09-13
   First Release
** 2010-12-18
   New release
   Most importannt changes
*** Parser for =sampledSurfaces=
    Now expressions for the field on a sampled surface can be
    evaluated. All =sampledSurfaces= offered by OpenFOAM now can be
    used 
*** Multiline =variables=
    The =variables= entry (most notably used in =groovyBC= and
    =swakExpression=) 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 =$FOAM_USER_APPBIN= is before =$FOAM_APPBIN= in the
    =$PATH= 
*** Parsers using 'external variables' are now run-time selectable
    This allows the inclusion of other parsers with the regular
    =swak4Foam= parsers and include them seamlessly with the
    =variables=-mechanism for 'externals' (in other words: you can add
    your own parser in a separate library without having to change
    anything about the overall =swak4Foam=, but it behaves as if it
    was part of it)

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks