diff options
Diffstat (limited to 'doc/compile.rst')
| -rw-r--r-- | doc/compile.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/compile.rst b/doc/compile.rst new file mode 100644 index 0000000..2a3b4a2 --- /dev/null +++ b/doc/compile.rst @@ -0,0 +1,51 @@ + +.. _compile: + +*************** +Compile Options +*************** + +There are several features that are not active by default, but can be used by defining a compiler flag. These will modify the constructor of :cpp:class:`system`. These can be used in concert when applicable. Note that at the moment, there is no :ref:`finite_states` support for systems with bond or site dependence. + +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 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. + +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 + +.. 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. + + +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&) + +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. + |