com.comsol.model

Interface GeomInfo

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

All Known Subinterfaces:

GeomContainer, GeomInfoBase, GeomObject, GeomSequence, GeomSubsequence, MeshNative

public interface GeomInfo
extends ModelEntity

Geometry information.

Method Summary

Modifier and Type	Method and Description
void	check() Throws an exception if the geometry is invalid.
double[]	edgeCurvature(int edge, double[] s) Evaluates edge curvature at the specified parameters.
double[][]	edgeDDDX(int edge, double[] s) Evaluates the parameters to third order derivative values.
double[][]	edgeDDX(int edge, double[] s) Evaluates the parameters to second order derivative values.
double[][]	edgeDX(int edge, double[] s) Evaluates the parameters to first order derivative values.
double[]	edgeMaxFaceAngle(int[] edge, int[] face1, int[] face2) Compute the "maximum" along a 3D edge of the angle (in radians) between the normal vectors of two faces that are adjacent to the edge.
double[][]	edgeNormal(int edge, double[] s) Evaluates the parameters to normal vector values in 2D.
double[]	edgeParamRange(int edge) Returns the parameter range for evaluation on the edge.
double[]	edgeTorsion(int edge, double[] s) Evaluates the parameters to torsion values.
double[][]	edgeX(int edge, double[] s) Evaluates the parameters to coordinate values.
boolean	exists() Check if an object exists.
double[][][][]	faceDDX(int face, double[][] param) Evaluates the parameters to second order derivative values.
double[][][]	faceDX(int face, double[][] param) Evaluates the parameters to first order derivative values.
double[][][]	faceFF1(int face, double[][] param) Evaluates the parameters to the first fundamental form values.
double[][][]	faceFF2(int face, double[][] param) Evaluates the parameters to the second fundamental form values.
double[]	faceGaussCurvature(int face, double[][] param) Evaluates the parameters to Gauss curvature values.
double[]	faceMeanCurvature(int face, double[][] param) Evaluates the parameters to mean curvature values.
double[][]	faceNormal(int face, double[][] param) Evaluates the parameters to normal vector values.
double[]	faceParamRange(int face) Returns two parameter ranges for evaluation on the face.
double[][]	faceX(int face, double[][] param) Evaluates the parameters to coordinate values.
int[][]	getAdj(int fromDim, int toDim) Gets adjacency between entities in dimensions fromDim and toDim.
int[]	getAdj(int fromDim, int toDim, int fromIdx) Gets adjacent entities in dimension toDim to entity fromIdx in dimension fromDim.
int[][]	getAdjExt(int fromDim, int toDim) Gets extended adjacency between entities in dimensions fromDim and toDim.
int[]	getAdjExt(int fromDim, int toDim, int fromIdx) Gets adjacent entities in dimension toDim to entity fromIdx in dimension fromDim.
int[][]	getAdjExtOrient(int fromDim, int toDim) Get relative orientation between adjacent entities in dimensions fromDim to toDim.
int[]	getAdjExtOrient(int fromDim, int toDim, int fromIdx) Get relative orientation between entity fromIdx in dimension fromDim and its adjacent entities in dimension toDim.
int[][]	getAdjOrient(int fromDim, int toDim) Get relative orientation between adjacent entities in dimensions fromDim to toDim.
int[]	getAdjOrient(int fromDim, int toDim, int fromIdx) Get relative orientation between entity fromIdx in dimension fromDim and its adjacent entities in dimension toDim.
int[][]	getAdjSparse(int fromDim, int toDim) Gets adjacency between entities in dimensions fromDim and toDim.
double[]	getBoundingBox() Returns bounding box of object.
double[][]	getEdge() Gets edge matrix.
double[][]	getFace() Gets face matrix.
int	getNBoundaries() Gets number of boundaries.
int	getNDomains() Gets number of domains.
int	getNEdges() Gets number of edges.
int[]	getNEntities() Gets number of entities of each dimension.
int[]	getNEntitiesMesh() Get number of entities in mesh construction geometry.
int	getNFaces() Gets number of faces.
int	getNFiniteVoids() Gets number of finite void regions.
int	getNVertices() Gets number of vertices.
double[][]	getPEdge() Gets parameter edges (embeddings of edges in faces).
double[][]	getPVertex() Gets parameter vertices (embeddings of vertices in faces).
double[]	getSD() Returns the domain index for each vertex.
int	getSDim() Returns the space dimension.
int[][]	getStartEnd() Returns a 2 x (number of edges) matrix with start and end points for edges.
java.lang.String	getType() Returns the object type: solid, surface, curve, point, mixed, or empty.
int[][]	getUpDown() Returns the up and down domain number for all boundaries in the first and second row of the returned matrix.
int[][]	getUpDownExt() Returns the up and down domain number for all boundaries in the first and second row of the returned matrix, using the extended domain numbering.
double[][]	getVertex() Gets vertices.
double[][]	getVertexCoord() Get point coordinates as a sdim x (number of points) matrix.
int[]	getVertexDomain() Returns the domain index for each vertex.
double[][]	getVtx() Gets vertices.
boolean	hasCadRep() Checks if the object is represented using the CAD Import Module's geometry kernel.
boolean	voidsAreLabeled() Returns true if all finite void regions are labeled with negative domain indices in the serialization (mphtxt/mphbin file).

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

Method Detail

check

void check()

Throws an exception if the geometry is invalid.

edgeCurvature

double[] edgeCurvature(int edge,
                       double[] s)

Evaluates edge curvature at the specified parameters. The method is not implemented for meshes.

Parameters:

edge - Edge index.

s - Vector of parameter values.

Returns:

Vector of curvature values.

edgeDDDX

double[][] edgeDDDX(int edge,
                    double[] s)

Evaluates the parameters to third order derivative values.

Parameters:

edge - Edge index.

s - Vector of parameter values.

Returns:

Matrix of third order derivative values.

edgeDDX

double[][] edgeDDX(int edge,
                   double[] s)

Evaluates the parameters to second order derivative values.

Parameters:

edge - Edge index.

s - Vector of parameter values.

Returns:

Matrix of second order derivative values.

edgeDX

double[][] edgeDX(int edge,
                  double[] s)

Evaluates the parameters to first order derivative values.

Parameters:

edge - Edge index.

s - Vector of parameter values.

Returns:

Matrix of first order derivative values.

edgeMaxFaceAngle

double[] edgeMaxFaceAngle(int[] edge,
                          int[] face1,
                          int[] face2)

Compute the "maximum" along a 3D edge of the angle (in radians) between the normal vectors of two faces that are adjacent to the edge. The "maximum" is defined as the value closest to pi/2. The method is vectorized so that the Nth entry in the returned array is the maximum along edge[N] of the angle between faces face1[N] and face2[N]. The edge and face numbers are one-based.

Parameters:

edge - Vector of edge indices.

face1 - Vector of first face indices.

face2 - Vector of second face indices.

Returns:

Vector of maximum angles.

edgeNormal

double[][] edgeNormal(int edge,
                      double[] s)

Evaluates the parameters to normal vector values in 2D.

Parameters:

edge - Vector of parameter values.

s - Vector of parameter values.

Returns:

Matrix of normal vector values.

edgeParamRange

double[] edgeParamRange(int edge)

Returns the parameter range for evaluation on the edge.

Parameters:

edge - Edge index.

Returns:

Parameter range vector of length 2.

edgeTorsion

double[] edgeTorsion(int edge,
                     double[] s)

Evaluates the parameters to torsion values.

Parameters:

edge - Edge index.

s - Vector of parameter values.

Returns:

Vector of torsion values.

edgeX

double[][] edgeX(int edge,
                 double[] s)

Evaluates the parameters to coordinate values.

Parameters:

edge - Edge index.

s - Vector of parameter values.

Returns:

Matrix of coordinate values.

exists

boolean exists()

Check if an object exists.

Returns:

true if object exists.

faceDDX

double[][][][] faceDDX(int face,
                       double[][] param)

Evaluates the parameters to second order derivative values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Rank 4 array of second order derivative values.

faceDX

double[][][] faceDX(int face,
                    double[][] param)

Evaluates the parameters to first order derivative values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Rank 3 array of first order derivative values.

faceFF1

double[][][] faceFF1(int face,
                     double[][] param)

Evaluates the parameters to the first fundamental form values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Matrix of first fundamental form values.

faceFF2

double[][][] faceFF2(int face,
                     double[][] param)

Evaluates the parameters to the second fundamental form values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Matrix of second fundamental form values.

faceGaussCurvature

double[] faceGaussCurvature(int face,
                            double[][] param)

Evaluates the parameters to Gauss curvature values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Matrix of Gauss curvature values.

faceMeanCurvature

double[] faceMeanCurvature(int face,
                           double[][] param)

Evaluates the parameters to mean curvature values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Matrix of mean curvature values.

faceNormal

double[][] faceNormal(int face,
                      double[][] param)

Evaluates the parameters to normal vector values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Matrix of normal vector values.

faceParamRange

double[] faceParamRange(int face)

Returns two parameter ranges for evaluation on the face.

Parameters:

face - Face index.

Returns:

Matrix of normal vector values.

faceX

double[][] faceX(int face,
                 double[][] param)

Evaluates the parameters to coordinate values.

Parameters:

face - Face index.

param - Matrix of parameter values.

Returns:

Matrix of coordinate values.

getAdj

int[][] getAdj(int fromDim,
               int toDim)

Gets adjacency between entities in dimensions fromDim and toDim. A row A[fromIdx] in the returned matrix A contains the 1-based entities in dimension toDim that are adjacent to entity fromIdx in dimension fromDim. fromIdx is a 1-based entity number. If fromDim==sdim, fromIdx=0 means the void regions.

Parameters:

fromDim - From dimension.

toDim - To dimension.

Returns:

Adjacency matrix.

getAdj

int[] getAdj(int fromDim,
             int toDim,
             int fromIdx)

Gets adjacent entities in dimension toDim to entity fromIdx in dimension fromDim. fromIdx is a 1-based entity number, and the returned entity numbers are also 1-based.

Parameters:

fromDim - From dimension.

toDim - To dimension.

fromIdx - From entity.

Returns:

Adjacency vector.

getAdjExt

int[][] getAdjExt(int fromDim,
                  int toDim)

Gets extended adjacency between entities in dimensions fromDim and toDim. A row A[fromIdx+offset] in the returned matrix A contains the 1-based entities in dimension toDim that are adjacent to entity fromIdx in dimension fromDim. If toDim=getSDim(), the entity numbers can also by negative or 0, representing finite/infinite void regions. fromIdx is a 1-based entity number. If fromDim=getSDim(), fromIdx can also be negative or 0, representing finite/infinite void regions. If fromDim=getSDim(), offset is the number of finite void regions, otherwise offset=0. Note: If voidsAreLabeled() is false, then there might be finite void regions that are denoted with 0 instead of a negative number.

Parameters:

fromDim - From dimension.

toDim - To dimension.

Returns:

Adjacency matrix.

getAdjExt

int[] getAdjExt(int fromDim,
                int toDim,
                int fromIdx)

Gets adjacent entities in dimension toDim to entity fromIdx in dimension fromDim. The returned array contains the 1-based entities in dimension toDim that are adjacent to entity fromIdx in dimension fromDim. If toDim=getSDim(), the entity numbers can also by negative or 0, representing finite/infinite void regions. fromIdx is a 1-based entity number. If fromDim=getSDim(), fromIdx can also be negative or 0, representing finite/infinite void regions. Note: If voidsAreLabeled() is false, then there might be finite void regions that are denoted with 0 instead of a negative number.

Parameters:

fromDim - From dimension.

toDim - To dimension.

fromIdx - From entity.

Returns:

Adjacency vector.

getAdjExtOrient

int[][] getAdjExtOrient(int fromDim,
                        int toDim)

Get relative orientation between adjacent entities in dimensions fromDim to toDim. The returned array has the same size as getAdjExt(fromDim,toDim). A value 1 means that the entities have the same orientation, and -1 means that they have the opposite orientation. A value 2 means that the relative orientation is undefined, since the the lower-dimensional entity is interior to the higher-dimensional entity. The return value is undefined if abs(fromDim-toDim)!=1.

Parameters:

fromDim - From dimension.

toDim - To dimension.

Returns:

Orientation matrix.

getAdjExtOrient

int[] getAdjExtOrient(int fromDim,
                      int toDim,
                      int fromIdx)

Get relative orientation between entity fromIdx in dimension fromDim and its adjacent entities in dimension toDim. The returned array has the same length as getAdjExt(fromDim,toDim,fromIdx). fromIdx is a 1-based entity number. If fromDim=getSDim(), fromIdx can also be negative or 0, representing finite/infinite void regions. A value 1 means that the entities have the same orientation, and -1 means that they have the opposite orientation. A value 2 means that the relative orientation is undefined, since the the lower-dimensional entity is interior to the higher-dimensional entity.

Parameters:

fromDim - From dimension.

toDim - To dimension.

fromIdx - From entity.

Returns:

Orientation vector.

getAdjOrient

int[][] getAdjOrient(int fromDim,
                     int toDim)

Get relative orientation between adjacent entities in dimensions fromDim to toDim. The returned array has the same size as getAdj(fromDim,toDim). A value 1 means that the entities have the same orientation, and -1 means that they have the opposite orientation. A value 2 means that the relative orientation is undefined, since the the lower-dimensional entity is interior to the higher-dimensional entity.

Parameters:

fromDim - From dimension.

toDim - To dimension.

Returns:

Adjacency matrix.

getAdjOrient

int[] getAdjOrient(int fromDim,
                   int toDim,
                   int fromIdx)

Get relative orientation between entity fromIdx in dimension fromDim and its adjacent entities in dimension toDim. The returned array has the same length as getAdj(fromDim,toDim,fromIdx). fromIdx is a 1-based entity number. A value 1 means that the entities have the same orientation, and -1 means that they have the opposite orientation. A value 2 means that the relative orientation is undefined, since the the lower-dimensional entity is interior to the higher-dimensional entity.

Parameters:

fromDim - From dimension.

toDim - To dimension.

fromIdx - From entity.

Returns:

Adjacency vector.

getAdjSparse

int[][] getAdjSparse(int fromDim,
                     int toDim)

Gets adjacency between entities in dimensions fromDim and toDim. The returned matrix A has three rows.
A[0] are 1-based from-entity indices.
A[1] are 1-based to-entity indices.
A[2] are orientation values (1, -1, or 2).
For domains, domain 0 means the void regions. Zeros can occur in both from-domains and to-domains.

Parameters:

fromDim - From dimension.

toDim - To dimension.

Returns:

Adjacency matrix.

getBoundingBox

double[] getBoundingBox()

Returns bounding box of object.

Returns:

Bounding box coordinates, ([xmin, xmax, ymin, ymax, ...] depending on dimension).

getEdge

double[][] getEdge()

Gets edge matrix.

Returns:

Edge matrix.

getFace

double[][] getFace()

Gets face matrix.

Returns:

Face matrix.

getNBoundaries

int getNBoundaries()

Gets number of boundaries.

Returns:

Number of boundaries.

getNDomains

int getNDomains()

Gets number of domains.

Returns:

Number of domains.

getNEdges

int getNEdges()

Gets number of edges.

Returns:

Number of edges.

getNEntities

int[] getNEntities()

Gets number of entities of each dimension.

Returns:

Vector with number of entities of each dimension.

getNEntitiesMesh

int[] getNEntitiesMesh()

Get number of entities in mesh construction geometry.

Returns:

Number of entities.

getNFaces

int getNFaces()

Gets number of faces.

Returns:

Number of faces.

getNFiniteVoids

int getNFiniteVoids()

Gets number of finite void regions.

Returns:

Number of finite void regions.

getNVertices

int getNVertices()

Gets number of vertices.

Returns:

Number of vertices.

getPEdge

double[][] getPEdge()

Gets parameter edges (embeddings of edges in faces).

Returns:

Matrix of parameter edges.

getPVertex

double[][] getPVertex()

Gets parameter vertices (embeddings of vertices in faces).

Returns:

Matrix of parameter vertices.

getSD

double[] getSD()

Returns the domain index for each vertex. For non-isolated vertices, the domain index is NaN.

Returns:

Domain indices.

getSDim

int getSDim()

Returns the space dimension.

Returns:

Space dimension.

getStartEnd

int[][] getStartEnd()

Returns a 2 x (number of edges) matrix with start and end points for edges.

Returns:

Start and end matrix.

getType

java.lang.String getType()

Returns the object type: solid, surface, curve, point, mixed, or empty.

Returns:

Object type.

getUpDown

int[][] getUpDown()

Returns the up and down domain number for all boundaries in the first and second row of the returned matrix. Domain number 0 is used for all void regions.

Returns:

Up and down matrix.

getUpDownExt

int[][] getUpDownExt()

Returns the up and down domain number for all boundaries in the first and second row of the returned matrix, using the extended domain numbering. Domain number 0 is used for the infinite void region. Negative domain numbers are used for finite void regions. Note: If voidsAreLabeled() is false, then there might be finite void regions that are denoted with 0 instead of a negative number.

Returns:

Up and down matrix.

getVertex

double[][] getVertex()

Gets vertices.

Returns:

Vertex information.

getVertexCoord

double[][] getVertexCoord()

Get point coordinates as a sdim x (number of points) matrix.

Returns:

Coordinate matrix.

getVertexDomain

int[] getVertexDomain()

Returns the domain index for each vertex. For non-isolated vertices, the domain index is -1.

Returns:

Domain index.

getVtx

double[][] getVtx()

Gets vertices.

Returns:

Vertex information.

hasCadRep

boolean hasCadRep()

Checks if the object is represented using the CAD Import Module's geometry kernel.

Returns:

true if CAD representation.

voidsAreLabeled

boolean voidsAreLabeled()

Returns true if all finite void regions are labeled with negative domain indices in the serialization (mphtxt/mphbin file). This also affects the domain indices in getAdjExt(), getAdjOrientExt(), getUpDownExt(), getFace(), getEdge(), and getVertex().

Returns:

false if some finite void regions might be denoted with 0 in the serialization, like in version 4.2.