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

A solution field with complex values. More...

Inheritance diagram for jarmos.ComplexSolutionField:
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...
 
boolean isConstant ()
 Convenience method to determine if the solution field is constant in value. More...
 
 ComplexSolutionField (FieldDescriptor f, int size)
 
void setComplexValue (int index, Complex value)
 
void addComplexValue (int index, Complex value)
 
void addComplexValue (int index, float r, float i)
 
void setComplexValue (int index, float r, float i)
 
float[][] getComplexValues ()
 Returns an two times field size-dimensional float array. More...
 
float[] getRealDoFs ()
 
float[] getImaginaryDoFs ()
 
float[] getNorms ()
 Returns the norms of each entry. More...
 
float getMaxRe ()
 
float getMinRe ()
 
float getMaxIm ()
 
float getMinIm ()
 
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 rmax
 
float imin
 
float imax
 

Additional Inherited Members

- Public Attributes inherited from jarmos.LogicSolutionField
FieldDescriptor descriptor
 

Detailed Description

A solution field with complex values.

Author
Daniel Wirtz
Date
2013-08-06

Definition at line 14 of file ComplexSolutionField.java.

Constructor & Destructor Documentation

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

Definition at line 29 of file ComplexSolutionField.java.

Member Function Documentation

void jarmos.ComplexSolutionField.addComplexValue ( int  index,
Complex  value 
)

Definition at line 42 of file ComplexSolutionField.java.

void jarmos.ComplexSolutionField.addComplexValue ( int  index,
float  r,
float  i 
)

Definition at line 46 of file ComplexSolutionField.java.

float [][] jarmos.ComplexSolutionField.getComplexValues ( )

Returns an two times field size-dimensional float array.

Returns

Definition at line 73 of file ComplexSolutionField.java.

float [] jarmos.ComplexSolutionField.getImaginaryDoFs ( )

Definition at line 81 of file ComplexSolutionField.java.

float jarmos.ComplexSolutionField.getMaxIm ( )

Definition at line 104 of file ComplexSolutionField.java.

float jarmos.ComplexSolutionField.getMaxRe ( )

Definition at line 96 of file ComplexSolutionField.java.

float jarmos.ComplexSolutionField.getMinIm ( )

Definition at line 108 of file ComplexSolutionField.java.

float jarmos.ComplexSolutionField.getMinRe ( )

Definition at line 100 of file ComplexSolutionField.java.

float [] jarmos.ComplexSolutionField.getNorms ( )

Returns the norms of each entry.

For complex solution fields only, returns null for real types.

Returns
array of complex value norms

Definition at line 92 of file ComplexSolutionField.java.

float [] jarmos.ComplexSolutionField.getRealDoFs ( )

Definition at line 77 of file ComplexSolutionField.java.

int jarmos.ComplexSolutionField.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 21 of file ComplexSolutionField.java.

VisualFeature [] jarmos.ComplexSolutionField.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 113 of file ComplexSolutionField.java.

boolean jarmos.ComplexSolutionField.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 25 of file ComplexSolutionField.java.

void jarmos.ComplexSolutionField.setComplexValue ( int  index,
Complex  value 
)

Definition at line 38 of file ComplexSolutionField.java.

void jarmos.ComplexSolutionField.setComplexValue ( int  index,
float  r,
float  i 
)

Definition at line 50 of file ComplexSolutionField.java.

Member Data Documentation

float jarmos.ComplexSolutionField.imax
package

Definition at line 19 of file ComplexSolutionField.java.

float jarmos.ComplexSolutionField.imin
package

Definition at line 19 of file ComplexSolutionField.java.

float jarmos.ComplexSolutionField.rmax
package

Definition at line 19 of file ComplexSolutionField.java.


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