Changeset 3713 for trunk/GSASIImapvars.py

Timestamp:

Oct 30, 2018 11:53:13 PM (5 years ago)

Author:

toby

Message:

constraint bug fix; comments

File:

• trunk/GSASIImapvars.py (modified) (4 diffs)

trunk/GSASIImapvars.py

@@ -49 +49 @@
 to the start of the refinement. In a formula, GSAS-II parameters will be replaced by the 
 value of the parameter before the formula is evaluated, so ``'np.cos(0::Ax:2)'`` is a valid 
-multiplier. 
+multiplier. At present, only phase (atom/cell) parameters are available for use in 
+a formula, but this can be expanded if needed. 
 
 This type of constraint describes an alternate 
@@ -77 +78 @@
 to the start of the refinement. In a formula, GSAS-II parameters will be replaced by the 
 value of the parameter before the formula is evaluated, so ``'np.cos(0::Ax:2)'`` is a valid 
-multiplier. 
+multiplier. At present, only phase (atom/cell) parameters are available for use in 
+a formula, but this can be expanded if needed. 
 
 These equations set an interdependence between variables. 
@@ -107 +109 @@
 the refinement. In a formula, GSAS-II parameters will be replaced by the value of the
 parameter before the formula is evaluate, so ``'np.cos(0::Ax:2)'`` is a valid multiplier. 
-
+At present, only phase (atom/cell) parameters are available for use in 
+a formula, but this can be expanded if needed. 
 Note that 
 the latter constraint expression is conceptually identical to 
@@ -437 +440 @@
 
 :func:`EvaluateMultipliers`
-   Convert any string-specified multipliers to numbers. Call this before 
+   Convert any string-specified (formula-based) multipliers to numbers. Call this before 
    using :func:`CheckConstraints` or :func:`GenerateConstraints`. 
+   At present, the code may pass only the dict for phase (atom/cell) parameters, 
+   but this could be expanded if needed. 
 
 :func:`Map2Dict`