MFreeElement3d (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.RenderableComponentBase
  - - artisynth.core.femmodels.FemElement
    - - artisynth.core.femmodels.FemElement3d
      - artisynth.core.mfreemodels.MFreeElement3d

All Implemented Interfaces:

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

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

Field Summary
- Fields inherited from class artisynth.core.femmodels.FemElement3d
  myProps
- Fields inherited from class artisynth.core.modelbase.ModelComponentBase
  enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames
- Fields inherited from interface artisynth.core.modelbase.CopyableComponent
  COPY_REFERENCES
- Fields inherited from interface maspack.render.IsRenderable
  TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors
Constructor and Description

MFreeElement3d(MFreeShapeFunction fun, FemNode3d[] nodes)

Constructors
Constructor and Description
`MFreeElement3d(MFreeShapeFunction fun, FemNode3d[] nodes)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIntegrationPoint(MFreeIntegrationPoint3d ipnt, IntegrationData3d idata, double iwgt, boolean updateVolumes)`
`void`	`clearState()`
`void`	`computeCentroid(Vector3d centroid)` Computed the centroid of this element.
`boolean`	`coordsAreInside(Vector3d coords)`
`PolygonalMesh`	`getBoundaryMesh()`
`void`	`getdNds(Vector3d dNds, int i, Vector3d coords)`
`int[]`	`getEdgeIndices()`
`int[]`	`getFaceIndices()`
`double[]`	`getIntegrationCoords()`
`IntegrationData3d[]`	`getIntegrationData()`
`IntegrationData3d`	`getIntegrationData(int idx)`
`MFreeIntegrationPoint3d`	`getIntegrationPoint(int idx)`
`int`	`getIntegrationPointIndex(IntegrationPoint3d pnt)`
`MFreeIntegrationPoint3d[]`	`getIntegrationPoints()`
`double`	`getN(int i, Point3d coords)`
`double`	`getN(int i, Vector3d coords)`
`boolean`	`getNaturalCoordinates(Point3d coords, Point3d pnt)` Computes "natural" coordinates (i.e.
`int`	`getNaturalCoordinates(Point3d coords, Point3d pnt, int maxIters, VectorNd N)` Given point p, get its natural coordinates with respect to this element.
`boolean`	`getNaturalCoordinates(Point3d coords, Point3d pnt, VectorNd N)`
`double[]`	`getNodalExtrapolationMatrix()`
`double[]`	`getNodeCoords()`
`Point3d`	`getPoint(int idx)` Returns the `idx`-th point associated with this element.
`MFreeShapeFunction`	`getShapeFunction()`
`MFreeIntegrationPoint3d`	`getWarpingPoint()`
`boolean`	`integrationPointsInterpolateToNodes()` Queries whether there is an interpolation mapping between integration points and nodes.
`boolean`	`isInside(Point3d pnt)` Tests whether or not a point is inside an element.
`boolean`	`isInvertedAtRest()` Returns true if the rest position for this element results in a negative Jacobian determinant for at least one integration point.
`int`	`numIntegrationPoints()`
`int`	`numPoints()` Returns the number of points associated with this element, if any, or zero otherwise.
`void`	`prerender(RenderList list)` Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
`void`	`render(Renderer renderer, RenderProps rprops, int flags)`
`void`	`renderWidget(Renderer renderer, double size, RenderProps props)`
`void`	`renderWidget(Renderer renderer, double size, RenderProps props, int flags)`
`void`	`renderWidget(Renderer renderer, RenderProps props, int flags)`
`void`	`setBoundaryMesh(PolygonalMesh bmesh)`
`void`	`setIntegrationData(java.util.ArrayList<IntegrationData3d> data)`
`void`	`setIntegrationPoints(java.util.ArrayList<MFreeIntegrationPoint3d> points)`
`void`	`setIntegrationPoints(java.util.ArrayList<MFreeIntegrationPoint3d> points, java.util.ArrayList<IntegrationData3d> data)`
`void`	`setIntegrationPoints(MFreeIntegrationPoint3d[] points, IntegrationData3d[] data)`
`void`	`setRestVolume(double vol)`
`void`	`setShapeFunction(MFreeShapeFunction f)`
`void`	`setVolume(double vol)`
`void`	`setWarpingPoint(MFreeIntegrationPoint3d warp)`
`void`	`setWarpingPoint(MFreeIntegrationPoint3d warp, IntegrationData3d data)`
`void`	`setWarpingPointData(IntegrationData3d data)`
`void`	`updateAllVolumes()`
`void`	`updateBounds(Vector3d min, Vector3d max)` Update the minimum and maximum points for this object.

Methods inherited from class artisynth.core.femmodels.FemElement3d
addAuxiliaryMaterial, addNodeForce, addNodeStiffness, computeCovariance, computeDirectedRenderSize, computeGravityWeights, computeJacobian, computePosition, computePressures, computeRenderCoordsAndGradient, computeRestVolumes, computeVolumes, computeWarping, connectToHierarchy, copy, createElement, createElement, createFrameAttachment, createIntegrationPoints, createPointAttachment, disconnectFromHierarchy, getAllPropertyInfo, getAuxiliaryMaterials, getCopyReferences, getElementWidgetSize, getElementWidgetSizeMode, getFaces, getFrame, getH, getIncompressConstraints, getIncompressIndex, getLagrangePressures, getMarkerCoordinates, getNaturalCoordinates, getNaturalCoordinates, getNaturalCoordinatesGSS, getNaturalCoordinatesOld, getNaturalCoordinatesStd, getNodeCoords, getNodeNeighbors, getNodes, getNumEdges, getNumFaces, getPressureWeightMatrix, getRestVolumes, getStiffnessWarper, getVolumes, getWarpingData, hasEdge, hasFace, hasFace, invalidateRestData, materialsAreInvertible, numAuxiliaryMaterials, numPressureVals, removeAuxiliaryMaterial, scaleDistance, setElementWidgetSize, setElementWidgetSizeMode, setFrame, setIncompressIndex, setStiffnessWarper, triangulateFace

Methods inherited from class artisynth.core.femmodels.FemElement
containsNode, createRenderProps, getDensity, getDensityMode, getEffectiveMaterial, getHardReferences, getIndex, getLocalNodeIndex, getMass, getMaterial, getRestVolume, getSelection, getVolume, hasActiveNodes, hasControllableNodes, integrationPointsMapToNodes, isDuplicatable, isInverted, isMassExplicit, numberString, numNodes, propertyChanged, render, scaleMass, setDensity, setDensityMode, setIndex, setInverted, setMass, setMassExplicit, setMaterial, updateRestVolumeAndMass

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase
getRenderHints, getRenderProps, isSelectable, numSelectionQueriesNeeded, setRenderProps, 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, hasState, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, updateReferences, write

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

Methods inherited from interface maspack.geometry.Boundable
computeCovariance

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

Methods inherited from interface maspack.properties.HasProperties
getProperty

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

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

- Constructor Detail
  - MFreeElement3d
```
public MFreeElement3d(MFreeShapeFunction fun,
                      FemNode3d[] nodes)
```
- Method Detail
  - setShapeFunction
```
public void setShapeFunction(MFreeShapeFunction f)
```
  - getShapeFunction
```
public MFreeShapeFunction getShapeFunction()
```
  - isInside
```
public boolean isInside(Point3d pnt)
```
    Description copied from class: FemElement3d
    
    Tests whether or not a point is inside an element.
    
    Overrides:
    
    isInside in class FemElement3d
    
    Parameters:
    
    pnt - point to check if is inside
    
    Returns:
    
    true if point is inside the element
  - isInvertedAtRest
```
public boolean isInvertedAtRest()
```
    Description copied from class: FemElement3d
    
    Returns true if the rest position for this element results in a negative Jacobian determinant for at least one integration point. This method should be used sparingly since it is computes this result from scratch.
    
    Overrides:
    
    isInvertedAtRest in class FemElement3d
    
    Returns:
    
    true if the rest position is inverted.
  - numIntegrationPoints
```
public int numIntegrationPoints()
```
    Specified by:
    
    numIntegrationPoints in class FemElement3d
  - getIntegrationPoints
```
public MFreeIntegrationPoint3d[] getIntegrationPoints()
```
    Specified by:
    
    getIntegrationPoints in class FemElement3d
  - getIntegrationPoint
```
public MFreeIntegrationPoint3d getIntegrationPoint(int idx)
```
  - getIntegrationPointIndex
```
public int getIntegrationPointIndex(IntegrationPoint3d pnt)
```
  - getIntegrationData
```
public IntegrationData3d[] getIntegrationData()
```
    Overrides:
    
    getIntegrationData in class FemElement3d
  - getIntegrationData
```
public IntegrationData3d getIntegrationData(int idx)
```
  - clearState
```
public void clearState()
```
    Overrides:
    
    clearState in class FemElement3d
  - updateAllVolumes
```
public void updateAllVolumes()
```
  - addIntegrationPoint
```
public void addIntegrationPoint(MFreeIntegrationPoint3d ipnt,
                                IntegrationData3d idata,
                                double iwgt,
                                boolean updateVolumes)
```
  - setIntegrationData
```
public void setIntegrationData(java.util.ArrayList<IntegrationData3d> data)
```
  - setIntegrationPoints
```
public void setIntegrationPoints(java.util.ArrayList<MFreeIntegrationPoint3d> points,
                                 java.util.ArrayList<IntegrationData3d> data)
```
  - setIntegrationPoints
```
public void setIntegrationPoints(MFreeIntegrationPoint3d[] points,
                                 IntegrationData3d[] data)
```
  - setIntegrationPoints
```
public void setIntegrationPoints(java.util.ArrayList<MFreeIntegrationPoint3d> points)
```
  - setWarpingPoint
```
public void setWarpingPoint(MFreeIntegrationPoint3d warp)
```
  - getWarpingPoint
```
public MFreeIntegrationPoint3d getWarpingPoint()
```
    Specified by:
    
    getWarpingPoint in class FemElement3d
  - setWarpingPoint
```
public void setWarpingPoint(MFreeIntegrationPoint3d warp,
                            IntegrationData3d data)
```
  - setWarpingPointData
```
public void setWarpingPointData(IntegrationData3d data)
```
  - computeCentroid
```
public void computeCentroid(Vector3d centroid)
```
    Description copied from interface: Boundable
    
    Computed the centroid of this element.
    
    Specified by:
    
    computeCentroid in interface Boundable
    
    Overrides:
    
    computeCentroid in class FemElement3d
    
    Parameters:
    
    centroid - returns the computed centroid value.
  - integrationPointsInterpolateToNodes
```
public boolean integrationPointsInterpolateToNodes()
```
    Description copied from class: FemElement
    
    Queries whether there is an interpolation 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:
    
    integrationPointsInterpolateToNodes in class FemElement
    
    Returns:
    
    true if there is an interpolation mapping between integration points and nodes
  - updateBounds
```
public void updateBounds(Vector3d min,
                         Vector3d max)
```
    Description copied from interface: IsRenderable
    
    Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.
    
    Specified by:
    
    updateBounds in interface Boundable
    
    Specified by:
    
    updateBounds in interface IsRenderable
    
    Overrides:
    
    updateBounds in class FemElement3d
    
    Parameters:
    
    min - minimum point
    
    max - maximum point
  - setRestVolume
```
public void setRestVolume(double vol)
```
  - setVolume
```
public void setVolume(double vol)
```
  - prerender
```
public void prerender(RenderList list)
```
    Description copied from interface: IsRenderable
    
    Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling
    list.addIfVisible (obj);
    for each of the objects in question.
    
    Specified by:
    
    prerender in interface IsRenderable
    
    Overrides:
    
    prerender in class FemElement
    
    Parameters:
    
    list - list of objects to be rendered
  - renderWidget
```
public void renderWidget(Renderer renderer,
                         RenderProps props,
                         int flags)
```
  - renderWidget
```
public void renderWidget(Renderer renderer,
                         double size,
                         RenderProps props,
                         int flags)
```
  - setBoundaryMesh
```
public void setBoundaryMesh(PolygonalMesh bmesh)
```
  - getBoundaryMesh
```
public PolygonalMesh getBoundaryMesh()
```
  - numPoints
```
public int numPoints()
```
    Description copied from interface: Boundable
    
    Returns the number of points associated with this element, if any, or zero otherwise. If the element has points, then it's spatial extent is assumed to be enclosed within their convex hull. At present, elements that do not have points cannot be enclosed within oriented bounding box (OBB) trees.
    
    Specified by:
    
    numPoints in interface Boundable
    
    Overrides:
    
    numPoints in class FemElement3d
    
    Returns:
    
    number of points associated with this element
  - getPoint
```
public Point3d getPoint(int idx)
```
    Description copied from interface: Boundable
    
    Returns the idx-th point associated with this element.
    
    Specified by:
    
    getPoint in interface Boundable
    
    Overrides:
    
    getPoint in class FemElement3d
    
    Parameters:
    
    idx - index of the point (must be on the range 0 to Boundable.numPoints()).
    
    Returns:
    
    idx-th point associated with this element. Must not be modified.
  - render
```
public void render(Renderer renderer,
                   RenderProps rprops,
                   int flags)
```
    Specified by:
    
    render in class FemElement
  - getNodalExtrapolationMatrix
```
public double[] getNodalExtrapolationMatrix()
```
    Specified by:
    
    getNodalExtrapolationMatrix in class FemElement3d
  - getNaturalCoordinates
```
public boolean getNaturalCoordinates(Point3d coords,
                                     Point3d pnt)
```
    Computes "natural" coordinates (i.e. shape-function coordinates) of a point in 3D world space
    
    Parameters:
    
    coords - initial guess, value is updated with final coordinate
    
    pnt - world point to determine coordinates of
    
    Returns:
    
    true if method is successful, if false may indicate that at iterative method failed to converge
  - coordsAreInside
```
public boolean coordsAreInside(Vector3d coords)
```
    Specified by:
    
    coordsAreInside in class FemElement3d
  - getNaturalCoordinates
```
public boolean getNaturalCoordinates(Point3d coords,
                                     Point3d pnt,
                                     VectorNd N)
```
  - getNaturalCoordinates
```
public int getNaturalCoordinates(Point3d coords,
                                 Point3d pnt,
                                 int maxIters,
                                 VectorNd N)
```
    Given point p, get its natural coordinates with respect to this element. Returns true if the algorithm converges, false if a maximum number of iterations is reached. Uses a modified Newton's method to solve the equations. The coords argument that returned the coordinates is used, on input, to supply an initial guess of the coordinates. Zero is generally a safe guess.
    
    Parameters:
    
    coords - Outputs the natural coordinates, and supplies (on input) an initial guess as to their position.
    
    pnt - A given point (in world coords)
    
    maxIters - Maximum number of Newton iterations
    
    N - Resulting shape functionvalues
    
    Returns:
    
    the number of iterations required for convergence, or -1 if the calculation did not converge.
  - getN
```
public double getN(int i,
                   Point3d coords)
```
  - getdNds
```
public void getdNds(Vector3d dNds,
                    int i,
                    Vector3d coords)
```
    Specified by:
    
    getdNds in class FemElement3d
  - getIntegrationCoords
```
public double[] getIntegrationCoords()
```
    Specified by:
    
    getIntegrationCoords in class FemElement3d
  - getN
```
public double getN(int i,
                   Vector3d coords)
```
    Specified by:
    
    getN in class FemElement3d
  - getEdgeIndices
```
public int[] getEdgeIndices()
```
    Specified by:
    
    getEdgeIndices in class FemElement3d
  - getFaceIndices
```
public int[] getFaceIndices()
```
    Specified by:
    
    getFaceIndices in class FemElement3d
  - getNodeCoords
```
public double[] getNodeCoords()
```
    Specified by:
    
    getNodeCoords in class FemElement3d
  - renderWidget
```
public void renderWidget(Renderer renderer,
                         double size,
                         RenderProps props)
```
    Specified by:
    
    renderWidget in class FemElement3d

Class MFreeElement3d

Nested Class Summary

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

Field Summary

Fields inherited from class artisynth.core.femmodels.FemElement3d

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.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 maspack.geometry.Boundable

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 maspack.util.Scannable

Constructor Detail

MFreeElement3d

Method Detail

setShapeFunction

getShapeFunction

isInside

isInvertedAtRest

numIntegrationPoints

getIntegrationPoints

getIntegrationPoint

getIntegrationPointIndex

getIntegrationData

getIntegrationData

clearState

updateAllVolumes

addIntegrationPoint

setIntegrationData

setIntegrationPoints

setIntegrationPoints

setIntegrationPoints

setWarpingPoint

getWarpingPoint

setWarpingPoint

setWarpingPointData

computeCentroid

integrationPointsInterpolateToNodes

updateBounds

setRestVolume

setVolume

prerender

renderWidget

renderWidget

setBoundaryMesh

getBoundaryMesh

numPoints

getPoint

render

getNodalExtrapolationMatrix

getNaturalCoordinates

coordsAreInside

getNaturalCoordinates

getNaturalCoordinates

getN

getdNds

getIntegrationCoords

getN

getEdgeIndices

getFaceIndices

getNodeCoords

renderWidget