HexElement (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.RenderableComponentBase
  - - artisynth.core.femmodels.FemElement
    - - artisynth.core.femmodels.FemElement3dBase
      - artisynth.core.femmodels.FemElement3d
        
        artisynth.core.femmodels.HexElement

All Implemented Interfaces:

FrameAttachable, PointAttachable, CopyableComponent, HasNumericState, ModelComponent, PostScannable, PropertyChangeListener, RenderableComponent, ScalableUnits, java.lang.Cloneable, Boundable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable
```
public class HexElement
extends FemElement3d
```

Nested Class Summary
- Nested classes/interfaces inherited from class artisynth.core.femmodels.FemElement
  FemElement.ElementClass
- Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent
  ModelComponent.NavpanelVisibility

Field Summary

Fields
Modifier and Type	Field and Description
`static double[]`	`INTEGRATION_COORDS_GAUSS_27`
`static double[]`	`INTEGRATION_COORDS_GAUSS_64`
`static double[]`	`INTEGRATION_COORDS_GAUSS_8`
`static double[]`	`INTEGRATION_COORDS_LOBATTO_27`
`static double[]`	`INTEGRATION_COORDS_LOBATTO_64`
`static double[]`	`INTEGRATION_COORDS_LOBATTO_8`
`static MatrixNd`	`NODAL_EXTRAPOLATION_27`
`static MatrixNd`	`NODAL_EXTRAPOLATION_64`
`static MatrixNd`	`NODAL_EXTRAPOLATION_8`

Fields inherited from class artisynth.core.femmodels.FemElement3dBase
myProps

Fields inherited from class artisynth.core.femmodels.FemElement
setScannedNodesInPostscan, writeNodeRefsByNumber

Fields inherited from class artisynth.core.modelbase.ModelComponentBase
enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.CopyableComponent
COPY_REFERENCES, REST_POSITION

Fields inherited from interface maspack.render.IsRenderable
TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors
Constructor and Description
`HexElement()`
`HexElement(FemNode3d[] nodes)`
`HexElement(FemNode3d n0, FemNode3d n1, FemNode3d n2, FemNode3d n3, FemNode3d n4, FemNode3d n5, FemNode3d n6, FemNode3d n7)` Creates a HexElement from eight nodes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTetElement(TetElement e)`
`void`	`clearTetElements()`
`static double`	`computeVolume(FemNode3d n1, FemNode3d n2, FemNode3d n3, FemNode3d n4, FemNode3d n5, FemNode3d n6, FemNode3d n7, FemNode3d n8)`
`boolean`	`coordsAreInside(Vector3d coords)` Queries whether or not a set of natural coordinates are inside this element.
`HexElement`	`copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)` Create a copy of this component.
`static double[]`	`createHexIntegrationCoords(double[] locs, double[] wgts)` Computes hexahedral integration coordinates using a tensor product of the supplied 1D quadrature rule.
`IntegrationPoint3d[]`	`getDefaultIntegrationPoints()`
`void`	`getdNds(Vector3d dNds, int i, Vector3d coords)`
`int[]`	`getEdgeIndices()`
`int[]`	`getFaceIndices()`
`HexElement[]`	`getFaceNeighbors()`
`double[]`	`getIntegrationCoords()` Returns the natural coordinates and weights for the default integration points associated with this element.
`IntegrationPoint3d[]`	`getIntegrationPoints()` Returns the integration points associated with this element, not including the warping point (see `FemElement3dBase.getWarpingPoint()`).
`double`	`getN(int i, Vector3d coords)`
`MatrixNd`	`getNodalAveragingMatrix()` Returns the nodal averaging matrix for this element, used for extrapolating values from the integration points to the element nodes for purposes of computing average nodal values.
`MatrixNd`	`getNodalExtrapolationMatrix()` Returns the nodal extrapolation matrix for this element.
`double[]`	`getNodeCoords()`
`double[]`	`getNodeMassWeights()`
`int`	`getParity()`
`FaceNodes3d[]`	`getQuadFaces()`
`TetElement`	`getTetElement(int i)`
`int[]`	`getTriangulatedFaceIndices()`
`IntegrationPoint3d`	`getWarpingPoint()` Returns the special warping integration point which is located at the center of the element and is used for computing stiffness warping and other specialized applications.
`boolean`	`hasEdge(FemNode3d n0, FemNode3d n1)`
`boolean`	`hasFace(FemNode3d n0, FemNode3d n1, FemNode3d n2, FemNode3d n3)`
`boolean`	`integrationPointsMapToNodes()` Queries whether there is a one-to-one mapping between integration points and nodes.
`boolean`	`isInside(Point3d pnt)` Tests whether or not a point is inside an element.
`static boolean`	`mapICoordsToNodes(double[] coords)`
`static boolean`	`mapIPointsToNodes(IntegrationPoint3d[] ipnts, MatrixNd nodalInterp, FemNode3d[] nodes)`
`int`	`numIntegrationPoints()` Returns the number of integration points actually used by this element (not including the warping point, if any).
`int`	`numTetElements()`
`boolean`	`removeTetElement(TetElement e)`
`void`	`render(Renderer renderer, RenderProps props, int flags)`
`void`	`renderWidget(Renderer renderer, double size, RenderProps props)`
`void`	`setFaceNeighbors(HexElement[] nbrs)`
`void`	`setIntegrationPoints(IntegrationPoint3d[] ipnts, MatrixNd nodalExtrapMat)`
`void`	`setIntegrationPoints(IntegrationPoint3d[] ipnts, MatrixNd nodalExtrapMat, boolean mapToNodes)`
`int`	`setNeighborParities()` Rescursively sets the partities of a nodes neighbors, starting with this element, so as to try and obtain conforming tesselation.
`static void`	`setNodalAveragingMatrix(MatrixNd NX)`
`static void`	`setParities(java.util.List<HexElement> hexes)`
`void`	`setParity(int parity)`
`TetElement[]`	`tesselate(int parity)`

Methods inherited from class artisynth.core.femmodels.FemElement3d
computeJacobian, computeLocalPosition, computeRestVolumes, computeVolumes, createElement, createElement, getH, getIncompressConstraints, getIncompressIndex, getLagrangePressures, getPressureWeightMatrix, getRestVolumes, getVolumes, numPressureVals, scaleDistance, setIncompressIndex

Methods inherited from class artisynth.core.femmodels.FemElement3dBase
addConsistentGravity, addConsistentMass, advanceState, clearRotationData, computeConsistentMass, computeCovariance, computeDirectedRenderSize, computeGravityWeights, computeRenderCoordsAndGradient, connectToHierarchy, containsEdge, containsFace, containsFace, containsNode, createFrameAttachment, createIntegrationPoints, createPointAttachment, disconnectFromHierarchy, getAllIntegrationPoints, getAllPropertyInfo, getCopyReferences, getDeformation, getDeformation, getElementClass, getElementWidgetSize, getElementWidgetSizeMode, getFaces, getFemModel, getFrame, getIntegrationData, getIntegrationShapeMatrix, getInvB, getInvB, getMarkerCoordinates, getNaturalCoordinates, getNaturalCoordinates, getNaturalCoordinatesGSS, getNodeCoords, getNodeNeighbors, getNodes, getNumFaces, getRotation, getRotation, getState, getStiffnessWarper, getWarpingData, invalidateRestData, invalidateRotationData, isInvertedAtRest, notifyStateVersionChanged, numAllIntegrationPoints, requiresAdvance, setElementWidgetSize, setElementWidgetSizeMode, setFrame, setNodes, setState, setStiffnessWarper, triangulateFace

Methods inherited from class artisynth.core.femmodels.FemElement
addAugmentingMaterial, addAuxiliaryMaterial, computeCentroid, containsNode, createRenderProps, defaultRenderPropsAreNull, getAugmentingMaterials, getAuxiliaryMaterials, getDensity, getDensityMode, getEffectiveMaterial, getHardReferences, getIndex, getLocalNodeIndex, getMass, getMaterial, getPlasticDeformation, getPoint, getRestVolume, getSelection, getStateVersion, getStrainEnergy, getVolume, hasActiveNodes, hasControllableNodes, hasState, integrationPointsInterpolateToNodes, invalidateMassIfNecessary, isDuplicatable, isInverted, isLinear, isMassExplicit, materialsAreInvertible, numAugmentingMaterials, numAuxiliaryMaterials, numberString, numNodes, numPoints, prerender, propertyChanged, removeAugmentingMaterial, removeAuxiliaryMaterial, render, scaleMass, setDensity, setDensityMode, setExplicitMass, setIndex, setInverted, setMass, setMaterial, setPlasticDeformation, unsetExplicitMass, updateBounds, updateRestVolumeAndMass

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase
getRenderHints, getRenderProps, isSelectable, isVisible, numSelectionQueriesNeeded, setRenderProps, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase
checkFlag, checkName, checkNameUniqueness, clearFlag, clone, createTempFlag, getChildren, getGrandParent, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences, write

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface artisynth.core.modelbase.ModelComponent
getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties
getProperty

Methods inherited from interface maspack.properties.HierarchyNode
getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable
postscan

Methods inherited from interface maspack.util.Scannable
isWritable, write

Methods inherited from interface artisynth.core.modelbase.HasNumericState
getAuxVarDerivative, getAuxVarState, numAuxVars, setAuxVarState

- Field Detail
  - INTEGRATION_COORDS_GAUSS_8
```
public static final double[] INTEGRATION_COORDS_GAUSS_8
```
  - INTEGRATION_COORDS_GAUSS_27
```
public static final double[] INTEGRATION_COORDS_GAUSS_27
```
  - INTEGRATION_COORDS_GAUSS_64
```
public static final double[] INTEGRATION_COORDS_GAUSS_64
```
  - INTEGRATION_COORDS_LOBATTO_8
```
public static final double[] INTEGRATION_COORDS_LOBATTO_8
```
  - INTEGRATION_COORDS_LOBATTO_27
```
public static final double[] INTEGRATION_COORDS_LOBATTO_27
```
  - INTEGRATION_COORDS_LOBATTO_64
```
public static final double[] INTEGRATION_COORDS_LOBATTO_64
```
  - NODAL_EXTRAPOLATION_8
```
public static final MatrixNd NODAL_EXTRAPOLATION_8
```
  - NODAL_EXTRAPOLATION_27
```
public static final MatrixNd NODAL_EXTRAPOLATION_27
```
  - NODAL_EXTRAPOLATION_64
```
public static final MatrixNd NODAL_EXTRAPOLATION_64
```
- Constructor Detail
  - HexElement
```
public HexElement()
```
  - HexElement
```
public HexElement(FemNode3d n0,
                  FemNode3d n1,
                  FemNode3d n2,
                  FemNode3d n3,
                  FemNode3d n4,
                  FemNode3d n5,
                  FemNode3d n6,
                  FemNode3d n7)
```
    Creates a HexElement from eight nodes. The first four nodes should describe a single face of the element, arranged counter-clockwise about the outward-directed normal. The last four nodes should describe the corresponding nodes on the opposite face (these will be arranged clockwise about that face's normal).
  - HexElement
```
public HexElement(FemNode3d[] nodes)
```
- Method Detail
  - integrationPointsMapToNodes
```
public boolean integrationPointsMapToNodes()
```
    Queries whether there is a one-to-one mapping between integration points and nodes. If so, this means that nodal values of quantities such as stress and volume can be adequately approximated by averaging the same quantities from all the associated integration points.
    
    Overrides:
    
    integrationPointsMapToNodes in class FemElement
    
    Returns:
    
    true if there is a one-to-one mapping between integration points and nodes
  - getDefaultIntegrationPoints
```
public IntegrationPoint3d[] getDefaultIntegrationPoints()
```
  - setIntegrationPoints
```
public void setIntegrationPoints(IntegrationPoint3d[] ipnts,
                                 MatrixNd nodalExtrapMat)
```
  - setIntegrationPoints
```
public void setIntegrationPoints(IntegrationPoint3d[] ipnts,
                                 MatrixNd nodalExtrapMat,
                                 boolean mapToNodes)
```
  - getIntegrationPoints
```
public IntegrationPoint3d[] getIntegrationPoints()
```
    Description copied from class: FemElement3dBase
    
    Returns the integration points associated with this element, not including the warping point (see FemElement3dBase.getWarpingPoint()). In some cases, such as with membrane elements, only the first n points of these points are actaully used, where n is the number returned by FemElement3dBase.numIntegrationPoints().
    
    Specified by:
    
    getIntegrationPoints in class FemElement3dBase
  - getWarpingPoint
```
public IntegrationPoint3d getWarpingPoint()
```
    Description copied from class: FemElement3dBase
    
    Returns the special warping integration point which is located at the center of the element and is used for computing stiffness warping and other specialized applications.
    
    Specified by:
    
    getWarpingPoint in class FemElement3dBase
  - coordsAreInside
```
public boolean coordsAreInside(Vector3d coords)
```
    Description copied from class: FemElement3dBase
    
    Queries whether or not a set of natural coordinates are inside this element.
    
    Specified by:
    
    coordsAreInside in class FemElement3dBase
    
    Returns:
    
    true if ncoords are inside this element.
  - numIntegrationPoints
```
public int numIntegrationPoints()
```
    Description copied from class: FemElement3dBase
    
    Returns the number of integration points actually used by this element (not including the warping point, if any). Typically this number will equal the length of the integration point array returned by FemElement3dBase.getIntegrationPoints(), but in some cases (such as shell elements being used as membrane elements), it will be less.
    
    Specified by:
    
    numIntegrationPoints in class FemElement3dBase
    
    Returns:
    
    number of integration points used by this element
  - getIntegrationCoords
```
public double[] getIntegrationCoords()
```
    Description copied from class: FemElement3dBase
    
    Returns the natural coordinates and weights for the default integration points associated with this element. The information is returned as an array of length 4*num, where num is the number of coordinates, and the information for each coordinate consists of a 4-tuple giving the three natural coordinates followed by the weight.
    
    Specified by:
    
    getIntegrationCoords in class FemElement3dBase
    
    Returns:
    
    coordinates and weights for the default integration points.
  - getNodeCoords
```
public double[] getNodeCoords()
```
    Specified by:
    
    getNodeCoords in class FemElement3dBase
  - getNodeMassWeights
```
public double[] getNodeMassWeights()
```
    Specified by:
    
    getNodeMassWeights in class FemElement3dBase
  - setNodalAveragingMatrix
```
public static void setNodalAveragingMatrix(MatrixNd NX)
```
  - getNodalAveragingMatrix
```
public MatrixNd getNodalAveragingMatrix()
```
    Description copied from class: FemElement3dBase
    
    Returns the nodal averaging matrix for this element, used for extrapolating values from the integration points to the element nodes for purposes of computing average nodal values. By default, this matrix is the same as that returned by FemElement3dBase.getNodalExtrapolationMatrix(). However, since the purpose of this matrix is for computing nodal averages, simpler matrices can sometimes be used, such as an identity or permutation matrix that assigns the value at each node to that of a specific integration point. Element subclasses may override this method to supply such simplified matrices.
    
    Overrides:
    
    getNodalAveragingMatrix in class FemElement3dBase
    
    Returns:
    
    nodal extrapolation matrix
  - getNodalExtrapolationMatrix
```
public MatrixNd getNodalExtrapolationMatrix()
```
    Description copied from class: FemElement3dBase
    
    Returns the nodal extrapolation matrix for this element. This is a matrix that maps values from the integration points to the element nodes, and is the inverse (or pseudo-inverse) of the integration point shape matrix returned by FemElement3dBase.getIntegrationShapeMatrix().
    
    Specified by:
    
    getNodalExtrapolationMatrix in class FemElement3dBase
    
    Returns:
    
    nodal extrapolation matrix
  - getN
```
public double getN(int i,
                   Vector3d coords)
```
    Specified by:
    
    getN in class FemElement3dBase
  - getdNds
```
public void getdNds(Vector3d dNds,
                    int i,
                    Vector3d coords)
```
    Specified by:
    
    getdNds in class FemElement3dBase
  - getEdgeIndices
```
public int[] getEdgeIndices()
```
    Specified by:
    
    getEdgeIndices in class FemElement3dBase
  - getFaceIndices
```
public int[] getFaceIndices()
```
    Specified by:
    
    getFaceIndices in class FemElement3dBase
  - getTriangulatedFaceIndices
```
public int[] getTriangulatedFaceIndices()
```
    Specified by:
    
    getTriangulatedFaceIndices in class FemElement3dBase
  - getParity
```
public int getParity()
```
  - setParity
```
public void setParity(int parity)
```
  - setFaceNeighbors
```
public void setFaceNeighbors(HexElement[] nbrs)
```
  - getFaceNeighbors
```
public HexElement[] getFaceNeighbors()
```
  - addTetElement
```
public void addTetElement(TetElement e)
```
  - removeTetElement
```
public boolean removeTetElement(TetElement e)
```
  - clearTetElements
```
public void clearTetElements()
```
  - numTetElements
```
public int numTetElements()
```
  - getTetElement
```
public TetElement getTetElement(int i)
```
  - tesselate
```
public TetElement[] tesselate(int parity)
```
  - render
```
public void render(Renderer renderer,
                   RenderProps props,
                   int flags)
```
    Specified by:
    
    render in class FemElement
  - renderWidget
```
public void renderWidget(Renderer renderer,
                         double size,
                         RenderProps props)
```
    Specified by:
    
    renderWidget in class FemElement3dBase
  - computeVolume
```
public static double computeVolume(FemNode3d n1,
                                   FemNode3d n2,
                                   FemNode3d n3,
                                   FemNode3d n4,
                                   FemNode3d n5,
                                   FemNode3d n6,
                                   FemNode3d n7,
                                   FemNode3d n8)
```
  - isInside
```
public boolean isInside(Point3d pnt)
```
    Tests whether or not a point is inside an element. Note: this routine divides the element into a set of Tets, making the assumption that faces are piece-wise planes. This isn't technically correct. Do avoid potential gaps between adjacent elements, we split the hex in all possible ways
    
    Overrides:
    
    isInside in class FemElement3dBase
    
    Parameters:
    
    pnt - point to check if is inside
    
    Returns:
    
    true if point is inside the element
  - getQuadFaces
```
public FaceNodes3d[] getQuadFaces()
```
  - setNeighborParities
```
public int setNeighborParities()
```
    Rescursively sets the partities of a nodes neighbors, starting with this element, so as to try and obtain conforming tesselation. Returns the number of elements, if any, whose parity code not be set properly.
  - setParities
```
public static void setParities(java.util.List<HexElement> hexes)
```
  - hasEdge
```
public boolean hasEdge(FemNode3d n0,
                       FemNode3d n1)
```
  - hasFace
```
public boolean hasFace(FemNode3d n0,
                       FemNode3d n1,
                       FemNode3d n2,
                       FemNode3d n3)
```
  - copy
```
public HexElement copy(int flags,
                       java.util.Map<ModelComponent,ModelComponent> copyMap)
```
    Description copied from interface: CopyableComponent
    
    Create a copy of this component. If COPY_REFERENCES is set in flags, then any component referenced by this component should itself be set to a copy. This should be done first checking copyMap for an existing copy of the referenced component. If there is no existing copy, then a copy should be created by calling copy recursively and adding the new copy to copyMap.
    
    Specified by:
    
    copy in interface CopyableComponent
    
    Overrides:
    
    copy in class FemElement3d
    
    Parameters:
    
    flags - flags to control the copying
    
    copyMap - map to possible existing instances of referenced components
    
    Returns:
    
    copy of this component
  - createHexIntegrationCoords
```
public static double[] createHexIntegrationCoords(double[] locs,
                                                  double[] wgts)
```
    Computes hexahedral integration coordinates using a tensor product of the supplied 1D quadrature rule.
    
    Parameters:
    
    locs - 1D locations in [-1 1]
    
    wgts - associated weights
    
    Returns:
    
    double array with [x1,y1,z1,w1, x2,y2,z2,w1, ...]
  - mapIPointsToNodes
```
public static boolean mapIPointsToNodes(IntegrationPoint3d[] ipnts,
                                        MatrixNd nodalInterp,
                                        FemNode3d[] nodes)
```
  - mapICoordsToNodes
```
public static boolean mapICoordsToNodes(double[] coords)
```

Class HexElement

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.femmodels.FemElement

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

Field Summary

Fields inherited from class artisynth.core.femmodels.FemElement3dBase

Fields inherited from class artisynth.core.femmodels.FemElement

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

Fields inherited from interface maspack.render.IsRenderable

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.femmodels.FemElement3d

Methods inherited from class artisynth.core.femmodels.FemElement3dBase

Methods inherited from class artisynth.core.femmodels.FemElement

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

Methods inherited from class java.lang.Object

Methods inherited from interface artisynth.core.modelbase.ModelComponent

Methods inherited from interface maspack.properties.HasProperties

Methods inherited from interface maspack.properties.HierarchyNode

Methods inherited from interface artisynth.core.modelbase.PostScannable

Methods inherited from interface maspack.util.Scannable

Methods inherited from interface artisynth.core.modelbase.HasNumericState

Field Detail

INTEGRATION_COORDS_GAUSS_8

INTEGRATION_COORDS_GAUSS_27

INTEGRATION_COORDS_GAUSS_64

INTEGRATION_COORDS_LOBATTO_8

INTEGRATION_COORDS_LOBATTO_27

INTEGRATION_COORDS_LOBATTO_64

NODAL_EXTRAPOLATION_8

NODAL_EXTRAPOLATION_27

NODAL_EXTRAPOLATION_64

Constructor Detail

HexElement

HexElement

HexElement

Method Detail

integrationPointsMapToNodes

getDefaultIntegrationPoints

setIntegrationPoints

setIntegrationPoints

getIntegrationPoints

getWarpingPoint

coordsAreInside

numIntegrationPoints

getIntegrationCoords

getNodeCoords

getNodeMassWeights

setNodalAveragingMatrix

getNodalAveragingMatrix

getNodalExtrapolationMatrix

getN

getdNds

getEdgeIndices

getFaceIndices

getTriangulatedFaceIndices

getParity

setParity

setFaceNeighbors

getFaceNeighbors

addTetElement

removeTetElement

clearTetElements

numTetElements

getTetElement

tesselate

render

renderWidget

computeVolume

isInside

getQuadFaces

setNeighborParities

setParities

hasEdge

hasFace

copy

createHexIntegrationCoords

mapIPointsToNodes