doc/man/manTemplates/interPhaseChangeFoam.1.in

   1 '\" t
   2 .\"     Title: @UP@INTERPHASECHANGEFOAM
   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@INTERPHASECHANGEFOAM" "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@interPhaseChangeFoam \- Solver for 2 incompressible, isothermal immiscible fluids with phase\-change (e\&.g\&. cavitation)\&.
  23 .SH "SYNOPSIS"
  24 .sp
  25 \fB@EXECUTABLE_PREFIX@interPhaseChangeFoam\fR [\-case \fI<dir>\fR] [\-parallel] [\-help] [\-doc] [\-srcDoc] [\-help] [\-doc] [\-srcDoc]
  26 .SH "DESCRIPTION"
  27 .sp
  28 Uses a VOF (volume of fluid) phase\-fraction based interface capturing approach\&. The momentum and other fluid properties are of the "mixture" and a single momentum equation is solved\&.
  29 .sp
  30 The set of phase\-change models provided are designed to simulate cavitation but other mechanisms of phase\-change are supported within this solver framework\&.
  31 .SH "OPTIONS"
  32 .PP
  33 \fB\-case\fR \fI<dir>\fR
  34 .RS 4
  35 Specify the case directory
  36 .RE
  37 .PP
  38 \fB\-parallel\fR
  39 .RS 4
  40 Run the case in parallel
  41 .RE
  42 .PP
  43 \fB\-help\fR
  44 .RS 4
  45 Display short usage message
  46 .RE
  47 .PP
  48 \fB\-doc\fR
  49 .RS 4
  50 Display Doxygen documentation page
  51 .RE
  52 .PP
  53 \fB\-srcDoc\fR
  54 .RS 4
  55 Display source code
  56 .RE
  57 .SH "SEE ALSO"
  58 .sp
  59 An overview of FreeFOAM is given in \fBfreefoam\fR(7)\&. For information on the configuration of FreeFOAM, refer to \fBfreefoam-config\fR(7)\&.
  60 .SH "AUTHOR"
  61 .sp
  62 OpenCFD Ltd\&.
  63 .SH "FREEFOAM"
  64 .sp
  65 Part of the \fBfreefoam\fR(7) suite\&.
  66 .SH "COPYRIGHT"
  67 .SS "Copyright \(co 2009 Michael Wild\&."
  68 .sp
  69 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
  70 .SS "Copyright \(co 1991\-2009 OpenCFD Ltd\&."
  71 .sp
  72 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
  73 .SS "Copyright \(co 2008\-2009 Michael Wild\&."
  74 .sp
  75 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