Skip to content

Commit

Permalink
update manuals
Browse files Browse the repository at this point in the history
  • Loading branch information
yomichi committed Aug 5, 2024
1 parent 54202f2 commit ca04d94
Show file tree
Hide file tree
Showing 9 changed files with 518 additions and 960 deletions.
Binary file modified doc/basicnotions/images/structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,166 changes: 220 additions & 946 deletions doc/basicnotions/images/structure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/basicnotions/images/structure_post.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
234 changes: 234 additions & 0 deletions doc/basicnotions/images/structure_post.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 28 additions & 8 deletions doc/basicnotions/structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,34 @@ Data flow
---------

**DCore** contains a set of programs which perform dynamical mean-field theory (DMFT) calculations for models and materials.
The structure of programs and data flow is summarized below.
The structure of programs and data flow for the DMFT calculation is summarized below.

.. image:: images/structure.png
:width: 700
:align: center

The DMFT calculation includes two **DCore** programs: (i) ``dcore_pre`` and (ii) ``dcore`` as described later.

After the DMFT loop is finished, one can compute dynamical physical quantities such as the density of states and the momentum-resolved spectrum functions using the post-processing tool.
The structure of the post-processing is shown below.

.. image:: images/structure_post.png
:width: 700
:align: center

The post-processing tool consists of two **DCore** programs: (iii) ``dcore_anacont`` and (iv) ``dcore_spectrum``.

..
**DCore** is a set of DMFT (Dynamical Mean Field Theory) programs which works together with other first-principles calculation packages.
**DCore** supports input hopping parameters in the wannier90 format.
Simple preset models such as a tight-binding model on the Bethe lattice are also available.
After the DMFT loop is finished, one can compute physical quantities such as the density of states and the momentum-resolved spectrum functions using the post-processing tool.
**DCore** consists of three layers: (i) interface layer, (ii) DMFT loop, and (iii) post-processing.
Those are respectively performed by the executables ``dcore_pre``, ``dcore``, and ``dcore_post``.
Input parameters are provided by a single text file, which is read by all the three programs.
Data generated by ``dcore_pre`` and ``dcore`` are severally stored in a file with HDF5 format and passed to the next process.
..
**DCore** consists of three layers: (i) interface layer, (ii) DMFT loop, and (iii) post-processing.
Those are respectively performed by the executables ``dcore_pre``, ``dcore``, and ``dcore_anacont`` and ``dcore_spectrum``.
Input parameters are provided by a single text file, which is read by all the three programs.
Data generated by ``dcore_pre`` and ``dcore`` are severally stored in a file with HDF5 format and passed to the next process.

(i) The interface layer ``dcore_pre``
Expand Down Expand Up @@ -64,10 +76,18 @@ The hopping parameters are given either for **preset models** (e.g., square latt
The effective impurity problem is solved repeatedly to fulfill the self-consistency condition of the DMFT.
For solving the impurity problem, ``dcore`` calls an external program such as the continuous-time quantum Monte Carlo method and the Hubbard-I approximation.

(iii) Post-processing ``dcore_post``
------------------------------------
(iii) Analytical continuation ``dcore_anacont``
---------------------------------------------------

The DMFT loop provides the self-energy in the Matsubara frequency domain.
To obtain physical quantities in the real frequency domain, we need to perform the analytical continuation (AC).
``dcore_anacont`` performs the analytical continuation using the Pade approximation or the SpM method.
Note that users can perform AC by using an external program.

(iv) Spectrum calculation ``dcore_spectrum``
---------------------------------------------------

``dcore_post`` computes some physical quantities from the converged solution of the DMFT loop.
``dcore_spectrum`` computes some physical quantities from the converged solution of the DMFT loop.
Currently, the following quantities can be calculated:

* (projected) density of states
Expand Down
28 changes: 28 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,31 @@
# overwrite css of html_theme
def setup(app):
app.add_css_file('dcore.css')



latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'dcore.tex', u'DCore Documentation',
u'DCore developers', 'manual', 'True'),
]
2 changes: 1 addition & 1 deletion doc/impuritysolvers/null.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ Note that, since self-energy is zero, one should introduce an artificial broaden

::

[tool]
[post.spectrum]
broadening = 0.001
4 changes: 3 additions & 1 deletion doc/impuritysolvers/pomerol/dmft_square_pomerol.ini
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ sigma_mix = 0.5
time_reversal = True
converge_tol = 1e-5

[tool]
[post.spectrum]
broadening = 0.4
knode = [(G,0.0,0.0,0.0),(X,0.5,0.0,0.0),(M,0.5,0.5,0.0),(G,0.0,0.0,0.0)]
nk_line = 100

[post.anacont]
omega_max =6.0
omega_min =-5.0
Nomega = 400
8 changes: 4 additions & 4 deletions doc/impuritysolvers/triqs_cthyb/cthyb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The original input file (without tail-fit) is as follows (dmft.ini):
[control]
max_step = 1
[tool]
[post.check]
omega_check = 30.0
We first execute the ordinary DMFT calculation:
Expand Down Expand Up @@ -221,10 +221,10 @@ Pade approximation for DOS and spectrum function
To obtain spectral functions, we need to perform analytical continuation from Matsubara frequency to real frequency.
Currently, the Pade approximation is the only choice for the analytical continuation.
There is one control parameter for Pade approximation, ``omega_pade`` in the ``[tool]`` block. It specifies an energy cutoff for Matsubara frequency.
A reasonable choice of ``omega_pade`` is the maximum frequency
There is one control parameter for Pade approximation, ``iomega_max`` in the ``[post.anacont.pade]`` block. It specifies an energy cutoff for Matsubara frequency.
A reasonable choice of ``iomega_max`` is the maximum frequency
before the self energy becomes noisy.
For example, in the case of figure (a) above, we can find that ``omega_pade=4.0`` is reasonable.
For example, in the case of figure (a) above, we can find that ``iomega_max=4.0`` is reasonable.
Legendre filter
---------------
Expand Down

0 comments on commit ca04d94

Please sign in to comment.