Diffpack Documentation

---

              Search  

---

SimResFilter Class Reference

base class for simres filters. More...

#include <SimResFilter.h>

Inheritance diagram for SimResFilter::

List of all members.

Public Methods
	SimResFilter (const String &file_ext, const String &module_name, bool silent=false)
virtual	~SimResFilter ()
virtual void	usage ()
virtual void	simresHeader (PlotSpecifications &plotspec)=0
virtual void	simresFooter (PlotSpecifications &plotspec)=0
virtual void	processFormatSpecificOptions (VecSimple(String) &arguments, PlotSpecifications &plotspec)=0
virtual void	exportScalarField (Field &scalarfield, FieldInformation &fieldinfo, PlotSpecifications &plotspec)=0
virtual void	exportVectorField (Fields &vectorfield, FieldInformation &fieldinfo, PlotSpecifications &plotspec)=0
int	driver (int argc, const char *argv[])
	DpList (Field, DpListItemHandle) field_list
Public Attributes
	DpList(Fields)
DpListItemHandle	fields_list
	DpList(FieldInformation)
DpListItemInst	field_info
DpListItemInst	fields_info
Protected Methods
void	readAndProcessFields (PlotSpecifications &plotspec)
void	readAndProcessAllFields (PlotSpecifications &plotspec)
String	makeTimeFilename (real t)
String	makeFieldNoFilename (int f)
void	makeOutputFilename (FieldInformation &fieldinfo, PlotSpecifications &plotspec)
void	checkSimResVersion (const String &dataset)
void	flipGrid (Grid *g, const PlotSpecifications &plotspec)
Protected Attributes
String	file_ext
String	module_name
String	options
bool	silent
Static Protected Attributes
bool	flipped_grid

---

Detailed Description

base class for simres filters.

NAME: SimResFilter - base class for simres filters

DESCRIPTION:

To code a filter from the SimRes format to a plotting program format, derive a subclass of "SimResFilter" and implement the necessary functions. In addition, make a "main" routine. See e.g. class "SimRes2mtv" for an example.

---

Constructor & Destructor Documentation

SimResFilter::SimResFilter ( const String & file_ext, const String & module_name, bool silent = false )

SimResFilter::~SimResFilter ( ) [inline, virtual]

---

Member Function Documentation

SimResFilter::DpList ( Field, DpListItemHandle )

void SimResFilter::checkSimResVersion ( const String & dataset ) [protected]

int SimResFilter::driver ( int argc, const char * argv[] )

the main routine.

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

export a scalar field to a file format that can be read by a specific visualization program. Reimplemented in SimRes2bob, SimRes2explorer, SimRes2gb, SimRes2gnuplot, SimRes2matlab, SimRes2mtv, SimRes2summary, SimRes2tecplot, SimRes2ucd, and SimRes2vtk.

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

as "exportScalarField", but handles vector fields instead. Reimplemented in SimRes2bob, SimRes2explorer, SimRes2gb, SimRes2gnuplot, SimRes2matlab, SimRes2mtv, SimRes2summary, SimRes2tecplot, SimRes2ucd, and SimRes2vtk.

void SimResFilter::flipGrid ( Grid * g, const PlotSpecifications & plotspec ) [protected]

String SimResFilter::makeFieldNoFilename ( int f ) [protected]

void SimResFilter::makeOutputFilename ( FieldInformation & fieldinfo, PlotSpecifications & plotspec ) [protected]

String SimResFilter::makeTimeFilename ( real t ) [protected]

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

process remaining command line arguments in derived classes (after "SimResFilter driver" has processed the arguments that are common to all filters). Reimplemented in SimRes2bob, SimRes2explorer, SimRes2gb, SimRes2gnuplot, SimRes2matlab, SimRes2mtv, SimRes2summary, SimRes2tecplot, SimRes2ucd, and SimRes2vtk.

void SimResFilter::readAndProcessAllFields ( PlotSpecifications & plotspec ) [protected]

void SimResFilter::readAndProcessFields ( PlotSpecifications & plotspec ) [protected]

void SimResFilter::simresFooter ( PlotSpecifications & plotspec ) [pure virtual]

task to be done just before exiting the filter. Reimplemented in SimRes2bob, SimRes2explorer, SimRes2gb, SimRes2gnuplot, SimRes2matlab, SimRes2mtv, SimRes2summary, SimRes2tecplot, SimRes2ucd, and SimRes2vtk.

void SimResFilter::simresHeader ( PlotSpecifications & plotspec ) [pure virtual]

task to be done once initially, after processing of command line args (in "driver"). Reimplemented in SimRes2bob, SimRes2explorer, SimRes2gb, SimRes2gnuplot, SimRes2matlab, SimRes2mtv, SimRes2summary, SimRes2tecplot, SimRes2ucd, and SimRes2vtk.

void SimResFilter::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 in SimRes2bob, SimRes2explorer, SimRes2gb, SimRes2gnuplot, SimRes2matlab, SimRes2mtv, SimRes2summary, SimRes2ucd, and SimRes2vtk.

---

Member Data Documentation

SimResFilter::DpList_FieldInformation

SimResFilter::DpList_Fields

DpListItemInst SimResFilter::field_info

DpListItemInst SimResFilter::fields_info

DpListItemHandle SimResFilter::fields_list

String SimResFilter::file_ext [protected]

bool SimResFilter::flipped_grid [static, protected]

String SimResFilter::module_name [protected]

String SimResFilter::options [protected]

bool SimResFilter::silent [protected]

---

The documentation for this class was generated from the following file:

• SimResFilter.h

---