foamToVTK1

Part of openfoam (the open source cfd toolbox).

Usage

foamToVTK [OPTIONS]

Overview

General OpenFOAM to VTK file writer

Options

-allRegions: Operate on all regions in regionProperties

-ascii: Write in ASCII format instead of binary

-case dir: Specify case directory to use (instead of the cwd)

-constant: Include the 'constant/' dir in the times list

-fields wordRes: Specify single or multiple fields to write (all by default) Eg, 'T' or '(p T U "alpha.*")'

-latestTime: Select the latest time

-name subdir: Directory name for VTK output (default: 'VTK')

-no-boundary: Suppress output for boundary patches

-no-internal: Suppress output for internal volume mesh

-no-lagrangian: Suppress writing lagrangian positions and fields

-no-point-data: Suppress conversion of pointFields. No interpolated PointData.

-noZero: Exclude the '0/' dir from the times list

-one-boundary: Combine all patches into a single file

-overwrite: Remove any existing VTK output directory

-parallel: Run in parallel [Parallel option]

-patches wordRes: Specify single patch or multiple patches to write Eg, 'top' or '( front ".*back" )'

-region name: Specify alternative mesh region

-regions wordRes: Operate on selected regions from regionProperties. Eg, '( gas "solid.*" )'

-time ranges: List of ranges. Eg, ':10,20 40:70 1000:', 'none', etc

-doc: Display documentation in browser

-help: Display short help and exit

-help-full: Display full help and exit

Advanced options

-cellSet name: Convert mesh subset corresponding to specified cellSet

-cellZone name: Convert mesh subset corresponding to specified cellZone

-debug-switch name=val: Specify the value of a registered debug switch. Default is 1 if the value is omitted. (Can be used multiple times)

-decomposeParDict file: Use specified file for decomposePar dictionary

-excludePatches wordRes: Specify single patch or multiple patches to exclude from writing. Eg, 'outlet' or '( inlet ".*Wall" )'

-faceSet name: Convert specified faceSet only

-faceZones wordRes: Specify single or multiple faceZones to write Eg, 'cells' or '( slice "mfp-.*" )'.

-fileHandler handler: Override the file handler type

-finiteAreaFields: Write finite area fields

-hostRoots ((host1 dir1) .. (hostN dirN)): Per-host slave root directories for distributed running. The host specification can be a regex. [Parallel option]

-info-switch name=val: Specify the value of a registered info switch. Default is 1 if the value is omitted. (Can be used multiple times)

-legacy: Write legacy format instead of xml

-lib name: Additional library or library list to load (can be used multiple times)

-nearCellValue: Use cell value on patches instead of patch value itself

-noFunctionObjects: Do not execute function objects

-opt-switch name=val: Specify the value of a registered optimisation switch (int/bool). Default is 1 if the value is omitted. (Can be used multiple times)

-pointSet name: Convert specified pointSet only

-poly-decomp: Decompose polyhedral cells into tets/pyramids

-processor-fields: Write field values on processor boundaries only

-roots (dir1 .. dirN): Slave root directories for distributed running [Parallel option]

-surfaceFields: Write surfaceScalarFields (eg, phi)

-with-ids: Additional mesh id fields (cellID, procID, patchID)

-with-point-ids: Additional pointID field for internal mesh

-doc-source: Display source code in browser

-help-compat: Display compatibility options and exit

-help-man: Display full help (manpage format) and exit

-help-notes: Display help notes (description) and exit

Compatibility options

-allPatches (now -one-boundary): The option was last used in 1806.

-noLagrangian (now -no-lagrangian): The option was last used in 1806.

-noPointValues (now -no-point-data): The option was last used in 1806.

-noFaceZones: This option is ignored after 1806.

-noLinks: This option is ignored after 1806.

-poly: This option is ignored after 1806.

-useTimeName: This option is ignored after 1806.

-xml: This option is ignored after 1806.

History

Debian 13 (Trixie) to Debian 11 (Bullseye): the text shown here
Debian 10 (Buster)
Debian 9 (Stretch)

-allRegions since Debian 10 (Buster); -ascii since Debian 10 (Buster); -case since Debian 10 (Buster); -cellSet since Debian 10 (Buster); -cellZone since Debian 10 (Buster); -constant since Debian 10 (Buster); -debug-switch since Debian 11 (Bullseye); -decomposeParDict since Debian 10 (Buster); -doc since Debian 10 (Buster); -doc-source since Debian 10 (Buster); -excludePatches since Debian 10 (Buster); -faceSet since Debian 10 (Buster); -faceZones since Debian 10 (Buster); -fields since Debian 10 (Buster); -fileHandler since Debian 10 (Buster); -finiteAreaFields since Debian 10 (Buster); -help since Debian 10 (Buster); -help-compat since Debian 10 (Buster); -help-full since Debian 10 (Buster); -help-man since Debian 10 (Buster); -help-notes since Debian 11 (Bullseye); -info-switch since Debian 11 (Bullseye); -latestTime since Debian 10 (Buster); -legacy since Debian 10 (Buster); -lib since Debian 11 (Bullseye); -name since Debian 10 (Buster); -nearCellValue since Debian 10 (Buster); -no-boundary since Debian 10 (Buster); -no-internal since Debian 10 (Buster); -no-lagrangian since Debian 10 (Buster); -no-point-data since Debian 10 (Buster); -noFaceZones since Debian 10 (Buster); -noFunctionObjects since Debian 10 (Buster); -noLinks since Debian 10 (Buster); -noZero since Debian 10 (Buster); -one-boundary since Debian 10 (Buster); -opt-switch since Debian 11 (Bullseye); -overwrite since Debian 10 (Buster); -parallel since Debian 10 (Buster); -patches since Debian 10 (Buster); -pointSet since Debian 10 (Buster); -poly since Debian 10 (Buster); -poly-decomp since Debian 10 (Buster); -processor-fields since Debian 11 (Bullseye); -region since Debian 10 (Buster); -regions since Debian 10 (Buster); -surfaceFields since Debian 10 (Buster); -time since Debian 10 (Buster); -useTimeName since Debian 10 (Buster); -with-ids since Debian 11 (Bullseye); -with-point-ids since Debian 11 (Bullseye); -xml since Debian 10 (Buster).