The representation of a FemMesh. More...

#include <FemMesh.h>

Classes

struct  FemMeshInfo
 

Public Member Functions

void addHypothesis (const TopoDS_Shape &aSubShape, SMESH_HypothesisPtr hyp)
 
void compute ()
 
 FemMesh ()
 
 FemMesh (const FemMesh &)
 
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? More...
 
SMESH_MeshgetSMesh ()
 
const SMESH_MeshgetSMesh () const
 
FemMeshoperator= (const FemMesh &)
 
virtual void Restore (Base::XMLReader &)
 This method is used to restore properties from an XML document. More...
 
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 SaveDocFile() saved data. More...
 
virtual void Save (Base::Writer &) const
 This method is used to save properties to an XML document. More...
 
void SaveDocFile (Base::Writer &writer) const
 This method is used to save large amounts of data to a binary file. More...
 
void setStandardHypotheses ()
 
 ~FemMesh ()
 
Subelement management
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. More...
 
virtual unsigned long countSubElements (const char *Type) const
 
virtual Data::SegmentgetSubElement (const char *Type, unsigned long) const
 get the subelement by type and number More...
 
search and retrieval
std::set< long > getSurfaceNodes (long ElemId, short FaceId, float Angle=360) const
 retrieving by region growing More...
 
std::set< int > getNodesBySolid (const TopoDS_Solid &solid) const
 retrieving by solid More...
 
std::set< int > getNodesByFace (const TopoDS_Face &face) const
 retrieving by face More...
 
std::set< int > getNodesByEdge (const TopoDS_Edge &edge) const
 retrieving by edge More...
 
std::set< int > getNodesByVertex (const TopoDS_Vertex &vertex) const
 retrieving by vertex More...
 
std::list< int > getElementNodes (int id) const
 retrieving node IDs by element ID More...
 
std::list< int > getFacesByFace (const TopoDS_Face &face) const
 retrieving face IDs number by face More...
 
std::list< int > getEdgesByEdge (const TopoDS_Edge &edge) const
 retrieving edge IDs number by edge More...
 
std::list< std::pair< int, int > > getVolumesByFace (const TopoDS_Face &face) const
 retrieving volume IDs and face IDs number by face More...
 
std::map< int, int > getccxVolumesByFace (const TopoDS_Face &face) const
 retrieving volume IDs and CalculiX face number by face More...
 
std::set< int > getEdgesOnly (void) const
 retrieving IDs of edges not belonging to any face (and thus not belonging to any volume too) More...
 
std::set< int > getFacesOnly (void) const
 retrieving IDs of faces not belonging to any volume More...
 
Placement control
void setTransform (const Base::Matrix4D &rclTrf)
 set the transformation More...
 
Base::Matrix4D getTransform (void) const
 get the transformation More...
 
Base::BoundBox3d getBoundBox (void) const
 Bound box from the shape. More...
 
Base::Quantity getVolume (void) const
 get the volume (when there are volume elements) More...
 
Modification
void transformGeometry (const Base::Matrix4D &rclMat)
 Applies a transformation on the real geometric data type. More...
 
- Public Member Functions inherited from Data::ComplexGeoData
 ComplexGeoData (void)
 Constructor. More...
 
virtual ~ComplexGeoData ()
 Destructor. More...
 
virtual SegmentgetSubElementByName (const char *Name) const
 get subelement by combined name More...
 
virtual void getLinesFromSubelement (const Segment *, std::vector< Base::Vector3d > &Points, std::vector< Line > &lines) const
 Get lines from segment. More...
 
virtual void getFacesFromSubelement (const Segment *, std::vector< Base::Vector3d > &Points, std::vector< Base::Vector3d > &PointNormals, std::vector< Facet > &faces) const
 Get faces from segment. More...
 
void applyTransform (const Base::Matrix4D &rclTrf)
 Applies an additional transformation to the current transformation. More...
 
void applyTranslation (const Base::Vector3d &)
 Applies an additional translation to the current transformation. More...
 
void applyRotation (const Base::Rotation &)
 Applies an additional rotation to the current transformation. More...
 
void setPlacement (const Base::Placement &rclPlacement)
 Override the current transformation with a placement using the setTransform() method. More...
 
Base::Placement getPlacement () const
 Return the current transformation as placement using getTransform(). More...
 
virtual Base::Vector3d getPointFromLineIntersection (const Base::Vector3f &base, const Base::Vector3f &dir) const
 Get point from line object intersection
More...
 
virtual void getPoints (std::vector< Base::Vector3d > &Points, std::vector< Base::Vector3d > &Normals, float Accuracy, uint16_t flags=0) const
 Get points from object with given accuracy. More...
 
virtual void getLines (std::vector< Base::Vector3d > &Points, std::vector< Line > &lines, float Accuracy, uint16_t flags=0) const
 Get lines from object with given accuracy. More...
 
virtual void getFaces (std::vector< Base::Vector3d > &Points, std::vector< Facet > &faces, float Accuracy, uint16_t flags=0) const
 Get faces from object with given accuracy. More...
 
virtual bool getCenterOfGravity (Base::Vector3d &center) const
 Get the center of gravity If this method is implemented then true is returned and the center of gravity. More...
 
- Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)
 
virtual Base::Type getTypeId (void) const
 
void restoreFromStream (std::istream &stream)
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
bool isDerivedFrom (const Type type) const
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 
- Public Member Functions inherited from Base::Handled
int getRefCount (void) const
 
 Handled ()
 
const Handledoperator= (const Handled &)
 
void ref () const
 
void unref () const
 
virtual ~Handled ()
 

Static Public Member Functions

static SMESH_GengetGenerator ()
 
- Static Public Member Functions inherited from Data::ComplexGeoData
static const std::string & elementMapPrefix ()
 Special prefix to mark the beginning of a mapped sub-element name. More...
 
static const std::string & tagPostfix ()
 Special postfix to mark the following tag. More...
 
static const std::string & indexPostfix ()
 Special postfix to mark the index of an array element. More...
 
static const std::string & missingPrefix ()
 Special prefix to mark a missing element. More...
 
static bool hasMissingElement (const char *subname)
 Check if a subname contains missing element. More...
 
static const char * isMappedElement (const char *name)
 Check if the name starts with elementMapPrefix() More...
 
static std::string newElementName (const char *name)
 Strip out the trailing element name if there is mapped element name precedes it. More...
 
static std::string oldElementName (const char *name)
 Strip out the mapped element name if there is one. More...
 
static std::string noElementName (const char *name)
 Strip out the old and new element name if there is one. More...
 
static const char * findElementName (const char *subname)
 Find the start of an element name in a subname. More...
 
static const char * hasMappedElementName (const char *subname)
 
- Static Public Member Functions inherited from Base::Persistence
static void * create (void)
 
static std::string encodeAttribute (const std::string &)
 Encodes an attribute upon saving. More...
 
static Base::Type getClassTypeId (void)
 
static void init (void)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create (void)
 
static Type getClassTypeId (void)
 
static void init (void)
 

Group management

int addGroup (const std::string, const std::string, const int=-1)
 Adds group to mesh. More...
 
void addGroupElements (int, const std::set< int > &)
 Adds elements to group (int due to int used by raw SMESH functions) More...
 
bool removeGroup (int)
 Remove group (Name due to similarity to SMESH basis functions) More...
 
struct FemMeshInfo getInfo (void) const
 
void read (const char *FileName)
 import from files More...
 
void write (const char *FileName) const
 
void writeABAQUS (const std::string &Filename, int elemParam, bool groupParam) const
 
void writeZ88 (const std::string &FileName) const
 

Additional Inherited Members

- Public Attributes inherited from Data::ComplexGeoData
long Tag
 
- Protected Member Functions inherited from Data::ComplexGeoData
Base::Vector3d transformToOutside (const Base::Vector3f &vec) const
 from local to outside More...
 
Base::Vector3f transformToInside (const Base::Vector3d &vec) const
 from local to inside More...
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 

Detailed Description

The representation of a FemMesh.

Constructor & Destructor Documentation

◆ FemMesh() [1/2]

FemMesh::FemMesh ( )

◆ FemMesh() [2/2]

FemMesh::FemMesh ( const FemMesh mesh)

◆ ~FemMesh()

FemMesh::~FemMesh ( )

Member Function Documentation

◆ addGroup()

int FemMesh::addGroup ( const std::string  TypeString,
const std::string  Name,
const int  theId = -1 
)

Adds group to mesh.

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

◆ addGroupElements()

void FemMesh::addGroupElements ( int  GroupId,
const std::set< int > &  ElementIds 
)

Adds elements to group (int due to int used by raw SMESH functions)

References SMESHDS_Group::Add(), SMESHDS_Group::Contains(), SMDS_MeshElement::GetID(), and SMESHDS_GroupBase::GetType().

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

◆ addHypothesis()

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

◆ compute()

void FemMesh::compute ( )

◆ countSubElements()

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

Implements Data::ComplexGeoData.

◆ getBoundBox()

Base::BoundBox3d FemMesh::getBoundBox ( void  ) const
virtual

◆ getccxVolumesByFace()

std::map< int, int > FemMesh::getccxVolumesByFace ( const TopoDS_Face &  face) const

retrieving volume IDs and CalculiX face number by face

That function returns map containing volume ID and face number as per CalculiX definition for tetrahedral elements. See CalculiX documentation for the details.

References DraftVecUtils::find(), SMDS_MeshElement::GetID(), SMDS_MeshElement::GetNode(), and SMDS_MeshElement::NbNodes().

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

◆ getEdgesByEdge()

std::list< int > FemMesh::getEdgesByEdge ( const TopoDS_Edge &  edge) const

◆ getEdgesOnly()

std::set< int > FemMesh::getEdgesOnly ( void  ) const

retrieving IDs of edges not belonging to any face (and thus not belonging to any volume too)

References SMDS_MeshElement::GetID().

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

◆ getElementNodes()

std::list< int > FemMesh::getElementNodes ( int  id) const

◆ getElementTypes()

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.

◆ getFacesByFace()

std::list< int > FemMesh::getFacesByFace ( const TopoDS_Face &  face) const

retrieving face IDs number by face

That function returns a list of face IDs.

References SMDS_MeshElement::NbNodes().

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

◆ getFacesOnly()

std::set< int > FemMesh::getFacesOnly ( void  ) const

retrieving IDs of faces not belonging to any volume

References SMDS_MeshElement::GetID().

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

◆ getGenerator()

SMESH_Gen * FemMesh::getGenerator ( )
static

◆ getInfo()

◆ getMemSize()

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.

◆ getNodesByEdge()

std::set< int > FemMesh::getNodesByEdge ( const TopoDS_Edge &  edge) const

◆ getNodesByFace()

std::set< int > FemMesh::getNodesByFace ( const TopoDS_Face &  face) const

◆ getNodesBySolid()

std::set< int > FemMesh::getNodesBySolid ( const TopoDS_Solid &  solid) const

◆ getNodesByVertex()

std::set< int > FemMesh::getNodesByVertex ( const TopoDS_Vertex &  vertex) const

◆ getSMesh() [1/2]

SMESH_Mesh * FemMesh::getSMesh ( )

◆ getSMesh() [2/2]

◆ getSubElement()

Data::Segment * FemMesh::getSubElement ( const char *  Type,
unsigned long   
) const
virtual

get the subelement by type and number

Implements Data::ComplexGeoData.

◆ getSurfaceNodes()

std::set< long > FemMesh::getSurfaceNodes ( long  ElemId,
short  FaceId,
float  Angle = 360 
) const

retrieving by region growing

◆ getTransform()

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

get the transformation

Implements Data::ComplexGeoData.

Referenced by Fem::FemMeshPy::getNodeById(), and Fem::FemMeshPy::getNodes().

◆ getVolume()

◆ getVolumesByFace()

std::list< std::pair< int, int > > FemMesh::getVolumesByFace ( const TopoDS_Face &  face) const

retrieving volume IDs and face IDs number by face

That function returns map containing volume ID and face ID.

References SMDS_MeshElement::facesIterator(), SMDS_MeshElement::GetID(), SMDS_MeshElement::NbNodes(), and SMDS_MeshElement::nodeIterator().

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

◆ operator=()

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

◆ read()

◆ removeGroup()

bool FemMesh::removeGroup ( int  GroupId)

Remove group (Name due to similarity to SMESH basis functions)

◆ Restore()

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 = reader.getAttributeAsFloat("valueX");
_cVec.y = reader.getAttributeAsFloat("valueY");
_cVec.z = reader.getAttributeAsFloat("valueZ");
}
The XML reader class This is an important helper class for the store and retrieval system of objects ...
Definition: Reader.h:118
void readElement(const char *ElementName=0)
read until a start element is found (<name>) or start-end element (<name/>) (with special name if giv...
Definition: Reader.cpp:240
double getAttributeAsFloat(const char *AttrName) const
return the named attribute as a double floating point (does type checking)
Definition: Reader.cpp:158

Implements Base::Persistence.

References Base::XMLReader::addFile(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::hasAttribute(), and Base::XMLReader::readElement().

◆ RestoreDocFile()

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 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{
// initiate a file read
reader.addFile(file.c_str(),this);
}
}
const char * getAttribute(const char *AttrName) const
return the named attribute as a double floating point (does type checking)
Definition: Reader.cpp:173
const char * addFile(const char *Name, Base::Persistence *Object)
add a read request of a persistent object
Definition: Reader.cpp:371
file
Definition: DrawingExample.py:75

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

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

Reimplemented from Base::Persistence.

References Base::FileInfo::deleteFile(), Base::FileInfo::filePath(), and App::Application::getTempFileName().

◆ Save()

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 indentation, 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.

References Base::Writer::addFile(), Base::Writer::ind(), Base::Writer::isForceXML(), and Base::Writer::Stream().

◆ SaveDocFile()

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 separate 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 class This is an important helper class for the store and retrieval system of persistent o...
Definition: Writer.h:58
const char * ind(void) const
get the current indentation
Definition: Writer.h:109
std::string addFile(const char *Name, const Base::Persistence *Object)
add a write request of a persistent object
Definition: Writer.cpp:165
bool isForceXML(void)
check on state
Definition: Writer.cpp:97

The writer.isForceXML() is an indication to force you to write XML. Regardless of size and effectiveness. 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.

References Base::FileInfo::deleteFile(), Base::FileInfo::filePath(), App::Application::getTempFileName(), and Base::Writer::Stream().

◆ setStandardHypotheses()

void FemMesh::setStandardHypotheses ( )

◆ setTransform()

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

set the transformation

Implements Data::ComplexGeoData.

◆ transformGeometry()

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

Applies a transformation on the real geometric data type.

Implements Data::ComplexGeoData.

References Base::Vector3< _Precision >::Set(), SMDS_MeshNode::X(), SMDS_MeshNode::Y(), and SMDS_MeshNode::Z().

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

◆ write()

◆ writeABAQUS()

void FemMesh::writeABAQUS ( const std::string &  Filename,
int  elemParam,
bool  groupParam 
) const

◆ writeZ88()

void FemMesh::writeZ88 ( const std::string &  FileName) const

The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/Mod/Fem/App/FemMesh.h
  • Sources/FreeCAD/src/Mod/Fem/App/FemMesh.cpp