Fem::FemMesh Class Reference

The representation of a FemMesh. More...

#include <FemMesh.h>

Inheritance diagram for Fem::FemMesh:
Data::ComplexGeoData Base::Persistence Base::Handled Base::BaseClass

List of all members.

Public Member Functions

void addHypothesis (const TopoDS_Shape &aSubShape, SMESH_HypothesisPtr hyp)
void compute ()
 FemMesh (const FemMesh &)
 FemMesh ()
SMESH_Gen * getGenerator ()
virtual unsigned int getMemSize (void) const
 This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?
SMESH_Mesh * getSMesh ()
const SMESH_Mesh * getSMesh () const
virtual Base::Type getTypeId (void) const
FemMeshoperator= (const FemMesh &)
void read (const char *FileName)
 import from files
virtual void Restore (Base::XMLReader &)
 This method is used to restore properties from an XML document.
void RestoreDocFile (Base::Reader &reader)
 This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.
virtual void Save (Base::Writer &) const
 This method is used to save properties to an XML document.
void SaveDocFile (Base::Writer &writer) const
 This method is used to save large amounts of data to a binary file.
void setStanardHypotheses ()
void write (const char *FileName) const
void writeABAQUS (const std::string &Filename, Base::Placement *=0) const
 ~FemMesh ()
Subelement management



virtual unsigned long countSubElements (const char *Type) const
virtual std::vector< const char * > getElementTypes (void) const
 Sub type list List of different subelement types it is NOT a list of the subelements itself.
virtual Data::SegmentgetSubElement (const char *Type, unsigned long) const
 get the subelement by type and number
Placement control



Base::BoundBox3d getBoundBox (void) const
 Bound box from the shape.
Base::Matrix4D getTransform (void) const
 get the transformation
void setTransform (const Base::Matrix4D &rclTrf)
 set the transformation
Modification



void transformGeometry (const Base::Matrix4D &rclMat)
 Applies a transformation on the real geometric data type.

Static Public Member Functions

static void * create (void)
static Base::Type getClassTypeId (void)
static void init (void)

Detailed Description

The representation of a FemMesh.

Definition at line 46 of file FemMesh.h.


Constructor & Destructor Documentation

FemMesh::FemMesh (  ) 

Definition at line 67 of file FemMesh.cpp.

FemMesh::FemMesh ( const FemMesh mesh  ) 

Definition at line 73 of file FemMesh.cpp.

FemMesh::~FemMesh (  ) 

Definition at line 80 of file FemMesh.cpp.


Member Function Documentation

void FemMesh::addHypothesis ( const TopoDS_Shape &  aSubShape,
SMESH_HypothesisPtr  hyp 
)

Definition at line 315 of file FemMesh.cpp.

Referenced by Fem::FemMeshPy::addHypothesis().

void FemMesh::compute (  ) 

Definition at line 365 of file FemMesh.cpp.

Referenced by Fem::FemMeshPy::compute().

unsigned long FemMesh::countSubElements ( const char *  Type  )  const [virtual]

Implements Data::ComplexGeoData.

Definition at line 716 of file FemMesh.cpp.

void * Fem::FemMesh::create ( void   )  [static]

Reimplemented from Data::ComplexGeoData.

Definition at line 65 of file FemMesh.cpp.

Base::BoundBox3d FemMesh::getBoundBox ( void   )  const [virtual]
Base::Type Fem::FemMesh::getClassTypeId ( void   )  [static]

Reimplemented from Data::ComplexGeoData.

Definition at line 65 of file FemMesh.cpp.

std::vector< const char * > FemMesh::getElementTypes ( void   )  const [virtual]

Sub type list List of different subelement types it is NOT a list of the subelements itself.

Implements Data::ComplexGeoData.

Definition at line 705 of file FemMesh.cpp.

SMESH_Gen * FemMesh::getGenerator (  ) 

Definition at line 310 of file FemMesh.cpp.

unsigned int FemMesh::getMemSize ( void   )  const [virtual]

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?

Implements Base::Persistence.

Definition at line 596 of file FemMesh.cpp.

SMESH_Mesh * FemMesh::getSMesh (  ) 

Definition at line 305 of file FemMesh.cpp.

const SMESH_Mesh * FemMesh::getSMesh (  )  const
Data::Segment * FemMesh::getSubElement ( const char *  Type,
unsigned long  n 
) const [virtual]

get the subelement by type and number

Implements Data::ComplexGeoData.

Definition at line 721 of file FemMesh.cpp.

Base::Matrix4D FemMesh::getTransform ( void   )  const [virtual]

get the transformation

Implements Data::ComplexGeoData.

Definition at line 675 of file FemMesh.cpp.

Base::Type Fem::FemMesh::getTypeId ( void   )  const [virtual]

Reimplemented from Data::ComplexGeoData.

Definition at line 65 of file FemMesh.cpp.

void Fem::FemMesh::init ( void   )  [static]

Reimplemented from Data::ComplexGeoData.

Definition at line 65 of file FemMesh.cpp.

Referenced by initFem().

FemMesh & FemMesh::operator= ( const FemMesh mesh  ) 

Reimplemented from Base::Handled.

Definition at line 92 of file FemMesh.cpp.

void FemMesh::read ( const char *  FileName  ) 
void FemMesh::Restore ( Base::XMLReader  )  [virtual]

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

 void PropertyVector::Restore(Base::XMLReader &reader)
 {
   // read my Element
   reader.readElement("PropertyVector");
   // get the value of my Attribute
   _cVec.x = (float)reader.getAttributeAsFloat("valueX");
   _cVec.y = (float)reader.getAttributeAsFloat("valueY");
   _cVec.z = (float)reader.getAttributeAsFloat("valueZ");
 }

Implements Base::Persistence.

Definition at line 605 of file FemMesh.cpp.

void FemMesh::RestoreDocFile ( Base::Reader  )  [virtual]

This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.

Again you have to apply for the call of this method in the Restore() call:

 void PropertyMeshKernel::Restore(Base::XMLReader &reader)
 {
   reader.readElement("Mesh");
   std::string file (reader.getAttribute("file") );
 
   if(file == "")
   {
     // read XML
     MeshCore::MeshDocXML restorer(*_pcMesh);
     restorer.Restore(reader);
   }else{
     // initate a file read
     reader.addFile(file.c_str(),this);
  }
 }

After you issued the reader.addFile() your RestoreDocFile() is called:

 void PropertyMeshKernel::RestoreDocFile(Base::Reader &reader)
 {
     _pcMesh->Read( reader );
 }
See also:
Base::Reader,Base::XMLReader

Reimplemented from Base::Persistence.

Definition at line 638 of file FemMesh.cpp.

References Base::FileInfo::deleteFile(), DrawingExample::file, Base::FileInfo::filePath(), and Base::FileInfo::getTempFileName().

void FemMesh::Save ( Base::Writer  )  const [virtual]

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

  void PropertyVector::Save (Writer &writer) const
  {
     writer << writer.ind() << "<PropertyVector valueX=\"" <<  _cVec.x <<
                                            "\" valueY=\"" <<  _cVec.y <<
                                            "\" valueZ=\"" <<  _cVec.z <<"\"/>" << endl;
  }

The writer.ind() expression writes the indention, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.

See also:
Base::Writer

Implements Base::Persistence.

Definition at line 601 of file FemMesh.cpp.

void FemMesh::SaveDocFile ( Base::Writer  )  const [virtual]

This method is used to save large amounts of data to a binary file.

Sometimes it makes no sense to write property data as XML. In case the amount of data is too big or the data type has a more effective way to save itself. In this cases it is possible to write the data in a seperate file inside the document archive. In case you want do so you have to re-implement SaveDocFile(). First, you have to inform the framework in Save() that you want do so. Here an example from the Mesh module which can save a (pontetionaly big) triangle mesh:

 void PropertyMeshKernel::Save (Base::Writer &writer) const
 {
   if (writer.isForceXML())
   {
     writer << writer.ind() << "<Mesh>" << std::endl;
     MeshCore::MeshDocXML saver(*_pcMesh);
     saver.Save(writer);
   }else{
    writer << writer.ind() << "<Mesh file=\"" << writer.addFile("MeshKernel.bms", this) << "\"/>" << std::endl;
 }

The writer.isForceXML() is an indication to force you to write XML. Regardless of size and effectivness. The second part informs the Base::writer through writer.addFile("MeshKernel.bms", this) that this object wants to write a file with the given name. The method addFile() returns a unique name that then is written in the XML stream. This allows your RestoreDocFile() method to identify and read the file again. Later your SaveDocFile() method is called as many times as you issued the addFile() call:

 void PropertyMeshKernel::SaveDocFile (Base::Writer &writer) const
 {
     _pcMesh->Write( writer );
 }

In this method you can simply stream your content to the file (Base::Writer inheriting from ostream).

Reimplemented from Base::Persistence.

Definition at line 609 of file FemMesh.cpp.

References Base::FileInfo::deleteFile(), Sketcher::end, DrawingExample::file, Base::FileInfo::filePath(), Base::FileInfo::getTempFileName(), and Base::Writer::Stream().

void FemMesh::setStanardHypotheses (  ) 

Definition at line 322 of file FemMesh.cpp.

Referenced by Fem::FemMeshPy::setStanardHypotheses().

void FemMesh::setTransform ( const Base::Matrix4D rclTrf  )  [virtual]

set the transformation

Implements Data::ComplexGeoData.

Definition at line 670 of file FemMesh.cpp.

void FemMesh::transformGeometry ( const Base::Matrix4D rclMat  )  [virtual]

Applies a transformation on the real geometric data type.

Implements Data::ComplexGeoData.

Definition at line 656 of file FemMesh.cpp.

References Base::Vector3< _Precision >::Set().

Referenced by minBoundingBox(), Fem::FemMeshPy::setTransform(), and SMESH_PCA().

void FemMesh::write ( const char *  FileName  )  const
void FemMesh::writeABAQUS ( const std::string &  Filename,
Base::Placement placement = 0 
) const

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

Generated on Wed Nov 23 19:01:56 2011 for FreeCAD by  doxygen 1.6.1