field-parameters.xml 7.78 KB
Newer Older
Dion Haefner's avatar
Dion Haefner committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
<?xml version="1.0" encoding="UTF-8"?>

<!--
If you want to use any special characters, you will need to define them here.
A full list is found at https://www.w3.org/TR/REC-html40/sgml/entities.html
-->

<!DOCTYPE naughtyxml [
    <!ENTITY alpha "&#945;">
    <!ENTITY beta "&#946;">
    <!ENTITY eta "&#951;">
    <!ENTITY tau "&#964;">
    <!ENTITY times "&#215;">
]>

<!--
XML file hierarchy:
<dorie> -> <category> -> <parameter> -> (parameter attributes)

Possible parameter attributes:

  definition: meaning of the parameter, will only show up in html output
  suggestion: standard value in created parameter files
  values: possible values, will only show up in html output
  comment: extra comment, will only show up in parameter files

All attributes are optional.

The parser supports rudimentary markdown / styling. You can add a paragraph by
adding an empty line, make text **bold** or ``monospaced``.
-->

<dorie>
  <category name="general" hidden="true">

    <parameter name="generator">
      <definition>
        Specifies which parameter field generator module should be used.
      </definition>
      <values> image, csv, fft, hdf5 </values>
      <suggestion> csv </suggestion>
      <comment> One of: image, csv, fft, hdf5 </comment>
    </parameter>

    <parameter name="inputFile">
      <definition>
        Path to file holding the parameter distribution data (i.e., image, CSV file,
        or HDF5 file). Has no effect when using FFT generator.
      </definition>
      <values> path </values>
    </parameter>

    <parameter name="outputFile">
      <definition>
        Output file name of the parameter field array.
      </definition>
      <values> path </values>
      <suggestion> field.h5 </suggestion>
    </parameter>

    <parameter name="parameterization">
      <definition>
        Parameterization to be used when mapping field value to parameter.
        Essentially sets which ``parameters.&lt;parameterization&gt;.&lt;x&gt;``
        values should be used.
      </definition>
      <values> vanGenuchten </values>
      <suggestion> vanGenuchten </suggestion>
    </parameter>

    <parameter name="overwrite">
      <definition>
        Whether an existing parameter field array should be overwritten.
      </definition>
      <values> bool </values>
      <suggestion> false </suggestion>
    </parameter>
  </category>

  <category name="parameters.vanGenuchten.1" hidden="true">
    <parameter name="theta_r">
      <definition>
        Residual water content of medium 1, used in the Mualem-van Genuchten
        parameterization. Default values for sand, according to Soil Physics, p. 92.
      </definition>
      <values> float </values>
      <suggestion> 0.03 </suggestion>
    </parameter>

    <parameter name="theta_s">
      <definition> Saturated water content. </definition>
      <values> float </values>
      <suggestion> 0.32 </suggestion>
    </parameter>

    <parameter name="alpha">
      <definition> log10(&alpha;) in the van Genuchten parameterization. Units: [1/m] </definition>
      <values> float </values>
      <suggestion> -2.3 </suggestion>
    </parameter>

    <parameter name="tau">
      <definition> &tau; in the Mualem parameterization of the hydraulic permeability. </definition>
      <values> float </values>
      <suggestion> -1.1 </suggestion>
    </parameter>

    <parameter name="n">
      <definition> n in the van Genuchten parameterization. </definition>
      <values> float </values>
      <suggestion> 4.17 </suggestion>
    </parameter>

    <parameter name="k0">
      <definition> Saturated hydraulic conductivity. Units: [m/s] </definition>
      <values> float </values>
      <suggestion> 2.2E-5 </suggestion>
    </parameter>
  </category>

  <category name="parameters.vanGenuchten.2" hidden="true">
    <parameter name="theta_r">
      <definition>
        Residual water content of medium 2, used in the Mualem-van Genuchten
        parameterization. Default values for silt, according to Soil Physics, p. 92.
      </definition>
      <values> float </values>
      <suggestion> 0.01 </suggestion>
    </parameter>

    <parameter name="theta_s">
      <definition> Saturated water content. </definition>
      <values> float </values>
      <suggestion> 0.41 </suggestion>
    </parameter>

    <parameter name="alpha">
      <definition> log10(&alpha;) in the van Genuchten parameterization. Units: [1/m] </definition>
      <values> float </values>
      <suggestion> -0.7 </suggestion>
    </parameter>

    <parameter name="tau">
      <definition> &tau; in the Mualem parameterization of the hydraulic permeability. </definition>
      <values> float </values>
      <suggestion> .0 </suggestion>
    </parameter>

    <parameter name="n">
      <definition> n in the van Genuchten parameterization. </definition>
      <values> float </values>
      <suggestion> 1.3 </suggestion>
    </parameter>

    <parameter name="k0">
      <definition> Saturated hydraulic conductivity. Units: [m/s] </definition>
      <values> float </values>
      <suggestion> 1E-5  </suggestion>
    </parameter>
  </category>

  <category name="generator">
    <parameter name="millerSimilarity" hidden="true">
      <definition>
        Whether to use Miller similarity or not. If set to true, only
        the first specified parameter set is used. Also, make sure to set a proper
        variance.
      </definition>
      <values> bool </values>
      <suggestion> false </suggestion>
    </parameter>

173 174 175 176 177 178 179 180 181
    <parameter name="dimensions">
      <definition>
        Spatial dimension of the created field. 3-dimensional fields are only supported
        by the fft and hdf5 generators.
      </definition>
      <values> 2, 3 </values>
      <suggestion> 2 </suggestion>
    </parameter>

Dion Haefner's avatar
Dion Haefner committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    <parameter name="variance">
      <definition>
        Variance of the resulting field, if ``millerSimilarity`` is used.
      </definition>
      <values> float </values>
      <suggestion> 0.2 </suggestion>
    </parameter>

    <parameter name="extensions">
      <definition>
        Physical extensions of the created field.
      </definition>
      <values> float &times; float (&times; float) </values>
      <suggestion> 1 1 </suggestion>
    </parameter>
  </category>

  <category name="generator.fft">
    <parameter name="outputPath">
      <definition>
        Path to the output folder of the generated field. Note that this only accepts
        a folder, not a file name (file names are fixed).
      </definition>
      <values> path </values>
      <suggestion> /tmp/fft_generator/ </suggestion>
    </parameter>

    <parameter name="N">
210
      <definition> Suggested size (in cells) of the created random field. </definition>
Dion Haefner's avatar
Dion Haefner committed
211 212 213 214
      <values> int &times; int (&times; int) </values>
      <suggestion> 1000 1000 </suggestion>
    </parameter>

215 216
    <parameter name="correlationLengths">
      <definition> Correlation lengths in each dimension of the random field, in
Dion Haefner's avatar
Dion Haefner committed
217
        meters. </definition>
218 219
      <values> float &times; float (&times; float) </values>
      <suggestion> .1 .05 </suggestion>
Dion Haefner's avatar
Dion Haefner committed
220 221 222 223 224 225 226 227 228
    </parameter>

    <parameter name="seed">
      <definition> Seed of all random number generators involved. Ensures reproducibility
        (the same seed will always lead to the same random field). </definition>
      <values> int </values>
      <suggestion> 123456789 </suggestion>
    </parameter>

229
    <parameter name="covariance">
Dion Haefner's avatar
Dion Haefner committed
230 231
      <definition> Defines which variogram function should be used to create the
        random field. </definition>
232
      <values> exponential, gaussian, spherical </values>
Dion Haefner's avatar
Dion Haefner committed
233
      <suggestion> gaussian </suggestion>
234
      <comment> exponential, gaussian, spherical </comment>
Dion Haefner's avatar
Dion Haefner committed
235 236 237 238 239 240 241 242 243 244 245 246
    </parameter>
  </category>

  <category name="generator.image" hidden="true">
  </category>

  <category name="generator.csv" hidden="true">
  </category>

  <category name="generator.h5" hidden="true">
  </category>
</dorie>