Module simpa.core

Package simpa.core.api

Class SolutionChecker

java.lang.Object

simpa.core.api.SolutionChecker

public class SolutionChecker
extends Object

Class that can be used to evaluate the precision of the solution.

Constructor Summary

Constructors

Constructor	Description
SolutionChecker(String elementName, FieldType fieldType, LengthUnit lengthUnit)	Creates a new implementation for SolutionChecker.

Method Summary

Modifier and Type	Method	Description
double	getNormalizedRmsError(double scalingFactor)	Gets the normalized RMS (root mean square) error for the element using the given scaling factor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SolutionChecker

public SolutionChecker(String elementName,
 FieldType fieldType,
 LengthUnit lengthUnit)

Creates a new implementation for SolutionChecker.

Parameters:

elementName - name of the element.

fieldType - type of field.

lengthUnit - unit for length.

Method Details

getNormalizedRmsError

public double getNormalizedRmsError(double scalingFactor)
                             throws FileNotFoundException

Gets the normalized RMS (root mean square) error for the element using the given scaling factor.

Parameters:

scalingFactor - scaling factor.

Returns:

the normalized RMS error.

Throws:

FileNotFoundException - when the file is not found