Skip to content

Commit

Permalink
build based on 10a63ae
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 29, 2024
1 parent 20fc4d9 commit 7322479
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-10-29T07:21:08","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-10-29T14:59:17","documenter_version":"1.7.0"}}
6 changes: 3 additions & 3 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
in_pol [= AllPol()]
out_spin [= AllSpin()]
out_pol [= AllPol()]
)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/3b3d994f059f9c755b7839697bdc2fb76981f759/src/processes/one_photon_compton/process.jl#L1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDprocesses.ScatteringProcess" href="#QEDprocesses.ScatteringProcess"><code>QEDprocesses.ScatteringProcess</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ScatteringProcess &lt;: AbstractProcessDefinition</code></pre><p>Generic implementation for scattering processes of arbitrary particles. Currently, only calculations in combination with <code>PerturbativeQED</code> are supported. However, this is supposed to describe scattering processes with any number of incoming and outgoing particles, and any combination of spins or polarizations for the particles.</p><p>The <a href="#QEDprocesses.isphysical-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}"><code>isphysical</code></a> function can be used to check whether the process is possible in perturbative QED.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The computation of cross sections and probabilities is currently unimplemented.</p></div></div><p><strong>Constructors</strong></p><pre><code class="nohighlight hljs">ScatteringProcess(
)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/10a63aed2301e7adc6548b69bb92140511dfc6c3/src/processes/one_photon_compton/process.jl#L1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDprocesses.ScatteringProcess" href="#QEDprocesses.ScatteringProcess"><code>QEDprocesses.ScatteringProcess</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ScatteringProcess &lt;: AbstractProcessDefinition</code></pre><p>Generic implementation for scattering processes of arbitrary particles. Currently, only calculations in combination with <code>PerturbativeQED</code> are supported. However, this is supposed to describe scattering processes with any number of incoming and outgoing particles, and any combination of spins or polarizations for the particles.</p><p>The <a href="#QEDprocesses.isphysical-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}"><code>isphysical</code></a> function can be used to check whether the process is possible in perturbative QED.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>The computation of cross sections and probabilities is currently unimplemented.</p></div></div><p><strong>Constructors</strong></p><pre><code class="nohighlight hljs">ScatteringProcess(
in_particles::Tuple{AbstractParticleType},
out_particles::Tuple{AbstractParticleType},
[in_sp::Tuple{AbstractSpinOrPolarization},
out_sp::Tuple{AbstractSpinOrPolarization}]
)</code></pre><p>Constructor for a ScatteringProcess with the given incoming and outgoing particles and their respective spins and pols. The constructor asserts that the particles are compatible with their respective spins and polarizations. If the assertion fails, an <code>InvalidInputError</code> is thrown.</p><p>The <code>in_sp</code> and <code>out_sp</code> parameters can be omitted in which case all spins and polarizations will be set to <code>AllSpin</code> and <code>AllPol</code> for every fermion and boson, respectively.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/3b3d994f059f9c755b7839697bdc2fb76981f759/src/processes/generic_process/process.jl#L1-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDbase._averaging_norm-Tuple{Compton}" href="#QEDbase._averaging_norm-Tuple{Compton}"><code>QEDbase._averaging_norm</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">_averaging_norm(proc::Compton)</code></pre><div class="admonition is-info"><header class="admonition-header">Convention</header><div class="admonition-body"><p>We average over the initial spins and pols, and sum over final.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/3b3d994f059f9c755b7839697bdc2fb76981f759/src/processes/one_photon_compton/perturbative/cross_section.jl#L16-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDbase.in_phase_space_dimension-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}" href="#QEDbase.in_phase_space_dimension-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}"><code>QEDbase.in_phase_space_dimension</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">in_phase_space_dimension(proc::AbstractProcessDefinition, ::PerturbativeQED)</code></pre><p>Return the number of degrees of freedom to determine the incoming phase space for processes in PerturbativeQED. </p><div class="admonition is-info"><header class="admonition-header">Convention</header><div class="admonition-body"><p>The current implementation only supports the case where two of the incoming particles collide head-on. </p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/3b3d994f059f9c755b7839697bdc2fb76981f759/src/models/perturbative_qed.jl#L6-L14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDprocesses._base_component_type-Union{Tuple{AbstractArray{LV}}, Tuple{LV}} where LV&lt;:QEDbase.AbstractLorentzVector" href="#QEDprocesses._base_component_type-Union{Tuple{AbstractArray{LV}}, Tuple{LV}} where LV&lt;:QEDbase.AbstractLorentzVector"><code>QEDprocesses._base_component_type</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">_base_component_type(array_of_lv::AbstractArray{LV}) where {LV&lt;:AbstractLorentzVector}</code></pre><p>Return the type of the components of given Lorentz vectors, which are by themself elements of an <code>AbstractArray</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia&gt; using QEDbase
)</code></pre><p>Constructor for a ScatteringProcess with the given incoming and outgoing particles and their respective spins and pols. The constructor asserts that the particles are compatible with their respective spins and polarizations. If the assertion fails, an <code>InvalidInputError</code> is thrown.</p><p>The <code>in_sp</code> and <code>out_sp</code> parameters can be omitted in which case all spins and polarizations will be set to <code>AllSpin</code> and <code>AllPol</code> for every fermion and boson, respectively.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/10a63aed2301e7adc6548b69bb92140511dfc6c3/src/processes/generic_process/process.jl#L1-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDbase._averaging_norm-Tuple{Compton}" href="#QEDbase._averaging_norm-Tuple{Compton}"><code>QEDbase._averaging_norm</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">_averaging_norm(proc::Compton)</code></pre><div class="admonition is-info"><header class="admonition-header">Convention</header><div class="admonition-body"><p>We average over the initial spins and pols, and sum over final.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/10a63aed2301e7adc6548b69bb92140511dfc6c3/src/processes/one_photon_compton/perturbative/cross_section.jl#L16-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDbase.in_phase_space_dimension-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}" href="#QEDbase.in_phase_space_dimension-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}"><code>QEDbase.in_phase_space_dimension</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">in_phase_space_dimension(proc::AbstractProcessDefinition, ::PerturbativeQED)</code></pre><p>Return the number of degrees of freedom to determine the incoming phase space for processes in PerturbativeQED. </p><div class="admonition is-info"><header class="admonition-header">Convention</header><div class="admonition-body"><p>The current implementation only supports the case where two of the incoming particles collide head-on. </p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/10a63aed2301e7adc6548b69bb92140511dfc6c3/src/models/perturbative_qed.jl#L6-L14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDprocesses._base_component_type-Union{Tuple{AbstractArray{LV}}, Tuple{LV}} where LV&lt;:QEDbase.AbstractLorentzVector" href="#QEDprocesses._base_component_type-Union{Tuple{AbstractArray{LV}}, Tuple{LV}} where LV&lt;:QEDbase.AbstractLorentzVector"><code>QEDprocesses._base_component_type</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">_base_component_type(array_of_lv::AbstractArray{LV}) where {LV&lt;:AbstractLorentzVector}</code></pre><p>Return the type of the components of given Lorentz vectors, which are by themself elements of an <code>AbstractArray</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia&gt; using QEDbase
julia&gt; using QEDprocesses
julia&gt; v = Vector{SFourMomentum}(undef,10)
julia&gt; QEDprocesses._base_component_type(v)
Float64</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/3b3d994f059f9c755b7839697bdc2fb76981f759/src/utils.jl#L7-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDprocesses.isphysical-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}" href="#QEDprocesses.isphysical-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}"><code>QEDprocesses.isphysical</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isphysical(proc::AbstractProcessDefinition, model::PerturbativeQED)</code></pre><p>A utility function that returns whether a given <code>AbstractProcessDefinition</code> conserves the number and charge of fermions and has at least 2 participating particles.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/3b3d994f059f9c755b7839697bdc2fb76981f759/src/models/perturbative_qed.jl#L32-L36">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 29 October 2024 07:21">Tuesday 29 October 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Float64</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/10a63aed2301e7adc6548b69bb92140511dfc6c3/src/utils.jl#L7-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QEDprocesses.isphysical-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}" href="#QEDprocesses.isphysical-Tuple{QEDbase.AbstractProcessDefinition, PerturbativeQED}"><code>QEDprocesses.isphysical</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">isphysical(proc::AbstractProcessDefinition, model::PerturbativeQED)</code></pre><p>A utility function that returns whether a given <code>AbstractProcessDefinition</code> conserves the number and charge of fermions and has at least 2 participating particles.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QEDjl-project/QEDprocesses.jl/blob/10a63aed2301e7adc6548b69bb92140511dfc6c3/src/models/perturbative_qed.jl#L32-L36">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 29 October 2024 14:59">Tuesday 29 October 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified dev/objects.inv
View file
Binary file not shown.

0 comments on commit 7322479

Please sign in to comment.