Schema sparseDudConfig.xsd


element SparseDudConfig
diagram sparseDudConfig_diagrams/sparseDudConfig_p1.png
annotation
documentation
Configuration of Sparse Dud algorithm.

complexType dependenciesXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p2.png

element dependenciesXML/obs
diagram sparseDudConfig_diagrams/sparseDudConfig_p3.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  derived by: xs:string  required      
documentation
Observation ID
annotation
documentation
Specify observation and one or more dependent calibration parameters.

attribute dependenciesXML/obs/@id
annotation
documentation
Observation ID

element dependenciesXML/obs/depends_on
diagram sparseDudConfig_diagrams/sparseDudConfig_p4.png

element dependenciesXML/obs/depends_on/par
diagram sparseDudConfig_diagrams/sparseDudConfig_p5.png
attributes
Name  Type  Use  Default  Fixed  Annotation
id  derived by: xs:string  required      
documentation
Parameter ID
annotation
documentation
Specify one or more calibration parameters, which are dependent on the observation specified on element obs.

attribute dependenciesXML/obs/depends_on/par/@id
annotation
documentation
Parameter ID

complexType SparseDudConfigXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p6.png

element SparseDudConfigXML/costFunction
diagram sparseDudConfig_diagrams/sparseDudConfig_p7.png
attributes
Name  Type  Use  Default  Fixed  Annotation
class  derived by: xs:string  required      
documentation
Set openda:class name of the cost function.
weakParameterConstraint  xs:boolean  optional  false    
documentation
Specify whether to use weak constraint (weakParameterConstraint=true) or strong constraint (weakParameterConstraint=false).
biasRemoval          
documentation
Specify whether bias should be removed (true) from the cost computation. Default: false.
tryParallel  xs:boolean  optional  false    
documentation
Specify whether to use parallel or serial run. If tryParallel="true", the models will all be started before the results are evaluated. Otherwise,  if tryParallel="false", then the first run is evaluated before starting the second run.
factor  xs:double  optional  0.5    
documentation
Specify the multiplication factor to use in the cost function.
annotation
documentation
Configure cost function to minimize

element SparseDudConfigXML/outerLoop
diagram sparseDudConfig_diagrams/sparseDudConfig_p8.png
attributes
Name  Type  Use  Default  Fixed  Annotation
maxIterations  xs:integer  optional  3    
documentation
Maximum number of outer iterations.
absTolerance  xs:double  optional  0.01    
documentation
Maximum absolute difference between the costs of two best parameter estimates.
relTolerance  xs:double  optional  0.01    
documentation
Maximum relative difference between the costs of two best parameter estimates.
relToleranceLinearCost  xs:double  optional  0.01    
documentation
Maximum relative difference between the linearized costs of two best parameter estimates.
annotation
documentation
Specify outer-loop stopping criteria.

element SparseDudConfigXML/lineSearch
diagram sparseDudConfig_diagrams/sparseDudConfig_p9.png
attributes
Name  Type  Use  Default  Fixed  Annotation
maxIterations  xs:integer  optional  6    
documentation
Maximum number of inner iterations.
maxRelStepSize  xs:double  optional  10.0    
documentation
Maximum size of relative step.
annotation
documentation
Specify inner-loop / linesearch criteria.

element SparseDudConfigXML/dependencies
diagram sparseDudConfig_diagrams/sparseDudConfig_p10.png

element SparseDudConfigXML/stopCriteria
diagram sparseDudConfig_diagrams/sparseDudConfig_p11.png
annotation
documentation
Additional optional stopping criteria

complexType CostFunctionXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p12.png
attributes
Name  Type  Use  Default  Fixed  Annotation
class  derived by: xs:string  required      
documentation
Set openda:class name of the cost function.
weakParameterConstraint  xs:boolean  optional  false    
documentation
Specify whether to use weak constraint (weakParameterConstraint=true) or strong constraint (weakParameterConstraint=false).
biasRemoval          
documentation
Specify whether bias should be removed (true) from the cost computation. Default: false.
tryParallel  xs:boolean  optional  false    
documentation
Specify whether to use parallel or serial run. If tryParallel="true", the models will all be started before the results are evaluated. Otherwise,  if tryParallel="false", then the first run is evaluated before starting the second run.
factor  xs:double  optional  0.5    
documentation
Specify the multiplication factor to use in the cost function.

attribute CostFunctionXML/@class
annotation
documentation
Set openda:class name of the cost function.

attribute CostFunctionXML/@weakParameterConstraint
annotation
documentation
Specify whether to use weak constraint (weakParameterConstraint=true) or strong constraint (weakParameterConstraint=false).

attribute CostFunctionXML/@biasRemoval
annotation
documentation
Specify whether bias should be removed (true) from the cost computation. Default: false.

attribute CostFunctionXML/@tryParallel
annotation
documentation
Specify whether to use parallel or serial run. If tryParallel="true", the models will all be started before the results are evaluated. Otherwise,  if tryParallel="false", then the first run is evaluated before starting the second run.

attribute CostFunctionXML/@factor
annotation
documentation
Specify the multiplication factor to use in the cost function.

complexType OuterLoopXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p13.png
attributes
Name  Type  Use  Default  Fixed  Annotation
maxIterations  xs:integer  optional  3    
documentation
Maximum number of outer iterations.
absTolerance  xs:double  optional  0.01    
documentation
Maximum absolute difference between the costs of two best parameter estimates.
relTolerance  xs:double  optional  0.01    
documentation
Maximum relative difference between the costs of two best parameter estimates.
relToleranceLinearCost  xs:double  optional  0.01    
documentation
Maximum relative difference between the linearized costs of two best parameter estimates.

attribute OuterLoopXML/@maxIterations
annotation
documentation
Maximum number of outer iterations.

attribute OuterLoopXML/@absTolerance
annotation
documentation
Maximum absolute difference between the costs of two best parameter estimates.

attribute OuterLoopXML/@relTolerance
annotation
documentation
Maximum relative difference between the costs of two best parameter estimates.

attribute OuterLoopXML/@relToleranceLinearCost
annotation
documentation
Maximum relative difference between the linearized costs of two best parameter estimates.

element DudConfig
diagram sparseDudConfig_diagrams/sparseDudConfig_p14.png
annotation
documentation
Configuration of Dud algorithm.

complexType DudConfigXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p15.png

element DudConfigXML/costFunction
diagram sparseDudConfig_diagrams/sparseDudConfig_p16.png
attributes
Name  Type  Use  Default  Fixed  Annotation
class  derived by: xs:string  required      
documentation
Set openda:class name of the cost function.
weakParameterConstraint  xs:boolean  optional  false    
documentation
Specify whether to use weak constraint (weakParameterConstraint=true) or strong constraint (weakParameterConstraint=false).
biasRemoval          
documentation
Specify whether bias should be removed (true) from the cost computation. Default: false.
tryParallel  xs:boolean  optional  false    
documentation
Specify whether to use parallel or serial run. If tryParallel="true", the models will all be started before the results are evaluated. Otherwise,  if tryParallel="false", then the first run is evaluated before starting the second run.
factor  xs:double  optional  0.5    
documentation
Specify the multiplication factor to use in the cost function.
annotation
documentation
Configure cost function to minimize

element DudConfigXML/restartOutFilePrefix
diagram sparseDudConfig_diagrams/sparseDudConfig_p17.png
annotation
documentation
For preparing restart files: specify the prefix of the restart file names.

element DudConfigXML/restartInFile
diagram sparseDudConfig_diagrams/sparseDudConfig_p18.png
annotation
documentation
For running from restart: specify the name of a restart file.

element DudConfigXML/outerLoop
diagram sparseDudConfig_diagrams/sparseDudConfig_p19.png
attributes
Name  Type  Use  Default  Fixed  Annotation
maxIterations  xs:integer  optional  3    
documentation
Maximum number of outer iterations.
absTolerance  xs:double  optional  0.01    
documentation
Maximum absolute difference between the costs of two best parameter estimates.
relTolerance  xs:double  optional  0.01    
documentation
Maximum relative difference between the costs of two best parameter estimates.
relToleranceLinearCost  xs:double  optional  0.01    
documentation
Maximum relative difference between the linearized costs of two best parameter estimates.
annotation
documentation
Specify outer-loop stopping criteria.

element DudConfigXML/lineSearch
diagram sparseDudConfig_diagrams/sparseDudConfig_p20.png
attributes
Name  Type  Use  Default  Fixed  Annotation
maxIterations  xs:integer  optional  6    
documentation
Maximum number of inner iterations.
maxRelStepSize  xs:double  optional  10.0    
documentation
Maximum size of relative step.
annotation
documentation
Specify inner-loop / linesearch criteria.

element DudConfigXML/stopCriteria
diagram sparseDudConfig_diagrams/sparseDudConfig_p21.png
annotation
documentation
Additional optional stopping criteria

element DudConfigXML/constraints
diagram sparseDudConfig_diagrams/sparseDudConfig_p22.png
attributes
Name  Type  Use  Default  Fixed  Annotation
parameterConstraint  xs:boolean  required      
documentation
Specify whether to use the constraints (parameterParameterConstraint=true) or not (parameterrConstraint=false).
annotation
documentation
Limits on parameter values in calibration process.

complexType LineSearchXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p23.png
attributes
Name  Type  Use  Default  Fixed  Annotation
maxIterations  xs:integer  optional  6    
documentation
Maximum number of inner iterations.
maxRelStepSize  xs:double  optional  10.0    
documentation
Maximum size of relative step.

attribute LineSearchXML/@maxIterations
annotation
documentation
Maximum number of inner iterations.

attribute LineSearchXML/@maxRelStepSize
annotation
documentation
Maximum size of relative step.

element LineSearchXML/backTracking
diagram sparseDudConfig_diagrams/sparseDudConfig_p24.png
attributes
Name  Type  Use  Default  Fixed  Annotation
shorteningFactor  xs:double  optional  0.5    
documentation
Factor for shortening step size.
startIterationNegativeLook  xs:integer  optional  3    
documentation
Maximum number of iterations before searching in opposite direction.
annotation
documentation
Back tracking if the line search produces estimate with larger cost.

attribute LineSearchXML/backTracking/@shorteningFactor
annotation
documentation
Factor for shortening step size.

attribute LineSearchXML/backTracking/@startIterationNegativeLook
annotation
documentation
Maximum number of iterations before searching in opposite direction.

complexType additionalStopCriteria
diagram sparseDudConfig_diagrams/sparseDudConfig_p25.png
annotation
documentation
Additional optional stopping criteria.

element additionalStopCriteria/stopCriterion
diagram sparseDudConfig_diagrams/sparseDudConfig_p26.png
attributes
Name  Type  Use  Default  Fixed  Annotation
threshold    required      
documentation
Threshold value of the stopping parameter.
class    required      
documentation
Java class of the corresponding stopping criterion
annotation
documentation
A stopping criterion

attribute additionalStopCriteria/stopCriterion/@threshold
annotation
documentation
Threshold value of the stopping parameter.

attribute additionalStopCriteria/stopCriterion/@class
annotation
documentation
Java class of the corresponding stopping criterion

complexType BoundsXML
diagram sparseDudConfig_diagrams/sparseDudConfig_p27.png
attributes
Name  Type  Use  Default  Fixed  Annotation
bounds  xs:string  required      
documentation
Array with values.

attribute BoundsXML/@bounds
annotation
documentation
Array with values.

complexType parameterConstraints
diagram sparseDudConfig_diagrams/sparseDudConfig_p28.png
attributes
Name  Type  Use  Default  Fixed  Annotation
parameterConstraint  xs:boolean  required      
documentation
Specify whether to use the constraints (parameterParameterConstraint=true) or not (parameterrConstraint=false).
annotation
documentation
Specify (phyisical) limits on parameter values in calibration process.

attribute parameterConstraints/@parameterConstraint
annotation
documentation
Specify whether to use the constraints (parameterParameterConstraint=true) or not (parameterrConstraint=false).

element parameterConstraints/lowerbounds
diagram sparseDudConfig_diagrams/sparseDudConfig_p29.png
attributes
Name  Type  Use  Default  Fixed  Annotation
bounds  xs:string  required      
documentation
Array with values.
annotation
documentation
Lower limits.

element parameterConstraints/upperbounds
diagram sparseDudConfig_diagrams/sparseDudConfig_p30.png
attributes
Name  Type  Use  Default  Fixed  Annotation
bounds  xs:string  required      
documentation
Array with values.
annotation
documentation
Upper limits.


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy