Diffpack Documentation

---

              Search  

---

SimRes2ucd Class Reference

class for exporting simres data to AVS (UCD format). More...

#include <SimRes2ucd.h>

Inheritance diagram for SimRes2ucd::

List of all members.

Public Methods
	SimRes2ucd ()
	~SimRes2ucd ()
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)
void	dumpList (FieldsFE &collection)
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,*")
Public Attributes
String	label
bool	collect_fields
real	current_time
String	multiple_field_outputname
Format_type	multiple_field_format

---

Detailed Description

class for exporting simres data to AVS (UCD format).

NAME: SimRes2ucd - class for exporting simres data to AVS (UCD format)

DESCRIPTION:

This class filters data in SimRes format to the UCD format used by AVS.

---

Constructor & Destructor Documentation

SimRes2ucd::SimRes2ucd ( )

See class "SimResFilter".

SimRes2ucd::~SimRes2ucd ( ) [inline]

---

Member Function Documentation

void SimRes2ucd::dumpList ( FieldsFE & collection )

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

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

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

as "plotVector", but aimed at scalar fields.

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

plots a vector field in "UCD" format

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

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

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

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

void SimRes2ucd::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

bool SimRes2ucd::collect_fields

real SimRes2ucd::current_time

String SimRes2ucd::label

Format_type SimRes2ucd::multiple_field_format

String SimRes2ucd::multiple_field_outputname

---

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

• SimRes2ucd.h

---