.TH "FOAMTOENSIGHT" 1 "OpenFOAM-" "www.openfoam.com" "OpenFOAM Commands Manual"
.SH "NAME"
foamToEnsight \- part of \fBOpenFOAM\fR (The Open Source CFD Toolbox).
.SH "SYNOPSIS"
\fBfoamToEnsight\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.nf
Translate OpenFOAM data to Ensight format with a part for the internalMesh and
for each patch.
.fi
.SH "OPTIONS"
.TP
\fB\-ascii\fR
Write in ASCII format instead of 'C Binary'
.TP
\fB\-case\fR \fIdir\fR
Specify case directory to use (instead of the cwd)
.TP
\fB\-cellZone\fR \fIword\fR
Specify cellZone to write
.TP
\fB\-constant\fR
Include the 'constant/' dir in the times list
.TP
\fB\-faceZones\fR \fIwordRes\fR
Specify single or multiple faceZones to write
Eg, 'cells' or '( slice "mfp-.*" )'.
.TP
\fB\-fields\fR \fIwordRes\fR
Specify single or multiple fields to write (all by default)
Eg, 'T' or '( "U.*" )'
.TP
\fB\-latestTime\fR
Select the latest time
.TP
\fB\-name\fR \fIsubdir\fR
Sub-directory name for Ensight output (default: 'EnSight')
.TP
\fB\-no-boundary\fR
Suppress writing any patches
.TP
\fB\-no-internal\fR
Suppress writing the internal mesh
.TP
\fB\-no-lagrangian\fR
Suppress writing lagrangian positions and fields
.TP
\fB\-noZero\fR
Exclude the '0/' dir from the times list
.TP
\fB\-nodeValues\fR
Write values at nodes
.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, 'inlet' or '(outlet "inlet.*")'
.TP
\fB\-region\fR \fIname\fR
Specify alternative mesh region
.TP
\fB\-time\fR \fIranges\fR
List of ranges. Eg, ':10,20 40:70 1000:', 'none', etc
.TP
\fB\-width\fR \fIn\fR
Width of Ensight data subdir
.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\-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\-fileHandler\fR \fIhandler\fR
Override the file handler type
.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\-lib\fR \fIname\fR
Additional library or library list to load (can be used multiple times)
.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\-roots\fR \fI(dir1 .. dirN)\fR
Slave root directories for distributed running
\fB[Parallel option]\fR
.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\-noLagrangian\fR (now \fB\-no-lagrangian\fR)
The option was last used in 1806.
.TP
\fB\-noPatches\fR (now \fB\-no-boundary\fR)
The option was last used in 1806.
.SH "SEE ALSO"
Online documentation https://www.openfoam.com/documentation/
.SH COPYRIGHT
Copyright \(co 2018-2019 OpenCFD Ltd.