 # Diff of /trunk/base/generic/solver/relman.h

revision 908 by johnpye, Thu Oct 26 10:18:53 2006 UTC revision 909 by johnpye, Thu Oct 26 12:44:41 2006 UTC
# Line 154  extern int relman_diff2(struct rel_relat Line 154  extern int relman_diff2(struct rel_relat
154                          int32 safe);                          int32 safe);
155  /**<  /**<
156      Calculates the row of the jacobian matrix (the transpose gradient of      Calculates the row of the jacobian matrix (the transpose gradient of
157      the relation residual grad^T(f) ) corresponding to the relation      the relation residual, \$ \grad^{T}(f) \$) corresponding to the relation
158      rel.  The filter determines which variables actually contribute to the      rel. The filter determines which variables actually contribute to the
159      jacobian.      jacobian.
160
161      derivative(I) will contain the derivative of the relation with      derivatives[i] will contain the derivative of the relation with
162      respect to the variable whose solver index is stored in      respect to the variable whose solver index is stored in
163      variables(I).      variables[i].

@param safe If nonzero, "safe" functions are used to for
the calculations
164
165        @param rel         Relation being differentiated
166        @param filter      Filter for variables for which derivs are desired
167        @param safe        If nonzero, "safe" functions are used to for the calculations
168      @param derivatives output vector (allocated by the calling function)      @param derivatives output vector (allocated by the calling function)
169      @param variables output vector (allocated by the calling function)      @param variables   output vector (allocated by the calling function)
170      @param count output value, will be set to the number of elements      @param count       output value, will be set to the number of elements assigned upon exit.
assigned upon exit.

171
172      @return 0 on success, 1 if an error is encountered in the calculation      @return 0 on success, non-zero if an error is encountered in the calculation
173  */  */
174