Diffpack Documentation

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

SimRes2matlab Class Reference

class for exporting simres data to. More...

#include <SimRes2matlab.h>

Inheritance diagram for SimRes2matlab::

SimResFilter List of all members.

Public Methods

 SimRes2matlab ()
 ~SimRes2matlab ()
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 init (String &tit, FieldInformation &fieldinfo, PlotSpecifications &plotspec)

Static Public Methods

void getmatlabNodeSequence (const GridFE &grid, VecSimplest(int) &ns, int &drawnodes, int &patchnodes, int &totpatches)
void plotmatlabNodeValues (const FieldFE &scalar_field, const String &filename, Os scriptfile, const Format_type format, const char *options, int frame_counter)
void plotVector (const FieldsFE &vector_field, const String &filename, Os scriptfile, const Format_type format=ASCII, const char *options="", int frame_counter=1)
void plotVector (const FieldsPiWisConst &vector_field, const String &filename, Os scriptfile, const Format_type format=ASCII, const char *options="", int frame_counter=1)
void plotScalar (const FieldFE &scalar_field, const String &filename, Os scriptfile, const Format_type format=ASCII, const char *options="", int frame_counter=1)
void plotScalar (const FieldPiWisConst &scalar_field, const String &filename, Os scriptfile, const Format_type format=ASCII, const char *options="", int frame_counter=1)
void plotScalar (const FieldLattice &scalar_field, const String &filename, Os scriptfile, const Format_type format=ASCII, const char *options="", int frame_counter=1)

Public Attributes

String mfile_name
Os mfile
int frame_counter
bool dumpnodes
bool movie
NUMT fmax
NUMT fmin
Ptv(real) gmin
Ptv(real) gmax
int field_nsd

Static Public Attributes

bool first_call

Detailed Description

class for exporting simres data to.

NAME: SimRes2matlab - class for exporting simres data to

DESCRIPTION:

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

Constructor & Destructor Documentation

SimRes2matlab::SimRes2matlab ( )
 

See class "SimResFilter".

SimRes2matlab::~SimRes2matlab ( ) [inline]
 

Member Function Documentation

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

as "exportScalarField", but handles vector fields instead.

Reimplemented from SimResFilter.

void SimRes2matlab::getmatlabNodeSequence ( const GridFE & grid,
VecSimplest(int) & ns,
int & drawnodes,
int & patchnodes,
int & totpatches ) [static]
 

void SimRes2matlab::init ( String & tit,
FieldInformation & fieldinfo,
PlotSpecifications & plotspec )
 

static void SimRes2matlab::plotScalar ( const FieldLattice & scalar_field,
const String & filename,
Os scriptfile,
const Format_type format = ASCII,
const char * options = " ",
int frame_counter = 1 ) [static]
 

See documentation of one of the overloaded functions.

static void SimRes2matlab::plotScalar ( const FieldPiWisConst & scalar_field,
const String & filename,
Os scriptfile,
const Format_type format = ASCII,
const char * options = "",
int frame_counter = 1 ) [static]
 

See documentation of one of the overloaded functions.

static void SimRes2matlab::plotScalar ( const FieldFE & scalar_field,
const String & filename,
Os scriptfile,
const Format_type format = ASCII,
const char * options = "",
int frame_counter = 1 ) [static]
 

as "plotVector", but aimed at scalar fields. Both 2D and 3D plots are made by filling polygons in 2D and 3D.

static void SimRes2matlab::plotVector ( const FieldsPiWisConst & vector_field,
const String & filename,
Os scriptfile,
const Format_type format = ASCII,
const char * options = "",
int frame_counter = 1 ) [static]
 

See documentation of one of the overloaded functions.

static void SimRes2matlab::plotVector ( const FieldsFE & vector_field,
const String & filename,
Os scriptfile,
const Format_type format = ASCII,
const char * options = "",
int frame_counter = 1 ) [static]
 

plots a vector field in "matlab" format. A file with name "filename" will contain the data (the field and grid information), while the file given throught the "Os" argument contains a script for realizing the plot in "matlab".

It is also useful in programs for dumping fields in "matlab" format directly, for example with additional titles, comments etc, instead of dumping fields on a general SimRes file and the use an export program like "simres2matlab". The "plotVector" and "plotScalar" functions are of course used by the "simres2matlab" program.

static void SimRes2matlab::plotmatlabNodeValues ( const FieldFE & scalar_field,
const String & filename,
Os scriptfile,
const Format_type format,
const char * options,
int frame_counter ) [static]
 

as "plotScalar", but only plots nodal values (line plot in 1D).

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

task to be done just before exiting the filter.

Reimplemented from SimResFilter.

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

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

Reimplemented from SimResFilter.

void SimRes2matlab::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 SimRes2matlab::dumpnodes
 

int SimRes2matlab::field_nsd
 

bool SimRes2matlab::first_call [static]
 

NUMT SimRes2matlab::fmax
 

NUMT SimRes2matlab::fmin
 

int SimRes2matlab::frame_counter
 

Ptv(real) SimRes2matlab::gmax
 

Ptv(real) SimRes2matlab::gmin
 

Os SimRes2matlab::mfile
 

String SimRes2matlab::mfile_name
 

bool SimRes2matlab::movie
 

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