JaRMoS  1.1
Java Reduced Model Simulations
 All Classes Namespaces Files Functions Variables Enumerator Groups Pages
jarmos.DefaultSolutionField Class Reference

The default solution field containing an array of real values. More...

Inheritance diagram for jarmos.DefaultSolutionField:
jarmos.LogicSolutionField

Public Member Functions

int getSize ()
 Returns the number of graphical elements (nodes/vertices or elements/faces) that this field contains information for. More...
 
 DefaultSolutionField (FieldDescriptor f, int size)
 
 DefaultSolutionField (FieldDescriptor f, float[] values)
 Compatibility constructor. More...
 
void setValue (int index, float value)
 
float getMax ()
 
float getMin ()
 
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)
 

Static Public Member Functions

static LogicSolutionField getZeroField (int size, FieldMapping mapping)
 

Package Attributes

float max
 

Additional Inherited Members

- Public Attributes inherited from jarmos.LogicSolutionField
FieldDescriptor descriptor
 

Detailed Description

The default solution field containing an array of real values.

Also provides a convenience static member to obtain a zero solution field.

Author
Daniel Wirtz

Definition at line 14 of file DefaultSolutionField.java.

Constructor & Destructor Documentation

jarmos.DefaultSolutionField.DefaultSolutionField ( FieldDescriptor  f,
int  size 
)

Definition at line 31 of file DefaultSolutionField.java.

jarmos.DefaultSolutionField.DefaultSolutionField ( FieldDescriptor  f,
float[]  values 
)

Compatibility constructor.

Takes a float array and performs insertions for all values.

Parameters
values

Definition at line 43 of file DefaultSolutionField.java.

Member Function Documentation

float jarmos.DefaultSolutionField.getMax ( )

Definition at line 58 of file DefaultSolutionField.java.

float jarmos.DefaultSolutionField.getMin ( )

Definition at line 62 of file DefaultSolutionField.java.

int jarmos.DefaultSolutionField.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 25 of file DefaultSolutionField.java.

VisualFeature [] jarmos.DefaultSolutionField.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
cgA color generator to use
Returns
An array of VisualFeature instances

Implements jarmos.LogicSolutionField.

Definition at line 71 of file DefaultSolutionField.java.

static LogicSolutionField jarmos.DefaultSolutionField.getZeroField ( int  size,
FieldMapping  mapping 
)
static

Definition at line 16 of file DefaultSolutionField.java.

boolean jarmos.DefaultSolutionField.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 66 of file DefaultSolutionField.java.

void jarmos.DefaultSolutionField.setValue ( int  index,
float  value 
)

Definition at line 50 of file DefaultSolutionField.java.

Member Data Documentation

float jarmos.DefaultSolutionField.max
package

Definition at line 29 of file DefaultSolutionField.java.


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