.TH "FOAMTOVTK" 1 "OpenFOAM-" "www.openfoam.com" "OpenFOAM Commands Manual"
.SH "NAME"
foamToVTK \- part of \fBOpenFOAM\fR (The Open Source CFD Toolbox).
.SH "SYNOPSIS"
\fBfoamToVTK\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.nf
General OpenFOAM to VTK file writer
.fi
.SH "OPTIONS"
.TP
\fB\-allRegions\fR
Operate on all regions in regionProperties
.TP
\fB\-ascii\fR
Write in ASCII format instead of binary
.TP
\fB\-case\fR \fIdir\fR
Specify case directory to use (instead of the cwd)
.TP
\fB\-constant\fR
Include the 'constant/' dir in the times list
.TP
\fB\-fields\fR \fIwordRes\fR
Specify single or multiple fields to write (all by default)
Eg, 'T' or '(p T U "alpha.*")'
.TP
\fB\-latestTime\fR
Select the latest time
.TP
\fB\-name\fR \fIsubdir\fR
Directory name for VTK output (default: 'VTK')
.TP
\fB\-no-boundary\fR
Suppress output for boundary patches
.TP
\fB\-no-internal\fR
Suppress output for internal volume mesh
.TP
\fB\-no-lagrangian\fR
Suppress writing lagrangian positions and fields
.TP
\fB\-no-point-data\fR
Suppress conversion of pointFields. No interpolated PointData.
.TP
\fB\-noZero\fR
Exclude the '0/' dir from the times list
.TP
\fB\-one-boundary\fR
Combine all patches into a single file
.TP
\fB\-overwrite\fR
Remove any existing VTK output directory
.TP
\fB\-parallel\fR
Run in parallel
\fB[Parallel option]\fR
.TP
\fB\-patches\fR \fIwordRes\fR
Specify single patch or multiple patches to write
Eg, 'top' or '( front ".*back" )'
.TP
\fB\-region\fR \fIname\fR
Specify alternative mesh region
.TP
\fB\-regions\fR \fIwordRes\fR
Operate on selected regions from regionProperties.
Eg, '( gas "solid.*" )'
.TP
\fB\-time\fR \fIranges\fR
List of ranges. Eg, ':10,20 40:70 1000:', 'none', etc
.TP
\fB\-doc\fR
Display documentation in browser
.TP
\fB\-help\fR
Display short help and exit
.TP
\fB\-help-full\fR
Display full help and exit
.SS "ADVANCED OPTIONS"
.TP
\fB\-cellSet\fR \fIname\fR
Convert mesh subset corresponding to specified cellSet
.TP
\fB\-cellZone\fR \fIname\fR
Convert mesh subset corresponding to specified cellZone
.TP
\fB\-debug-switch\fR \fIname=val\fR
Specify the value of a registered debug switch. Default is 1 if the value is
omitted. (Can be used multiple times)
.TP
\fB\-decomposeParDict\fR \fIfile\fR
Use specified file for decomposePar dictionary
.TP
\fB\-excludePatches\fR \fIwordRes\fR
Specify single patch or multiple patches to exclude from writing. Eg, 'outlet'
or '( inlet ".*Wall" )'
.TP
\fB\-faceSet\fR \fIname\fR
Convert specified faceSet only
.TP
\fB\-faceZones\fR \fIwordRes\fR
Specify single or multiple faceZones to write
Eg, 'cells' or '( slice "mfp-.*" )'.
.TP
\fB\-fileHandler\fR \fIhandler\fR
Override the file handler type
.TP
\fB\-finiteAreaFields\fR
Write finite area fields
.TP
\fB\-hostRoots\fR \fI((host1 dir1) .. (hostN dirN))\fR
Per-host slave root directories for distributed running. The host specification
can be a regex.
\fB[Parallel option]\fR
.TP
\fB\-info-switch\fR \fIname=val\fR
Specify the value of a registered info switch. Default is 1 if the value is
omitted. (Can be used multiple times)
.TP
\fB\-legacy\fR
Write legacy format instead of xml
.TP
\fB\-lib\fR \fIname\fR
Additional library or library list to load (can be used multiple times)
.TP
\fB\-nearCellValue\fR
Use cell value on patches instead of patch value itself
.TP
\fB\-noFunctionObjects\fR
Do not execute function objects
.TP
\fB\-opt-switch\fR \fIname=val\fR
Specify the value of a registered optimisation switch (int/bool). Default is 1
if the value is omitted. (Can be used multiple times)
.TP
\fB\-pointSet\fR \fIname\fR
Convert specified pointSet only
.TP
\fB\-poly-decomp\fR
Decompose polyhedral cells into tets/pyramids
.TP
\fB\-processor-fields\fR
Write field values on processor boundaries only
.TP
\fB\-roots\fR \fI(dir1 .. dirN)\fR
Slave root directories for distributed running
\fB[Parallel option]\fR
.TP
\fB\-surfaceFields\fR
Write surfaceScalarFields (eg, phi)
.TP
\fB\-with-ids\fR
Additional mesh id fields (cellID, procID, patchID)
.TP
\fB\-with-point-ids\fR
Additional pointID field for internal mesh
.TP
\fB\-doc-source\fR
Display source code in browser
.TP
\fB\-help-compat\fR
Display compatibility options and exit
.TP
\fB\-help-man\fR
Display full help (manpage format) and exit
.TP
\fB\-help-notes\fR
Display help notes (description) and exit
.SS "COMPATIBILITY OPTIONS"
.TP
\fB\-allPatches\fR (now \fB\-one-boundary\fR)
The option was last used in 1806.
.TP
\fB\-noLagrangian\fR (now \fB\-no-lagrangian\fR)
The option was last used in 1806.
.TP
\fB\-noPointValues\fR (now \fB\-no-point-data\fR)
The option was last used in 1806.
.TP
\fB\-noFaceZones\fR
This option is ignored after 1806.
.TP
\fB\-noLinks\fR
This option is ignored after 1806.
.TP
\fB\-poly\fR
This option is ignored after 1806.
.TP
\fB\-useTimeName\fR
This option is ignored after 1806.
.TP
\fB\-xml\fR
This option is ignored after 1806.
.SH "SEE ALSO"
Online documentation https://www.openfoam.com/documentation/
.SH COPYRIGHT
Copyright \(co 2018-2019 OpenCFD Ltd.