IOField Class Reference
[Input/Output]

#include <IOField.h>

List of all members.

---

Detailed Description

Enables working with files in the XML Format.

Public Member Functions
void	close ()
	Close XML file.
int	get (EdgeVect< double > &v, double t)
	Get an ElementVect instance from file with time value t.
int	get (EdgeVect< double > &v)
	Get EdgeVect instance v from file.
int	get (SideVect< double > &v, double t)
	Get ElementVect instance v from file with time value t.
int	get (SideVect< double > &v)
	Get SideVect instance v from file.
int	get (ElementVect< double > &v, double t)
	Get ElementVect instance v from file with time value t.
int	get (ElementVect< double > &v)
	Get ElementVect instance v from file.
int	get (NodeVect< double > &v, double t)
	Get NodeVect instance v from file with time value t.
int	get (NodeVect< double > &v)
	Get NodeVect instance v from file.
double	get (Vect< double > &v)
	Get Vect v instance from file.
	IOField (const string &mesh_file, const string &file, Mesh &ms, int access, bool compact=true)
	Constructor using file name and mesh.
	IOField (const string &file, int access, bool compact=true)
	Constructor using file name.
	IOField ()
	Default constructor.
void	open (const string &file, int access)
	Open XML file.
void	open ()
	Open XML file.
void	put (const Vect< double > &v, const string &name="u", size_t nb_dof=1, double t=0, int type=NODE_FIELD)
	Store Vect instance v in file with time value t.
void	put (const SideVect< double > &v)
	Store SideVect instance v in file.
void	put (const ElementVect< double > &v)
	Store ElementVect instance v in file.
void	put (const NodeVect< double > &v)
	Store NodeVect instance v in file.
void	setMeshFile (const string &file)
	Set mesh file.
	~IOField ()
	Destructor.

---

Constructor & Destructor Documentation

IOField	(	const string &	file,
		int	access,
		bool	compact = true
	)

Constructor using file name.

Parameters:

[in]	file	File name.
[in]	access	Access code. This number is to be chosen among two enumerated values: XML_READ to read the FDF file XML_WRITE to write on it

IOField	(	const string &	mesh_file,
		const string &	file,
		Mesh &	ms,
		int	access,
		bool	compact = true
	)

Constructor using file name and mesh.

Parameters:

[in]	mesh_file	File containing mesh
[in]	file	File that contains field stored or to store
[in]	ms	Mesh instance
[in]	access	Access code. This number is to be chosen among two enumerated values: XML_READ to read the FDF file XML_WRITE to write on it

---

Member Function Documentation

double get

(

Vect< double > &

v

)

Get Vect v instance from file.

First time step is read from the XML file.

void open	(	const string &	file,
		int	access
	)

Open XML file.

Parameters:

[in]	file	File name.
[in]	access	Access code. This number is to be chosen among two enumerated values: XML_READ to read the XML file XML_WRITE to write on it

void open

(

)

Open XML file.

Case where file name has been previously given (in the constructor).

void put	(	const Vect< double > &	v,
		const string &	name = "u",
		size_t	nb_dof = 1,
		double	t = 0,
		int	type = NODE_FIELD
	)

Store Vect instance v in file with time value t.

Parameters:

[in]	v	Vect instance to store
[in]	name	Name to assign to vector
[in]	nb_dof	Number of degrees of freedom per entity (by node, side or element) [default: 1]
[in]	t	Time value to store (default = 1)
[in]	type	Type of vector to store (to choose among enumerated values NODE_FIELD, ELEMENT_FIELD, or SIDE_FIELD)

void setMeshFile

(

const string &

file

)

Set mesh file.

Parameters:

[in]

file

Mesh file