doc/man/manSource/clearPolyMesh.1.in.txt

   1 = @FOAM_UPPER_EXE_PREFIX@CLEARPOLYMESH(1) =
   2 :mansource: @PROJECT_NAME@
   3 :manversion: @FOAM_VERSION_FULL@
   4 :manmanual: @PROJECT_NAME@ Manual
   5
   6 NAME
   7 ----
   8 @FOAM_EXE_PREFIX@clearPolyMesh - Remove the contents of the constant/polyMesh directory as per the +Foam::polyMesh::removeFiles()+ method.
   9
  10 SYNOPSIS
  11 --------
  12 *@LOWER_PROJECT_NAME@ clearPolyMesh* [-case '<caseDir>'] [-region '<regionName>'] [-h | -help]
  13
  14 DESCRIPTION
  15 -----------
  16 Removes the files
  17 - 'points'
  18 - 'faces'
  19 - 'owner'
  20 - 'neighbour'
  21 - 'cells'
  22 - 'boundary'
  23 - 'pointZones'
  24 - 'faceZones'
  25 - 'cellZones'
  26 - 'meshModifiers'
  27 - 'parallelData'
  28 - 'sets'
  29 from the '<caseDir>/constant/<regionName>/polyMesh' directory. '<caseDir>'
  30 defaults to the current working directory and can be specified with *-case*.
  31 '<regionName>' is the empty string by default and can be set with the *-region*
  32 option.
  33
  34 OPTIONS
  35 -------
  36 *-case* '<caseDir>'::
  37   Case from which to clear the mesh data
  38 *-region* '<regionName>'::
  39   Mesh region to clear (e.g. '<caseDir>/constant/<regionName>/polyMesh')
  40 *-h | -help*::
  41   Display an option summary
  42
  43 SEE ALSO
  44 --------
  45 An overview of @PROJECT_NAME@ is given in linkff:@LOWER_PROJECT_NAME@[1].
  46
  47 AUTHOR
  48 ------
  49 OpenCFD Ltd.
  50
  51 FREEFOAM
  52 --------
  53 Part of the linkff:@LOWER_PROJECT_NAME@[1] suite.
  54
  55 COPYRIGHT
  56 ---------
  57 * Copyright (C) 1991-2010 OpenCFD Ltd.
  58 * Copyright (C) 2008-2011 Michael Wild.
  59
  60 /////////////////////////////////////////////////////////
  61 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
  62 /////////////////////////////////////////////////////////