genopt.algorithm

Class Parametric

java.lang.Object

genopt.algorithm.Optimizer

genopt.algorithm.Parametric

public class Parametric
extends Optimizer

Class for doing a parametric run where one parameter is perturbed at a time while the others are fixed. Linear and logarithmic spacing can be selected for each parameter independently.

This project was carried out at:

• Lawrence Berkeley National Laboratory (LBNL), Simulation Research Group,

and supported by

• the U.S. Department of Energy (DOE),
• the Swiss Academy of Engineering Sciences (SATW),
• the Swiss National Energy Fund (NEFF), and
• the Swiss National Science Foundation (SNSF)

GenOpt Copyright (c) 1998-2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

Version:

GenOpt(R) 3.1.1 (March 24, 2016)

Author:

Michael Wetter

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dimCon number of independent continuous variables
protected int	dimDis number of independent discrete variables
protected int	dimF number of function values
protected java.util.TreeMap<Point,java.lang.Double[]>	evaPoi list with evaluated points and its function values
protected boolean	stopAtError flag whether run should stop or proceed if a simulation error occurs

Fields inherited from class genopt.algorithm.Optimizer

done, EXCLUDING, FS, INCLUDING, LS, MAINITERATION, ORIGINAL, SUBITERATION, TRANSFORMED

Constructor Summary

Constructors

Constructor and Description
Parametric(GenOpt genOptData) Constructor

Method Summary

Modifier and Type	Method and Description
Point	getF(Point pt) Evaluates a simulation and reports result
int	run(Point x0) Runs the evaluation

Methods inherited from class genopt.algorithm.Optimizer

algorithmRequiresUsageOfStepNumber, appendToOutputListing, checkMaxIteration, checkObjectiveFunctionValue, ensureOnlyContinuousParameters, ensureOnlyDiscreteParameters, getAbsAccuracyFunction, getDimensionContinuous, getDimensionDiscrete, getDimensionF, getDimensionX, getDiscreteValueDouble0, getDx, getDx0, getF, getIndex0, getIndex0, getInputValueBoolean, getInputValueDouble, getInputValueDouble, getInputValueInteger, getInputValueInteger, getInputValueString, getInputValueString, getKindOfConstraint, getL, getLengthDiscrete, getMainIterationNumber, getMaximumThreadPoolSize, getMaxIterationNumber, getMinimumPoint, getMode, getObjectiveFunctionName, getOutputPath, getPointerToEqualPoints, getRelAccuracyFunction, getSimulationNumber, getStepNumber, getU, getVariableNameContinuous, getVariableNameDiscrete, getX0, getX0, goToEndOfCommandFile, increaseStepNumber, increaseStepNumber, isFeasible, isNextToken, maxIterationReached, mustStopOptimization, print, println, replace, report, reportCurrentLowestPoint, reportMinimum, resetStepNumber, roundCoordinates, run, setInfo, setMode, setNumberOfMatchingResults, setToFeasibleCoordinate, setToFeasibleCoordinate, setWarning, simulate, throwInputError, useStepNumber, writeStepNumber

Methods inherited from class java.lang.Object

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

Field Detail

dimCon

protected int dimCon

number of independent continuous variables

dimDis

protected int dimDis

number of independent discrete variables

dimF

protected int dimF

number of function values

stopAtError

protected boolean stopAtError

flag whether run should stop or proceed if a simulation error occurs

evaPoi

protected java.util.TreeMap<Point,java.lang.Double[]> evaPoi

list with evaluated points and its function values

Constructor Detail

Parametric

public Parametric(GenOpt genOptData)
           throws OptimizerException,
                  java.io.IOException,
                  java.lang.Exception,
                  InputFormatException

Constructor

Parameters:

genOptData - a reference to the GenOpt object.
Note: the object is used as a reference. Hence, the datas of GenOpt are modified by this Class.

Throws:

OptimizerException

java.io.IOException - if an I/O exception occurs

java.lang.Exception

InputFormatException

Method Detail

run

public int run(Point x0)
        throws OptimizerException,
               java.lang.Exception

Runs the evaluation

Specified by:

run in class Optimizer

Parameters:

x0 - initial point

Returns:

+4 the only possible return value

Throws:

java.lang.Exception

OptimizerException

InputFormatException - if an InputFormatException occurs

java.lang.NoSuchMethodException - if a method that should be invoked could not be found

java.lang.IllegalAccessException - if an invoked method enforces Java language access control and the underlying method is inaccessible

java.lang.reflect.InvocationTargetException - if an invoked method throws an exception

getF

public Point getF(Point pt)
           throws SimulationInputException,
                  OptimizerException,
                  java.lang.Exception

Evaluates a simulation and reports result

Overrides:

getF in class Optimizer

Parameters:

pt - point to be evaluated

Returns:

a clone of the point with the new function values stored

Throws:

OptimizerException - if an OptimizerException occurs or if the user required to stop GenOpt

SimulationInputException - if an error in writing the simulation input file occurs

java.lang.Exception - if an I/O error in the simulation input file occurs