Package com.comsol.model
Interface GeomFeature
-
- All Superinterfaces:
GeomMeshFeature,IPlotAndImageExport,ModelEntity,PrimitiveModelEntity,PropFeature,SelectionContainer,SelectionEntity
- All Known Subinterfaces:
GeomDefeature,GeomProblemFeature,GeomSubsequenceCallFeature,WorkPlaneFeature
public interface GeomFeature extends GeomMeshFeature, IPlotAndImageExport
Geometry feature.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GeomFeaturecreate(java.lang.String featureTag, java.lang.String featureType)Creates a geometry feature.GeomObjectGroupSelectiondetail()For a defeaturing operation, access the selection of details to remove.voidedgeDelete(int edge)Removes an edge from a GeomEdit geometry feature.intedgeNew()Creates a new edge in a GeomEdit geometry feature.voidendVertexDisconnect(int edge)Creates a new vertex for an edge end point in a GeomEdit geometry feature.GeomFeatureListfeature()Returns all geometry features.GeomFeaturefeature(java.lang.String tag)Returns a geometry feature.GeomFeaturefind()For a defeaturing operation, search for small details.GeomSequencegeom()For a work plane feature, access its 2D geometry sequence.For a part instance feature, access its local part.java.lang.StringgetAttribute(java.lang.String name)Get the current attribute value for the given name assigned to all output objects and entities of the geometry feature.voidimportData()Update the output geometry objects of this feature to account for the following external changes:
1.voidimportToTable()Import data from a file to a table.java.lang.String[]objectNames()Returns the names of all output objects.java.lang.String[]outputSelection()Returns tags of selection output objects.GeomProblemFeatureListproblem()Gets the list of problem features.GeomProblemFeatureproblem(java.lang.String fTag)Returns the problem feature with tag fTag.voidreceiveData(java.lang.String filename)Receive a synchronization file for an offline LiveLink.voidreceiveDataNext()Load the next synchronization for an offline LiveLink.voidrequestData(java.lang.String filename)Create a request file for an offline LiveLink.voidrequestDataAppend()Append a request file for an offline LiveLink.GeomObjectSelectionselection(java.lang.String name)Access the selection property with the given name.GeomFeaturesetAttribute(java.lang.String name, java.lang.String value)Assign an attribute value to all output objects and entities of the geometry feature.voidstartVertexDisconnect(int edge)Creates a new vertex for an edge start point in a GeomEdit geometry feature.voidupdateCadParamTable(boolean addParameters, boolean overwriteValues)Update LiveLink node parameter table with information from CAD program.voidvertexDelete(int vertex)Deletes a vertex from a GeomEdit geometry feature.intvertexNew()Add a new vertex to a GeomEdit geometry feature.voidvertexSnap(int vertex)Removes a vertex from a GeomEdit geometry feature, and moves all edge endpoints connected to the removed vertex to the closest remaining vertex.-
Methods inherited from interface com.comsol.model.GeomMeshFeature
errors, hasError, hasProblem, hasWarning, isBuilt, message, problems, status, warnings
-
Methods inherited from interface com.comsol.model.IPlotAndImageExport
image
-
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
-
Methods inherited from interface com.comsol.model.PropFeature
getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex
-
Methods inherited from interface com.comsol.model.SelectionEntity
selection
-
-
-
-
Method Detail
-
create
GeomFeature create(java.lang.String featureTag, java.lang.String featureType)
Creates a geometry feature.- Parameters:
featureTag- Tag of created feature.featureType- Type of created feature.- Returns:
- Created geometry feature.
-
detail
GeomObjectGroupSelection detail()
For a defeaturing operation, access the selection of details to remove.- Returns:
- Detail selection.
-
edgeDelete
void edgeDelete(int edge)
Removes an edge from a GeomEdit geometry feature. If the act of removing the edge makes one or both end point vertices isolated, those vertices are also removed.- Parameters:
edge- Edge index.
-
edgeNew
int edgeNew()
Creates a new edge in a GeomEdit geometry feature. The edge will have zero length, located at the origin, and not connected to any vertex. Returns the (1-based) number of the new edge.- Returns:
- Index of new edge.
-
endVertexDisconnect
void endVertexDisconnect(int edge)
Creates a new vertex for an edge end point in a GeomEdit geometry feature. The new vertex gets the same coordinate as the old end vertex.- Parameters:
edge- Edge index.
-
feature
GeomFeatureList feature()
Returns all geometry features.- Returns:
- List of geometry features.
-
feature
GeomFeature feature(java.lang.String tag)
Returns a geometry feature.- Parameters:
tag- Geometry feature tag.- Returns:
- Geometry feature.
-
find
GeomFeature find()
For a defeaturing operation, search for small details.- Returns:
- Geometry feature.
-
geom
GeomSequence geom()
For a work plane feature, access its 2D geometry sequence.For a part instance feature, access its local part.- Returns:
- Geometry sequence.
-
getAttribute
java.lang.String getAttribute(java.lang.String name)
Get the current attribute value for the given name assigned to all output objects and entities of the geometry feature.- Parameters:
name- Attribute name.- Returns:
- The attribute value.
-
importData
void importData()
Update the output geometry objects of this feature to account for the following external changes:
1. Import geometry data from a file, a LiveLink, or another sequence.
2. Update geometry after changes in functions.
3. Update a deformed configuration from a solution dataset.
.- Specified by:
importDatain interfaceGeomMeshFeature
-
importToTable
void importToTable()
Import data from a file to a table.
-
objectNames
java.lang.String[] objectNames()
Returns the names of all output objects.- Returns:
- Vector of output object names.
-
outputSelection
java.lang.String[] outputSelection()
Returns tags of selection output objects.- Returns:
- Tags of created selections.
-
problem
GeomProblemFeatureList problem()
Gets the list of problem features.- Returns:
- List of geometry problem features.
-
problem
GeomProblemFeature problem(java.lang.String fTag)
Returns the problem feature with tag fTag.- Parameters:
fTag- Problem feature tag.- Returns:
- Geometry problem feature.
-
receiveData
void receiveData(java.lang.String filename)
Receive a synchronization file for an offline LiveLink.- Parameters:
filename- Filename.
-
receiveDataNext
void receiveDataNext()
Load the next synchronization for an offline LiveLink.
-
requestData
void requestData(java.lang.String filename)
Create a request file for an offline LiveLink.- Parameters:
filename- Filename.
-
requestDataAppend
void requestDataAppend()
Append a request file for an offline LiveLink.
-
selection
GeomObjectSelection selection(java.lang.String name)
Access the selection property with the given name.- Specified by:
selectionin interfacePropFeature- Parameters:
name- Selection property name.- Returns:
- Geometry object selection.
-
setAttribute
GeomFeature setAttribute(java.lang.String name, java.lang.String value)
Assign an attribute value to all output objects and entities of the geometry feature.- Parameters:
name- Attribute name.value- Attribute value.- Returns:
- The modified geometry feature.
-
startVertexDisconnect
void startVertexDisconnect(int edge)
Creates a new vertex for an edge start point in a GeomEdit geometry feature. The new vertex gets the same coordinate as the old start vertex.- Parameters:
edge- Edge index.
-
updateCadParamTable
void updateCadParamTable(boolean addParameters, boolean overwriteValues)Update LiveLink node parameter table with information from CAD program.- Parameters:
addParameters- If addParameters istrue, add new parameters to the LiveLink node parameter table.overwriteValues- If overwriteValues istrue, overwrite parameter values in COMSOL with values from CAD program.
-
vertexDelete
void vertexDelete(int vertex)
Deletes a vertex from a GeomEdit geometry feature.- Parameters:
vertex- vertex Vertex index to delete.
-
vertexNew
int vertexNew()
Add a new vertex to a GeomEdit geometry feature. Returns the (1-based) number of the new vertex.- Returns:
- Vertex index.
-
vertexSnap
void vertexSnap(int vertex)
Removes a vertex from a GeomEdit geometry feature, and moves all edge endpoints connected to the removed vertex to the closest remaining vertex.- Parameters:
vertex- Vertex index.
-
-