#include <MEDMEM_Field.hxx>

Inheritance diagram for MEDMEM.FIELD_:

Public Member Functions
	FIELD_ ()
	FIELD_ (const SUPPORT *Support, const int NumberOfComponents)
	FIELD_ (const FIELD_ &m)
virtual	~FIELD_ ()
FIELD_ &	operator= (const FIELD_ &m)
virtual void	rmDriver (int index=0)
virtual int	addDriver (driverTypes driverType, const string &fileName="Default File Name.med", const string &driverFieldName="Default Field Nam", MED_EN::med_mode_acces access=MED_EN::RDWR)
virtual int	addDriver (GENDRIVER &driver)
virtual void	read (driverTypes driverType, const std::string &fileName)
virtual void	read (const GENDRIVER &)
virtual void	read (int index=0)
virtual void	openAppend (void)
virtual void	write (const GENDRIVER &, MED_EN::med_mode_acces medMode=MED_EN::RDWR)
virtual void	write (driverTypes driverType, const std::string &fileName, MED_EN::med_mode_acces medMode=MED_EN::RDWR)
virtual void	write (int index=0)
virtual void	writeAppend (const GENDRIVER &)
virtual void	writeAppend (int index=0, const string &driverName="")
void	setName (const string Name)
string	getName () const
void	setDescription (const string Description)
string	getDescription () const
const SUPPORT *	getSupport () const
void	setSupport (const SUPPORT *support)
void	setNumberOfComponents (const int NumberOfComponents)
int	getNumberOfComponents () const
void	setNumberOfValues (const int NumberOfValues)
int	getNumberOfValues () const
void	setComponentsNames (const string *ComponentsNames)
void	setComponentName (int i, const string ComponentName)
const string *	getComponentsNames () const
string	getComponentName (int i) const
void	setComponentsDescriptions (const string *ComponentsDescriptions)
void	setComponentDescription (int i, const string ComponentDescription)
const string *	getComponentsDescriptions () const
string	getComponentDescription (int i) const
void	setComponentsUnits (const UNIT *ComponentsUnits)
const UNIT *	getComponentsUnits () const
const UNIT *	getComponentUnit (int i) const
void	setMEDComponentsUnits (const string *MEDComponentsUnits)
void	setMEDComponentUnit (int i, const string MEDComponentUnit)
const string *	getMEDComponentsUnits () const
string	getMEDComponentUnit (int i) const
void	setIterationNumber (int IterationNumber)
int	getIterationNumber () const
void	setTime (double Time)
double	getTime () const
void	setOrderNumber (int OrderNumber)
int	getOrderNumber () const
MED_EN::med_type_champ	getValueType () const
MED_EN::medModeSwitch	getInterlacingType () const
virtual bool	getGaussPresence () const throw (MEDEXCEPTION)
Protected Member Functions
void	_checkNormCompatibility (const FIELD< double > *p_field_volume=NULL, const bool nodalAllowed=false) const throw (MEDEXCEPTION)
FIELD< double > *	_getFieldSize (const SUPPORT *subSupport=NULL) const
void	copyGlobalInfo (const FIELD_ &m)
Static Protected Member Functions
static void	_checkFieldCompatibility (const FIELD_ &m, const FIELD_ &n, bool checkUnit=true) throw (MEDEXCEPTION)
static void	_deepCheckFieldCompatibility (const FIELD_ &m, const FIELD_ &n, bool checkUnit=true) throw (MEDEXCEPTION)
Protected Attributes
bool	_isRead
bool	_isMinMax
string	_name
string	_description
const SUPPORT *	_support
int	_numberOfComponents
int	_numberOfValues
vector< int >	_componentsTypes
vector< string >	_componentsNames
vector< string >	_componentsDescriptions
vector< UNIT >	_componentsUnits
vector< string >	_MEDComponentsUnits
int	_iterationNumber
double	_time
int	_orderNumber
MED_EN::med_type_champ	_valueType
MED_EN::medModeSwitch	_interlacingType
vector< GENDRIVER * >	_drivers
Friends
class	MED_MED_RDONLY_DRIVER21
class	MED_MED_WRONLY_DRIVER21
class	MED_MED_RDWR_DRIVER21
class	MED_MED_RDONLY_DRIVER22
class	MED_MED_WRONLY_DRIVER22
class	MED_MED_RDWR_DRIVER22
class	VTK_MED_DRIVER

Detailed Description

This class contains all the informations related with a template class FIELD :

Components descriptions
Time step description
Location of the values (a SUPPORT class)

Constructor & Destructor Documentation

FIELD_::FIELD_ ( )

Constructor.

References MESSAGE_MED.

FIELD_::FIELD_	(	const SUPPORT *	Support,
		const int	NumberOfComponents
	)

Constructor.

References MEDMEM.FIELD_._componentsDescriptions, MEDMEM.FIELD_._componentsNames, MEDMEM.FIELD_._componentsTypes, MEDMEM.FIELD_._componentsUnits, MEDMEM.FIELD_._MEDComponentsUnits, MEDMEM.FIELD_._numberOfValues, MEDMEM.FIELD_._support, MEDMEM.RCBASE.addReference(), MEDMEM.SUPPORT.getNumberOfElements(), MED_EN.MED_ALL_ELEMENTS, and MESSAGE_MED.

FIELD_::FIELD_ ( const FIELD_ & m )

Copy constructor.

References MEDMEM.FIELD_._description, MEDMEM.FIELD_._isMinMax, MEDMEM.FIELD_._isRead, MEDMEM.FIELD_._name, MEDMEM.FIELD_._numberOfComponents, MEDMEM.FIELD_._numberOfValues, MEDMEM.FIELD_._support, MEDMEM.RCBASE.addReference(), and MEDMEM.FIELD_.copyGlobalInfo().

FIELD_::~FIELD_ ( ) [virtual]

Destructor.

References MEDMEM.FIELD_._drivers, MEDMEM.FIELD_._support, medClient_test.index, MESSAGE_MED, MEDMEM.RCBASE.removeReference(), and SCRUTE_MED.

Member Function Documentation

void FIELD_::_checkFieldCompatibility	(	const FIELD_ &	m,
		const FIELD_ &	n,
		bool	checkUnit = `true`
	)		throw (MEDEXCEPTION) `[static, protected]`

References TestMedCorba2.m, and TestMedCorba2.n.

void FIELD_::_deepCheckFieldCompatibility	(	const FIELD_ &	m,
		const FIELD_ &	n,
		bool	checkUnit = `true`
	)		throw (MEDEXCEPTION) `[static, protected]`

References TestMedCorba2.m, and TestMedCorba2.n.

void FIELD_::_checkNormCompatibility	(	const FIELD< double > *	p_field_volume = `NULL`,
		const bool	nodalAllowed = `false`
	)		const throw (MEDEXCEPTION) `[protected]`

References MED_EN.MED_ALL_ELEMENTS, MED_EN.MED_CELL, MED_EN.MED_NODAL, and MED_EN.MED_NODE.

FIELD< double > * FIELD_::_getFieldSize ( const SUPPORT * subSupport = NULL ) const [protected]

References MEDMEM.RCBASE.addReference(), MEDMEM.GMESH.getArea(), MEDMEM.GMESH.getLength(), MEDMEM.SUPPORT.getMesh(), MEDMEM.GMESH.getMeshDimension(), MEDMEM.FIELD_.getSupport(), MEDMEM.GMESH.getSupportOnAll(), MEDMEM.GMESH.getVolume(), MED_EN.MED_CELL, MED_EN.MED_EDGE, MED_EN.MED_FACE, MED_EN.MED_NODE, MED_test2.mesh, MEDMEM.RCBASE.removeReference(), and medClient_test.support.

FIELD_ & FIELD_::operator= ( const FIELD_ & m )

References MEDMEM.FIELD_._componentsDescriptions, MEDMEM.FIELD_._componentsNames, MEDMEM.FIELD_._componentsTypes, MEDMEM.FIELD_._componentsUnits, MEDMEM.FIELD_._description, MEDMEM.FIELD_._isMinMax, MEDMEM.FIELD_._isRead, MEDMEM.FIELD_._iterationNumber, MEDMEM.FIELD_._MEDComponentsUnits, MEDMEM.FIELD_._name, MEDMEM.FIELD_._numberOfComponents, MEDMEM.FIELD_._numberOfValues, MEDMEM.FIELD_._orderNumber, MEDMEM.FIELD_._support, MEDMEM.FIELD_._time, MEDMEM.RCBASE.addReference(), and MEDMEM.RCBASE.removeReference().

void FIELD_::rmDriver ( int index = 0 ) [virtual]

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

References MESSAGE_MED.

int FIELD_::addDriver	(	driverTypes	driverType,
		const string &	fileName = `"Default File Name.med"`,
		const string &	driverFieldName = `"Default Field Nam"`,
		MED_EN::med_mode_acces	access = `MED_EN::RDWR`
	)		`[virtual]`

Creates a driver for reading/writing fields in a file.

Parameters:

driverType	specifies the file type (MED_DRIVER, VTK_DRIVER)
fileName	name of the output file
driverFieldName	name of the field
access	specifies whether the file is opened for read, write or both.

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >.

References MESSAGE_MED.

int FIELD_::addDriver ( GENDRIVER & driver ) [virtual]

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

References MESSAGE_MED.

void FIELD_::read	(	driverTypes	driverType,
		const std::string &	fileName
	)		`[virtual]`

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::read ( const GENDRIVER & ) [virtual]

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::read ( int index = 0 ) [virtual]

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::openAppend ( void ) [virtual]

void FIELD_::write	(	const GENDRIVER &	,
		MED_EN::med_mode_acces	medMode = `MED_EN::RDWR`
	)		`[virtual]`

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::write	(	driverTypes	driverType,
		const std::string &	fileName,
		MED_EN::med_mode_acces	medMode = `MED_EN::RDWR`
	)		`[virtual]`

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::write ( int index = 0 ) [virtual]

Triggers the writing of the field with respect to the driver handle index given by addDriver(...) method.

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::writeAppend ( const GENDRIVER & ) [virtual]

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >, MEDMEM.FIELD< double >, MEDMEM.FIELD< double, FullInterlace >, MEDMEM.FIELD< T >, and MEDMEM.FIELD< int, FullInterlace >.

void FIELD_::writeAppend	(	int	index = `0`,
		const string &	driverName = `""`
	)		`[virtual]`

Reimplemented in MEDMEM.FIELD< T, INTERLACING_TAG >.

void MEDMEM.FIELD_::setName ( const string Name )

Sets FIELD name. The length should not exceed MED_TAILLE_NOM as defined in Med (i.e. 32 characters).

string MEDMEM.FIELD_::getName ( ) const

Gets FIELD name.

void MEDMEM.FIELD_::setDescription ( const string Description )

Sets FIELD description. The length should not exceed MED_TAILLE_DESC as defined in Med (i.e. 200 characters).

string MEDMEM.FIELD_::getDescription ( ) const

Gets FIELD description.

const SUPPORT * MEDMEM.FIELD_::getSupport ( ) const

Gets a reference to the SUPPORT object associated to FIELD.

void MEDMEM.FIELD_::setSupport ( const SUPPORT * support )

Sets the reference to the SUPPORT object associated to FIELD.

Reference is not duplicate, so it must not be deleted.

References medClient_test.support.

void MEDMEM.FIELD_::setNumberOfComponents ( const int NumberOfComponents )

Sets FIELD number of components.

int MEDMEM.FIELD_::getNumberOfComponents ( ) const

Gets FIELD number of components.

void MEDMEM.FIELD_::setNumberOfValues ( const int NumberOfValues )

Sets FIELD number of values.

It must be the same than in the associated SUPPORT object.

int MEDMEM.FIELD_::getNumberOfValues ( ) const

Gets FIELD number of value.

void MEDMEM.FIELD_::setComponentsNames ( const string * ComponentsNames )

Sets FIELD components names.

Duplicates the ComponentsNames string array to put components names in FIELD. ComponentsNames size must be equal to number of components.

void MEDMEM.FIELD_::setComponentName	(	int	i,
		const string	ComponentName
	)

Sets FIELD i^th component name.

i must be >=1 and <= number of components.

References BEGIN_OF_MED.

const string * MEDMEM.FIELD_::getComponentsNames ( ) const

Gets a reference to the string array which contain the components names.

This Array size is equal to number of components

string MEDMEM.FIELD_::getComponentName ( int i ) const

Gets the name of the i^th component.

References BEGIN_OF_MED.

void MEDMEM.FIELD_::setComponentsDescriptions ( const string * ComponentsDescriptions )

Sets FIELD components descriptions.

Duplicates the ComponentsDescriptions string array to put components descriptions in FIELD. ComponentsDescriptions size must be equal to number of components.