Package net.simplace.sim.control.generators

Class RandomSimGenerator

java.lang.Object
net.simplace.sim.control.FWSimulationControlContainer
net.simplace.sim.control.FWSimulationGenerator
net.simplace.sim.control.generators.DefaultSimulationGenerator
net.simplace.sim.control.generators.RandomSimGenerator
All Implemented Interfaces:
net.simplace.sim.util.FWSimFieldContainer
public class RandomSimGenerator extends net.simplace.sim.control.generators.DefaultSimulationGenerator
Generate simulations with parameters created randomly from specified distributions.

Distributions

For each model variable the user can chose one of the distribution below:

Distribution Distribution Parameters Optional Param.Return datatype Remark
Uniform min, max DOUBLE
Normal mean, sigma min, max DOUBLE
Exponential lambda min, max DOUBLE
Poisson lambda min, max INT
Binomial n, p min, max INT n has to be of type INT
Choice values frequencies any Choses randomly a value from a list. Values have to be an array of the same type as the cal variable

If min and max are specified and the generated value exceeds them, new random numbers are generated until one fits the interval. The number of trials is limited to cMaxAttemptsOutOfRange. If no number is found, the parameter set is skipped.

Generated parameter sets can be further restricted by constraints.

Variable specific configuration

Arbitrary number of calibration variables (either INT or DOUBLE, depending on distribution used). When using the distribution Choice, then the datatype can be additionally CHAR, DATE or BOOLEAN.

| <cal id="VariableName" target="vModuleName">

For each calibration variable the distribution and it's parametrization as in the table above.

| <cal id="VariableName" target="vModelParameter" datatype="DOUBLE">
|   <input id="distribution" datatype="CHAR">DISTRIBUTION</input>
|   <input id="PARAMETER1" datatype="DOUBLE">3.0</input>
|   <input id="PARAMETER2" datatype="DOUBLE">.5</input>
| </cal>

General configuration

Name DATATYPE Description
cCount INT the number of parameter sets to be generated, mandatory
cRandomSeed CHAR optional random seed for the generator. Can be a long integer, therefore it has datatype CHAR
cMaxAttemptsOutOfRange INT maximum number of trials to re-generate a random number if it's value is outside min/max range

A constraint prohibits the creation of invalid variable values.

| <constraint rule="${Generator.TsumMaturity} >         ${Generator.TsumAnthesis}+100">

Remark

The number of created simulations can be smaller than Count.

  • the min and max attributes of the generated values may prohibit generation of some parameter sets
  • an additional constraint on the parameter set may prevent generation of a simulation

The random seed is set only on initialization of the generator. That means, that a subsequent iteration or a subsequent project can not set it's individual random seed.

Example

|<generator id="Generator" class="net.simplace.sim.control.generators.RandomSimGenerator">
|
| <cal id="TsumAnthesis" datatype="DOUBLE" target="vTsumAnt">
|   <input id="distribution" datatype="CHAR">Uniform</input>
|   <input id="min" datatype="DOUBLE">0</input>
|   <input id="max" datatype="DOUBLE" source="vTsumMax" />
| </cal>
|
| <cal id="TsumMat" datatype="DOUBLE" target="vTsumMat">
|   <input id="distribution" datatype="CHAR">Normal</input>
|   <input id="sigma" datatype="DOUBLE" source="Iterator.TsumMat.sigma" />
|   <input id="mean" datatype="DOUBLE" source="Iterator.TsumMat.mean" />
|   <input id="min" datatype="DOUBLE">0</input>
|   <input id="max" datatype="DOUBLE" source="vTsumMax" />
| </cal>
|
| <cal id="Soiltype" datatype="CHAR" target="vSoiltype">
|   <input id="distribution" datatype="CHAR">Choice</input>
|   <input id="values" datatype="CHARARRAY">{loam,sand,sandyloam}</input>
|   <input id="frequencies" datatype="DOUBLEARRAY" >{2,9,6}</input>
| </cal>
|
| <input id="cRandomSeed" datatype="CHAR">342345734</input>
| <input id="cCount" datatype="INT">100</input>
|
| <constraint rule="${Generator.TsumMaturity} > ${Generator.TsumAnthesis}+100">
|
|</generator>
Author:
Gunther Krauss

  • Field Summary

    Fields inherited from class net.simplace.sim.control.FWSimulationGenerator

    iContentType, iSimulationsMap

    Fields inherited from class net.simplace.sim.control.FWSimulationControlContainer

    iCache, iCals, iConstraint, iContainerElement, iControlMap, iFieldMap, iIdentifier, iInputMap, iInputs, iName, iParams, iSession, iSimulationMap

  • Constructor Summary

    Constructors
    Constructor
    Description
    RandomSimGenerator(org.jdom2.Element aGeneratorElement, net.simplace.sim.FWSimSession aSession, HashMap<String,net.simplace.sim.util.FWSimVariable<?>> aFieldMap, net.simplace.sim.util.FWSimVariable.CONTENT_TYPE aContentType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    HashMap<String,net.simplace.sim.util.FWSimVariable<?>>
    createVariables()
     
    void
    generate(net.simplace.sim.control.FWSimulationControlCache aCache, ResultSet aResultSet)
     
    protected static int
    getIndex(double value, Double[] breaks)
    Return the index of the first break, that is bigger than the value.
    void
    init()
     
    protected static double
    nextRandom(Random randomizer, String distribution, double min, double max, double mean, double sigma, double lambda, double p, int n)
    Generates a next random number

    Methods inherited from class net.simplace.sim.control.FWSimulationGenerator

    addSimulation, canUpdate, clearSimulations, createSimulationGenerator, finalize, getSimulation, getSimulationsListSize, initializeProject, reset, setFinished, setInitial, updateSimulations, writeSimulation

    Methods inherited from class net.simplace.sim.control.FWSimulationControlContainer

    addProcessTime, addVariable, checkCondition, evaluate, getContentType, getCreateFormXML, getEditFormXML, getFieldMap, getFrequence, getInputVariables, getName, getOrderNumber, getOutputVariables, getVariable, getVarMap, isConditionCheck, readInputCalAndConstraint, removeVariable, setPropertyValue, toXML

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RandomSimGenerator

      public RandomSimGenerator(org.jdom2.Element aGeneratorElement, net.simplace.sim.FWSimSession aSession, HashMap<String,net.simplace.sim.util.FWSimVariable<?>> aFieldMap, net.simplace.sim.util.FWSimVariable.CONTENT_TYPE aContentType)

  • Method Details

    • init

      public void init()
      Overrides:
      init in class net.simplace.sim.control.generators.DefaultSimulationGenerator

    • createVariables

      public HashMap<String,net.simplace.sim.util.FWSimVariable<?>> createVariables()
      Specified by:
      createVariables in interface net.simplace.sim.util.FWSimFieldContainer
      Overrides:
      createVariables in class net.simplace.sim.control.generators.DefaultSimulationGenerator

    • generate

      public void generate(net.simplace.sim.control.FWSimulationControlCache aCache, ResultSet aResultSet) throws SQLException
      Overrides:
      generate in class net.simplace.sim.control.generators.DefaultSimulationGenerator
      Throws:
      SQLException

    • nextRandom

      protected static double nextRandom(Random randomizer, String distribution, double min, double max, double mean, double sigma, double lambda, double p, int n)
      Generates a next random number
      Parameters:
      randomizer -
      distribution -
      min -
      max -
      mean -
      sigma -
      lambda -
      p -
      n -
      Returns:
      random number

    • getIndex

      protected static int getIndex(double value, Double[] breaks)
      Return the index of the first break, that is bigger than the value.
      Parameters:
      value - a value between 0 and 1
      breaks - an array of ordered values between 0 and 1
      Returns:
      index