field(1rheolef)

Usage

field [options] file [.field [.gz]]

Overview

Read and output a finite element field from file.

Examples

    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 one to change this default. Useful when dealing with output formats (graphic, format conversion) that creates auxiliary files, based on this name.

-Idir
-I dir

Add dir to the Rheolef file search path. This option is useful 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.

-mark string
-catch string
-catchmark string

Jump across the file to the specified string . Label start at the beginning of a line, preceded by a # mark (see catchmark(3)).

Options

-field -text: Output field on standard output stream in Rheolef ascii (field or geo) text file format.

-gmsh: Output field on standard output stream in .gmsh file format.

-gmsh-pos: Output field on standard output stream in .gmsh-pos 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: For image or video capture. The supported argument are .jpg, .png, .tif and .bmp. This option should be combined with the paraview render. The output file is basename.png where basename is the name of the mesh, or can be set with the -name option.

-resolution int int

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

-get-geo

Print the name of the mesh associated to the field and exit.

Options

-gnuplot: Use the gnuplot tool. This is the default in one dimension.

-paraview: Use the paraview tool. This is the default for two- and tri-dimensional geometries.

Options

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

-[no]showlabel

Show or hide title, color bar and various annotations. Default is to show labels.

-label *string* <blockquote>&zwj; Set the label to show for the represented value. This supersedes the default value. </blockquote>-[no]elevation <blockquote>&zwj; For two dimensional field, represent values as elevation in the third dimension. The default is no elevation. </blockquote>-scale*float* <blockquote>&zwj; Applies a multiplicative factor to the field. This is useful e.g. in conjunction with theelevationoption. The default value is 1. </blockquote>-[no]stereo <blockquote>&zwj; Rendering mode suitable for red-blue anaglyph 3D stereoscopic glasses. This option is only available withparaview. </blockquote>-[no]fill <blockquote>&zwj; Isoline intervals are filled with color. This is the default. When-nofill, draw isolines by using lines. </blockquote>-[no]volume <blockquote>&zwj; For 3D data, render values using a colored translucid volume. This option requires theparaviewcode. </blockquote>-[no]cut <blockquote>&zwj; Cut by a specified plane. The cutting plane is specified by its origin point and normal vector. This option requires theparaviewcode. </blockquote>-origin*float* [*float* [*float*]] <blockquote>&zwj; Set the origin of the cutting plane. Default is (0.5, 0.5, 0.5). </blockquote>-normal*float* [*float* [*float*]] <blockquote>&zwj; Set the normal of the cutting plane. Default is (1, 0, 0). </blockquote>-isovalue[*float*] \n -iso[*float*] <blockquote>&zwj; Draw 2d isoline or 3d isosurface. When the optional float is not provided, a median value is used. This option requires theparaviewcode. </blockquote>-noisovalue <blockquote>&zwj; Do not draw isosurface. This is the default. </blockquote>-n-iso*int* <blockquote>&zwj; For 2D visualizations, the isovalue table contains regularly spaced values from fmin to fmax, the bounds of the field. </blockquote> @addindex vorticity @addindex stream function -n-iso-negative*int* <blockquote>&zwj; 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. </blockquote> @addindex projection @addindex approximation P1 -proj*approx* -proj <blockquote>&zwj; Convert all selected fields to approximation *approx* by using a L2 projection. When argument is omitted,P1approximation is assumed. </blockquote>-lumped-proj <blockquote>&zwj; ForceP1approximation for L2 projection and use a lumped mass matrix for it. </blockquote>-round[*float*] <blockquote>&zwj; Round the input up to the specified precision. This option, combined with-field, leads to a round filter. Useful 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. </blockquote> -subdivide*int* <blockquote>&zwj; When using a high order geometry, the number of points per edge used to draw a curved element. Default value is the mesh order. </blockquote> -deformation -velocity <blockquote>&zwj; Render vector-valued fields as deformed mesh usingparavieworgnuplot. This is the default vector field representation. Whenvelocity, render vector-valued fields as arrows usingparaview` instead.

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

Options

-[no]verbose

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

`-[no]clean

Clear temporary graphic files (this is the default).

-[no]execute

Execute graphic command (this is the default). The -noexecute variant is useful in conjunction with the -verbose and -noclean options in order to modify some render options by hand.

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 finally the list of values:

A sample field file write

    field
    1 4
    square
    P1
    0.0
    1.0
    2.0
    3.0

See also geo(1) for the .geo mesh file format.

Examples

The following command send to vtk the cuted 2d plane of the 3d field:

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

Next, let us generate the cuted 2d field and its associated mesh:

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

For drawing the isosurface:

    field cube.field -isovalue 0.5

Finally, let us generate the isosurface as a 3d surface mesh in the .geo file format:

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

This file is then suitable for others treatments.

Implementation

This documentation has been generated from file main/bin/field.cc

Releases

7 releases since Debian 7 (Wheezy); the text changed 6 times.

7
8
9
10
11
12
13

-paraview since Debian 9 (Stretch); -text since Debian 9 (Stretch).

-clean until Debian 10 (Buster); -cut until Debian 10 (Buster); -deformation until Debian 12 (Bookworm); -elevation until Debian 10 (Buster); -execute until Debian 10 (Buster); -fill until Debian 10 (Buster); -iso until Debian 10 (Buster); -label until Debian 10 (Buster); -lumped-proj until Debian 12 (Bookworm); -mayavi until Debian 10 (Buster); -n-iso until Debian 12 (Bookworm); -n-iso-negative until Debian 12 (Bookworm); -noclean until Debian 10 (Buster); -nocut until Debian 10 (Buster); -noelevation until Debian 10 (Buster); -noexecute until Debian 10 (Buster); -nofill until Debian 10 (Buster); -noiso until Debian 10 (Buster); -noisovalue until Debian 12 (Bookworm); -nolabel until Debian 10 (Buster); -nostereo until Debian 10 (Buster); -noverbose until Debian 10 (Buster); -novolume until Debian 10 (Buster); -proj until Debian 12 (Bookworm); -round until Debian 12 (Bookworm); -scale until Debian 12 (Bookworm); -stereo until Debian 10 (Buster); -subdivide until Debian 12 (Bookworm); -velocity until Debian 12 (Bookworm); -verbose until Debian 10 (Buster); -volume until Debian 10 (Buster).

Usage

Overview

Examples

Input file specification

Options

Getting information

Options

Options

Component extraction and domain reduction

Options

Field file format

Examples

Implementation

Releases

See also

Mentioned on this page