OpenCMISS::Zinc::MeshGroup Class Reference

A subset of a master mesh. More...

#include <element.hpp>

Inheritance diagram for OpenCMISS::Zinc::MeshGroup:

Public Member Functions
	MeshGroup (cmzn_mesh_group_id mesh_id)
cmzn_mesh_group_id	getId () const
int	addElement (const Element &element)
int	addElementsConditional (const Field &conditionalField)
int	removeAllElements ()
int	removeElement (const Element &element)
int	removeElementsConditional (const Field &conditionalField)
Public Member Functions inherited from OpenCMISS::Zinc::Mesh
	Mesh (cmzn_mesh_id mesh_id)
	Mesh (const Mesh &mesh)
bool	isValid () const
Mesh &	operator= (const Mesh &mesh)
cmzn_mesh_id	getId () const
MeshGroup	castGroup ()
bool	containsElement (const Element &element)
Elementtemplate	createElementtemplate ()
Element	createElement (int identifier, const Elementtemplate &elementTemplate)
Elementiterator	createElementiterator ()
int	defineElement (int identifier, const Elementtemplate &elementTemplate)
int	destroyAllElements ()
int	destroyElement (const Element &element)
int	destroyElementsConditional (const Field &conditionalField)
Element	findElementByIdentifier (int identifier)
Differentialoperator	getChartDifferentialoperator (int order, int term)
int	getDimension ()
Fieldmodule	getFieldmodule () const
Mesh	getMasterMesh ()
char *	getName ()
int	getSize ()

Additional Inherited Members
Protected Attributes inherited from OpenCMISS::Zinc::Mesh
cmzn_mesh_id	id

Detailed Description

A subset of a master mesh.

A specialised mesh consisting of a subset of elements from a master mesh.

Member Function Documentation

int OpenCMISS::Zinc::MeshGroup::addElement ( const Element &  element )

inline

Add specified element to mesh group.

Parameters

element

Handle to element to add. Must be from the group's master mesh.

Returns

Status OpenCMISS::Zinc::OK on success, CMZN_ERROR_ALREADY_EXISTS if element was already in the group but otherwise successful, or any other value on more serious failure.

int OpenCMISS::Zinc::MeshGroup::addElementsConditional ( const Field &  conditionalField )

inline

Ensure this mesh group contains all elements from the master mesh for which the conditional field is true i.e. non-zero valued in the element. Results are undefined if conditional field is not constant over element. Note that group and element_group fields are valid conditional fields.

Parameters

conditionalField

Field which if non-zero in an element indicates it is to be added.

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

cmzn_mesh_group_id OpenCMISS::Zinc::MeshGroup::getId ( ) const

inline

Return the C handle of the MeshGroup object.

Returns

C handle of MeshGroup if this objects is valid, 0 otherwise.

int OpenCMISS::Zinc::MeshGroup::removeAllElements ( )

inline

Remove all elements from mesh group.

Returns

Status OpenCMISS::Zinc::OK if all elements removed, any other value if failed.

int OpenCMISS::Zinc::MeshGroup::removeElement ( const Element &  element )

inline

Remove specified element from mesh group.

Parameters

element

Handle to element to remove.

Returns

Status OpenCMISS::Zinc::OK on success, CMZN_ERROR_NOT_FOUND if element was not in the group but otherwise successful, or any other value on more serious failure.

int OpenCMISS::Zinc::MeshGroup::removeElementsConditional ( const Field &  conditionalField )

inline

Remove all elements from the mesh group for which the conditional field is true i.e. non-zero valued in the element. Results are undefined if conditional field is not constant over element. Note that group and element_group fields are valid conditional fields.

Parameters

conditionalField

Field which if non-zero in the element indicates it is to be removed.

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

---

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

• auto_comments_output/element.hpp