initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / utilities / postProcessing / graphics / fieldview9Reader / README
bloba70ed87df7ec08ffc48ac035f862011b7e0a7ab6
1 Fieldview9 reader module
2 ------------------------
3 This is a version of the fvbin executable with a built-in reader for Foam
4 data.
6 1] Limitations
7 --------------
8 - only volScalarFields and volVectorFields and only on points, not on boundary.
9 - handles polyhedra by decomposition (introduces cell centre)
10 - no surface fields, no lagrangian fields, no tetFem fields.
11 - does not run in parallel
13 2] Building
14 -----------
15 It has only been tested on Linux. Other platforms should build with a little
16 bit of effort. Have a look at the Fieldview link script and see which options
17 you need to add to Make/options to make it build.
19 Instructions:
20 0. Make sure FV_HOME is set to the root of the FieldView installation.
21 (i.e. $FV_HOME/user should exist)
23 1. Add $FV_HOME/bin to your path and make sure you can actually run fv.
25 2. Make the new fv executable by typing
27     wmake
29    This should create an 'fvbinFoam' executable.
31 3. On Linux you can directly run this executable instead of through the 'fv'
32 script. On other machines you might have to backup the old $FV_HOME/bin/fvbin
33 executable and move the fvbinFoam one into its position. Now you can use the
34 fv script to start it all up.
37 3] Running
38 ----------
39 After starting it up (see step above) you should have a 'Foam Reader' under
40 the 'Data Files' pull-down menu. This will open a file selection box. Go to the
41 case directory and click on any file. The reader will recognize that the
42 current directory is a case directory (it has checks for a 'constant' directory)
43 and start reading the mesh. It will
44 pop-up a box with time steps and a list of variables as usual.
46 In case of a case with topology changes (i.e. more than one mesh) it
47 will ask for the time step a second time. This is due to a limitation in
48 Fieldview. Choose the same time as before.
50 In the terminal window it will print various informational messages.
52 A not fairly well tested feature is cellSet displaying. Instead of selecting
53 a case directory selecting a cellSet (in a polyMesh/sets/ directory) it
54 will try to subset the mesh using the selected cellSet. It is not possible
55 to display fields on subsetted meshes.