Diffpack Documentation

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

SimRes2gnuplot Class Reference

class for exporting simres data to gnuplot. More...

#include <SimRes2gnuplot.h>

Inheritance diagram for SimRes2gnuplot::

SimResFilter List of all members.

Public Methods

 SimRes2gnuplot ()
 ~SimRes2gnuplot ()
virtual void usage ()
virtual void simresHeader (PlotSpecifications &plotspec)
virtual void simresFooter (PlotSpecifications &plotspec)
virtual void processFormatSpecificOptions (VecSimple(String) &arguments, PlotSpecifications &plotspec)
virtual void exportScalarField (Field &scalarfield, FieldInformation &fieldinfo, PlotSpecifications &plotspec)
virtual void exportVectorField (Fields &vectorfield, FieldInformation &fieldinfo, PlotSpecifications &plotspec)

Static Public Methods

void gnuplot (const FieldLattice &field, const String &filename)
void gnuplot (const FieldFE &field, const String &filename)
String makeCurvePlot (const FieldLattice &field, CurvePlotFile &file, const String &plot_title, const String &name_of_field, const String &comment, bool staggered_grid=false, const Ptv(int) *end_offset=NULL)
String makeCurvePlot (const FieldFE &field, CurvePlotFile &file, const String &plot_title, const String &fieldname, const String &comment)
String makeCurvePlot (const FieldPiWisConst &field, CurvePlotFile &file, const String &plot_title, const String &fieldname, const String &comment)

Detailed Description

class for exporting simres data to gnuplot.

NAME: SimRes2gnuplot - class for exporting simres data to gnuplot

DESCRIPTION:

This class filters data in SimRes format to the format used by the visualization program "gnuplot".

Constructor & Destructor Documentation

SimRes2gnuplot::SimRes2gnuplot ( )
 

See class "SimResFilter".

SimRes2gnuplot::~SimRes2gnuplot ( ) [inline]
 

Member Function Documentation

void SimRes2gnuplot::exportScalarField ( Field & scalarfield,
FieldInformation & fieldinfo,
PlotSpecifications & plotspec ) [virtual]
 

export a scalar field to a file format that can be read by a specific visualization program.

Reimplemented from SimResFilter.

void SimRes2gnuplot::exportVectorField ( Fields & vectorfield,
FieldInformation & fieldinfo,
PlotSpecifications & plotspec ) [virtual]
 

as "exportScalarField", but handles vector fields instead.

Reimplemented from SimResFilter.

static void SimRes2gnuplot::gnuplot ( const FieldFE & field,
const String & filename ) [static]
 

See documentation of one of the overloaded functions.

static void SimRes2gnuplot::gnuplot ( const FieldLattice & field,
const String & filename ) [static]
 

dumps a "FieldLattice" object in "gnuplot" readable format on file. Can be applied only to 1D and 2D fields. The "makeCurvePlot" function performs a similar task, but writes the data in the Diffpack plotting program independent curve plot format. To use "makeCurvePlot" and "gnuplot", one applies the script "Gnuplot".

static String SimRes2gnuplot::makeCurvePlot ( const FieldPiWisConst & field,
CurvePlotFile & file,
const String & plot_title,
const String & fieldname,
const String & comment ) [static]
 

See documentation of one of the overloaded functions.

static String SimRes2gnuplot::makeCurvePlot ( const FieldFE & field,
CurvePlotFile & file,
const String & plot_title,
const String & fieldname,
const String & comment ) [static]
 

See documentation of one of the overloaded functions.

static String SimRes2gnuplot::makeCurvePlot ( const FieldLattice & field,
CurvePlotFile & file,
const String & plot_title,
const String & name_of_field,
const String & comment,
bool staggered_grid = false,
const Ptv(int) * end_offset = NULL ) [static]
 

the field can be plotted in two ways: 1D fiels are plotted as ordinary (x,y) data points while 2D and 3D fields are dumped as lattice plots, where the grid data appear in the plot file. The "staggered_grid" variable can be set to "true" if all indices are to be interpreted as being located one half spaceing to the ""right"". The final argument, the "end_offset" contains the numbers 0 or -1 for each space dimension which is the reduction of the largest index in each dimension. For example, if a variable in a staggered grid is defined from 1/2 to "n"-1/2, but the array is of length "n", the last index should not be plotted and, if this situation occurs in the y direction, the "end_offset(2)" value should equal -1.

The function returns a string containing information about the file with the data for the plot. This can be used in the calling code for run-time visualization (and communication via files). See the man page for the "initPair" function class "CurvePlot" for detailed explanation of the syntax of this return string.

void SimRes2gnuplot::processFormatSpecificOptions ( VecSimple(String) & arguments,
PlotSpecifications & plotspec ) [virtual]
 

process remaining command line arguments in derived classes (after "SimResFilter driver" has processed the arguments that are common to all filters).

Reimplemented from SimResFilter.

void SimRes2gnuplot::simresFooter ( PlotSpecifications & plotspec ) [virtual]
 

task to be done just before exiting the filter.

Reimplemented from SimResFilter.

void SimRes2gnuplot::simresHeader ( PlotSpecifications & plotspec ) [virtual]
 

task to be done once initially, after processing of command line args (in "driver").

Reimplemented from SimResFilter.

void SimRes2gnuplot::usage ( ) [virtual]
 

description of various command line arguments. The command line arguments that are common to all filters are explained in "SimResFilter usage" and processed in "SimResFilter driver". Additional command line arguments can be explained in the "usage" function in derived classes and processed in the "processFormatSpecificOptions" function in the derived class.

Reimplemented from SimResFilter.

The documentation for this class was generated from the following file:
Copyright © 2003 inuTech GmbH. All rights reserved.