Skip to content
Snippets Groups Projects
  1. May 18, 2017
  2. Sep 20, 2016
  3. Jun 29, 2016
  4. May 28, 2016
    • Henry Weller's avatar
      postProcessing: Replaced 'foamCalc' and the 'postCalc' utilities · e4dc50dc
      Henry Weller authored
      with the more general and flexible 'postProcess' utility and '-postProcess' solver option
      
      Rationale
      ---------
      
      Both the 'postProcess' utility and '-postProcess' solver option use the
      same extensive set of functionObjects available for data-processing
      during the run avoiding the substantial code duplication necessary for
      the 'foamCalc' and 'postCalc' utilities and simplifying maintenance.
      Additionally consistency is guaranteed between solver data processing
      and post-processing.
      
      The functionObjects have been substantially re-written and generalized
      to simplify development and encourage contribution.
      
      Configuration
      -------------
      
      An extensive set of simple functionObject configuration files are
      provided in
      
      OpenFOAM-dev/etc/caseDicts/postProcessing
      
      and more will be added in the future.  These can either be copied into
      '<case>/system' directory and included into the 'controlDict.functions'
      sub-dictionary or included directly from 'etc/caseDicts/postProcessing'
      using the '#includeEtc' directive or the new and more convenient
      '#includeFunc' directive which searches the
      '<etc>/caseDicts/postProcessing' directories for the selected
      functionObject, e.g.
      
      functions
      {
          #includeFunc Q
          #includeFunc Lambda2
      }
      
      '#includeFunc' first searches the '<case>/system' directory in case
      there is a local configuration.
      
      Description of #includeFunc
      ---------------------------
      
          Specify a functionObject dictionary file to include, expects the
          functionObject name to follow (without quotes).
      
          Search for functionObject dictionary file in
          user/group/shipped directories.
          The search scheme allows for version-specific and
          version-independent files using the following hierarchy:
          - \b user settings:
            - ~/.OpenFOAM/\<VERSION\>/caseDicts/postProcessing
            - ~/.OpenFOAM/caseDicts/postProcessing
          - \b group (site) settings (when $WM_PROJECT_SITE is set):
            - $WM_PROJECT_SITE/\<VERSION\>/caseDicts/postProcessing
            - $WM_PROJECT_SITE/caseDicts/postProcessing
          - \b group (site) settings (when $WM_PROJECT_SITE is not set):
            - $WM_PROJECT_INST_DIR/site/\<VERSION\>/caseDicts/postProcessing
            - $WM_PROJECT_INST_DIR/site/caseDicts/postProcessing
          - \b other (shipped) settings:
            - $WM_PROJECT_DIR/etc/caseDicts/postProcessing
      
          An example of the \c \#includeFunc directive:
          \verbatim
              #includeFunc <funcName>
          \endverbatim
      
      postProcess
      -----------
      
      The 'postProcess' utility and '-postProcess' solver option provide the
      same set of controls to execute functionObjects after the run either by
      reading a specified set of fields to process in the case of
      'postProcess' or by reading all fields and models required to start the
      run in the case of '-postProcess' for each selected time:
      
      postProcess -help
      
      Usage: postProcess [OPTIONS]
      options:
        -case <dir>       specify alternate case directory, default is the cwd
        -constant         include the 'constant/' dir in the times list
        -dict <file>      read control dictionary from specified location
        -field <name>     specify the name of the field to be processed, e.g. U
        -fields <list>    specify a list of fields to be processed, e.g. '(U T p)' -
                          regular expressions not currently supported
        -func <name>      specify the name of the functionObject to execute, e.g. Q
        -funcs <list>     specify the names of the functionObjects to execute, e.g.
                          '(Q div(U))'
        -latestTime       select the latest time
        -newTimes         select the new times
        -noFunctionObjects
                          do not execute functionObjects
        -noZero           exclude the '0/' dir from the times list, has precedence
                          over the -withZero option
        -parallel         run in parallel
        -region <name>    specify alternative mesh region
        -roots <(dir1 .. dirN)>
                          slave root directories for distributed running
        -time <ranges>    comma-separated time ranges - eg, ':10,20,40:70,1000:'
        -srcDoc           display source code in browser
        -doc              display application documentation in browser
        -help             print the usage
      
       pimpleFoam -postProcess -help
      
      Usage: pimpleFoam [OPTIONS]
      options:
        -case <dir>       specify alternate case directory, default is the cwd
        -constant         include the 'constant/' dir in the times list
        -dict <file>      read control dictionary from specified location
        -field <name>     specify the name of the field to be processed, e.g. U
        -fields <list>    specify a list of fields to be processed, e.g. '(U T p)' -
                          regular expressions not currently supported
        -func <name>      specify the name of the functionObject to execute, e.g. Q
        -funcs <list>     specify the names of the functionObjects to execute, e.g.
                          '(Q div(U))'
        -latestTime       select the latest time
        -newTimes         select the new times
        -noFunctionObjects
                          do not execute functionObjects
        -noZero           exclude the '0/' dir from the times list, has precedence
                          over the -withZero option
        -parallel         run in parallel
        -postProcess      Execute functionObjects only
        -region <name>    specify alternative mesh region
        -roots <(dir1 .. dirN)>
                          slave root directories for distributed running
        -time <ranges>    comma-separated time ranges - eg, ':10,20,40:70,1000:'
        -srcDoc           display source code in browser
        -doc              display application documentation in browser
        -help             print the usage
      
      The functionObjects to execute may be specified on the command-line
      using the '-func' option for a single functionObject or '-funcs' for a
      list, e.g.
      
      postProcess -func Q
      postProcess -funcs '(div(U) div(phi))'
      
      In the case of 'Q' the default field to process is 'U' which is
      specified in and read from the configuration file but this may be
      overridden thus:
      
      postProcess -func 'Q(Ua)'
      
      as is done in the example above to calculate the two forms of the divergence of
      the velocity field.  Additional fields which the functionObjects may depend on
      can be specified using the '-field' or '-fields' options.
      
      The 'postProcess' utility can only be used to execute functionObjects which
      process fields present in the time directories.  However, functionObjects which
      depend on fields obtained from models, e.g. properties derived from turbulence
      models can be executed using the '-postProcess' of the appropriate solver, e.g.
      
      pisoFoam -postProcess -func PecletNo
      
      or
      
      sonicFoam -postProcess -func MachNo
      
      In this case all required fields will have already been read so the '-field' or
      '-fields' options are not be needed.
      
      Henry G. Weller
      CFD Direct Ltd.
      e4dc50dc
  5. May 16, 2016
  6. May 12, 2016
    • Henry Weller's avatar
      Standardized the naming of functions which control the writing of fields etc. · 6164c2f2
      Henry Weller authored
      to have the prefix 'write' rather than 'output'
      
      So outputTime() -> writeTime()
      
      but 'outputTime()' is still supported for backward-compatibility.
      
      Also removed the redundant secondary-writing functionality from Time
      which has been superseded by the 'writeRegisteredObject' functionObject.
      6164c2f2
    • Henry Weller's avatar
      functionObjects: Changed options 'outputControl' -> 'writeControl' and... · c983670c
      Henry Weller authored
      functionObjects: Changed options 'outputControl' -> 'writeControl' and 'outputInterval' -> 'writeInterval'
      
      for consistency with the time controls in controlDict and to avoid
      unnecessary confusion.  All code and tutorials have been updated.
      
      The old names 'outputControl' and 'outputInterval' are but supported for
      backward compatibility but deprecated.
      c983670c
  7. Dec 22, 2015
  8. Dec 09, 2015
  9. Jul 21, 2015
  10. Dec 11, 2014
  11. Feb 17, 2014
  12. Feb 03, 2014
  13. Sep 11, 2013
  14. Sep 21, 2012
  15. Sep 20, 2012
  16. Aug 14, 2011
  17. Jun 17, 2011
  18. Jun 08, 2011
  19. Jun 07, 2011
  20. Apr 05, 2011
  21. Mar 17, 2011
  22. Sep 29, 2010
  23. Jun 23, 2010
  24. Apr 09, 2010
  25. Jul 23, 2009
  26. Jul 09, 2009
  27. Jun 24, 2009
  28. Feb 18, 2009
    • Andrew Heather's avatar
      updates · 181f2522
      Andrew Heather authored
      181f2522
    • Mark Olesen's avatar
      use while (runTime.loop() { .. } where possible in solvers · 4b60453c
      Mark Olesen authored
      - change system/controlDict to use functions {..} instead of functions (..);
        * This is internally more efficient
      - fixed formatting of system/controlDict functions entry
      
      - pedantic change: use 'return 0' instead of 'return(0)' in the applications,
        since return is a C/C++ keyword, not a function.
      4b60453c
  29. Feb 13, 2009
  30. Feb 12, 2009
  31. Feb 11, 2009
  32. Oct 20, 2008
  33. Jul 02, 2008
  34. Jul 01, 2008
  35. Jun 25, 2008