doc/man/manTemplates/PDRFoam.1.in

   1 '\" t
   2 .\"     Title: @UP@PDRFOAM
   3 .\"    Author: [see the "AUTHOR" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
   5 .\"      Date: 07/25/2009
   6 .\"    Manual: FreeFOAM Manual
   7 .\"    Source: FreeFOAM @FF_VERSION_FULL@
   8 .\"  Language: English
   9 .\"
  10 .TH "@UP@PDRFOAM" "1" "07/25/2009" "FreeFOAM @FF_VERSION_FULL@" "FreeFOAM Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 @EXECUTABLE_PREFIX@PDRFoam \- Compressible premixed/partially\-premixed combustion solver with turbulence modelling\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@PDRFoam\fR [\-case \fI<dir>\fR] [\-parallel] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 Combusting RANS code using the b\-Xi two\-equation model\&. Xi may be obtained by either the solution of the Xi transport equation or from an algebraic exression\&. Both approaches are based on Gulder\(cqs flame speed correlation which has been shown to be appropriate by comparison with the results from the spectral model\&.
  29 .sp
  30 Strain effects are encorporated directly into the Xi equation but not in the algebraic approximation\&. Further work need to be done on this issue, particularly regarding the enhanced removal rate caused by flame compression\&. Analysis using results of the spectral model will be required\&.
  31 .sp
  32 For cases involving very lean Propane flames or other flames which are very strain\-sensitive, a transport equation for the laminar flame speed is present\&. This equation is derived using heuristic arguments involving the strain time scale and the strain\-rate at extinction\&. the transport velocity is the same as that for the Xi equation\&.
  33 .sp
  34 For large flames e\&.g\&. explosions additional modelling for the flame wrinkling due to surface instabilities may be applied\&.
  35 .sp
  36 PDR (porosity/distributed resistance) modelling is included to handle regions containing blockages which cannot be resolved by the mesh\&.
  37 .SH "OPTIONS"
  38 .PP
  39 \fB\-case\fR \fI<dir>\fR
  40 .RS 4
  41 Specify the case directory
  42 .RE
  43 .PP
  44 \fB\-parallel\fR
  45 .RS 4
  46 Run the case in parallel
  47 .RE
  48 .PP
  49 \fB\-help\fR
  50 .RS 4
  51 Display short usage message
  52 .RE
  53 .PP
  54 \fB\-doc\fR
  55 .RS 4
  56 Display Doxygen documentation page
  57 .RE
  58 .PP
  59 \fB\-srcDoc\fR
  60 .RS 4
  61 Display source code
  62 .RE
  63 .SH "SEE ALSO"
  64 .sp
  65 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  66 .SH "AUTHOR"
  67 .sp
  68 OpenCFD Ltd\&.
  69 .SH "FREEFOAM"
  70 .sp
  71 Part of the \fBfreefoam\fR(7) suite\&.
  72 .SH "COPYRIGHT"
  73 .SS "Copyright \(co 2009 Michael Wild\&."
  74 .sp
  75 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1\&.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front\-Cover Texts, and no Back\-Cover Texts\&. A copy of the license is available from http://www\&.gnu\&.org/copyleft/fdl\&.html
  76 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
  77 .sp
  78 OpenFOAM 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\&. A copy of the license is available from http://www\&.gnu\&.org/licenses/old\-licenses/gpl\-2\&.0\&.html
  79 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
  80 .sp
  81 FreeFOAM 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\&. A copy of the license is available from http://www\&.gnu\&.org/licenses/old\-licenses/gpl\-2\&.0\&.html