Diffpack Documentation

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

SimRes2mtv Class Reference

class for exporting simres data to plotmtv format. More...

#include <SimRes2mtv.h>

Inheritance diagram for SimRes2mtv::

Public Methods
	SimRes2mtv ()
	~SimRes2mtv ()
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 *options="")
void	plotScalar (const FieldFE &scalar_field, const String &filename, const Format_type format=ASCII, const char *options="")
void	plotVector (const FieldsFV &vector_field, const String &filename, const Format_type format=ASCII, const char *options="", const bool smooth=true)
void	plotScalar (const FieldFV &scalar_field, const String &filename, const Format_type format=ASCII, const char *options="", const bool smooth=true)
void	plotVector (const FieldsPiWisConst &vector_field, const String &filename, const Format_type format=ASCII, const char *options="")
void	plotScalar (const FieldPiWisConst &scalar_field, const String &filename, const Format_type format=ASCII, const char *options="")
void	plotScalar (const FieldLattice &scalar_field, const String &filename, const Format_type format=ASCII, const char *options="")
void	fe3d22d (const FieldFE &field3D, FieldLattice &field2D, int dir, int level, const String &field2D_name)
void	plotScalar3DCrossSections (const FieldFE &fe3D, int dir, int jump, const String &filename_stem)

Detailed Description

class for exporting simres data to plotmtv format.

NAME: SimRes2mtv - class for exporting simres data to plotmtv format

DESCRIPTION:

This class filters data in SimRes format to the "Plotmtv" format.

Constructor & Destructor Documentation

SimRes2mtv::SimRes2mtv ( )

See class "SimResFilter".

SimRes2mtv::~SimRes2mtv ( ) [inline]

Member Function Documentation

void SimRes2mtv::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 SimRes2mtv::exportVectorField ( Fields & vectorfield,

FieldInformation & fieldinfo,

PlotSpecifications & plotspec ) [virtual]

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

static void SimRes2mtv::fe3d22d ( const FieldFE & field3D,

FieldLattice & field2D,

int dir,

int level,

const String & field2D_name ) [static]

extracts a 2D section from a 3D field. The 3D field must be of lattice type, and the function will return a filled-in 2D "FieldLattice" object. The input data "dir" and "level" determines the 2D section by picking the "level"th 2D plane in the direction "dir".

static void SimRes2mtv::plotScalar ( const FieldLattice & scalar_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " " ) [static]

See documentation of one of the overloaded functions.

static void SimRes2mtv::plotScalar ( const FieldPiWisConst & scalar_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " " ) [static]

See documentation of one of the overloaded functions.

static void SimRes2mtv::plotScalar ( const FieldFV & scalar_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " ",

const bool smooth = true ) [static]

See documentation of one of the overloaded functions.

static void SimRes2mtv::plotScalar ( const FieldFE & scalar_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " " ) [static]

as "plotVector", but aimed at scalar fields.

static void SimRes2mtv::plotScalar3DCrossSections ( const FieldFE & fe3D,

int dir,

int jump,

const String & filename_stem ) [static]

extracts one or more cross sections from a 3D lattice field and saves them to file. The sections are determined by "dir" and "jump", generating a cross-section plot for each "jump"th index in the direction indicated by "dir". Each cross-section plot is handled by "fe3d22d".

static void SimRes2mtv::plotVector ( const FieldsPiWisConst & vector_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " " ) [static]

See documentation of one of the overloaded functions.

static void SimRes2mtv::plotVector ( const FieldsFV & vector_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " ",

const bool smooth = true ) [static]

See documentation of one of the overloaded functions.

static void SimRes2mtv::plotVector ( const FieldsFE & vector_field,

const String & filename,

const Format_type format = ASCII,

const char * options = " " ) [static]

plots a vector field in "Plotmtv" format

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

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

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

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

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

SimRes2mtv.h

Diffpack Documentation

SimRes2mtv Class Reference

Public Methods

Static Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation