Package com.comsol.model

Interface Selection

All Superinterfaces:

AbstractSelection, ModelEntity, PrimitiveModelEntity

All Known Subinterfaces:

HideGeom, HideMesh, LocalSelection, MeshSelection, SavePointHideGeom, SavePointSelection, SelectionFeature, XDLocalSelection

public interface Selection
extends AbstractSelection

Selection.

Method Summary

Modifier and Type	Method	Description
Selection	add(int... entities)	Adds the given entities to the selection.
Selection	all()	Select all geometric entities (not including void regions) in the current dimension.
Selection	allgeom()	Deprecated. Use allGeom() instead.
Selection	allGeom()	Sets the selection to the whole geometry.
Selection	allVoids()	Select all void regions.
Selection	clear()	Removes all entities from the selection.
int[]	dom(int arg0)	Deprecated. Use entities(int) instead.
int[]	entities()	If the selection is on a geometry, return the geometric entities in the selection's maximum dimension.
int[]	entities(int dim)	If the selection is on a geometry, return the geometric entities on the given dimension.
Selection	geom(int dim)	Sets the selection to be the geometric entities of level dim.
Selection	geom(java.lang.String geom)	Sets the selection to a geometry geom.
Selection	geom(java.lang.String geom, int dim)	Sets the selection to be the geometric entities of level dim on geometry geom.
Selection	geom(java.lang.String geom, int highdim, int lowdim, java.lang.String[] typelist)	Sets the selection to be the geometric entities of level lowdim on geometry geom.
Selection	global()	Makes the selection global.
Selection	inherit(boolean flag)	Sets the inherit flag.
int	inputDimension()	Get the dimension of the geometric entities used as input.
int[]	inputEntities()	Get the geometric entities used as input to the selection.
int[]	interiordom(int arg0)	Deprecated. Use interiorEntities(int) instead.
int[]	interiorEntities(int dim)	If the selection is on a geometry, return the interior entities of the given dimension.
boolean	isgeom()	Deprecated. Use isGeom() instead.
boolean	isGeom()	Returns true if the selection is a whole geometry.
boolean	isglobal()	Deprecated. Use isGlobal() instead.
boolean	isGlobal()	Returns true if the selection is global.
boolean	isinheriting()	Deprecated. Use isInheriting() instead.
boolean	isInheriting()	Returns true if the selection is inherited to lower dimension levels.
Selection	remove(int... entities)	Removes the given entities from the selection.
Selection	set(int... entities)	Sets the selection to use the given geometric entities.

Methods inherited from interface com.comsol.model.AbstractSelection

dim, 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

Selection add(int... entities)

Adds the given entities to the selection.

Parameters:

entities - Geometric entities to add to the selection.

Returns:

Selection.

all

Selection all()

Select all geometric entities (not including void regions) in the current dimension.

Returns:

Selection.

allGeom

Selection allGeom()

Sets the selection to the whole geometry. Can be used instead of geom(String) when the geometry is unambiguous.

Returns:

Selection.

allVoids

Selection allVoids()

Select all void regions.

Returns:

Selection.

allgeom

@Deprecated
Selection allgeom()

Deprecated.

Use allGeom() instead.

clear

Selection clear()

Removes all entities from the selection.

Returns:

Selection.

dom

@Deprecated
int[] dom(int arg0)

Deprecated.

Use entities(int) instead.

entities

int[] entities()

If the selection is on a geometry, return the geometric entities in the selection's maximum dimension.

Returns:

Vector of geometric entities.

entities

int[] entities(int dim)

If the selection is on a geometry, return the geometric entities on the given dimension.

Parameters:

dim - Dimension to analyze.

Returns:

Vector of geometric entities.

geom

Selection geom(java.lang.String geom)

Sets the selection to a geometry geom.

Parameters:

geom - Geometry tag.

Returns:

Selection.

geom

Selection geom(int dim)

Sets the selection to be the geometric entities of level dim. Can be used instead of geom(String, int) when the geometry is unambiguous.

Parameters:

dim - Geometric entity level.

Returns:

Selection.

geom

Selection geom(java.lang.String geom,
               int dim)

Sets the selection to be the geometric entities of level dim on geometry geom.

Parameters:

geom - Geometry tag.

dim - Geometry entity level.

Returns:

Selection.

geom

Selection geom(java.lang.String geom,
               int highdim,
               int lowdim,
               java.lang.String[] typelist)

Sets the selection to be the geometric entities of level lowdim on geometry geom. The input is given on level highdim and the output is calculated using the given types, which can be exterior, interior, meshinterior.

Parameters:

geom - Geometry tag.

highdim - Geometric entity level for selection input.

lowdim - Geometric entity level for selection output.

typelist - Types included in output.

Returns:

Selection.

global

Selection global()

Makes the selection global.

Returns:

Selection.

inherit

Selection inherit(boolean flag)

Sets the inherit flag.

Parameters:

flag - Inherit flag.

Returns:

Selection.

inputDimension

int inputDimension()

Get the dimension of the geometric entities used as input. If the selection is of the type interior, exterior, or meshinterior, this method returns the higher dimension with the input domains. If the selection is not a selection of entities in a specified dimension, this method returns -1.

Returns:

Selection input dimension.

inputEntities

int[] inputEntities()

Get the geometric entities used as input to the selection. If the selection is of the type interior, exterior, or meshinterior. this method returns the unfiltered list of domains at the higher dimension which are used as the input. If the selection is not a selection of domains at a certain level or the selection is not of the types Explicit or FromGeom (derived from a geometry feature), this method returns null.

Returns:

Selection input entities.

interiorEntities

int[] interiorEntities(int dim)

If the selection is on a geometry, return the interior entities of the given dimension.

Parameters:

dim - Dimension to analyze.

Returns:

List of interior entities.

interiordom

@Deprecated
int[] interiordom(int arg0)

Deprecated.

Use interiorEntities(int) instead.

isGeom

boolean isGeom()

Returns true if the selection is a whole geometry.

Returns:

true if a whole geometry.

isGlobal

boolean isGlobal()

Returns true if the selection is global.

Returns:

true if a global selection.

isInheriting

boolean isInheriting()

Returns true if the selection is inherited to lower dimension levels.

Returns:

true if the selection is inherited.

isgeom

@Deprecated
boolean isgeom()

Deprecated.

Use isGeom() instead.

isglobal

@Deprecated
boolean isglobal()

Deprecated.

Use isGlobal() instead.

isinheriting

@Deprecated
boolean isinheriting()

Deprecated.

Use isInheriting() instead.

remove

Selection remove(int... entities)

Removes the given entities from the selection.

Parameters:

entities - Geometric entities to remove from the selection.

Returns:

Selection.

set

Selection set(int... entities)

Sets the selection to use the given geometric entities.

Parameters:

entities - Geometric entities.

Returns:

Selection.