PointFem3dAttachment (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.mechmodels.DynamicAttachment
  - - artisynth.core.mechmodels.PointAttachment
    - - artisynth.core.femmodels.PointFem3dAttachment

All Implemented Interfaces:

CopyableComponent, ModelComponent, java.lang.Cloneable, HasProperties, HierarchyNode, Scannable
```
public class PointFem3dAttachment
extends PointAttachment
```

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

Field Summary
- Fields inherited from class artisynth.core.modelbase.ModelComponentBase
  enforceUniqueCompositeNames, enforceUniqueNames, myNumber, myProps, NULL_OBJ, useCompactPathNames
- Fields inherited from interface artisynth.core.modelbase.CopyableComponent
  COPY_REFERENCES

Constructor Summary

Constructors
Constructor and Description
`PointFem3dAttachment()`
`PointFem3dAttachment(Point pnt)`
`PointFem3dAttachment(Point pnt, FemModel3d fem)`
`PointFem3dAttachment(Point pnt, FemNode[] nodes, double[] coords)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMassToMaster(MatrixBlock mblk, MatrixBlock sblk, int idx)`
`void`	`addMassToMasters()`
`int`	`addTargetJacobian(SparseBlockMatrix J, int bi)`
`void`	`applyForces()`
`void`	`computeNodeCoordinates()`
`PointFem3dAttachment`	`copy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap)` Create a copy of this component.
`static PointFem3dAttachment`	`create(Point pnt, FemElement3d elem, Point3d loc, double reduceTol)` Create an attachment that connects a point to a FemElement within a specified element.
`double`	`getCoordinate(int idx)`
`VectorNd`	`getCoordinates()`
`void`	`getCurrentPos(Vector3d pos)` Returns the current position of the attached point, in world coordinates.
`void`	`getCurrentVel(Vector3d vel, Vector3d dvel)`
`boolean`	`getDerivative(double[] buf, int idx)`
`FemElement`	`getElement()`
`void`	`getHardReferences(java.util.List<ModelComponent> refs)` Appends all hard references for this component to a list.
`FemNode[]`	`getNodes()`
`void`	`getRestPosition(Point3d pos)`
`void`	`mulSubG(MatrixBlock D, MatrixBlock B, int idx)` Computes
`void`	`mulSubGT(double[] ybuf, int yoff, double[] xbuf, int xoff, int idx)` Computes
`void`	`mulSubGT(MatrixBlock D, MatrixBlock B, int idx)` Computes
`boolean`	`setFromElement(Point3d pos, FemElement elem)`
`boolean`	`setFromElement(Point3d pos, FemElement elem, double reduceTol)`
`void`	`setFromFem(Point3d pos, FemModel3d fem)`
`boolean`	`setFromFem(Point3d pos, FemModel3d fem, boolean project)`
`void`	`setFromNodes(java.util.Collection<? extends FemNode> nodes, VectorNd weights)`
`void`	`setFromNodes(FemNode[] nodes, double[] weights)`
`boolean`	`setFromNodes(Point3d pos, java.util.Collection<? extends FemNode> nodes)`
`boolean`	`setFromNodes(Point3d pos, FemNode[] nodes)`
`void`	`updateAttachment()` Update attachment to reflect changes in the slave state.
`void`	`updatePosStates()`
`void`	`updateVelStates()`
`void`	`writeItems(java.io.PrintWriter pw, NumberFormat fmt, CompositeComponent ancestor)`

Methods inherited from class artisynth.core.mechmodels.PointAttachment
getCopyReferences, getMasterBlocks, getMasters, getPoint, getSlave, getSlaveSolveIndex, invalidateMasters, isDuplicatable, numMasters

Methods inherited from class artisynth.core.mechmodels.DynamicAttachment
addAttachmentJacobian, addBackRefs, addSolveBlocks, clone, connectToHierarchy, containsLoop, containsLoops, containsMaster, createOrderedList, disconnectFromHierarchy, oneMasterActive, reduceConstraints, reduceMass, reduceRowMatrix, removeBackRefs

Methods inherited from class artisynth.core.modelbase.ModelComponentBase
checkFlag, checkName, checkNameUniqueness, clearFlag, createTempFlag, getAllPropertyInfo, 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 artisynth.core.modelbase.ModelComponent
connectToHierarchy, disconnectFromHierarchy, 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
getAllPropertyInfo, getProperty

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

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

- Constructor Detail
  - PointFem3dAttachment
```
public PointFem3dAttachment()
```
  - PointFem3dAttachment
```
public PointFem3dAttachment(Point pnt)
```
  - PointFem3dAttachment
```
public PointFem3dAttachment(Point pnt,
                            FemModel3d fem)
```
  - PointFem3dAttachment
```
public PointFem3dAttachment(Point pnt,
                            FemNode[] nodes,
                            double[] coords)
```
- Method Detail
  - getElement
```
public FemElement getElement()
```
  - setFromNodes
```
public void setFromNodes(java.util.Collection<? extends FemNode> nodes,
                         VectorNd weights)
```
  - setFromNodes
```
public boolean setFromNodes(Point3d pos,
                            java.util.Collection<? extends FemNode> nodes)
```
  - setFromNodes
```
public void setFromNodes(FemNode[] nodes,
                         double[] weights)
```
  - setFromNodes
```
public boolean setFromNodes(Point3d pos,
                            FemNode[] nodes)
```
  - setFromElement
```
public boolean setFromElement(Point3d pos,
                              FemElement elem)
```
  - setFromElement
```
public boolean setFromElement(Point3d pos,
                              FemElement elem,
                              double reduceTol)
```
  - setFromFem
```
public void setFromFem(Point3d pos,
                       FemModel3d fem)
```
  - setFromFem
```
public boolean setFromFem(Point3d pos,
                          FemModel3d fem,
                          boolean project)
```
  - getCoordinates
```
public VectorNd getCoordinates()
```
  - getCoordinate
```
public double getCoordinate(int idx)
```
  - updatePosStates
```
public void updatePosStates()
```
    Specified by:
    
    updatePosStates in class DynamicAttachment
  - getCurrentPos
```
public void getCurrentPos(Vector3d pos)
```
    Description copied from class: PointAttachment
    
    Returns the current position of the attached point, in world coordinates.
    
    Specified by:
    
    getCurrentPos in class PointAttachment
    
    Parameters:
    
    pos - used to return current point position
  - getCurrentVel
```
public void getCurrentVel(Vector3d vel,
                          Vector3d dvel)
```
  - updateVelStates
```
public void updateVelStates()
```
    Specified by:
    
    updateVelStates in class DynamicAttachment
  - updateAttachment
```
public void updateAttachment()
```
    Update attachment to reflect changes in the slave state.
    
    Specified by:
    
    updateAttachment in class DynamicAttachment
  - applyForces
```
public void applyForces()
```
    Overrides:
    
    applyForces in class PointAttachment
  - getRestPosition
```
public void getRestPosition(Point3d pos)
```
  - mulSubGT
```
public void mulSubGT(MatrixBlock D,
                     MatrixBlock B,
                     int idx)
```
    Description copied from class: DynamicAttachment
    Computes
```
       T
 D -= G  B
 
```
    where D and B are matrices associated with master and slave components, respectively, and G is the constraint matrix for the attachment.
    Parameters:
    
    D - dependent matrix associated with a master component
    
    B - matrix associated with a slave component
  - mulSubG
```
public void mulSubG(MatrixBlock D,
                    MatrixBlock B,
                    int idx)
```
    Description copied from class: DynamicAttachment
    Computes
```
 D -= B G
 
```
    where D and B are matrices associated with master and slave components, respectively, and G is the constraint matrix for the attachment.
    Parameters:
    
    D - dependent matrix associated with a master component
    
    B - matrix associated with a slave component
  - mulSubGT
```
public void mulSubGT(double[] ybuf,
                     int yoff,
                     double[] xbuf,
                     int xoff,
                     int idx)
```
    Description copied from class: DynamicAttachment
    Computes
```
       T
 y -= G  x
 
```
    where y and x are vectors associated with master and slave components, respectively, and G is the constraint matrix for the attachment.
    Parameters:
    
    ybuf - buffer into which to store result
    
    yoff - offset into ybuf
    
    xbuf - buffer containing right hand side vector
    
    xoff - offset into xbuf
    
    idx - master component index
  - writeItems
```
public void writeItems(java.io.PrintWriter pw,
                       NumberFormat fmt,
                       CompositeComponent ancestor)
                throws java.io.IOException
```
    Overrides:
    
    writeItems in class PointAttachment
    
    Throws:
    
    java.io.IOException
  - addTargetJacobian
```
public int addTargetJacobian(SparseBlockMatrix J,
                             int bi)
```
    Overrides:
    
    addTargetJacobian in class PointAttachment
  - computeNodeCoordinates
```
public void computeNodeCoordinates()
```
  - create
```
public static PointFem3dAttachment create(Point pnt,
                                          FemElement3d elem,
                                          Point3d loc,
                                          double reduceTol)
```
    Create an attachment that connects a point to a FemElement within a specified element.
    
    Parameters:
    
    pnt - Point to be attached
    
    elem - FemElement3d to attach the point to
    
    loc - point location with respect to the element. If null, will be assumed to be pnt.getPosition().
    
    reduceTol - try to reduce the number of attached nodes by removing those whose coordinate values are less then this number. A value of zero ensures no reduction. If reduction is desired, a value around 1e-5 is reasonable.
    
    Returns:
    
    an attachment for
  - addMassToMasters
```
public void addMassToMasters()
```
    Specified by:
    
    addMassToMasters in class DynamicAttachment
  - addMassToMaster
```
public void addMassToMaster(MatrixBlock mblk,
                            MatrixBlock sblk,
                            int idx)
```
  - getDerivative
```
public boolean getDerivative(double[] buf,
                             int idx)
```
    Specified by:
    
    getDerivative in class DynamicAttachment
  - getNodes
```
public FemNode[] getNodes()
```
  - getHardReferences
```
public void getHardReferences(java.util.List<ModelComponent> refs)
```
    Description copied from class: ModelComponentBase
    
    Appends all hard references for this component to a list. References are other components, outside of this component's immediate ancestry, on which this component depends. For example, an AxialSpring refers to two Point components as for it's end points. A hard reference is one which the referring component must have, and which if deleted, implies that the referring component should be deleted too.
    
    Specified by:
    
    getHardReferences in interface ModelComponent
    
    Overrides:
    
    getHardReferences in class DynamicAttachment
    
    Parameters:
    
    refs - list to which hard references are appended
  - copy
```
public PointFem3dAttachment 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 PointAttachment
    
    Parameters:
    
    flags - flags to control the copying
    
    copyMap - map to possible existing instances of referenced components
    
    Returns:
    
    copy of this component

Class PointFem3dAttachment

Nested Class Summary

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

Field Summary

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface artisynth.core.modelbase.CopyableComponent

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.mechmodels.PointAttachment

Methods inherited from class artisynth.core.mechmodels.DynamicAttachment

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

Constructor Detail

PointFem3dAttachment

PointFem3dAttachment

PointFem3dAttachment

PointFem3dAttachment

Method Detail

getElement

setFromNodes

setFromNodes

setFromNodes

setFromNodes

setFromElement

setFromElement

setFromFem

setFromFem

getCoordinates

getCoordinate

updatePosStates

getCurrentPos

getCurrentVel

updateVelStates

updateAttachment

applyForces

getRestPosition

mulSubGT

mulSubG

mulSubGT

writeItems

addTargetJacobian

computeNodeCoordinates

create

addMassToMasters

addMassToMaster

getDerivative

getNodes

getHardReferences

copy