diff options
| author | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 11:05:06 -0400 |
|---|---|---|
| committer | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 11:05:06 -0400 |
| commit | c41db143c477b627c8c690b621f7bb514e08bbbf (patch) | |
| tree | ca0eb942e7828189d795226ebe89aa41487db748 /doc/models.rst | |
| parent | 6e2bb4738bf5df9c0552c6fdc25743c91e45ebe9 (diff) | |
| download | c++-c41db143c477b627c8c690b621f7bb514e08bbbf.tar.gz c++-c41db143c477b627c8c690b621f7bb514e08bbbf.tar.bz2 c++-c41db143c477b627c8c690b621f7bb514e08bbbf.zip | |
polished up the documentation
Diffstat (limited to 'doc/models.rst')
| -rw-r--r-- | doc/models.rst | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/models.rst b/doc/models.rst index aa80ee6..e376e2e 100644 --- a/doc/models.rst +++ b/doc/models.rst @@ -3,8 +3,8 @@ Defining a Model **************** -To define your own model, you need a class for spin states, a class for spin transformations, a bond and site coupling, and a generator of transformations. - +To define your own model, you need a class for spin states, a class for spin transformations, a bond and site coupling, and a generator of transformations. Many examples of models can be found in the headers contained in :file:`wolff/models/`. + Spin States =========== @@ -23,18 +23,30 @@ Transformations The action of the transformation on a spin, returning the transformed spin. + :param const X_t&: The spin state to transform. + :returns: The transformed spin state. + .. cpp:function:: R_t act(const R_t&) The action of the transformation on another transformation, returning the transformed transformation. + :param const R_t&: The transformation state to transform. + :returns: The transformed spin state. + .. cpp:function:: X_t act_inverse(const X_t&) The action of the inverse transformation on a spin, returning the transformed spin. + :param const X_t&: The spin state to transform. + :returns: The transformed spin state. + .. cpp:function:: R_t act_inverse(const R_t&) The action of the inverse transformation on another transformation, returning the transformed transformation. + :param const R_t&: The transformation state to transform. + :returns: The transformed spin state. + Couplings ========= |