A Guide to Dessert
Dessert is part of the
Fondue Family.
There is an associated program called
Fondue that produces the input files for Dessert.
Digest is free and can be re-distributed under the terms of
GNU General Public License. This is an implementation of the
Copyleft concept provided by the
Free Software Foundation.
Overview
Dessert is a parser for the binary
save_disk file produced by
Fondue. Dessert requires not only this binary file
but also the summary file produced by Fondue. This summary file tells Dessert the format for the save_disk file.
Note that Dessert is a preliminary version. You should expect the user interface to change in later versions.
Dessert is invoked from the command line by
dessert [options] filename_stem
The
options and the filename_stem can appear in any order on the command line.
Command Line Options
Dessert extracts out a numbers along a single line through the Disk. This line can be at a constant radius or constant
depth. The position of the line is specified by one of the position options detailed below. Only one position option is permitted.
The output of Dessert will be two column text sent to
stdout
. The first column contains the position [m] and the second contains the temperature [K].
The position options all require a position value to be specified that is within the valid range for the modeled Disk. If the user specifies a value outside
the relevant valid range, Dessert will send a message to
stderr
stating what the valid range is.
- --row row_number
-
This specifies that temperatures along the given row will be presented. Acceptable values for row_numberare 0 to
Rpoints-1. If the last row is desired, the user may enter the word
last
instead of a numeric value.
- --col column_number
-
This specifies that temperatures along the given column will be presented. Acceptable values for column_number
are 0 to Zpoints-1. If the last column is desired, the user may enter the wordlastinstead of
a numeric value.
- --radius radius
-
This specifies that temperatures along the given radius will be presented. The values will be linearly interpolated for a radius that
is in between grid points. Acceptable values for radiusare dx to Radius - dr. Where dr =
Radius/Rpoints. If the last radius is desired, the user may enter the word
last
instead of a numeric value. (There is currently
no equivalent for the first radius. Use --col 0
instead.)
- --depth depth
-
This specifies that temperatures along the given depth will be presented. The values will be linearly interpolated for a depth that
is in between grid points. Acceptable values for depthare dz to Depth - dz. Where dz = Depth/Zpoints.
If the last depth is desired, the user may enter the word
last
instead of a numeric value. (There is currently no equivalent for the
first depth. Use --row 0
instead.)
- --help
-
A help message will be printed to
stdout
. This will be done instead of performing any computation. The brief "usage" statement will
be printed along with a one-line description of the command line arguments.
- --version
- A message stating the version will be printed to
stdout
. This will be done instead of performing any computation.
Examples
A few examples might be useful. Assume that I have run Fondue and created the files
myrun.sum
and
myrun.sav
. The model has
Rpoints=100
and
Zpoints = 10
.
Radius=5E-2
and
Depth = 5E-3
. I might try the following:
dessert --row 2 myrun
will print to=stdout=>the temperatures of row 2 as a function of position.
dessert --row 9 myrun > row9.dat
will write the values of the magnetic field as a funtion of time to the file
row9.dat
.
dessert --depth 1E-3 myrun
will print to
stdout
the temperatures at the constant depth of 1E-3 m.