.\" .de Id .. .de Sp .if n .sp .if t .sp 0.4 .. .TH branch 1rheolef "rheolef-7.0" "rheolef-7.0" "rheolef-7.0" .\" label: /*Prog:branch .SH NAME \fBbranch\fP -- handle a family of fields .PP .\" skip: @cindex animation .\" skip: @cindex continuation methods .\" skip: @cindex time-dependent problems .\" skip: @pindex branch .\" skip: @cindex RHEOPATH environment variable .\" skip: @fiindex @file{.branch} family of fields .PP .SH SYNOPSIS .\" begin_example .Sp .nf branch [\fIoptions\fP] \fIfilename\fP .Sp .fi .\" end_example .PP .SH EXAMPLE Generates vtk file colection for visualization with paraview: .\" begin_example .Sp .nf branch output.branch -paraview .Sp .fi .\" end_example .SH DESCRIPTION Read and output a branch of finite element fields from file, in field text file format. .SH INPUT FILE SPECIFICATION .\" begin table .\" start item .TP .B -I\fIdir\fP add \fIdir\fP to the RHEOPATH search path. See also geo(2) for RHEOPATH mechanism. .\" start item .TP .B \fIfilename\fP specifies the name of the file containing the input field. .\" start item .TP .B - read field on standard input instead on a file. .\" start item .TP .B -ndigit \fIint\fP Number of digits used to print floating point values when using the `\fB-geo'\fP option. Default depends upon the machine precision associated to the \fBFloat\fP type. .\" end table .PP .SH INQUIRE .\" begin table .\" start item .TP .B -toc print the table of contents (toc) to standard output and exit. .\" end table .SH OUTPUT AND RENDER SPECIFICATION .\" begin table .\" start item .TP .B -extract \fIint\fP Extract the i-th record in the file. The output is a field or multi-field file format. .\" start item .TP .B -branch Output on stdout in `\fB.branch'\fP format. This is the default. .\" skip: @toindex gnuplot .\" skip: @toindex plotmtv .\" skip: @toindex paraview .\" skip: @toindex vtk .\" start item .TP .B -paraview Generate a collection of \fBvtk\fP files for using \fBparaview\fP. .\" start item .TP .B -vtk Generate a single \fBvtk\fP file with numbered fields. .\" start item .TP .B -gnuplot Run 1d animation using \fBgnuplot\fP. .\" start item .TP .B -plotmtv This driver is unsupported for animations. .\" end table .PP .SH OTHER OPTIONS .\" begin table .\" start item .TP .B -umin \fIfloat\fP .\" start item .TP .B -umax \fIfloat\fP set the solution range for the \fBgnuplot\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. .\" start item .TP .B -subdivide int When using a high order geometry, the number of points per edge used to draw a curved element. Default value is the mesh order. .\" skip: @cindex topography .\" start item .TP .B -topography \fIfilename\fP[.field[.gz]] performs a tridimensionnal elevation view based on the topographic data. .\" skip: @cindex projection .\" skip: @apindex P0 .\" skip: @apindex P1 .\" start item .TP .B -proj performs a \fBP1\fP projection on the fly. This option is useful when rendering \fBP0\fP data while \fBvtk\fP render requires \fBP1\fP description. .\" skip: @cindex elevation .\" start item .TP .B -elevation For two dimensional field, represent values as elevation in the third dimension. This is the default. .\" start item .TP .B -noelevation Prevent from the elevation representation. .\" start item .TP .B -scale \fIfloat\fP applies a multiplicative factor to the field. This is useful e.g. in conjonction with the \fBelevation\fP option. The default value is 1. .\" start item .TP .B -verbose print messages related to graphic files created and command system calls (this is the default). .\" start item .TP .B -noverbose does not print previous messages. .\" start item .TP .B -clean clear temporary graphic files (this is the default). .\" start item .TP .B -noclean does not clear temporary graphic files. .\" start item .TP .B -execute execute graphic command (this is the default). .\" start item .TP .B -noexecute does not execute graphic command. Generates only graphic files. This is useful in conjunction with the \fB-noclean\fP command. .\" end table .PP .SH BRANCH FILE FORMAT .PP .\" skip: @pindex field .\" skip: @pindex mfield .\" skip: @fiindex @file{.field} field .PP The `\fB.branch'\fP file format bases on the `\fB.field'\fP one: .\" begin_example .Sp .nf EXAMPLE GENERAL FORM .PP #!branch #!branch branch branch 1 1 11 time u .PP #time 3.14 # #u # field ..... .... .PP ..... .... #time 6.28 # #u # field ..... .... .Sp .fi .\" end_example The key name is here \fBtime\fP, but could be any string (without spaces). The previous example contains one \fBfield\fP at each time step. Labels appears all along the file to facilitate direct jumps and field and step skips. .PP The format supports several fields, such as (t,u(t),p(t)), where u could be a multi-component (e.g. a vector) field: .\" begin_example .Sp .nf #!branch branch 1 2 11 time u p .PP #time 3.14 #u mfield 1 2 #u0 field ... #u1 field ... #p .PP #time 6.28 ... .Sp .fi .\" end_example .PP .\" END .\" LENGTH = 1 .SH SEE ALSO geo(2) .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.