GmLuaBoundaryConditionBase Class Reference

A proxy class to export common methods between GmBoundaryCondition and GmContact BoundaryCondition to the Lua environment. More...

#include <gmLuaBoundaryCondition.h>

Inheritance diagram for GmLuaBoundaryConditionBase:

Collaboration diagram for GmLuaBoundaryConditionBase:

Public Member Functions
virtual	~GmLuaBoundaryConditionBase ()
	Destructor.
virtual void	fillMetatable (lua_State *L, int index)
	Prepares the object metatable for calling methods.
Public Member Functions inherited from GmLuaObject
virtual	~GmLuaObject ()
	Destrutor.
virtual void	populateMetatable (lua_State *L, int index)
	Fills the object metatable to allow for the proxy to export its methods.
QVariant	ptrToVariant ()
	Constructs a QVariant storing a POINTER to the current object.
void	ref ()
	Increments the object reference count. Use with care.
Public Member Functions inherited from LuaProxy::Base
virtual void *	getClassMetatableID ()=0

Protected Member Functions
	GmLuaBoundaryConditionBase (GmBoundaryConditionBase *bc, const GmLogCategory &logger)
	Constructor. Receives the boundary to be wrapped.
Protected Member Functions inherited from GmLuaObject
	GmLuaObject (const GmLogCategory &logger)
	Construtor protegido. Somente classes derivadas devem ser instanciadas.
virtual const char *	typeName () const =0
	Returns the object type as will be stored in the object metatable.
virtual QString	toString () const
	Default method used by the __tostring metamethod to capture the result of tostring() over an object.

Protected Attributes
GmBoundaryConditionBase *	_bc
	The boundary condition 'wrapped' by this proxy object.
Protected Attributes inherited from GmLuaObject
const GmLogCategory &	_logger
	A logger used by the proxy when needed.
QAtomicInteger< int >	_refCount
	Lua objects are reference counted to enable sharing them among different states. This is needed to allow for passing objects as parameters in a parallel call. The garbage collection method releases memory only for the last reference.

Private Member Functions
int	id (lua_State *L)
	Returns the boundary condition name.
int	description (lua_State *L)
	Returns the boundary condition description.
int	type (lua_State *L)
	Returns the boundary condition type.
int	mesh (lua_State *L)
	Returns the mesh that this boundary conditions are tied to.
int	bcType (lua_State *L)
	Returns a string representing the type of bc ('node', 'edge', 'face', 'cell')
int	numValues (lua_State *L)
	Returns the number of boundary conditions (lines) stored in the object.
int	numProperties (lua_State *L)
	Returns the number of properties (columns) stored for each condition in the object.
int	propertyIds (lua_State *L)
	Returns a table with a list of property ids associated to this boundary condition.
int	propertyInfo (lua_State *L)
	Returns a GmLuaValueInfo object with information about the requested property. Returns nil if the requested value does not exist.
int	numNodes (lua_State *L)
	Returns the number of nodes over which the referenced boundary condition is applied or nil if bcType() != GM_BC_NODE.
int	node (lua_State *L)
	Returns a node from the list with node numbers over which the referenced boundary condition is applied or nil if bcType() != GM_BC_NODE.
int	cell (lua_State *L)
	Returns the cell object over which the referenced boundary condition is applied or nil if bcType() != GM_BC_CELL.
int	numBoundaryCells (lua_State *L)
	Returns the number of cells over which the referenced boundary condition is applied or nil if bcType() != GM_BC_EDGE or GM_BC_FACE.
int	boundaryCell (lua_State *L)
	Returns a pair formed by a cell object + border index from the list with pairs over which the referenced boundary condition is applied or nil if bcType() != GM_BC_EDGE or GM_BC_FACE.
int	boundary (lua_State *L)
	Returns the cell boundary over which the referenced boundary condition is applied or nil if bcType() != GM_BC_EDGE, GM_BC_FACE or GM_BC_NODE with an associated boundary.
int	nodeSet (lua_State *L)
	Returns the node set over which the referenced boundary condition is applied or nil if bcType() != GM_BC_NODE with an associated boundary.
int	setNode (lua_State *L)
	Updates the node(s) over which the referenced boundary condition is applied. Should be called only if bcType() == GM_BC_NODE. Gets as parameter either:
int	setCell (lua_State *L)
	Updates the cell over which the referenced boundary condition is applied. Should be called only if bcType() == GM_BC_CELL. Gets as parameter the bc index + the new cell index.
int	setBoundary (lua_State *L)
	Updates the cell boundary over which the referenced boundary condition is applied. Should be called only if bcType() == GM_BC_EDGE or GM_BC_FACE. Receives as parameters the bc index + either a boundary object or a cell + a border index or a cell list + a border list.
int	reloadNodeBoundaryData (lua_State *L)
	Reloads node data after a border, defining a node bc, has changed.
int	clear (lua_State *L)
	Clears BC application points data.
int	addLines (lua_State *L)
	Adds the given number of lines to the boundary condition. Returns the index of the first added line.
int	removeLines (lua_State *L)
	Removes the given number of lines from the boundary condition starting at the specified line.
int	addNodeLine (lua_State *L)
	Adds one line to the boundary condition and fills node information with the given node/boundary. Accepts as parameters the same options as setNode(). Returns the index of the first added line.
int	addCellLine (lua_State *L)
	Adds one line to the boundary condition and fills cell information with the given cell. Returns the index of the first added line.
int	addBoundaryLine (lua_State *L)
	Adds one line to the boundary condition and fills boundary information with the given boundary/cell + border/lists data. Returns the index of the first added line.
int	print (lua_State *L)
	Prints information about the boundary condition.

Detailed Description

A proxy class to export common methods between GmBoundaryCondition and GmContact BoundaryCondition to the Lua environment.

Member Function Documentation

boundaryCell()

int GmLuaBoundaryConditionBase::boundaryCell ( lua_State * L )

private

Returns a pair formed by a cell object + border index from the list with pairs over which the referenced boundary condition is applied or nil if bcType() != GM_BC_EDGE or GM_BC_FACE.

Receives as stack parameters the bc index + the (cell, border) pair index (between 1 and numBoundaryCells())

fillMetatable()

void GmLuaBoundaryConditionBase::fillMetatable ( lua_State * L, int index )

virtual

Prepares the object metatable for calling methods.

Implements GmLuaObject.

Reimplemented in GmLuaBoundaryCondition, and GmLuaContactBoundaryCondition.

node()

int GmLuaBoundaryConditionBase::node ( lua_State * L )

private

Returns a node from the list with node numbers over which the referenced boundary condition is applied or nil if bcType() != GM_BC_NODE.

Receives as stack parameters the bc index + the list index (between 1 and numNodes())

propertyInfo()

int GmLuaBoundaryConditionBase::propertyInfo ( lua_State * L )

private

Returns a GmLuaValueInfo object with information about the requested property. Returns nil if the requested value does not exist.

Receives as stack parameter the name of the desired property

setNode()

int GmLuaBoundaryConditionBase::setNode ( lua_State * L )

private

Updates the node(s) over which the referenced boundary condition is applied. Should be called only if bcType() == GM_BC_NODE. Gets as parameter either:

• the bc index + the new node index
• the bc index + the boundary object
• the bc index + the node set object
• the bc index + a list with nodes If the node is a ghost node, it should have its ghost bit set.

---

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

• inc/gmLuaBoundaryCondition.h
• src/gmLuaBoundaryCondition.cpp