Xfem
The Xfem Plugin
Public Member Functions | Private Member Functions | List of all members
XfemLuaMesh Class Reference

A proxy class to export XfemMesh methods to the Lua environment. More...

#include <xfemLuaMesh.h>

Inheritance diagram for XfemLuaMesh:
Inheritance graph
[legend]
Collaboration diagram for XfemLuaMesh:
Collaboration graph
[legend]

Public Member Functions

 XfemLuaMesh (XfemMesh *mesh, const GmLogCategory &logger)
 Constructor.
 
virtual const char * typeName () const
 
virtual void fillMetatable (lua_State *L, int index)
 Prepares the object metatable for calling methods.
 
virtual void * getClassMetatableID ()
 Returns an unique identifier to identify an user object as a XfemLuaMesh object.
 
- Public Member Functions inherited from GmLuaElementMesh
 GmLuaElementMesh (GmElementMesh *mesh, const GmLogCategory &logger)
 
- Public Member Functions inherited from GmLuaCellMesh
 GmLuaCellMesh (GmCellMesh *mesh, const GmLogCategory &logger)
 
- Public Member Functions inherited from GmLuaMesh
 GmLuaMesh (GmMesh *mesh, const GmLogCategory &logger)
 
virtual QString toString () const
 
GmMeshmesh () const
 
- Public Member Functions inherited from GmLuaObject
virtual void populateMetatable (lua_State *L, int index)
 
QVariant ptrToVariant ()
 
void ref ()
 

Private Member Functions

int element (lua_State *L)
 Returns an xfem element object given the element index inside the mesh. More...
 
int numRegularSubElements (lua_State *L)
 Returns the number of regular sub-elements of the given xfem element.
 
int numFractureSubElements (lua_State *L)
 Returns the number of fracture sub-elements of the given xfem element.
 
int subElement (lua_State *L)
 Returns an xfem sub-element object given its father element and its index inside the father. More...
 
int fractureSubElement (lua_State *L)
 Returns an xfem fracture sub-element object given its father element and its index inside the father (with 1 being the first fracture sub-element). More...
 
int clearSubElements (lua_State *L)
 If an element is given as parameter, removes all sub-elements from that element. Otherwise, removes all sub-elements from the mesh.
 
int addSubElement (lua_State *L)
 Adds a new subelement to the xfem element. Receives as parameters in the Lua stack the father element, the sub-element type as a string, a boolean stating if this is a fracture sub-element, the matrix with node coordinates for the sub-element vertices in the father natural coordinates (size = dxn, where d is the number of natural coordinates and n the number of nodes) and the optional rule set applied to the sub-element. Returns the new sub-element index inside the element.
 
int removeSubElement (lua_State *L)
 Removes an existing sub-element from the enriched element given its father element and index.
 
int updateSubElementCoordinates (lua_State *L)
 Updates the set of coordinates from a subelement (keeping its type). Receives as parameters the father element, the sub-element index, the matrix with new node coordinates in the father natural coordinates (size = dxn, where d is the number of natural coordinates and n the number of nodes) and the optional rule set applied to the sub-element (must be equal to the one used while creating the sub-element).
 
int enrichedElementRegularIntegrationRule (lua_State *L)
 Returns the enriched element regular integration rule for the given element. More...
 
int enrichedElementFractureIntegrationRule (lua_State *L)
 Returns the enriched element fracture integration rule for the given sub-element. More...
 
int enrichedGaussAttributeAccessor (lua_State *L)
 Returns an accessor object for querying enriched Gauss attributes or nil on error. More...
 
int numNaturalFractures (lua_State *L)
 Returns the number of natural fractures associated with this mesh.
 
int naturalFracture (lua_State *L)
 Returns a fracture object given its index in the mesh. More...
 
int addNaturalFracture (lua_State *L)
 Given a table or a vector with a list of point coordinates, creates a new fracture and adds it to the mesh fracture list. Returns the newly created fracture.
 

Additional Inherited Members

- Protected Member Functions inherited from GmLuaObject
 GmLuaObject (const GmLogCategory &logger)
 
- Protected Attributes inherited from GmLuaMesh
GmMesh_mesh
 
- Protected Attributes inherited from GmLuaObject
const GmLogCategory_logger
 
QAtomicInteger< int > _refCount
 

Detailed Description

A proxy class to export XfemMesh methods to the Lua environment.

Member Function Documentation

◆ element()

int XfemLuaMesh::element ( lua_State *  L)
private

Returns an xfem element object given the element index inside the mesh.

Following Lua tradition, the index is one based

◆ enrichedElementFractureIntegrationRule()

int XfemLuaMesh::enrichedElementFractureIntegrationRule ( lua_State *  L)
private

Returns the enriched element fracture integration rule for the given sub-element.

Expects as parameter an xfem sub-element. A second parameter can give a rule set number used for non enriched elements.

◆ enrichedElementRegularIntegrationRule()

int XfemLuaMesh::enrichedElementRegularIntegrationRule ( lua_State *  L)
private

Returns the enriched element regular integration rule for the given element.

Expects as parameter an xfem element. A second parameter can give a rule set number used for non enriched elements.

◆ enrichedGaussAttributeAccessor()

int XfemLuaMesh::enrichedGaussAttributeAccessor ( lua_State *  L)
private

Returns an accessor object for querying enriched Gauss attributes or nil on error.

Receives as stack parameter the name of the desired Gauss attribute and, optionally, the unit in which values should be returned. A third optional parameter defines the state to be queried and if it is locked or not

◆ fractureSubElement()

int XfemLuaMesh::fractureSubElement ( lua_State *  L)
private

Returns an xfem fracture sub-element object given its father element and its index inside the father (with 1 being the first fracture sub-element).

Following Lua tradition, the index is one based

◆ naturalFracture()

int XfemLuaMesh::naturalFracture ( lua_State *  L)
private

Returns a fracture object given its index in the mesh.

Following Lua tradition, the index is one based

◆ subElement()

int XfemLuaMesh::subElement ( lua_State *  L)
private

Returns an xfem sub-element object given its father element and its index inside the father.

Following Lua tradition, the index is one based


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