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

Represents a logical solution field of a simulation. More...

Inheritance diagram for jarmos.LogicSolutionField:
jarmos.ComplexSolutionField jarmos.DefaultSolutionField jarmos.geometry.DisplacementField

Public Member Functions

abstract int getSize ()
 Returns the number of graphical elements (nodes/vertices or elements/faces) that this field contains information for. More...
 
abstract boolean isConstant ()
 Convenience method to determine if the solution field is constant in value. More...
 
 LogicSolutionField (FieldDescriptor f)
 
abstract VisualFeature[] getVisualFeatures (ColorGenerator cg)
 Abstract method that returns all available visual features for a logical solution field. More...
 

Public Attributes

FieldDescriptor descriptor
 

Detailed Description

Represents a logical solution field of a simulation.

In difference to the DoF fields (plain float/double arrays) these solution fields have their own structure to represent different behavior. Examples are ComplexSolutionFields, which involve two DoF fields for real and imaginary DoFs, or displacements fields which contain x,y (and z) DoF fields.

This class is a base class containing a FieldDescriptor instance providing solution field information. The data storage is totally left to the subclasses, however, access to any desired visual.VisualFeature is enabled via the getVisualFeatures method.

For examples refer to the subclasses.

Author
Daniel Wirtz

Definition at line 23 of file LogicSolutionField.java.

Constructor & Destructor Documentation

jarmos.LogicSolutionField.LogicSolutionField ( FieldDescriptor  f)

Definition at line 45 of file LogicSolutionField.java.

Member Function Documentation

abstract int jarmos.LogicSolutionField.getSize ( )
pure virtual

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

Returns

Implemented in jarmos.geometry.DisplacementField, jarmos.DefaultSolutionField, and jarmos.ComplexSolutionField.

abstract VisualFeature [] jarmos.LogicSolutionField.getVisualFeatures ( ColorGenerator  cg)
pure 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

Implemented in jarmos.ComplexSolutionField, jarmos.geometry.DisplacementField, and jarmos.DefaultSolutionField.

abstract boolean jarmos.LogicSolutionField.isConstant ( )
pure 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

Implemented in jarmos.geometry.DisplacementField, jarmos.DefaultSolutionField, and jarmos.ComplexSolutionField.

Member Data Documentation

FieldDescriptor jarmos.LogicSolutionField.descriptor

Definition at line 25 of file LogicSolutionField.java.


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