diff options
Diffstat (limited to 'doc/compile.rst')
| -rw-r--r-- | doc/compile.rst | 26 |
1 files changed, 6 insertions, 20 deletions
diff --git a/doc/compile.rst b/doc/compile.rst index 2a3b4a2..e4960a3 100644 --- a/doc/compile.rst +++ b/doc/compile.rst @@ -12,28 +12,18 @@ Building Without A Field .. c:macro:: WOLFF_NO_FIELD -When this flag is defined Wolff will not use a field. When a field isn't necessary, this will improve performance: no ghost site will be initialize and no time will be wasted checking the energy change with respect to a uncoupled ghost site. + When this flag is defined Wolff will not use a field. When a field isn't necessary, this will improve performance: no ghost site will be initialize and no time will be wasted checking the energy change with respect to a uncoupled ghost site. -When defined, the constructor for :cpp:class:`system` becomes - -.. cpp:namespace:: cflags - -.. cpp:function:: system(graph, double, std::function <double(const X_t&, const X_t&)>) - -The resulting :cpp:class:`system` object does not have member objects :cpp:member:`B` or :cpp:member:`s0`, and :cpp:member:`system::G` does not have a ghost site initialized. + When defined, the constructor for :cpp:class:`system` becomes :cpp:any:`system(graph, double, std::function <double(const X_t&, const X_t&)>)`. The resulting :cpp:class:`system` object does not have member objects :cpp:any:`B` or :cpp:member:`s0`, and :cpp:member:`system::G` does not have a ghost site initialized. Building With Bond Dependence ============================= .. c:macro:: WOLFF_BOND_DEPENDENCE -When this flag is defined Wolff will ask for the indices of the spins on each side a bond, allowing the implementation of random bonds or anisotropic interactions. - -When defined, the bond coupling must be a function of the form + When this flag is defined Wolff will ask for the indices of the spins on each side a bond, allowing the implementation of random bonds or anisotropic interactions. -.. cpp:function:: double Z(v_t, const X_t&, v_t, const X_t&) - -where the first argument is the index of the first spin and the third argument is the index of the second spin. A function of this type is passed to :cpp:class:`system` in place of the original bond coupling. + When defined, the bond coupling must be a function of the form :cpp:any:`double Z(v_t, const X_t&, v_t, const X_t&)`, where the first argument is the index of the first spin and the third argument is the index of the second spin. A function of this type is passed to :cpp:class:`system` in place of the original bond coupling. Building With Site Dependence @@ -41,11 +31,7 @@ Building With Site Dependence .. c:macro:: WOLFF_SITE_DEPENDENCE -When this flag is defined Wolff will ask for the indices of the spin when measuring the external field, allowing the implementation of random fields or to emulate boundaries. - -When defined, the field coupling must be a function of the form - -.. cpp:function:: double B(v_t, const X_t&) + When this flag is defined Wolff will ask for the indices of the spin when measuring the external field, allowing the implementation of random fields or to emulate boundaries. -where the first argument is the index of the spin. A function of this type is passed to :cpp:class:`system` in place of the original field coupling. + When defined, the field coupling must be a function of the form :cpp:any:`double B(v_t, const X_t&)`, where the first argument is the index of the spin. A function of this type is passed to :cpp:class:`system` in place of the original field coupling. |