|
19 | 19 |
|
20 | 20 |
|
21 | 21 | <link rel="icon" href="images/gsas2.png"> |
22 | | - <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6"> |
| 22 | + <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7"> |
23 | 23 |
|
24 | 24 |
|
25 | 25 |
|
26 | 26 | <title>Universal items - GSAS-II Help</title> |
27 | 27 |
|
28 | 28 |
|
29 | 29 |
|
30 | | - <link rel="stylesheet" href="assets/stylesheets/main.484c7ddc.min.css"> |
| 30 | + <link rel="stylesheet" href="assets/stylesheets/main.ec1eaa64.min.css"> |
31 | 31 |
|
32 | 32 |
|
33 | 33 |
|
@@ -1959,6 +1959,44 @@ <H3 style="color:blue;font-size:1.1em">What can I do here?</H3> |
1959 | 1959 | <li><strong>Add constraint</strong> - If selected, a dialog box will appear with a list of the available parameters. Select one and press OK; a second dialog box will appear with only those parameters that can be used in a constraint with the first one. Choose those and press OK. Cancel in either dialog will cancel the operation. The equivalenced parameters will show as an equation of the form <span class="arithmatex">\(M1*P1+M2*P2+…=C\)</span>; the multipliers M1, M2, … and C can be changed via the 'Edit' button. The equation is shown in the window tagged by 'CONSTR' to mark it as a constraint equation assignment.</li> |
1960 | 1960 | <li><strong>Add New Var</strong> - This behaves very much like the "Add constraint" menu command except that it defines a new parameter rather than define a value for the expression. That new var parameter can optionally have a named assigned. The expression is displayed with the keyword 'New Var' to mark its type. Note that a 'Refine?' box is included for this type of constraint.</li> |
1961 | 1961 | <li><strong>Make atoms equivalent</strong> - This provides a shortcut for establishing constraints when two share a single site. Coordinates and Uiso values are constrained to be the same and site fractions are constrained to add to 1.</li> |
| 1962 | +<li><strong>Make atoms equivalent</strong> - This provides a shortcut for establishing constraints</li> |
| 1963 | +<li><strong>Export constraints</strong> - This writes the current constraints (Histogram, |
| 1964 | + Phase and HAP) to a text file that can be used with the <strong>Import constraints</strong> |
| 1965 | + command (see below) to copy the constraints to another GSAS-II project. |
| 1966 | + The file extension for this is usually <code>.constr</code>.</li> |
| 1967 | +<li> |
| 1968 | +<p><strong>Import constraints</strong> - This reads a text file and adds the constraints into the |
| 1969 | + current GSAS-II project. The type of contraint (Histogram vs. Phase vs. HAP) is |
| 1970 | + determined from the variable name. |
| 1971 | + This can be used to copy constraints from one file to another or may be used |
| 1972 | + to generate a large number of constraints rather than using the GUI. It may be |
| 1973 | + useful to generate and export a small number of constraints as a template |
| 1974 | + and then use a text editor or script to generate what is needed. </p> |
| 1975 | +<p>The format for the file consists of a tag ("Equation", "Hold", "Equivalence" |
| 1976 | +or "NewVar") followed by a "&" spacer and then |
| 1977 | +the constraint. |
| 1978 | +The file extension for this is usually <code>.constr</code>. |
| 1979 | +Examples are below. </p> |
| 1980 | +<p>Note that any line beginning with a "#" will be ignored as a comment. |
| 1981 | +Note that Equations are of form: <code>m1 * v1 + m2 * v2 + ... = m0</code>, and |
| 1982 | +Holds are simply a variable name. Equivalences are in form: <code>m1 * v1 = m2 * v2 = ...</code>. |
| 1983 | +NewVar constraints are of form <code>m1 * v1 + m2 * v2 + ...</code></p> |
| 1984 | +<p>There are other two variations for NewVar constraints. |
| 1985 | +If the NewVar constraint is named, or to specifiy that the variable should be |
| 1986 | +refined (the two forms can be combined), use one of the subsequent examples. </p> |
| 1987 | +</li> |
| 1988 | +</ul> |
| 1989 | +<pre><code> # Constraints from 4constr.gpx on 2026-08-11T20:50 |
| 1990 | + Equation & 1.0 * 0:0:Scale + 1.0 * 1:0:Scale = 1.0 |
| 1991 | + Hold & 0::dAz:2 |
| 1992 | + Equivalence & 1.0 * 1::AUiso:0 = 1.0 * 1::AUiso:1 |
| 1993 | + NewVar & 1.0 * 0::Afrac:0 + 1.0 * 0::Afrac:1 |
| 1994 | +</code></pre> |
| 1995 | +<pre><code> NewVar & variable-name & 1.0 * 0::Afrac:0 + 1.0 * 0::Afrac:1 |
| 1996 | +</code></pre> |
| 1997 | +<pre><code> NewVar & 1.0 * 0::Afrac:0 + 1.0 * 0::Afrac:1 & varied |
| 1998 | +</code></pre> |
| 1999 | +<ul> |
1962 | 2000 | <li><strong>Show New Var modes</strong> – When New Var constraints are present, this opens a window that shows the effect of the constraints to be seen. This is of particular value when representational analysis generated normal modes have been read from a CIF created with ISODISTORT. From the created window, the New Var parameters can be changed and the changes that the constraints make to the linked dependent parameters are shown. When this command is used from a Phase "Draw Atoms" tab rather than here, the structure plot is updated. The changes made here are temporary, unless the Save button is used to close the window. </li> |
1963 | 2001 | </ul> |
1964 | 2002 | <p>In addition to menu commands, this window also offer the following actions by pressing buttons:</p> |
@@ -2169,7 +2207,7 @@ <H3 style="color:blue;font-size:1.1em">What can I do here?</H3> |
2169 | 2207 | <script id="__config" type="application/json">{"annotate": null, "base": ".", "features": [], "search": "assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> |
2170 | 2208 |
|
2171 | 2209 |
|
2172 | | - <script src="assets/javascripts/bundle.79ae519e.min.js"></script> |
| 2210 | + <script src="assets/javascripts/bundle.d7400e89.min.js"></script> |
2173 | 2211 |
|
2174 | 2212 | <script src="javascripts/mathjax.js"></script> |
2175 | 2213 |
|
|
0 commit comments