class UCD

Save field and normal derivative values in UCD file (*inp) for subsequent plotting using AVS/Express for instance.

Public Methods

UCD(const std::string filename, const int nsteps=1)

Constructor.

void setXY(const Vec &xi, const Vec &yi)

Set the contour coordinates.

void setV(const Vec &node_values, const std::string name="v", const std::string name_units="m")

Set the field's values.

void setDvn(const Vec &node_values, const std::string name="dvn", const std::string name_units="1")

Set the field's normal derivatives.

void dumpData(int step=1)

Save the data in file.

~UCD()

Destructor

Documentation

Save field and normal derivative values in UCD file (*inp) for subsequent plotting using AVS/Express for instance.

UCD(const std::string filename, const int nsteps=1)

Constructor. Data are saved in 'filename'. For movie allow nsteps >1.

Parameters:

filename - where data will be saved
nsteps - set this to > 1 for a movie.

void setXY(const Vec &xi, const Vec &yi)

Set the contour coordinates. Neighbour (x, y) are connected [i.e. (x, y)_i connects to (x, y)_i-1 and (x, y)_i+1].

Parameters:

xi - x coordinates
yi - y coordinates

See Also:

setXY

void setV(const Vec &node_values, const std::string name="v", const std::string name_units="m")

Set the field's values. Call this after invoking setXY.

Parameters:

node_values - field's values on the nodes
name - the field's name (legend)
name_units - the field's units

See Also:

setXY

void setDvn(const Vec &node_values, const std::string name="dvn", const std::string name_units="1")

Set the field's normal derivatives. Call this after invoking setXY.

Parameters:

node_values - field's normal derivatives on the nodes
name - the name of the field's normal derivative (legend)
name_units - the units of the field's normal derivative

See Also:

setXY

void dumpData(int step=1)

Save the data in file. Call this after invoking setXY, setV and setDvn.

Parameters:

- step the 'time' step.

See Also:

setXY
setV
setDvn

~UCD()

Destructor

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java