Version: 5.1.6

MEDMEM.FIELD_ Class Reference

#include <MEDMEM_Field.hxx>

Inheritance diagram for MEDMEM.FIELD_:
Inheritance graph

Public Member Functions

void _checkNormCompatibility (const FIELD< double > *p_field_volume=0, const bool nodalAllowed=false) const throw (MEDEXCEPTION)
FIELD< double > * _getFieldSize (const SUPPORT *subSupport=0) const
 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 (const GENDRIVER &)
virtual void read (int index=0)
virtual void openAppend (void)
virtual void write (const GENDRIVER &)
virtual void write (int index=0, const string &driverName="")
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 SUPPORTgetSupport () 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 UNITgetComponentsUnits () const
const UNITgetComponentUnit (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)
void copyGlobalInfo (const FIELD_ &m)

Static Public 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)

Data Fields

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 :


Constructor & Destructor Documentation

FIELD_::FIELD_ (  ) 

Constructor.

References MESSAGE_MED.

FIELD_::FIELD_ ( const SUPPORT Support,
const int  NumberOfComponents 
)
FIELD_::FIELD_ ( const FIELD_ m  ) 
FIELD_::~FIELD_ (  )  [virtual]

Member Function Documentation

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

References TestMedCorba2.m, and TestMedCorba2.n.

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

References TestMedCorba2.m, and TestMedCorba2.n.

void FIELD_::_checkNormCompatibility ( const FIELD< double > *  p_field_volume = 0,
const bool  nodalAllowed = false 
) const throw (MEDEXCEPTION)
FIELD< double > * FIELD_::_getFieldSize ( const SUPPORT subSupport = 0  )  const
FIELD_ & FIELD_::operator= ( const FIELD_ m  ) 
void FIELD_::rmDriver ( int  index = 0  )  [virtual]
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]
void FIELD_::read ( const GENDRIVER  )  [virtual]
void FIELD_::read ( int  index = 0  )  [virtual]
void FIELD_::openAppend ( void   )  [virtual]
void FIELD_::write ( const GENDRIVER  )  [virtual]
void FIELD_::write ( int  index = 0,
const string &  driverName = "" 
) [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 >.

void FIELD_::writeAppend ( const GENDRIVER  )  [virtual]
void FIELD_::writeAppend ( int  index = 0,
const string &  driverName = "" 
) [virtual]
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.

References MEDMEM.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).

References MEDMEM.FIELD_._description.

string MEDMEM.FIELD_::getDescription (  )  const

Gets FIELD description.

References MEDMEM.FIELD_._description.

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

Gets a reference to the SUPPORT object associated to FIELD.

References MEDMEM.FIELD_._support.

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 MEDMEM.FIELD_._support, MEDMEM.SUPPORT.addReference(), and MEDMEM.SUPPORT.removeReference().

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

Gets FIELD number of components.

References MEDMEM.FIELD_._numberOfComponents.

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

Sets FIELD number of values.

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

References MEDMEM.FIELD_._numberOfValues.

int MEDMEM.FIELD_::getNumberOfValues (  )  const

Gets FIELD number of value.

References MEDMEM.FIELD_._numberOfValues.

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.

References MEDMEM.FIELD_._componentsNames, and MEDMEM.FIELD_._numberOfComponents.

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

Sets FIELD i^th component name.

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

References MEDMEM.FIELD_._componentsNames, MEDMEM.FIELD_._numberOfComponents, and 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

References MEDMEM.FIELD_._componentsNames.

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

Gets the name of the i^th component.

References MEDMEM.FIELD_._componentsNames, MEDMEM.FIELD_._numberOfComponents, and 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.

References MEDMEM.FIELD_._componentsDescriptions, and MEDMEM.FIELD_._numberOfComponents.

void MEDMEM.FIELD_::setComponentDescription ( int  i,
const string  ComponentDescription 
)

Sets FIELD i^th component description.

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

References MEDMEM.FIELD_._componentsDescriptions, MEDMEM.FIELD_._numberOfComponents, and BEGIN_OF_MED.

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

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

This Array size is equal to number of components

References MEDMEM.FIELD_._componentsDescriptions.

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

Gets the description of the i^th component.

References MEDMEM.FIELD_._componentsDescriptions, MEDMEM.FIELD_._numberOfComponents, and BEGIN_OF_MED.

void MEDMEM.FIELD_::setComponentsUnits ( const UNIT ComponentsUnits  ) 
Todo:
Sets FIELD components UNIT.

Duplicates the ComponentsUnits UNIT array to put components units in FIELD. ComponentsUnits size must be equal to number of components.

References MEDMEM.FIELD_._componentsUnits, and MEDMEM.FIELD_._numberOfComponents.

const UNIT * MEDMEM.FIELD_::getComponentsUnits (  )  const

Gets a reference to the UNIT array which contain the components units.

This array size is equal to number of components

References MEDMEM.FIELD_._componentsUnits.

const UNIT * MEDMEM.FIELD_::getComponentUnit ( int  i  )  const

Gets the UNIT of the i^th component.

References MEDMEM.FIELD_._componentsUnits, MEDMEM.FIELD_._numberOfComponents, and BEGIN_OF_MED.

void MEDMEM.FIELD_::setMEDComponentsUnits ( const string *  MEDComponentsUnits  ) 

Sets FIELD components unit.

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

References MEDMEM.FIELD_._MEDComponentsUnits, and MEDMEM.FIELD_._numberOfComponents.

void MEDMEM.FIELD_::setMEDComponentUnit ( int  i,
const string  MEDComponentUnit 
)

Sets FIELD i^th component unit.

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

References MEDMEM.FIELD_._MEDComponentsUnits, MEDMEM.FIELD_._numberOfComponents, and BEGIN_OF_MED.

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

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

This array size is equal to number of components

References MEDMEM.FIELD_._MEDComponentsUnits.

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

Gets the string for unit of the i^th component.

References MEDMEM.FIELD_._MEDComponentsUnits, MEDMEM.FIELD_._numberOfComponents, and BEGIN_OF_MED.

void MEDMEM.FIELD_::setIterationNumber ( int  IterationNumber  ) 

Sets the iteration number where FIELD has been calculated.

References MEDMEM.FIELD_._iterationNumber.

int MEDMEM.FIELD_::getIterationNumber (  )  const

Gets the iteration number where FIELD has been calculated.

References MEDMEM.FIELD_._iterationNumber.

void MEDMEM.FIELD_::setTime ( double  Time  ) 

Sets the time when FIELD has been calculated.

References MEDMEM.FIELD_._time.

double MEDMEM.FIELD_::getTime (  )  const

Gets the time when FIELD has been calculated.

References MEDMEM.FIELD_._time.

void MEDMEM.FIELD_::setOrderNumber ( int  OrderNumber  ) 

Sets the order number where FIELD has been calculated.

It corresponds to internal iteration during one time step.

References MEDMEM.FIELD_._orderNumber.

int MEDMEM.FIELD_::getOrderNumber (  )  const

Gets the order number where FIELD has been calculated.

References MEDMEM.FIELD_._orderNumber.

MED_EN::med_type_champ MEDMEM.FIELD_::getValueType (  )  const

Gets the FIELD med value type (MED_INT32 or MED_REEL64).

References MEDMEM.FIELD_._valueType.

MED_EN::medModeSwitch MEDMEM.FIELD_::getInterlacingType (  )  const

Gets the FIELD med interlacing type (MED_FULL_INTERLACE or MED_NO_INTERLACE).

References MEDMEM.FIELD_._interlacingType.

bool MEDMEM.FIELD_::getGaussPresence (  )  const throw (MEDEXCEPTION) [virtual]
void FIELD_::copyGlobalInfo ( const FIELD_ m  ) 

Friends And Related Function Documentation

friend class MED_MED_RDONLY_DRIVER21 [friend]
friend class MED_MED_WRONLY_DRIVER21 [friend]
friend class MED_MED_RDWR_DRIVER21 [friend]
friend class MED_MED_RDONLY_DRIVER22 [friend]
friend class MED_MED_WRONLY_DRIVER22 [friend]
friend class MED_MED_RDWR_DRIVER22 [friend]
friend class VTK_MED_DRIVER [friend]

Field Documentation