MeshGroupList Class Reference

MeshGroupList class is used to manage the list of MeshGroup objects. It enables to create, duplicate, and delete a mesh group.
The class can be called from Study class.
. More...

Public Member Functions
MeshGroup *	CopyMeshGroup (MeshGroup *set)
	Creates information for specified mesh group. More...
MeshGroup *	CreateElementEdgeGroup (String &name=String("untitled"))
	Creates an element edge group. More...
MeshGroup *	CreateElementFaceGroup (String &name=String("untitled"))
	Creates an element face group. More...
MeshGroup *	CreateElementGroup (String &name=String("untitled"))
	Creates an element group. More...
MeshGroup *	CreateNodeGroup (String &name=String("untitled"))
	Creates a node group. More...
void	DeleteMeshGroup (Variant &var)
	Deletes the specified mesh group. More...
void	DeleteUnusedMeshGroups ()
	Deletes unused mesh groups.
MeshGroup *	DuplicateMeshGroup (Variant &var)
	Copies the mesh group by specifying the name or index. More...
MeshGroup *	GetMeshGroup (Variant &var)
	Returns a MeshGroup object by specifying a name or index. More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	NumMeshGroup ()
	Returns the number of mesh groups included in a study. More...

Detailed Description

MeshGroupList class is used to manage the list of MeshGroup objects. It enables to create, duplicate, and delete a mesh group.
The class can be called from Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetMeshGroupList()

Member Function Documentation

MeshGroup * MeshGroupList::CopyMeshGroup

(

MeshGroup *

set

)

Creates information for specified mesh group.

Parameters

set	MeshGroup object

Returns

MeshGroup object

MeshGroup * MeshGroupList::CreateElementEdgeGroup

(

String &

name = String("untitled")

)

Creates an element edge group.

Parameters

name	Group name

Returns

MeshGroup object

MeshGroup * MeshGroupList::CreateElementFaceGroup

(

String &

name = String("untitled")

)

Creates an element face group.

Parameters

name	Group name

Returns

MeshGroup object

MeshGroup * MeshGroupList::CreateElementGroup

(

String &

name = String("untitled")

)

Creates an element group.

Parameters

name	Group name

Returns

MeshGroup object

MeshGroup * MeshGroupList::CreateNodeGroup

(

String &

name = String("untitled")

)

Creates a node group.

Parameters

name	Group name

Returns

MeshGroup object

void MeshGroupList::DeleteMeshGroup

(

Variant &

var

)

Deletes the specified mesh group.

Parameters

var	Name or index of mesh group

The group that was specified first is deleted when specifying a name of the group to delete and there are multiple groups with the same name.

MeshGroup * MeshGroupList::DuplicateMeshGroup

(

Variant &

var

)

Copies the mesh group by specifying the name or index.

Parameters

var	Name or index of the mesh group

Returns

MeshGroup object

MeshGroup * MeshGroupList::GetMeshGroup

(

Variant &

var

)

Returns a MeshGroup object by specifying a name or index.

Parameters

var	Name or index of mesh group

Returns

MeshGroup object

bool MeshGroupList::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the MeshGroupList objects in the list are valid

int MeshGroupList::NumMeshGroup

(

)

Returns the number of mesh groups included in a study.

Returns

Number of mesh groups