Schema threeDVarConfig.xsd


element ThreeDVarConfig
diagram threeDVarConfig_diagrams/threeDVarConfig_p1.png
annotation
documentation
Configuration of 3DVar algorithm.

complexType LineSearchXML
diagram threeDVarConfig_diagrams/threeDVarConfig_p2.png
attributes
Name  Type  Use  Default  Fixed  Annotation
type  xs:string    brent    
documentation
Type of linesearch algorithm. Default: brent.
maxIterations  xs:integer  optional  100    
documentation
Maximum iterations of linesearch.
absTolBrent  xs:double  optional  0.01    
documentation
Tolerance of the absolute search range.
relTolBrent  xs:double    0.01    
documentation
Tolerance of the relative search range.

attribute LineSearchXML/@type
annotation
documentation
Type of linesearch algorithm. Default: brent.

attribute LineSearchXML/@maxIterations
annotation
documentation
Maximum iterations of linesearch.

attribute LineSearchXML/@absTolBrent
annotation
documentation
Tolerance of the absolute search range.

attribute LineSearchXML/@relTolBrent
annotation
documentation
Tolerance of the relative search range.

element LineSearchXML/brent
diagram threeDVarConfig_diagrams/threeDVarConfig_p3.png
attributes
Name  Type  Use  Default  Fixed  Annotation
startBracketValue  xs:double    1.0    
documentation
First value evaluated for bracketing in linesearch.
maxItBracket  xs:double  optional  0.5    
documentation
Maximum number of iterations for bracketing.
maxExtension  xs:double  optional  100.0    
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/brent/@startBracketValue
annotation
documentation
First value evaluated for bracketing in linesearch.

attribute LineSearchXML/brent/@maxItBracket
annotation
documentation
Maximum number of iterations for bracketing.

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

complexType ThreeDVarConfigXML
diagram threeDVarConfig_diagrams/threeDVarConfig_p4.png

element ThreeDVarConfigXML/costFunction
diagram threeDVarConfig_diagrams/threeDVarConfig_p5.png
attributes
Name  Type  Use  Default  Fixed  Annotation
factor  xs:double    0.5    
documentation
Specify the multiplication factor for the quadratic cost function.
annotation
documentation
Configure cost function to minimize

attribute ThreeDVarConfigXML/costFunction/@factor
annotation
documentation
Specify the multiplication factor for the quadratic cost function.

element ThreeDVarConfigXML/algorithm
diagram threeDVarConfig_diagrams/threeDVarConfig_p6.png
attributes
Name  Type  Use  Default  Fixed  Annotation
type  xs:string  optional      
documentation
type of algorithm, default = BFGS, other option = ConjugateGradient
method  xs:string  optional      
documentation
method for conjugategradient algorithm
maxIterations  xs:integer  optional      
documentation
maxIterations, default 25
absTolGrad  xs:double  optional      
documentation
absTolGrad, defalut 0.01
relTolGrad  xs:double  optional      
documentation
relTolGrad, defalut 0.01
absTolStep  xs:double  optional      
documentation
absTolStep, defalut 0.001
relTolStep  xs:double  optional      
documentation
relTolStep, defalut 0.01
annotation
documentation
algorithm

attribute ThreeDVarConfigXML/algorithm/@type
annotation
documentation
type of algorithm, default = BFGS, other option = ConjugateGradient

attribute ThreeDVarConfigXML/algorithm/@method
annotation
documentation
method for conjugategradient algorithm

attribute ThreeDVarConfigXML/algorithm/@maxIterations
annotation
documentation
maxIterations, default 25

attribute ThreeDVarConfigXML/algorithm/@absTolGrad
annotation
documentation
absTolGrad, defalut 0.01

attribute ThreeDVarConfigXML/algorithm/@relTolGrad
annotation
documentation
relTolGrad, defalut 0.01

attribute ThreeDVarConfigXML/algorithm/@absTolStep
annotation
documentation
absTolStep, defalut 0.001

attribute ThreeDVarConfigXML/algorithm/@relTolStep
annotation
documentation
relTolStep, defalut 0.01

element ThreeDVarConfigXML/outerLoop
diagram threeDVarConfig_diagrams/threeDVarConfig_p7.png
attributes
Name  Type  Use  Default  Fixed  Annotation
type      BFGS    
documentation
Specify the optimization algorithm to use: BFGS (default),  fletcher reeves, polak ribiere, or Steepest Descent.
limitedMemory  xs:boolean  optional  true    
documentation
If 'type'= BFGS, specify whether to use LBFGS (limited memory BFGS).
numOfVectors  xs:integer  optional  3    
documentation
Maximum number of  stored vectors.
maxIterations  xs:integer  optional  200    
documentation
Maximum number of iterations for (L)BFGS.
absTolGrad  xs:double  optional  0.01    
documentation
Absolute tolerance for gradient.
relTolGrad  xs:double  optional  0.01    
documentation
Relative tolerance for gradient.
absTolStep  xs:double  optional  0.001    
documentation
Absolute tolerance for step size.
relTolStep  xs:double  optional  0.001    
documentation
Relative tolerance for step size.
annotation
documentation
Specify outer-loop stopping criteria.

element ThreeDVarConfigXML/lineSearch
diagram threeDVarConfig_diagrams/threeDVarConfig_p8.png
attributes
Name  Type  Use  Default  Fixed  Annotation
type  xs:string    brent    
documentation
Type of linesearch algorithm. Default: brent.
maxIterations  xs:integer  optional  100    
documentation
Maximum iterations of linesearch.
absTolBrent  xs:double  optional  0.01    
documentation
Tolerance of the absolute search range.
relTolBrent  xs:double    0.01    
documentation
Tolerance of the relative search range.
annotation
documentation
Specify inner-loop / linesearch criteria.

complexType OuterLoopXML
diagram threeDVarConfig_diagrams/threeDVarConfig_p9.png
attributes
Name  Type  Use  Default  Fixed  Annotation
type      BFGS    
documentation
Specify the optimization algorithm to use: BFGS (default),  fletcher reeves, polak ribiere, or Steepest Descent.
limitedMemory  xs:boolean  optional  true    
documentation
If 'type'= BFGS, specify whether to use LBFGS (limited memory BFGS).
numOfVectors  xs:integer  optional  3    
documentation
Maximum number of  stored vectors.
maxIterations  xs:integer  optional  200    
documentation
Maximum number of iterations for (L)BFGS.
absTolGrad  xs:double  optional  0.01    
documentation
Absolute tolerance for gradient.
relTolGrad  xs:double  optional  0.01    
documentation
Relative tolerance for gradient.
absTolStep  xs:double  optional  0.001    
documentation
Absolute tolerance for step size.
relTolStep  xs:double  optional  0.001    
documentation
Relative tolerance for step size.

attribute OuterLoopXML/@type
annotation
documentation
Specify the optimization algorithm to use: BFGS (default),  fletcher reeves, polak ribiere, or Steepest Descent.

attribute OuterLoopXML/@limitedMemory
annotation
documentation
If 'type'= BFGS, specify whether to use LBFGS (limited memory BFGS).

attribute OuterLoopXML/@numOfVectors
annotation
documentation
Maximum number of  stored vectors.

attribute OuterLoopXML/@maxIterations
annotation
documentation
Maximum number of iterations for (L)BFGS.

attribute OuterLoopXML/@absTolGrad
annotation
documentation
Absolute tolerance for gradient.

attribute OuterLoopXML/@relTolGrad
annotation
documentation
Relative tolerance for gradient.

attribute OuterLoopXML/@absTolStep
annotation
documentation
Absolute tolerance for step size.

attribute OuterLoopXML/@relTolStep
annotation
documentation
Relative tolerance for step size.


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