Diffpack Documentation

---

              Search  

---

SimRes2explorer Class Reference

class for exporting simres data to IRIS Explorer. More...

#include <SimRes2explorer.h>

Inheritance diagram for SimRes2explorer::

List of all members.

Public Methods
	SimRes2explorer ()
	~SimRes2explorer ()
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	plotVector (const FieldsFE &vector_field, const String &filename, const Format_type format=ASCII, const char *label="Vector,*")
void	plotScalar (const FieldFE &scalar_field, const String &filename, const Format_type format=ASCII, const char *label="Scalar,*")
void	plotVector (const FieldsLattice &vector_field, const String &filename, const Format_type format=ASCII)
void	plotScalar (const FieldLattice &scalar_field, const String &filename, const Format_type format=ASCII)
Public Attributes
String	label

---

Detailed Description

class for exporting simres data to IRIS Explorer.

NAME: SimRes2explorer - class for exporting simres data to IRIS Explorer

DESCRIPTION:

This class filters data in SimRes format to the format used by the visualization program IRIS Explorer.

---

Constructor & Destructor Documentation

SimRes2explorer::SimRes2explorer ( )

See class "SimResFilter".

SimRes2explorer::~SimRes2explorer ( ) [inline]

---

Member Function Documentation

void SimRes2explorer::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 SimRes2explorer::exportVectorField ( Fields & vectorfield, FieldInformation & fieldinfo, PlotSpecifications & plotspec ) [virtual]

as "exportScalarField", but handles vector fields instead. Reimplemented from SimResFilter.

void SimRes2explorer::plotScalar ( const FieldLattice & scalar_field, const String & filename, const Format_type format = ASCII ) [static]

void SimRes2explorer::plotScalar ( const FieldFE & scalar_field, const String & filename, const Format_type format = ASCII, const char * label = "Scalar,*" ) [static]

void SimRes2explorer::plotVector ( const FieldsLattice & vector_field, const String & filename, const Format_type format = ASCII ) [static]

void SimRes2explorer::plotVector ( const FieldsFE & vector_field, const String & filename, const Format_type format = ASCII, const char * label = "Vector,*" ) [static]

void SimRes2explorer::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 SimRes2explorer::simresFooter ( PlotSpecifications & plotspec ) [virtual]

task to be done just before exiting the filter. Reimplemented from SimResFilter.

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

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

void SimRes2explorer::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.

---

Member Data Documentation

String SimRes2explorer::label

---

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

• SimRes2explorer.h

---