Model help:GSDCalculator: Difference between revisions

From CSDMS
(Created page with "<!-- How to create a new "Model help" page: 1) Log in to the wiki 2) Create a new page for each model, by using the following URL: * http://csdms.colorado.edu/wiki/Model help:...")
 
m (Text replacement - "http://csdms.colorado.edu/wiki/" to "https://csdms.colorado.edu/wiki/")
 
(9 intermediate revisions by 2 users not shown)
Line 3: Line 3:
1) Log in to the wiki
1) Log in to the wiki
2) Create a new page for each model, by using the following URL:
2) Create a new page for each model, by using the following URL:
   * http://csdms.colorado.edu/wiki/Model help:<modelname>
   * https://csdms.colorado.edu/wiki/Model help:<modelname>
   * Replace <modelname> with the name of a model
   * Replace <modelname> with the name of a model
3) Than follow the link "edit this page"
3) Than follow the link "edit this page"
Line 14: Line 14:
__NOTOC__
__NOTOC__
==<big><big>{{PAGENAME}}</big></big>==
==<big><big>{{PAGENAME}}</big></big>==
This model is used to calculate statistical characteristics of grain size distributions.
This model is a Grain Size Distribution Statistics Calculator.


==Model introduction==
==Model introduction==
This model is a Grain Size Distribution Statistics Calculator.
This model is used to calculate statistical characteristics of grain size distributions. Given a grain size distribution, the program computes the geometric mean diameter, and the geometric standard deviation.
 
==Model parameters==
==Model parameters==
= First tab header =
= Input Files and Directories =
{|{{Prettytable}} class = "wikitable unsortable"  cellspacing="0" cellpadding="0" style="margin:0em 0em 0em 0;"
{|{{Prettytable}} class = "wikitable unsortable"  cellspacing="0" cellpadding="0" style="margin:0em 0em 0em 0;"
|-
|-
!Parameter!!Description!!Unit
!Parameter!!Description!!Unit
|-valign="top"
|-valign="top"
|width="20%"|<span class="remove_this_tag">First parameter</span>
|width="20%"|Input directory
|width="60%"|<span class="remove_this_tag">Description parameter</span>
|width="60%"|path to input files
|width="20%"|<span class="remove_this_tag">[Units]</span>
|width="20%"|
|-
|Site prefix
|Site prefix for Input/Output files
|
|-
|Case prefix
|Case prefix for Input/Output files
|
|-
|}
|}


= Second tab header =
= About =
{|{{Prettytable}} class = "wikitable unsortable"  cellspacing="0"  cellpadding="0" style="margin:0em 0em 0em 0;"
{|{{Prettytable}} class = "wikitable unsortable"  cellspacing="0"  cellpadding="0" style="margin:0em 0em 0em 0;"
|-
|-
!Parameter!!Description!!Unit
!Parameter!!Description!!Unit
|-valign="top"
|-valign="top"
|width="20%"|<span class="remove_this_tag">First parameter</span>
|width="20%"|Model name
|width="60%"|<span class="remove_this_tag">Description parameter</span>
|width="60%"|name of the model
|width="20%"|<span class="remove_this_tag">[Units]</span>
|width="20%"| -
|-
|Author name
|name of the model author
| -
|-
|}
|}
= Etc. tab header =
<headertabs/>
<headertabs/>
</div>


==Uses ports==
==Uses ports==
Line 50: Line 62:


==Main equations==
==Main equations==
<span class="remove_this_tag">A list of the key equations. HTML format is supported; latex format will be supported in the future</span>
* Linearly interpolated grain size (in Ψ scale)
::::{|
|width=800px|<math>\Psi = \Phi =log_{2}D </math>
|width=50px align="right"|(1)
|}
* Calculation of D<sub>x</sub>
::::{|
|width=800px|<math>\psi_{x} = \phi_{b,i} + {\frac{\psi_{b,i+1} - \psi_{b,i}}{f_{f,i+1} - f_{f,i}}} \left ({\frac{x}{100} - f_{f,i}}\right ) </math>
|width=50px align="right"|(2)
|}
::::{|
|width=800px|<math> D_{x} = 2^ \left (\psi_{x}\right ) </math>
|width=50px align="right"|(3)
|}
* Calculation of geometric mean size and standard deviation
::::{|
|width=800px|<math> f_{i} = f_{f,i+1} - f_{f,i} </math>
|width=50px align="right"|(4)
|}
::::{|
|width=800px|<math> D_{i} = \left (D_{b,i} - D_{b,i+1}\right )^ \left ({\frac{1}{2}}\right ) </math>
|width=50px align="right"|(5)
|}
::::{|
|width=800px|<math> \psi_{i} = {\frac{1}{2}}\left (\psi_{b,i} - \psi_{b,i+1}\right ) </math>
|width=50px align="right"|(6)
|}
::::{|
|width=800px|<math> \bar{\psi} = \sum\limits_{i=1}^N \psi_{i} f_{i} </math>
|width=50px align="right"|(7)
|}
::::{|
|width=800px|<math> \sigma^2 = \sum\limits_{i=1}^N \left (\psi_{i} - \bar{\psi}\right )^2 f_{i} </math>
|width=50px align="right"|(8)
|}
::::{|
|width=800px|<math> D_{g} = 2^ \left (\bar{\psi}\right ) </math>
|width=50px align="right"|(9)
|}
::::{|
|width=800px|<math> \sigma_{g} = 2^\left (\sigma\right ) </math>
|width=50px align="right"|(10)
|}
 
<div class="NavFrame collapsed" style="text-align:left">
  <div class="NavHead">Nomenclature</div>
  <div class="NavContent">
{| {{Prettytable}} class="wikitable sortable"
!Symbol!!Description!!Unit
|-
| D
| sediment size
| L
|-
| D<sub>xU</sub>
| upper bound of the size distribution based on the percent finer
| L
|-
| D<sub>xL</sub>
| lower bound of the size distribution based on the percent finer
| L
|-
| D<sub>b,i</sub>
| the ith grain size diameter
| L
|-
| f<sub>f,i</sub>
| mass fraction in the sample that is finer than size D<sub>b,i</sub>
| -
|-
| ψ<sub>i</sub>
| characteristic size of ith grain size range
| L
|-
| f<sub>i</sub>
| fraction of sample in ith grain size range
| -
|-
| xU
| percent finer of the upper bound of the size distribution
| -
|-
| xL
| percent finer of the lower bound of the size distribution
| -
|-
| Ψ
| sediment size in the psi-scale
| -
|-
| bar{Ψ}
| mean grain size on psi scale
| L
|-
| σ
| standard deviation on psi scale
| -
|-
|}
 
'''Output'''
{| {{Prettytable}} class="wikitable sortable"
!Symbol!!Description!!Unit
|-
| D<sub>g</sub>
| geometric mean diameter of the size distribution
| L
|-
| σ<sub>g</sub>
| geometric standard deviation of the size distribution
| -
|-
| D<sub>x</sub>
| characteristic diameter of the size diameter based on the percent finer
| L
|-
|}
  </div>
</div>
 


==Notes==
==Notes==
<span class="remove_this_tag">Any notes, comments, you want to share with the user</span>  
Characteristic diameters is based on percent finer, D<sub>x</sub> (i.e. size such that x percent of the sample is finer than D<sub>x</sub>) can  be computed if requested by the user.
 
If the inputted size distribution does not have a lower bound, D<sub>xL</sub>, such that xL = 0 and an upper bound, D<sub>xU</sub>, such that xU = 100, the program computes these bounds with a linear interpolation of the data using the following equation:
Ψ<sub>b,i-1</sub> = log<sub>2</sub> (D<sub>b,i+1</sub>)+(log<sub>2</sub>(D<sub>b,i</sub>)- log<sub>2</sub>(D<sub>b,i+1</sub>)) (0 - f<sub>f,i+1</sub>)/ (f<sub>f,i</sub> - f<sub>f,i</sub>).
 
Input data may be entered either from the finer to the coarser size or from the coarser to the finer. The program will automatically reorder the data.
 
Data may be on either a 0.00-1.00 scale or a 0-100 scale.  The program will always use a 0-1 scale to do the calculations.


<span class="remove_this_tag">Numerical scheme</span>
The program will prompt users if they want to calculate characteristic diameters based on percent finer, D<sub>x</sub>, and what diameters they would like to know.


The program can calculate up to 10 characteristic diameters based on percent finer.
The geometric mean diameter, D<sub>g</sub>, the geometric standard deviation, σ<sub>g</sub>, and the user-defined characteristic diameters based on percent finer will be appended to a file with the reorganized, scaled, and bounded grain size distribution.


==Examples==
==Examples==
Line 62: Line 203:


<span class="remove_this_tag">Follow the next steps to include images / movies of simulations:</span>
<span class="remove_this_tag">Follow the next steps to include images / movies of simulations:</span>
* <span class="remove_this_tag">Upload file: http://csdms.colorado.edu/wiki/Special:Upload</span>
* <span class="remove_this_tag">Upload file: https://csdms.colorado.edu/wiki/Special:Upload</span>
* <span class="remove_this_tag">Create link to the file on your page: <nowiki>[[Image:<file name>]]</nowiki>.</span>
* <span class="remove_this_tag">Create link to the file on your page: <nowiki>[[Image:<file name>]]</nowiki>.</span>


Line 68: Line 209:


==Developer(s)==
==Developer(s)==
<span class="remove_this_tag">Name of the module developer(s)</span>
[[User:Gparker|Gary Parker ]]
 
==References==
==References==
<span class="remove_this_tag">Key papers</span>
<span class="remove_this_tag">Key papers</span>


==Links==
==Links==
<span class="remove_this_tag">Any link, eg. to the model questionnaire, etc.</span>
* [[Model:GSDCalculator]]


[[Category:Modules]] [[Category:Utility components]]
[[Category:Utility components]]

Latest revision as of 17:18, 19 February 2018

The CSDMS Help System

GSDCalculator

This model is a Grain Size Distribution Statistics Calculator.

Model introduction

This model is used to calculate statistical characteristics of grain size distributions. Given a grain size distribution, the program computes the geometric mean diameter, and the geometric standard deviation.

Model parameters

Parameter Description Unit
Input directory path to input files
Site prefix Site prefix for Input/Output files
Case prefix Case prefix for Input/Output files
Parameter Description Unit
Model name name of the model -
Author name name of the model author -

Uses ports

This will be something that the CSDMS facility will add

Provides ports

This will be something that the CSDMS facility will add

Main equations

  • Linearly interpolated grain size (in Ψ scale)
[math]\displaystyle{ \Psi = \Phi =log_{2}D }[/math] (1)
  • Calculation of Dx
[math]\displaystyle{ \psi_{x} = \phi_{b,i} + {\frac{\psi_{b,i+1} - \psi_{b,i}}{f_{f,i+1} - f_{f,i}}} \left ({\frac{x}{100} - f_{f,i}}\right ) }[/math] (2)
[math]\displaystyle{ D_{x} = 2^ \left (\psi_{x}\right ) }[/math] (3)
  • Calculation of geometric mean size and standard deviation
[math]\displaystyle{ f_{i} = f_{f,i+1} - f_{f,i} }[/math] (4)
[math]\displaystyle{ D_{i} = \left (D_{b,i} - D_{b,i+1}\right )^ \left ({\frac{1}{2}}\right ) }[/math] (5)
[math]\displaystyle{ \psi_{i} = {\frac{1}{2}}\left (\psi_{b,i} - \psi_{b,i+1}\right ) }[/math] (6)
[math]\displaystyle{ \bar{\psi} = \sum\limits_{i=1}^N \psi_{i} f_{i} }[/math] (7)
[math]\displaystyle{ \sigma^2 = \sum\limits_{i=1}^N \left (\psi_{i} - \bar{\psi}\right )^2 f_{i} }[/math] (8)
[math]\displaystyle{ D_{g} = 2^ \left (\bar{\psi}\right ) }[/math] (9)
[math]\displaystyle{ \sigma_{g} = 2^\left (\sigma\right ) }[/math] (10)


Notes

Characteristic diameters is based on percent finer, Dx (i.e. size such that x percent of the sample is finer than Dx) can be computed if requested by the user.

If the inputted size distribution does not have a lower bound, DxL, such that xL = 0 and an upper bound, DxU, such that xU = 100, the program computes these bounds with a linear interpolation of the data using the following equation: Ψb,i-1 = log2 (Db,i+1)+(log2(Db,i)- log2(Db,i+1)) (0 - ff,i+1)/ (ff,i - ff,i).

Input data may be entered either from the finer to the coarser size or from the coarser to the finer. The program will automatically reorder the data.

Data may be on either a 0.00-1.00 scale or a 0-100 scale. The program will always use a 0-1 scale to do the calculations.

The program will prompt users if they want to calculate characteristic diameters based on percent finer, Dx, and what diameters they would like to know.

The program can calculate up to 10 characteristic diameters based on percent finer.

The geometric mean diameter, Dg, the geometric standard deviation, σg, and the user-defined characteristic diameters based on percent finer will be appended to a file with the reorganized, scaled, and bounded grain size distribution.

Examples

An example run with input parameters, BLD files, as well as a figure / movie of the output

Follow the next steps to include images / movies of simulations:

See also: Help:Images or Help:Movies

Developer(s)

Gary Parker

References

Key papers

Links