Package com.comsol.model

Interface EmbeddedSelection

All Superinterfaces:

AbstractSelection, ModelEntity, PrimitiveModelEntity

public interface EmbeddedSelection
extends AbstractSelection

Selection supporting embedded entities.

Method Summary

Modifier and Type	Method	Description
EmbeddedSelection	add(int... entities)	Adds the given embedded entities to the selection.
EmbeddedSelection	all()	Select all embedded entities in the current dimension.
EmbeddedSelection	clear()	Removes all embedded entities from the selection.
int	dim()	Returns the (maximum) embedded entity dimension.
EmbeddedSelection	dim(int dim)	Specifies the embedded entity level and clears the selection.
int[]	entities()	Returns the embedded entities in the selection's dimension.
java.lang.String	meshElements()	Get the mesh elements to consider (if supported). The value includeghost (default) means that the elements in the ghost region are also considered. The value ghostonly means that only the elements in the ghost region are considered.
EmbeddedSelection	meshElements(java.lang.String me)	Set the mesh elements to consider (if supported). me = includeghost means that the elements in the ghost region are also considered. me = ghostonly means that only the elements in the ghost region are considered.
EmbeddedSelection	remove(int... entities)	Removes the given embedded entities from the selection.
EmbeddedSelection	set(int... entities)	Sets the selection to use the given embedded entities.

Methods inherited from interface com.comsol.model.AbstractSelection

dimension, geom

Methods inherited from interface com.comsol.model.ModelEntity

active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

add

EmbeddedSelection add(int... entities)

Adds the given embedded entities to the selection.

Parameters:

entities - Embedded entities to add to the selection.

Returns:

Embedded selection.

all

EmbeddedSelection all()

Select all embedded entities in the current dimension.

Returns:

Embedded selection.

clear

EmbeddedSelection clear()

Removes all embedded entities from the selection.

Returns:

Embedded selection.

dim

int dim()

Returns the (maximum) embedded entity dimension. Otherwise, returns -1.

Specified by:

dim in interface AbstractSelection

Returns:

Embedded entity dimension or -1.

dim

EmbeddedSelection dim(int dim)

Specifies the embedded entity level and clears the selection.

Parameters:

dim - The entity level.

Returns:

Embedded selection.

entities

int[] entities()

Returns the embedded entities in the selection's dimension.

Returns:

Array of embedded entities.

meshElements

java.lang.String meshElements()

Get the mesh elements to consider (if supported).
The value includeghost (default) means that the elements in the ghost region are also considered.
The value ghostonly means that only the elements in the ghost region are considered.

Returns:

Mesh elements to consider.

meshElements

EmbeddedSelection meshElements(java.lang.String me)

Set the mesh elements to consider (if supported).
me = includeghost means that the elements in the ghost region are also considered.
me = ghostonly means that only the elements in the ghost region are considered.

Parameters:

me - Mesh elements to consider.

Returns:

Embedded selection.

remove

EmbeddedSelection remove(int... entities)

Removes the given embedded entities from the selection.

Parameters:

entities - Embedded entities to remove from the selection.

Returns:

Embedded selection.

set

EmbeddedSelection set(int... entities)

Sets the selection to use the given embedded entities.

Parameters:

entities - Embedded entities.

Returns:

Embedded selection.