From 6e72f3430b34f2bf61d8db9962f4c8c48d21fc3c Mon Sep 17 00:00:00 2001 From: Alice Russell <Alice.Russell@tessella.com> Date: Thu, 5 Mar 2020 18:11:10 +0000 Subject: [PATCH] Re #16480 add documentation for UserFunctionMD --- .../fitting/fitfunctions/UserFunctionMD.rst | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/source/fitting/fitfunctions/UserFunctionMD.rst diff --git a/docs/source/fitting/fitfunctions/UserFunctionMD.rst b/docs/source/fitting/fitfunctions/UserFunctionMD.rst new file mode 100644 index 00000000000..b6b58566f76 --- /dev/null +++ b/docs/source/fitting/fitfunctions/UserFunctionMD.rst @@ -0,0 +1,26 @@ +.. _func-UserFunctionMD: + +============== +UserFunctionMD +============== + +.. index:: UserFunctionMD + +Description +----------- + +A UserFunctionMD is the multi-dimensional equivalent of :ref:`UserFunction <func-UserFunction>`. It is defined by a string formula. +The formula is assigned by setting string attribute Formula: + +``Â "name=UserFunctionMD,Formula=a + y + (b + 0.1*y) * x, a=0, b=2"`` + +The fitting parameters become defined only after the Formula attribute is set that is why Formula must +go first in UserFunctionMD definition. + +.. attributes:: + +.. properties:: + +.. categories:: + +.. sourcelink:: \ No newline at end of file -- GitLab