mirror of
https://github.com/triqs/dft_tools
synced 2024-12-26 14:23:38 +01:00
bdac3e159c
- little details : code cleaning, clang formatting, along with documentation writing for c++ gf. - separated the mesh in small class for better doc. - work on documentation : reorganize specialisation, ...
67 lines
1.4 KiB
ReStructuredText
67 lines
1.4 KiB
ReStructuredText
.. highlight:: c
|
|
|
|
.. _gf_legendre:
|
|
|
|
Legendre representation
|
|
==========================================================
|
|
|
|
This is a specialisation of :ref:`gf<gf_and_view>` for Legendre polynomial expansion.
|
|
|
|
Synopsis
|
|
------------
|
|
|
|
.. code::
|
|
|
|
gf<legendre, Target, Opt>
|
|
|
|
The *Target* template parameter can take the following values :
|
|
|
|
+-------------------------+-----------------------------------------------------+
|
|
| Target | Meaning |
|
|
+=========================+=====================================================+
|
|
| scalar_valued | The function is scalar valued (double, complex...). |
|
|
+-------------------------+-----------------------------------------------------+
|
|
| matrix_valued [default] | The function is matrix valued. |
|
|
+-------------------------+-----------------------------------------------------+
|
|
|
|
Domain & mesh
|
|
----------------
|
|
|
|
TO BE WRITTEN
|
|
|
|
Singularity
|
|
-------------
|
|
|
|
None
|
|
|
|
|
|
Evaluation method
|
|
---------------------
|
|
|
|
TO BE WRITTEN
|
|
|
|
Data storage
|
|
---------------
|
|
|
|
TO BE WRITTEN
|
|
|
|
HDF5 storage convention
|
|
---------------------------
|
|
|
|
h5 tag : `Legendre`
|
|
|
|
Examples
|
|
---------
|
|
|
|
.. compileblock::
|
|
|
|
#include <triqs/gfs.hpp>
|
|
using namespace triqs::gfs;
|
|
|
|
int main() {
|
|
// We want a 2x2 matrix valued function on this mesh...
|
|
//auto g = gf<legendre> { {wmin, wmax, n_freq}, {2,2} };
|
|
};
|
|
|
|
|