genopt.db
Class OptimizationSettings

java.lang.Object
  genopt.db.OptimizationSettings

public class OptimizationSettings
extends java.lang.Object

Object for the specific settings of the optimization process.

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-2011, 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.0 (December 8, 2011)

Author:

Michael Wetter

Field Summary

protected int	maxIteration
protected int	uniOfExe
protected boolean	wriSteNum

Constructor Summary

OptimizationSettings()

OptimizationSettings(int maximumNumberOfIteration, boolean writeStepNumber, int unitsOfExecution)

Method Summary

int	getMaxIteration() Get the maximum number of main iteration steps
int	getMaxUnitsOfExecution() Get the maximum number of units of executions
boolean	writeStepNumber() returns the flag that indicates whether the step number has to written to the simulation input file or not.

Methods inherited from class java.lang.Object

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

Field Detail

maxIteration

protected int maxIteration

wriSteNum

protected boolean wriSteNum

uniOfExe

protected int uniOfExe

Constructor Detail

OptimizationSettings

public OptimizationSettings()

OptimizationSettings

public OptimizationSettings(int maximumNumberOfIteration,
                            boolean writeStepNumber,
                            int unitsOfExecution)

Parameters:

maximumNumberOfIteration - the maximum number of iteration

writeStepNumber - flag that indicates whether the step number has to written to the simulation input file (true) or not false

unitsOfExecution - the maximum number of units of executions to be used

Method Detail

writeStepNumber

public final boolean writeStepNumber()

returns the flag that indicates whether the step number has to written to the simulation input file or not.

Returns:

true if the step number has to written, false otherwise

getMaxIteration

public final int getMaxIteration()

Get the maximum number of main iteration steps

Returns:

Maximum number of main iteration steps

getMaxUnitsOfExecution

public final int getMaxUnitsOfExecution()

Get the maximum number of units of executions

Returns:

Maximum number of units of executions, or zero.