libMesh::PltLoader Class Reference

This class will read a binary .plt file. More...

#include <plt_loader.h>

Public Types
enum	OldZoneType { BLOCK =0, POINT, FEBLOCK, FEPOINT }
	Writes a plot3d files. More...
enum	NewZoneType {   ORDERED =0, FELINESEG, FETRIANGLE, FEQUADRILATERAL,   FETETRAHEDRON, FEBRICK }
	Enum defining the zone type in the Tecplot binary file, for use with the new .plt format. More...
enum	DataType {   FLOAT =1, DOUBLE, LONGINT, SHORTINT,   BYTE, BIT }
	Enum defining the data type of each variable. More...
enum	FEType { TRI =0, QUAD, TET, HEX }
	Enum defining the finite element types. More...

Public Member Functions
	PltLoader (const bool v=false)
	Constructor. More...
	PltLoader (const std::string &name, const bool v=false)
	Constructor. More...
	~PltLoader ()
	Destructor. More...
void	clear ()
	Clear all data and return to a pristine state. More...
bool	verbose () const
void	read (const std::string &name)
	Reads the .plt file specified by name. More...
void	write_dat (const std::string &name, const unsigned int version=10) const
	Writes an ASCII Tecplot file. More...
const std::string &	version () const
bool	is_foreign () const
const std::string &	title () const
unsigned int	n_vars () const
const std::string &	var_name (const unsigned int v) const
unsigned int	var_type (const unsigned int v) const
unsigned int	n_zones () const
unsigned int	zone_type (const unsigned int z) const
const std::string &	zone_name (const unsigned int z) const
unsigned int	zone_pack (const unsigned int z) const
unsigned int	imax (const unsigned int z) const
unsigned int	jmax (const unsigned int z) const
unsigned int	kmax (const unsigned int z) const
unsigned int	n_nodes (const unsigned int z) const
unsigned int	n_elem (const unsigned int z) const
FEType	elem_type (const unsigned int z) const
const std::vector< std::vector< std::vector< float > > > &	get_data () const

Static Public Attributes
static const unsigned int	NNodes [4]
	Enum defining the number of nodes for each element type. More...

Private Member Functions
void	read_header (std::istream &in)
	Read the header of the binary file. More...
void	read_data (std::istream &in)
	Read data from the binary file. More...
void	read_block_data (std::istream &in, const unsigned int zn)
	Read data for the zth zone in BLOCK structured format. More...
void	read_point_data (std::istream &in, const unsigned int zn)
	Read data for the zth zone in POINT structured format. More...
void	read_feblock_data (std::istream &in, const unsigned int zn)
	Read data for the zth zone in FEBLOCK unstructured format. More...
void	read_fepoint_data (std::istream &in, const unsigned int zn)
	Read data for the zth zone in FEPOINT unstructured format. More...
std::string &	version ()
bool &	is_foreign ()
std::string &	title ()
void	set_n_vars (const unsigned int nv)
std::string &	var_name (const unsigned int v)
unsigned int &	var_type (const unsigned int v)
void	set_n_zones (const unsigned int nz)
unsigned int &	zone_type (const unsigned int z)
std::string &	zone_name (const unsigned int z)
unsigned int &	zone_pack (const unsigned int z)
unsigned int &	imax (const unsigned int z)
unsigned int &	jmax (const unsigned int z)
unsigned int &	kmax (const unsigned int z)

Private Attributes
const bool	_verbose
	Verbosity. More...
std::string	_version
	The Tecplot Version number string. More...
bool	_is_foreign
	Is the data foreign? More...
std::string	_title
	The Tecplot data set title. More...
unsigned int	_n_vars
	The number of variables in the data set. More...
std::vector< std::string >	_var_names
	The name for each variable. More...
std::vector< unsigned int >	_var_types
	The type of each variable. More...
unsigned int	_n_zones
	The number of zones. More...
std::vector< unsigned int >	_zone_types
	The type of each zone. More...
std::vector< std::string >	_zone_names
	The name of each zone. More...
std::vector< unsigned int >	_zone_pack
	The data packing for each zone (new version only) More...
std::vector< unsigned int >	_imax
	The (imax,jmax,kmax) value for each zone. More...
std::vector< unsigned int >	_jmax
std::vector< unsigned int >	_kmax
std::vector< std::vector< std::vector< float > > >	_data
	Vector to hold the data. More...
std::vector< std::vector< int > >	_conn
	Vectors to hold the connectivity for each zone (only for unstructured files). More...
char	buf [512]
	Scratch data & relevant sizes. More...

Detailed Description

This class will read a binary .plt file.

These types of files are for use with Amtec's Tecplot visualization package.

Author

Benjamin S. Kirk

Date

2004

Definition at line 43 of file plt_loader.h.

Member Enumeration Documentation

DataType

enum libMesh::PltLoader::DataType

Enum defining the data type of each variable.

Enumerator
FLOAT
DOUBLE
LONGINT
SHORTINT
BYTE
BIT

Definition at line 136 of file plt_loader.h.

                { FLOAT=1,
                  DOUBLE,
                  LONGINT,
                  SHORTINT,
                  BYTE,
                  BIT};

FEType

enum libMesh::PltLoader::FEType

Enum defining the finite element types.

Enumerator
TRI
QUAD
TET
HEX

Definition at line 146 of file plt_loader.h.

              { TRI=0,
                QUAD,
                TET,
                HEX };

NewZoneType

enum libMesh::PltLoader::NewZoneType

Enum defining the zone type in the Tecplot binary file, for use with the new .plt format.

Enumerator
ORDERED
FELINESEG
FETRIANGLE
FEQUADRILATERAL
FETETRAHEDRON
FEBRICK

Definition at line 126 of file plt_loader.h.

                   { ORDERED=0,
                     FELINESEG,
                     FETRIANGLE,
                     FEQUADRILATERAL,
                     FETETRAHEDRON,
                     FEBRICK };

OldZoneType

enum libMesh::PltLoader::OldZoneType

Writes a plot3d files.

The grid will be in basename.g and the solution will be in basename.q. It is assumed that the first three variables from the .plt file are the (x,y,z) locations of the grid points. The optional parameter reverse specifies if the output file will have reversed byte ordering. Writes a Cart3D .tri component file. The number of components will be the number of zones in the .plt file. Enum defining the zone type in the Tecplot binary file, for use with the old .plt format.

Enumerator
BLOCK
POINT
FEBLOCK
FEPOINT

Definition at line 117 of file plt_loader.h.

                   { BLOCK=0,
                     POINT,
                     FEBLOCK,
                     FEPOINT };

Constructor & Destructor Documentation

PltLoader() [1/2]

libMesh::PltLoader::PltLoader

(

const bool

v = false

)

Constructor.

Initializes data.

Definition at line 449 of file plt_loader.h.

                                  :
  _verbose      (v),
  _is_foreign   (false),
  _n_vars       (0),
  _n_zones      (0)
{
}

PltLoader() [2/2]

libMesh::PltLoader::PltLoader	(	const std::string &	name,
		const bool	v = false
	)

Constructor.

Reads the file specified by name.

Definition at line 460 of file plt_loader.h.

References read().

                                                          :
  _verbose      (v),
  _is_foreign   (false),
  _n_vars       (0),
  _n_zones      (0)
{
  this->read (name);
}

~PltLoader()

libMesh::PltLoader::~PltLoader

(

)

Destructor.

Definition at line 472 of file plt_loader.h.

{
}

Member Function Documentation

clear()

void libMesh::PltLoader::clear

(

)

Clear all data and return to a pristine state.

elem_type()

PltLoader::FEType libMesh::PltLoader::elem_type

(

const unsigned int

z

)

const

Returns

The element type for the zth zone (for unstructured meshes).

Definition at line 691 of file plt_loader.h.

References kmax(), n_zones(), and zone_type().

{
  libmesh_assert_less (z, this->n_zones());

  // Only for unstructured zones!
  libmesh_assert_greater (this->zone_type(z), 1);

  return static_cast<FEType>(this->kmax(z));
}

get_data()

const std::vector< std::vector< std::vector< float > > > & libMesh::PltLoader::get_data

(

)

const

Returns

A reference to the data read from the file

Definition at line 704 of file plt_loader.h.

References _data.

{
  return _data;
}

imax() [1/2]

unsigned int libMesh::PltLoader::imax

(

const unsigned int

z

)

const

Returns

imax for zone z.

Definition at line 599 of file plt_loader.h.

References _imax, and n_zones().

Referenced by n_nodes().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_equal_to (_imax.size(), this->n_zones());

  return _imax[z];
}

imax() [2/2]

unsigned int & libMesh::PltLoader::imax ( const unsigned int  z )

private

Returns

imax for zone z.

Definition at line 610 of file plt_loader.h.

References _imax, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_equal_to (_imax.size(), this->n_zones());

  return _imax[z];
}

is_foreign() [1/2]

bool libMesh::PltLoader::is_foreign

(

)

const

Returns

true if the binary type of the file is different than the machine that is reading it. If this is the case we must perform an endian-swap on all input data.

Definition at line 170 of file plt_loader.h.

References _is_foreign.

{ return _is_foreign; }

is_foreign() [2/2]

bool& libMesh::PltLoader::is_foreign ( )

private

Returns

true if the binary type of the file is different than the machine that is reading it. If this is the case we must perform an endian-swap on all input data.

Definition at line 302 of file plt_loader.h.

References _is_foreign.

{ return _is_foreign; }

jmax() [1/2]

unsigned int libMesh::PltLoader::jmax

(

const unsigned int

z

)

const

Returns

jmax for zone z.

Definition at line 621 of file plt_loader.h.

References _jmax, and n_zones().

Referenced by n_elem().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_equal_to (_jmax.size(), this->n_zones());

  return _jmax[z];
}

jmax() [2/2]

unsigned int & libMesh::PltLoader::jmax ( const unsigned int  z )

private

Returns

jmax for zone z.

Definition at line 632 of file plt_loader.h.

References _jmax, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_equal_to (_jmax.size(), this->n_zones());

  return _jmax[z];
}

kmax() [1/2]

unsigned int libMesh::PltLoader::kmax

(

const unsigned int

z

)

const

Returns

kmax for zone z.

Definition at line 643 of file plt_loader.h.

References _kmax, and n_zones().

Referenced by elem_type().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_equal_to (_kmax.size(), this->n_zones());

  return _kmax[z];
}

kmax() [2/2]

unsigned int & libMesh::PltLoader::kmax ( const unsigned int  z )

private

Returns

kmax for zone z.

Definition at line 654 of file plt_loader.h.

References _kmax, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_equal_to (_kmax.size(), this->n_zones());

  return _kmax[z];
}

n_elem()

unsigned int libMesh::PltLoader::n_elem

(

const unsigned int

z

)

const

Returns

The number of elements in the mesh (for unstructured meshes).

Definition at line 678 of file plt_loader.h.

References jmax(), n_zones(), and zone_type().

{
  libmesh_assert_less (z, this->n_zones());

  // Only for unstructured zones!
  libmesh_assert_greater (this->zone_type(z), 1);

  return this->jmax(z);
}

n_nodes()

unsigned int libMesh::PltLoader::n_nodes

(

const unsigned int

z

)

const

Returns

The number of nodes in the mesh (for unstructured meshes).

Definition at line 665 of file plt_loader.h.

References imax(), n_zones(), and zone_type().

{
  libmesh_assert_less (z, this->n_zones());

  // Only for unstructured zones!
  libmesh_assert_greater (this->zone_type(z), 1);

  return this->imax(z);
}

n_vars()

unsigned int libMesh::PltLoader::n_vars

(

)

const

Returns

The number of variables in the data set.

Definition at line 180 of file plt_loader.h.

References _n_vars.

Referenced by var_name(), and var_type().

{ return _n_vars; }

n_zones()

unsigned int libMesh::PltLoader::n_zones

(

)

const

Returns

The number of zones.

Definition at line 195 of file plt_loader.h.

References _n_zones.

Referenced by elem_type(), imax(), jmax(), kmax(), n_elem(), n_nodes(), zone_name(), zone_pack(), and zone_type().

{ return _n_zones; }

read()

void libMesh::PltLoader::read

(

const std::string &

name

)

Reads the .plt file specified by name.

Referenced by PltLoader().

read_block_data()

void libMesh::PltLoader::read_block_data ( std::istream &  in, const unsigned int  zn  )

private

Read data for the zth zone in BLOCK structured format.

read_data()

void libMesh::PltLoader::read_data ( std::istream &  in )

private

Read data from the binary file.

read_feblock_data()

void libMesh::PltLoader::read_feblock_data ( std::istream &  in, const unsigned int  zn  )

private

Read data for the zth zone in FEBLOCK unstructured format.

read_fepoint_data()

void libMesh::PltLoader::read_fepoint_data ( std::istream &  in, const unsigned int  zn  )

private

Read data for the zth zone in FEPOINT unstructured format.

read_header()

void libMesh::PltLoader::read_header ( std::istream &  in )

private

Read the header of the binary file.

read_point_data()

void libMesh::PltLoader::read_point_data ( std::istream &  in, const unsigned int  zn  )

private

Read data for the zth zone in POINT structured format.

set_n_vars()

void libMesh::PltLoader::set_n_vars ( const unsigned int  nv )

private

Returns

The number of variables in the data set.

set_n_zones()

void libMesh::PltLoader::set_n_zones ( const unsigned int  nz )

private

Returns

The number of zones.

title() [1/2]

const std::string& libMesh::PltLoader::title

(

)

const

Returns

The data set title

Definition at line 175 of file plt_loader.h.

References _title.

{ return _title; }

title() [2/2]

std::string& libMesh::PltLoader::title ( )

private

Returns

The data set title

Definition at line 307 of file plt_loader.h.

References _title.

{ return _title; }

var_name() [1/2]

const std::string & libMesh::PltLoader::var_name

(

const unsigned int

v

)

const

Returns

The name of variable v.

Definition at line 479 of file plt_loader.h.

References _var_names, and n_vars().

{
  libmesh_assert_less (v, this->n_vars());
  libmesh_assert_less (v, _var_names.size());
  libmesh_assert_equal_to (this->n_vars(), _var_names.size());

  return _var_names[v];
}

var_name() [2/2]

std::string & libMesh::PltLoader::var_name ( const unsigned int  v )

private

Returns

The name of variable v.

Definition at line 491 of file plt_loader.h.

References _var_names, and n_vars().

{
  libmesh_assert_less (v, this->n_vars());
  libmesh_assert_less (v, _var_names.size());
  libmesh_assert_equal_to (this->n_vars(), _var_names.size());

  return _var_names[v];
}

var_type() [1/2]

unsigned int libMesh::PltLoader::var_type

(

const unsigned int

v

)

const

Returns

The type of variable v

Definition at line 503 of file plt_loader.h.

References _var_types, and n_vars().

{
  libmesh_assert_less (v, this->n_vars());
  libmesh_assert_less (v, _var_types.size());
  libmesh_assert_equal_to (this->n_vars(), _var_types.size());

  return _var_types[v];
}

var_type() [2/2]

unsigned int & libMesh::PltLoader::var_type ( const unsigned int  v )

private

Returns

The type of variable v

Definition at line 515 of file plt_loader.h.

References _var_types, and n_vars().

{
  libmesh_assert_less (v, this->n_vars());
  libmesh_assert_less (v, _var_types.size());
  libmesh_assert_equal_to (this->n_vars(), _var_types.size());

  return _var_types[v];
}

verbose()

bool libMesh::PltLoader::verbose

(

)

const

Returns

The verbosity.

Definition at line 70 of file plt_loader.h.

References _verbose.

{ return _verbose; }

version() [1/2]

const std::string& libMesh::PltLoader::version

(

)

const

Returns

The Tecplot version number string. This identifies the version of Tecplot (or preplot) that wrote the binary file. Currently, PltLoader understands versions "#!TDV7X " and "#!TDV1XX"

Definition at line 163 of file plt_loader.h.

References _version.

{ return _version; }

version() [2/2]

std::string& libMesh::PltLoader::version ( )

private

Returns

The Tecplot version number string.

Definition at line 295 of file plt_loader.h.

References _version.

{ return _version; }

write_dat()

void libMesh::PltLoader::write_dat	(	const std::string &	name,
		const unsigned int	version = 10
	)		const

Writes an ASCII Tecplot file.

The optional parameter version specifies the version format to write.

zone_name() [1/2]

const std::string & libMesh::PltLoader::zone_name

(

const unsigned int

z

)

const

Returns

The name of zone z.

Definition at line 551 of file plt_loader.h.

References _zone_names, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_less (z, _zone_names.size());
  libmesh_assert_equal_to (this->n_zones(), _zone_names.size());

  return _zone_names[z];
}

zone_name() [2/2]

std::string & libMesh::PltLoader::zone_name ( const unsigned int  z )

private

Returns

The name of zone z.

Definition at line 563 of file plt_loader.h.

References _zone_names, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_less (z, _zone_names.size());
  libmesh_assert_equal_to (this->n_zones(), _zone_names.size());

  return _zone_names[z];
}

zone_pack() [1/2]

unsigned int libMesh::PltLoader::zone_pack

(

const unsigned int

z

)

const

Returns

The data packing flag for zone z.

Definition at line 575 of file plt_loader.h.

References _zone_pack, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_less (z, _zone_pack.size());
  libmesh_assert_equal_to (this->n_zones(), _zone_pack.size());

  return _zone_pack[z];
}

zone_pack() [2/2]

unsigned int & libMesh::PltLoader::zone_pack ( const unsigned int  z )

private

Returns

The data pack flag for zone z.

Definition at line 587 of file plt_loader.h.

References _zone_pack, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_less (z, _zone_pack.size());
  libmesh_assert_equal_to (this->n_zones(), _zone_pack.size());

  return _zone_pack[z];
}

zone_type() [1/2]

unsigned int libMesh::PltLoader::zone_type

(

const unsigned int

z

)

const

Returns

The type of zone z

Definition at line 527 of file plt_loader.h.

References _zone_types, and n_zones().

Referenced by elem_type(), n_elem(), and n_nodes().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_less (z, _zone_types.size());
  libmesh_assert_equal_to (this->n_zones(), _zone_types.size());

  return _zone_types[z];
}

zone_type() [2/2]

unsigned int & libMesh::PltLoader::zone_type ( const unsigned int  z )

private

Returns

The type of zone z

Definition at line 539 of file plt_loader.h.

References _zone_types, and n_zones().

{
  libmesh_assert_less (z, this->n_zones());
  libmesh_assert_less (z, _zone_types.size());
  libmesh_assert_equal_to (this->n_zones(), _zone_types.size());

  return _zone_types[z];
}

Member Data Documentation

_conn

std::vector<std::vector<int> > libMesh::PltLoader::_conn

private

Vectors to hold the connectivity for each zone (only for unstructured files).

Definition at line 436 of file plt_loader.h.

_data

std::vector<std::vector<std::vector<float> > > libMesh::PltLoader::_data

private

Vector to hold the data.

Definition at line 430 of file plt_loader.h.

Referenced by get_data().

_imax

std::vector<unsigned int> libMesh::PltLoader::_imax

private

The (imax,jmax,kmax) value for each zone.

Definition at line 423 of file plt_loader.h.

Referenced by imax().

_is_foreign

bool libMesh::PltLoader::_is_foreign

private

Is the data foreign?

Definition at line 377 of file plt_loader.h.

Referenced by is_foreign().

_jmax

std::vector<unsigned int> libMesh::PltLoader::_jmax

private

Definition at line 424 of file plt_loader.h.

Referenced by jmax().

_kmax

std::vector<unsigned int> libMesh::PltLoader::_kmax

private

Definition at line 425 of file plt_loader.h.

Referenced by kmax().

_n_vars

unsigned int libMesh::PltLoader::_n_vars

private

The number of variables in the data set.

Definition at line 387 of file plt_loader.h.

Referenced by n_vars().

_n_zones

unsigned int libMesh::PltLoader::_n_zones

private

The number of zones.

Definition at line 403 of file plt_loader.h.

Referenced by n_zones().

_title

std::string libMesh::PltLoader::_title

private

The Tecplot data set title.

Definition at line 382 of file plt_loader.h.

Referenced by title().

_var_names

std::vector<std::string> libMesh::PltLoader::_var_names

private

The name for each variable.

Definition at line 392 of file plt_loader.h.

Referenced by var_name().

_var_types

std::vector<unsigned int> libMesh::PltLoader::_var_types

private

The type of each variable.

Must be one of the enumerated DataType types.

Definition at line 398 of file plt_loader.h.

Referenced by var_type().

_verbose

const bool libMesh::PltLoader::_verbose

private

Verbosity.

Definition at line 367 of file plt_loader.h.

Referenced by verbose().

_version

std::string libMesh::PltLoader::_version

private

The Tecplot Version number string.

Definition at line 372 of file plt_loader.h.

Referenced by version().

_zone_names

std::vector<std::string> libMesh::PltLoader::_zone_names

private

The name of each zone.

Definition at line 413 of file plt_loader.h.

Referenced by zone_name().

_zone_pack

std::vector<unsigned int> libMesh::PltLoader::_zone_pack

private

The data packing for each zone (new version only)

Definition at line 418 of file plt_loader.h.

Referenced by zone_pack().

_zone_types

std::vector<unsigned int> libMesh::PltLoader::_zone_types

private

The type of each zone.

Definition at line 408 of file plt_loader.h.

Referenced by zone_type().

buf

char libMesh::PltLoader::buf[512]

mutableprivate

Scratch data & relevant sizes.

Definition at line 441 of file plt_loader.h.

NNodes

const unsigned int libMesh::PltLoader::NNodes[4]

static

Enum defining the number of nodes for each element type.

Definition at line 250 of file plt_loader.h.

---

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

• include/utils/plt_loader.h