.TH "branch" 1rheolef "Sat Mar 13 2021" "Version 7.1" "rheolef" \" -*- nroff -*- .ad l .nh .SH NAME branch \- handle a family of fields (rheolef-7\&.1) .PP .SH "SYNOPSIS" .PP .PP .nf branch [options] file[.branch[.gz]] .fi .PP .SH "EXAMPLES" .PP Run an animation: .PP .nf branch file.branch .fi .PP It uses either \fCgnuplot\fP, for 1d geometries, or \fCparaview\fP, otherwise\&. .PP Next, let us extract the 17-th indexed and save it in \fC\&.field\fP file format\&. Indexes started at 0: .PP .nf branch file.branch -extract 17 -branch > file-17.field .fi .PP .SH "DESCRIPTION" .PP Read and visualize or output a branch of finite element fields from file\&. .SH "INPUT FILE SPECIFICATION" .PP .PP filename .PP .RS 4 Specifies the name of the file containing the input field\&. .RE .PP \fC-\fP .PP .RS 4 Read field on standard input instead on a file\&. .RE .PP \fC-I\fP\fIdir\fP \\ \fC-I\fP \fIdir\fP .PP .RS 4 Add \fIdir\fP to the Rheolef file search path\&. This option is useful e\&.g\&. when the mesh \&.geo and the \&.field files are in different directories\&. This mechanism initializes a search path given by the environment variable \fCRHEOPATH\fP\&. If the environment variable \fCRHEOPATH\fP is not set, the default value is the current directory\&. .RE .PP \fC-name\fP .PP .RS 4 When the field comes from standard input, the file base name is not known and is set to 'output' by default\&. This option allows one to change this default\&. Useful when dealing with output formats (graphic, format conversion) that creates auxiliary files, based on this name\&. .RE .PP .SH "INPUT FORMAT OPTIONS" .PP .PP \fC-if\fP \fIformat\fP .br \fC-input-format\fP \fIformat\fP .PP .RS 4 Load a mesh in the prescribed file \fIformat\fP\&. Supported input file formats are: \fC\&.branch\fP and \fC\&.vtk\fP\&. .RE .PP .SH "RENDER SPECIFICATION" .PP \fC-gnuplot\fP .PP .RS 4 Run a 1d animation using \fCgnuplot\fP\&. .RE .PP .PP \fC-paraview\fP .PP .RS 4 Run 2d and 3d animations using \fCparaview\fP\&. Generate a collections of \fC\&.vtk\fP files and a main \fC\&.py\fP python one, then execute the python file\&. .RE .PP .SH "RENDERING OPTIONS" .PP \fC-skipvtk\fP .PP .RS 4 Do not regenerate the collection of \fC\&.vtk\fP files when using the \fCparaview\fP render\&. Only generate the main \fC\&.py\fP python file and execute it\&. Assume that all the \fC\&.vtk\fP files was already created with the \fC-vtk\fP option or with \fC-paraview\fP one combined with \fC-noclean\fP\&. .RE .PP \fC-color\fP .br \fC-gray\fP .br \fC-black-and-white\fP .br \fC-bw\fP .PP .RS 4 Use (color/gray scale/black and white) rendering\&. Color rendering is the default\&. .RE .PP \fC-[no]showlabel\fP .PP .RS 4 Show or hide title, color bar and various annotations\&. Default is to show labels\&. .RE .PP \fC-label\fP \fIstring\fP .PP .RS 4 Set the label to show for the represented value\&. This supersedes the default value\&. .RE .PP \fC-[no]elevation\fP .PP .RS 4 For a two dimensional field, represent values as elevation in the third dimension\&. The default is no elevation\&. .RE .PP \fC-[no]fill\fP .PP .RS 4 Isoline intervals are filled with color\&. This is the default\&. .RE .PP \fC-[no]volume\fP .PP .RS 4 For 3D data, render values using a colored translucid volume\&. This option requires the \fCparaview\fP code\&. .RE .PP \fC-scale\fP \fIfloat\fP .PP .RS 4 Applies a multiplicative factor to the field\&. This is useful e\&.g\&. in conjunction with the \fC-elevation\fP option\&. The default value is 1\&. .RE .PP \fC-[no]stereo\fP .PP .RS 4 Rendering mode suitable for red-blue anaglyph 3D stereoscopic glasses\&. This option is only available with \fCparaview\fP\&. .RE .PP \fC-[no]cut\fP .PP .RS 4 Cut by a specified plane\&. The cutting plane is specified by its origin point and normal vector\&. This option requires \fCparaview\fP\&. .RE .PP \fC-origin\fP \fIfloat\fP [\fIfloat\fP [\fIfloat\fP]] .PP .RS 4 Set the origin of the cutting plane\&. Default is (0\&.5, 0\&.5, 0\&.5)\&. .RE .PP \fC-normal\fP \fIfloat\fP [\fIfloat\fP [\fIfloat\fP]] .PP .RS 4 Set the normal of the cutting plane\&. Default is (1, 0, 0)\&. .RE .PP \fC-isovalue\fP [\fIfloat\fP] .br \fC-iso\fP [\fIfloat\fP] .PP .RS 4 Draw 2d isoline or 3d isosurface\&. When the optional float is not provided, a median value is used\&. This option requires the \fCparaview\fP code\&. .RE .PP \fC-noisovalue\fP .PP .RS 4 Do not draw isosurface\&. This is the default\&. .RE .PP \fC-n-iso\fP \fIint\fP .PP .RS 4 For 2D visualizations, the isovalue table contains regularly spaced values from fmin to fmax, the bounds of the field\&. .RE .PP \fC-n-iso-negative\fP \fIint\fP .PP .RS 4 The isovalue table is split into negatives and positives values\&. Assume there is n_iso=15 isolines: if 4 is requested by this option, then, there will be 4 negatives isolines, regularly spaced from fmin to 0 and 11=15-4 positive isolines, regularly spaced from 0 to fmax\&. This option is useful when plotting e\&.g\&. vorticity or stream functions, where the sign of the field is representative\&. .RE .PP .SH "OUTPUT FILE SPECIFICATION" .PP \fC-vtk\fP .PP .RS 4 Generate a collection of \fC\&.vtk\fP files for \fCparaview\fP\&. .RE .PP \fC-branch\fP .PP .RS 4 Output on stdout in \fC\&.branch\fP format\&. .RE .PP \fC-extract\fP \fIint\fP .br \fC-index\fP \fIint\fP .PP .RS 4 Extract the i-th record in the file\&. The output is a field or multi-field file format\&. Indexes started at 0\&. .RE .PP \fC-toc\fP .PP .RS 4 Print the table of contents (toc) to standard output and exit\&. Each index value is followed by the associated value (e\&.g\&. the time or a physical parameter)\&. .RE .PP \fC-ndigit\fP \fIint\fP .PP .RS 4 Number of digits used to print floating point values when using the \fC-branch\fP option\&. Note that the default value depends upon the machine precision associated to the \fCFloat\fP type, as defined by the \fCconfigure\fP script during the installation of the library (see \fBconfiguration\fP)\&. When \fCFloat\fP is \fCdouble\fP, then 16 digits are used by default\&. This default value can be changed by this option, e\&.g\&. for the portability of non-regression tests\&. .RE .PP .PP \fC-image-format\fP \fIstring\fP .PP .RS 4 For image or video capture\&. The supported argument are \&.\fCavi\fP, \&.\fCjpg\fP, \&.\fCpng\fP, \&.\fCtif\fP and \&.\fCbmp\fP\&. .RE .PP This option should be combined with the \fCparaview\fP render\&. The output file is basename\&.\fCavi\fP where \fIbasename\fP is the name of the mesh, or can be set with the \fC-name\fP option\&. \fC-resolution\fP \fIint\fP \fIint\fP .PP .RS 4 For the resolution of an image or a video capture\&. The argument is a couple of sizes, separated by a white space\&. This option can be used together with the \fC-image-format\fP for any of the bitmap image formats\&. This option requires the \fCparaview\fP render\&. .RE .PP .SH "OTHERS OPTIONS" .PP \fC-umin\fP \fIfloat\fP .br \fC-umax\fP \fIfloat\fP .PP .RS 4 Set the solution range for the \fCgnuplot\fP driver\&. By default this range is computed from the first field of the branch, and this could be problematic when this field is initialy zero\&. .RE .PP `-subdivide \fIint\fP .PP .RS 4 When using a high order geometry, the number of points per edge used to draw a curved element\&. Default value is the mesh order\&. .RE .PP .PP \fC-topography\fP filename[\&.field[\&.gz]] .PP .RS 4 Performs a tridimensional elevation view based on the topographic data\&. .RE .PP .PP \fC-proj\fP .PP .RS 4 Performs a \fCP1\fP projection on the fly\&. This option is useful when rendering \fCP0\fP data while the \fCparaview\fP render requires \fCP1\fP description\&. .RE .PP \fC-lumped-proj\fP .PP .RS 4 Force P1 approximation for L2 projection and use a lumped mass matrix for it\&. .RE .PP \fC-[no]verbose\fP .PP .RS 4 Print messages related to graphic files created and command system calls (this is the default)\&. .RE .PP `-[no]clean .PP .RS 4 Clear temporary graphic files (this is the default)\&. .RE .PP .br \fC-[no]execute\fP .PP .RS 4 Execute graphic command (this is the default)\&. The \fC-noexecute\fP variant is useful in conjunction with the \fC-verbose\fP and \fC-noclean\fP options in order to modify some render options by hand\&. .RE .PP .SH "EXAMPLE OF FILE FORMAT CONVERSION" .PP For conversion from the \fC\&.vtk\fP legacy ascii file format to the \fC\&.branch\fP one, simply writes: .PP .nf branch -if vtk -branch - < input.vtk > output.branch .fi .PP .SH "THE BRANCH FILE FORMAT" .PP .PP The \fC\&.branch\fP file format bases on the \fC\&.field\fP one (see \fBfield(1)\fP ): .PP .nf example | general format ------------------------------------------------- #!branch | #!branch branch | branch 1 1 11 | time u | | #time 3.14 | # #u | # field | ..... | .... | ..... | .... #time 6.28 | # #u | # field | ..... | .... .fi .PP The key is here \fCtime\fP, but could be any string without spaces, such as \fCt\fP or \fClambda\fP\&. Labels appears all along the file to facilitate direct jumps and field and step skips\&. .PP The previous example contained one \fCfield\fP at each time step\&. The format supports several fields, such as (t,u(t),p(t)), where u could be a multi-component field (e\&.g\&. a vector): .PP .nf #!branch branch 1 2 11 time u p #time 3.14 #u ... #p ... #time 6.28 ... .fi .PP .SH "IMPLEMENTATION" .PP This documentation has been generated from file main/bin/branch\&.cc .SH AUTHOR Pierre Saramito .SH COPYRIGHT Copyright (C) 2000-2018 Pierre Saramito GPLv3+: GNU GPL version 3 or later . This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.