Provided by: rheolef_6.6-1build2_amd64 bug

NAME

       field -- plot a field

SYNOPSIS

               field options filename[.field[.gz]]

DESCRIPTION

       Read and output a finite element field from file.

EXAMPLE

               field square.field
               field square.field -bw
               field box.field

INPUT FILE SPECIFICATION

       filename
              specifies the name of the file containing the input field.

       -      read field on standard input instead on a file.

       -name  when  the  field  comes from standard input, the file base name is not known and is
              set to "output" by default.  This option allows to  change  this  default.   Useful
              when  dealing  with  output  formats  (graphic,  format  conversion)  that  creates
              auxilliary files, based on this name.

       -Idir

       -I dir Add dir to the rheolef file search path.  This option is usefull e.g. when the mesh
              .geo and the .field fikes are in different directories.  This mechanism initializes
              a search path given by the environment variable  `RHEOPATH'.   If  the  environment
              variable `RHEOPATH' is not set, the default value is the current directory.

       -catchmark string
              Jump  accross  the file to the specifield string.  Label start at the begining of a
              line, preceded by a `#' mark (see see catchmark(4)).

OUTPUT FILE FORMAT OPTIONS

       -field output field on standard output stream in field text file format.

       -gmsh  output field on standard output stream in gmsh text file format.

       -gmsh-pos
              output field on standard output stream in gmsh-pos text file format,  suitable  for
              mesh adaptation purpose.

       -bamg-bb
              output  field  on  standard output stream in bamg-bb text file format, suitable for
              mesh adaptation purpose.

       -image-format string
              The argument is any valid image format, such as bitmap png, jpg, gif, tif, ppm, bmp
              or  vectorial  pdf,  eps, ps, svg image file formats.  this option can be used with
              the paraview and the gnuplot renders.  The output file is  e.g.  basename.png  when
              basename is the name of the mesh, or can be set with the -name option.

       -resolution int int
              The  argument  is  a couple of sizes, for the image resolution.  This option can be
              used together with the -image-format for any of the  bitmap  image  formats.   This
              option requires the paraview render.

GETTING INFORMATION

       -min

       -max   print the min (resp. max) value of the scalar field and then exit.

RENDER OPTIONS

       -gnuplot
              use gnuplot tool.  This is the default in one and two dimension.

       -mayavi
              use mayavi tool.  This is the default for tridimensional geometries.

       -paraview
              use paraview tool.  This is feature is under development.

RENDERING OPTIONS

       -color

       -gray

       -black-and-white

       -bw    Use (color/gray scale/black and white) rendering.  Color rendering is the default.

       -label

       -nolabel
              Show or hide title, color bar and various anotations.  Default is to show labels.

       -elevation

       -noelevation
              For  two  dimensional  field, represent values as elevation in the third dimension.
              The default is no evelation.

       -scale float
              applies a multiplicative factor to the field.  This is useful e.g.  in  conjonction
              with the elevation option.  The default value is 1.

       -stereo

       -nostereo
              Rendering mode suitable for red-blue anaglyph 3D stereoscopic glasses.  This option
              is only available with mayavi and paraview.

       -fill  isoline intervals are filled with color.  This is the default.

       -nofill
              draw isolines by using lines.

       -volume

       -novolume
              for 3D data, render values using a colored translucid volume.  This option requires
              the paraview code.

       -cut

       -nocut Cut  by  a specified plane.  The cutting plane is specified by its origin point and
              normal vector.  This option requires the mayavi or paraview code.

       -origin float [float [float]]
              set the origin of the cutting plane.  Default is (0.5, 0.5, 0.5).

       -normal float [float [float]]
              set the normal of the cutting plane.  Default is (1, 0, 0).

       -iso [float]
              do draw 3d isosurface. When the optional float is not provided, a median  value  is
              used.  This option requires the mayavi code.

       -noiso do not draw isosurface.

       -n-iso int
              For  2D  visualizations,  the  isovalue table contains regularly spaced values from
              fmin to fmax, the bounds of the field.

       -proj  Convert  all  selected  fields  to  Pk-continuous  approximation  by  using  a   L2
              projection.

       -round [float]
              Round the input up to the specifiexd precision.  This option, combined with -field,
              leads to a round filter.  Usefull for non-regression  test  purpose,  in  order  to
              compare  numerical  results  between files with a limited precision, since the full
              double precision is machine-dependent.

       -n-iso-negative int
              The isovalue table is splitted 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 usefull when plotting e.g.
              vorticity or stream functions, where the sign of the field is representative.

       -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.

       -deformation
              Render  vector-valued  fields  as  deformed mesh using mayavi, paraview or gnuplot.
              This is the default vector field representation.

       -velocity
              Render vector-valued fields as arrows using mayavi or  paraview.

COMPONENT EXTRACTION AND DOMAIN REDUCTION

       -comp int

       -comp string
              Extract the i-th component of a vector-valued field.  For  a  tensor-valued  field,
              indexing components as "00", "01", "11"... is supported.

       -domain name
              Reduce the visualization to the specified domain.

OTHERS OPTIONS

       -verbose
              print  messages  related to graphic files created and command system calls (this is
              the default).

       -noverbose
              does not print previous messages.

       -clean clear temporary graphic files (this is the default).

       -noclean
              does not clear temporary graphic files.

       -execute
              execute graphic command (this is the default).

       -noexecute
              does not execute graphic command. Generates only graphic files. This is usefull  in
              conjuction with the -noclean command.

FIELD FILE FORMAT

       It  contains  a  header  and a list values at degrees of freedom.  The header contains the
       field keyword followed by a line containing a format version  number  (presently  1),  the
       number  of  degrees  of  freedom  (i.e.  the  number of values listed), the mesh file name
       without the `.geo' extension the approximation (e.g. P1, P2, etc), and finaly the list  of
       values:  A sample field file (compatible with the sample mesh example presented in command
       manual; see geo(1)) writes:

               field
               1 4
               square
               P1
               0.0
               1.0
               2.0
               3.0

EXAMPLES

           field cube.field -cut -normal 0 1 0 -origin 0.5 0.5 0.5 -vtk

       This command send to vtk the cutted 2d plane of the 3d field.

           field cube.field -cut -normal 0 1 0 -origin 0.5 0.5 0.5 -text > cube-cut.field

       This command generates the cutted 2d field and its associated mesh.

           field cube.field -iso 0.5 -plotmtv

       This command draws the isosurface.

           field cube.field -iso 0.5 -text > isosurf.geo

       This command generates the isosurface as a 3d surface  mesh  in  `.geo'  format.  This  is
       suitable for others treatments.

INPUT FILE FORMAT OPTIONS

       TODO

FILE FORMAT CONVERSIONS

        TODO

GETTING INFORMATION

        TODO

SEE ALSO

       catchmark(4), geo(1)