diff options
Diffstat (limited to 'doc/system.rst')
| -rw-r--r-- | doc/system.rst | 76 |
1 files changed, 47 insertions, 29 deletions
diff --git a/doc/system.rst b/doc/system.rst index 1751e2b..cb78a6d 100644 --- a/doc/system.rst +++ b/doc/system.rst @@ -1,61 +1,79 @@ +.. default-domain:: cpp + ************************************* Constructing a System & Running Wolff ************************************* -The core of the library lies in the :cpp:class:`system` class and its member functions. Here, the state of your model is stored and cluster flip Monte Carlo can be carried out in various ways. +This class and associated member functions are defined in the header files :file:`wolff.hpp`, :file:`wolff/system.hpp`, and :file:`wolff/cluster.hpp`. -Note that the member objects and functions described here will change when compiled with certain compiler flags active, as described in :ref:`compile`. +.. class:: template\<R_t, X_t> system -.. cpp:class:: template\<class R_t, class X_t> system + The core of the library lies in the :class:`system` class and its member functions. Here, the state of your model is stored and cluster flip Monte Carlo can be carried out in various ways. -Member Objects -============== + Note that the member objects and functions described here will change when compiled with certain compiler flags active, as described in :ref:`compile`. -.. cpp:member:: v_t system::nv + .. member:: v_t system::nv - Stores the number of ordinary sites in the model. + Stores the number of ordinary sites in the model. -.. cpp:member:: v_t system::ne + .. member:: v_t system::ne - Stores the number of ordinary bonds in the model. + Stores the number of ordinary bonds in the model. -.. cpp:member:: graph system::G + .. member:: graph system::G - Stores the graph describing the lattice, including the ghost site. + Stores the graph describing the lattice, including the ghost site. -.. cpp:member:: double system::T + .. member:: double system::T - Stores the temperature of the model. + Stores the temperature of the model. -.. cpp:member:: std::vector<X_t> system::s + .. member:: std::vector<X_t> system::s - The :math:`i\text{th}` component stores the spin state of site :math:`i`. + The :math:`i\text{th}` component stores the spin state of site :math:`i`. -.. cpp:member:: R_t system::s0 + .. member:: R_t system::s0 - Stores the state of the ghost site. + Stores the state of the ghost site. -.. cpp:member:: std::function <double(const X_t&, const X_t&)> system::Z + .. member:: std::function <double(const X_t&, const X_t&)> system::Z - The function that returns the coupling between neighboring sites. + The function that returns the coupling between neighboring sites. -.. cpp:member:: std::function <double(const X_t&)> system::B + .. member:: std::function <double(const X_t&)> system::B - The function that returns the coupling to the field. + The function that returns the coupling to the field. -Member Functions -================ + .. function:: system::system(graph G, double T, std::function <double(const X_t&, const X_t&)> Z, std::function <double(const X_t&)> B) -.. cpp:function:: system::system(graph G, double T, std::function <double(const X_t&, const X_t&)> Z, std::function <double(const X_t&)> B) + The constructor for systems. + + :param graph G: A lattice graph *without* the ghost spin added. + :param double T: The temperature. + :param std\:\:function<double(const X_t&, const X_t&)> Z: The bond coupling. + :param std\:\:function<double(const X_t&)> B: The field coupling. + + The states of the spins and ghost site are initialized using the default constructors for :type:`X_t` and :type:`R_t`, respectively. :any:`nv` and :any:`ne` are taken directly from :any:`G`, after which the ghost site is added to :any:`G`. - The constructor for systems. The arguments given are a graph :cpp:any:`G` *without* the ghost spin added, the temperature :cpp:any:`T`, and the coupling functions :cpp:any:`Z` and :cpp:any:`B`. The states of the spins and ghost site are initialized using the default constructors for :cpp:type:`X_t` and :cpp:type:`R_t`, respectively. :cpp:any:`nv` and :cpp:any:`ne` are taken directly from :cpp:any:`G`, after which the ghost site is added to :cpp:any:`G`. + .. function:: system::flip_cluster(v_t i0, const R_t& r, std::mt19937& rng, measurement<R_t, X_t>& A, double x = 1.0) -.. cpp:function:: system::flip_cluster(v_t i0, const R_t& r, std::mt19937& rng, measurement<R_t, X_t>& A) + Performs one Wolff cluster flip to the system. + + :param v_t i0: The index of the seed site. + :param const R_t& r: The transformation by which the cluster is flipped. + :param std\:\:mt19937& rng: A random number generator. + :param measurement<R_t, X_t>& A: Object whose class inherits :class:`measurement` and provides relevant measurement hooks. + :param double x = 1.0: Optional argument. When assigned, changes the bond activation probability to :math:`p=1-xe^{-\beta\Delta\mathcal H}`. - Performs one Wolff cluster flip to the system. The cluster is seeded at vertex :cpp:any:`i0` and the spins added are transformed by :cpp:any:`r`. A random number generator :cpp:any:`rng` provides required random numbers during, and the relevant measurement hooks defined in the inherited class of :cpp:any:`A` are run during the cluster formation. + .. function:: system::run_wolff(N_t N, std::function <R_t(std::mt19937&, const system<R_t, X_t>&, v_t)> r_gen, measurement<R_t, X_t>& A, std::mt19937& rng, double x = 1.0) -.. cpp:function:: system::run_wolff(N_t N, std::function <R_t(std::mt19937&, const system<R_t, X_t>&, v_t)> r_gen, measurement<R_t, X_t>& A, std::mt19937& rng) + Performs :any:`N` Wolff cluster flips to the system. + + :param N_t N: Number of clusters to flip. + :param std\:\:function <R_t(std\:\:mt19937&, const system<R_t, X_t>&, v_t>)> r_gen: Generator of transformations for the cluster flips. + :param measurement<R_t, X_t>& A: Object whose class inherits :class:`measurement` and provides relevant measurement hooks. + :param std\:\:mt19937& rng: A random number generator. + :param double x = 1.0: Optional argument. When assigned, changes the bond activation probability to :math:`p=1-xe^{-\beta\Delta\mathcal H}`. - Performs :cpp:any:`N` Wolff cluster flips to the system. One must provide a function :cpp:func:`r_gen` that takes a random number generator, the system state, and the index of the seed site and returns a transformation for each flip. Also required are an object from a class which inherits :cpp:class:`measurement` to run measurements, and a random number generator :cpp:any:`rng`. |