artisynth.core.fields

Class ScalarNodalField

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.fields.FemFieldComp

artisynth.core.fields.ScalarFemField

artisynth.core.fields.ScalarNodalField

All Implemented Interfaces:

FieldComponent, ModelComponent, PostScannable, RenderableComponent, ScalarFieldComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

public class ScalarNodalField
extends ScalarFemField

A scalar field defined over an FEM model, using values set at the nodes. Values at other points are obtained by nodal interpolation on the elements nearest to those points. Values at nodes for which no explicit value has been set are given by the field's default value.

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.fields.ScalarFemField

ScalarFemField.Visualization

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

ModelComponent.NavpanelVisibility

Field Summary

Fields inherited from class artisynth.core.fields.ScalarFemField

DEFAULT_COLOR_INTERPOLATION, DEFAULT_VISUALIZATION, myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
ScalarNodalField() This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.
ScalarNodalField(FemModel3d fem) Constructs a field for a given FEM model, with a default value of 0.
ScalarNodalField(FemModel3d fem, double defaultValue) Constructs a field for a given FEM model and default value.
ScalarNodalField(java.lang.String name, FemModel3d fem) Constructs a named field for a given FEM model, with a default value of 0.
ScalarNodalField(java.lang.String name, FemModel3d fem, double defaultValue) Constructs a named field for a given FEM model and default value.

Method Summary

Modifier and Type	Method and Description
void	clearAllValues() Clear all values defined for the features (e.g., nodes, elements) associated with this field.
void	clearCacheIfNecessary() Used internally by the system to clear cached values for subclasses that support value caching.
void	clearValue(FemNode3d node) Clears the value at a given node.
boolean	equals(ScalarNodalField field) Returns true if this field is functionally equal to another field.
void	getSoftReferences(java.util.List<ModelComponent> refs) Appends all soft references for this component to a list.
double	getValue(FemFieldPoint fp) Returns the value of the this field at a specified FEM field point.
double	getValue(FemNode3d node) Returns the value at a node.
double	getValue(int nodeNum) Returns the value at the node specified by the given number.
double	getValue(int[] nodeNums, double[] weights)
double	getValue(Point3d pos) Returns the value of the this field at a specified spatial position.
Range	getVisualizationRange()
boolean	isValueSet(FemNode3d node) Queries whether a value has been seen at a given node.
void	postscan(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor) Performs any required post-scanning for this component.
void	setValue(FemNode3d node, double value) Sets the value at a node.
void	updateReferences(boolean undo, java.util.Deque<java.lang.Object> undoInfo) May be called by the system if any of the soft references for this component are removed from the the component hierarchy.

Methods inherited from class artisynth.core.fields.ScalarFemField

addRenderMeshComp, clearRenderMeshComps, createDefaultRenderProps, createRenderProps, equals, getAllPropertyInfo, getColorInterpolation, getColorMap, getDefaultValue, getRenderMeshComp, getRenderRange, getSelection, getValue, getValueRange, getVisualization, numRenderMeshComps, numSelectionQueriesNeeded, prerender, removeRenderMeshComp, render, setColorInterpolation, setColorMap, setDefaultValue, setRenderRange, setVisualization

Methods inherited from class artisynth.core.fields.FemFieldComp

equals, getFemModel, getRenderHints, getRenderProps, isSelectable, setRenderProps, updateBounds

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, copy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface maspack.render.IsSelectable

isSelectable

Methods inherited from interface maspack.render.IsRenderable

getRenderHints, updateBounds

Methods inherited from interface maspack.render.HasRenderProps

getRenderProps, setRenderProps

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable

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

ScalarNodalField

public ScalarNodalField()

This constructor should not be called by applications, unless ModelComponentBase.scan(maspack.util.ReaderTokenizer, java.lang.Object) is called immediately after.

ScalarNodalField

public ScalarNodalField(FemModel3d fem)

Constructs a field for a given FEM model, with a default value of 0.

Parameters:

fem - FEM model over which the field is defined

ScalarNodalField

public ScalarNodalField(FemModel3d fem,
                        double defaultValue)

Constructs a field for a given FEM model and default value.

Parameters:

fem - FEM model over which the field is defined

defaultValue - default value for nodes which don't have explicitly set values

ScalarNodalField

public ScalarNodalField(java.lang.String name,
                        FemModel3d fem)

Constructs a named field for a given FEM model, with a default value of 0.

Parameters:

name - name of the field

fem - FEM model over which the field is defined

ScalarNodalField

public ScalarNodalField(java.lang.String name,
                        FemModel3d fem,
                        double defaultValue)

Constructs a named field for a given FEM model and default value.

Parameters:

name - name of the field

fem - FEM model over which the field is defined

defaultValue - default value for nodes which don't have explicitly set values

Method Detail

getVisualizationRange

public Range getVisualizationRange()

Overrides:

getVisualizationRange in class ScalarFemField

getValue

public double getValue(int nodeNum)

Returns the value at the node specified by the given number. The default value is returned if a value has not been explicitly set for that node. Node numbers are used instead of indices as they are more persistent if the FEM model is modified.

Parameters:

nodeNum - node number

Returns:

value at the node

getValue

public double getValue(FemNode3d node)

Returns the value at a node. The default value is returned if a value has not been explicitly set for that node.

Parameters:

node - node for which the value is requested

Returns:

value at the node

getValue

public double getValue(FemFieldPoint fp)

Returns the value of the this field at a specified FEM field point.

Parameters:

fp - point at which value is requested

Returns:

value at the point

getValue

public double getValue(Point3d pos)

Returns the value of the this field at a specified spatial position.

Specified by:

getValue in interface ScalarFieldComponent

Specified by:

getValue in class ScalarFemField

Parameters:

pos - position at which value is requested

Returns:

value at the position

setValue

public void setValue(FemNode3d node,
                     double value)

Sets the value at a node.

Parameters:

node - node for which the value is to be set

value - new value for the node

isValueSet

public boolean isValueSet(FemNode3d node)

Queries whether a value has been seen at a given node.

Parameters:

node - node being queried

Returns:

true if a value has been set at the node

clearValue

public void clearValue(FemNode3d node)

Clears the value at a given node. After this call, the node will be associated with the default value.

Parameters:

node - node whose value is to be cleared

clearAllValues

public void clearAllValues()

Clear all values defined for the features (e.g., nodes, elements) associated with this field. After this call, the field will have a uniform value defined by its defaultValue.

Specified by:

clearAllValues in class ScalarFemField

getValue

public double getValue(int[] nodeNums,
                       double[] weights)

postscan

public void postscan(java.util.Deque<ScanToken> tokens,
                     CompositeComponent ancestor)
              throws java.io.IOException

Performs any required post-scanning for this component. This involves handling any information whose processing was deferred during the scan() method and stored in the token queue. The most common use of this method is to resolve the paths of component references, which may not have been created at the time of the initial scan() call.

Specified by:

postscan in interface PostScannable

Overrides:

postscan in class ModelComponentBase

Parameters:

tokens - token information that was stored during scan().

ancestor - ancestor component with respect to which reference component paths are defined.

Throws:

java.io.IOException - if an error is encountered (such as a reference to a non-existent component)

getSoftReferences

public void getSoftReferences(java.util.List<ModelComponent> refs)

Appends all soft 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 ExcitationComponent may refer to one or more other ExcitationComponents to act as excitation sources. A soft reference is one which can be removed from the referring component. In particular, if any soft references for a component are deleted, then that component's updateReferences() method will be called to update its internal reference information.

Specified by:

getSoftReferences in interface ModelComponent

Overrides:

getSoftReferences in class ScalarFemField

Parameters:

refs - list to which soft references are appended

updateReferences

public void updateReferences(boolean undo,
                             java.util.Deque<java.lang.Object> undoInfo)

May be called by the system if any of the soft references for this component are removed from the the component hierarchy. If called with undo equal to false, this component should then examine its soft references and use ComponentUtils.areConnected() to determine which of them have been disconnected from the hierarchy. Disconnected references should be removed, and sufficient information should be appended to undoInfo to allow this update to be undone if this method is called later with undo equal to true. When undoing an update, the undo information should be removed from the front of undoInfo.

Specified by:

updateReferences in interface ModelComponent

Overrides:

updateReferences in class ScalarFemField

Parameters:

undo - if true, indicates that the most recent reference update should be undone, using the supplied undo information.

undoInfo - if undo is false, should be used to store information allowing the reference update to be undone. Otherwise, if undo is true, then this supplied information to undo the most recent update.

clearCacheIfNecessary

public void clearCacheIfNecessary()

Used internally by the system to clear cached values for subclasses that support value caching.

Specified by:

clearCacheIfNecessary in interface FieldComponent

Overrides:

clearCacheIfNecessary in class FemFieldComp

equals

public boolean equals(ScalarNodalField field)

Returns true if this field is functionally equal to another field. Intended mainly for testing and debugging.