org.keridwen.modelling.mesh.inspector.interfaces
Interface MeshAnalyserInterface

All Superinterfaces:

Comparable

All Known Implementing Classes:

BorderCellLocator, CellVolumeAnalyser, EtaQualityAnalyser, MeshAnalyser, RhoQualityAnalyser

public interface MeshAnalyserInterface
extends Comparable

Generic interface of mesh analyser. This defines a common for all analysis algorithms or procedures to explore or validate the mesh as used in the JFreeMeshInspector. All analysers should implement this interface. All analysers return their results into a generic analysis object.

Author:

J.Forest, Artenum SARL

Method Summary

Object	analyseAndBuildVtkDataSet() Call the analyseMesh method and return a vtkDataSet with the selected sub-set of the mesh and/or the quality factor mapped on it as a scalar value.
GenericAnalysis	analyseMesh() Perform the analysis of the mesh.
GenericAnalysis	getAnalysis() Return the current result of the analysis.
HashMap	getOutputParameters()
void	printAnalysis() Print the result of the current analysis in the default console.
GenericAnalysis	probeCell(int meshId) Probe (i.e analyse) a cell specified by its Id.
void	setAnalysis(GenericAnalysis analysis) If the default analysis (i.e generated by default by the constructor) is not used, set the analysis to be filled by the analyser.
void	setInputParameters(HashMap inputParameters) Set the control input parameter for the analyser.
void	setMesh(com.artenum.penelope.mesh.interfaces.Mesh mesh) Set the mesh to be analysed.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setMesh

void setMesh(com.artenum.penelope.mesh.interfaces.Mesh mesh)

Set the mesh to be analysed.

Parameters:

mesh -

analyseMesh

GenericAnalysis analyseMesh()

Perform the analysis of the mesh.
Remark: Depending on the concrete implementation this method can be long and/or CPU/memory consuming.

Returns:

This method should return the result of the analysis under an object implementing the GenericAnalysis interface.

getAnalysis

GenericAnalysis getAnalysis()

Return the current result of the analysis. This method do not call the analyseMesh method and the analysis may not be computed and/or up-to-date. To update the analysis call the analyseMesh method before.

Returns:

Analysis object implementing the GenericAnalysis interface.

printAnalysis

void printAnalysis()

Print the result of the current analysis in the default console. Remark: This method is not implemented and/or operational in all concrete implementations classes.

analyseAndBuildVtkDataSet

Object analyseAndBuildVtkDataSet()

Call the analyseMesh method and return a vtkDataSet with the selected sub-set of the mesh and/or the quality factor mapped on it as a scalar value.

Returns:

a vtkDataSet of the analysed mesh with the quality factor.

setInputParameters

void setInputParameters(HashMap inputParameters)

Set the control input parameter for the analyser. May depend on the concrete implementation.

Parameters:

inputParameters -

getOutputParameters

HashMap getOutputParameters()

Returns:

the control parameters of the analyser.

probeCell

GenericAnalysis probeCell(int meshId)

Probe (i.e analyse) a cell specified by its Id.

Parameters:

meshId - of the cell.

Returns:

the quality factor.

setAnalysis

void setAnalysis(GenericAnalysis analysis)

If the default analysis (i.e generated by default by the constructor) is not used, set the analysis to be filled by the analyser.

Parameters:

analysis -