3
0
mirror of https://github.com/triqs/dft_tools synced 2024-12-27 06:43:40 +01:00
dft_tools/doc/reference/gfs/c++/gf_retime.rst
tayral edd1ff4529 Restructuring documentation.
A first general restructuration of the doc according to the pattern [tour|tutorial|reference].
In the reference part, objects are documented per topic.
In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-18 12:21:08 +01:00

85 lines
2.0 KiB
ReStructuredText

.. highlight:: c
.. _gf_retime:
Real time
===================================================
This is a specialisation of :ref:`gf_and_view` for imaginary Matsubara frequencies.
Synopsis
------------
.. code::
gf<retime, 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
----------------
CORRECT THIS !! PUT OUT THE C++ impl for doxy doc
The domain is :doxy:`matsubara_freq_domain<triqs::gfs::matsubara_domain>`.
The mesh is :doxy:`matsubara_freq_mesh<triqs::gfs::matsubara_freq_mesh>`.
Singularity
-------------
The singularity is a high frequency expansion, :ref:`gf_tail`.
Evaluation method
---------------------
* Linear interpolation on the mesh.
* Return type:
* If Target==scalar_valued: a complex
* If Target==matrix_valued: an object modeling ImmutableMatrix concept.
* When the point is outside of the mesh, the evaluation of the gf returns:
* the evaluation of the high frequency tail if no_tail is not set.
* 0 otherwise
Data storage
---------------
* If Target==scalar_valued :
* `data_t`: 1d array of complex<double>.
* g.data()(i) is the value of g for the i-th point of the mesh.
* If Target==matrix_valued :
* `data_t`: 3d array (C ordered) of complex<double>.
* g.data()(i, range(), range()) is the value of g for the i-th point of the mesh.
HDF5 storage convention
---------------------------
h5 tag: `ReTime`
Examples
---------
.. triqs_example:: ./gf_retime_0.cpp