jarmos.geometry.DisplacementField Class Reference

The displacement field is a logical solution field describing displacements of geometry nodes/vertices as a solution to the given problem. More...

Inheritance diagram for jarmos.geometry.DisplacementField:

Public Member Functions
	DisplacementField (FieldDescriptor f, int size)
	DisplacementField (FieldDescriptor f, float[][] xyz)
void	setDisplacement (int index, float x, float y, float z)
float	getMin ()
float	getMax ()
void	setDisplacement (int index, float x, float y)
float[]	getXDisplacements ()
float[]	getYDisplacements ()
float[]	getZDisplacements ()
int	getSize ()
	Returns the number of graphical elements (nodes/vertices or elements/faces) that this field contains information for. More...
boolean	isConstant ()
	Convenience method to determine if the solution field is constant in value. More...
VisualFeature[]	getVisualFeatures (ColorGenerator cg)
	Abstract method that returns all available visual features for a logical solution field. More...
Public Member Functions inherited from jarmos.LogicSolutionField
	LogicSolutionField (FieldDescriptor f)

Package Attributes
float	max

Additional Inherited Members
Public Attributes inherited from jarmos.LogicSolutionField
FieldDescriptor	descriptor

Detailed Description

The displacement field is a logical solution field describing displacements of geometry nodes/vertices as a solution to the given problem.

The displacement data is always kept in 3D, however, 2D displacements are realized using zero values for the third axis.

Author

Daniel Wirtz

Definition at line 16 of file DisplacementField.java.

Constructor & Destructor Documentation

jarmos.geometry.DisplacementField.DisplacementField	(	FieldDescriptor	f,
		int	size
	)

Definition at line 21 of file DisplacementField.java.

jarmos.geometry.DisplacementField.DisplacementField	(	FieldDescriptor	f,
		float	xyz[][]
	)

Definition at line 31 of file DisplacementField.java.

Member Function Documentation

float jarmos.geometry.DisplacementField.getMax

(

)

Definition at line 61 of file DisplacementField.java.

float jarmos.geometry.DisplacementField.getMin

(

)

Definition at line 57 of file DisplacementField.java.

int jarmos.geometry.DisplacementField.getSize ( )

virtual

Returns the number of graphical elements (nodes/vertices or elements/faces) that this field contains information for.

Returns

Implements jarmos.LogicSolutionField.

Definition at line 82 of file DisplacementField.java.

VisualFeature [] jarmos.geometry.DisplacementField.getVisualFeatures ( ColorGenerator  cg )

virtual

Abstract method that returns all available visual features for a logical solution field.

This may be real and complex parts for complex fields or single x,y,z displacements

Parameters

cg	A color generator to use

Returns

An array of VisualFeature instances

Implements jarmos.LogicSolutionField.

Definition at line 92 of file DisplacementField.java.

float [] jarmos.geometry.DisplacementField.getXDisplacements

(

)

Definition at line 69 of file DisplacementField.java.

float [] jarmos.geometry.DisplacementField.getYDisplacements

(

)

Definition at line 73 of file DisplacementField.java.

float [] jarmos.geometry.DisplacementField.getZDisplacements

(

)

Definition at line 77 of file DisplacementField.java.

boolean jarmos.geometry.DisplacementField.isConstant ( )

virtual

Convenience method to determine if the solution field is constant in value.

If this is the case, the default field colors are used for display.

See Also

visual.VisualizationData::computeVisualFeatures

Returns

True if the field data is constant

Implements jarmos.LogicSolutionField.

Definition at line 87 of file DisplacementField.java.

void jarmos.geometry.DisplacementField.setDisplacement	(	int	index,
		float	x,
		float	y,
		float	z
	)

Definition at line 39 of file DisplacementField.java.

void jarmos.geometry.DisplacementField.setDisplacement	(	int	index,
		float	x,
		float	y
	)

Definition at line 65 of file DisplacementField.java.

Member Data Documentation

float jarmos.geometry.DisplacementField.max

package

Definition at line 19 of file DisplacementField.java.

---

The documentation for this class was generated from the following file:

• JaRMoSBase/src/jarmos/geometry/DisplacementField.java