-<!DOCTYPE html><HTML lang="en"><head><script charset="utf-8" src="../../../assets/default/multidoc_injector.js" type="text/javascript"></script><script charset="utf-8" type="text/javascript">window.MULTIDOCUMENTER_ROOT_PATH = '/'</script><script charset="utf-8" src="../../../assets/default/flexsearch.bundle.js" type="text/javascript"></script><script charset="utf-8" src="../../../assets/default/flexsearch_integration.js" type="text/javascript"></script><meta charset="UTF-8"/><meta content="width=device-width, initial-scale=1.0" name="viewport"/><title>Distributions · GEMPIC</title><script data-outdated-warner="" src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script data-main="../assets/documenter.js" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" data-theme-name="documenter-dark" data-theme-primary-dark="" href="../assets/themes/documenter-dark.css" rel="stylesheet" type="text/css"/><link class="docs-theme-link" data-theme-name="documenter-light" data-theme-primary="" href="../assets/themes/documenter-light.css" rel="stylesheet" type="text/css"/><script src="../assets/themeswap.js"></script><link href="nothing/gempic/stable/distributions/" rel="canonical"/><link href="../../../assets/default/multidoc.css" rel="stylesheet" type="text/css"/><link href="../../../assets/default/flexsearch.css" rel="stylesheet" type="text/css"/></head><body><nav id="multi-page-nav"><div class="hidden-on-mobile" id="nav-items"><a class="nav-link active nav-item" href="../../">GEMPIC</a><a class="nav-link nav-item" href="../../../semi-lagrangian/">SemiLagrangian</a><a class="nav-link nav-item" href="../../../vlasov-solvers/">VlasovSolvers</a><a class="nav-link nav-item" href="../../../scalar-spin/">SpinGEMPIC</a><a class="nav-link nav-item" href="../../../vector-spin/">VectorSpin</a><div class="search nav-item"><input id="search-input" placeholder="Search..."/><ul class="suggestions hidden" id="search-result-container"></ul><div class="search-keybinding">/</div></div></div><button id="multidoc-toggler"><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"></path></svg></button></nav><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">GEMPIC</a></span></div><form action="../search/" class="docs-search"><input class="docs-search-query" id="documenter-search-query" name="q" placeholder="Search docs" type="text"/></form><ul class="docs-menu"><li><span class="tocitem">Documentation</span><ul><li><a class="tocitem" href="../">GEMPIC.jl Documentation</a></li><li><a class="tocitem" href="../mesh/">Mesh</a></li><li><a class="tocitem" href="../low_level_bsplines/">Splines</a></li><li><a class="tocitem" href="../splinepp/">Periodic spline</a></li><li><a class="tocitem" href="../particle_mesh_coupling/">Particle-Mesh coupling</a></li><li class="is-active"><a class="tocitem" href="">Distributions</a><ul class="internal"><li><a class="tocitem" href="#Spin-version"><span>Spin version</span></a></li></ul></li><li><a class="tocitem" href="../particle_group/">Particle group</a></li><li><a class="tocitem" href="../particle_sampling/">Particle sampling</a></li><li><a class="tocitem" href="../maxwell_solver/">Maxwell solver</a></li><li><input class="collapse-toggle" id="menuitem-1-10" type="checkbox"/><label class="tocitem" for="menuitem-1-10"><span class="docs-label">Splitting</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../hamiltonian_splitting/">Hamiltonian splitting</a></li><li><a class="tocitem" href="../hamiltonian_splitting_spin/">Hamiltonian splitting Spin</a></li><li><a class="tocitem" href="../hamiltonian_splitting_boris/">Hamiltonian splitting Boris</a></li></ul></li><li><a class="tocitem" href="../diagnostics/">Diagnostics</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../strong_landau_damping/">Strong Landau Damping</a></li></ul></li><li><a class="tocitem" href="../contents/">Contents</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Documentation</a></li><li class="is-active"><a href="">Distributions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="">Distributions</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaVlasov/GEMPIC.jl/blob/master/docs/src/distributions.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" href="#" id="documenter-settings-button" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" href="#" id="documenter-sidebar-button"></a></div></header><article class="content" id="documenter-page"><h1 id="Distributions"><a class="docs-heading-anchor" href="#Distributions">Distributions</a><a id="Distributions-1"></a><a class="docs-heading-anchor-permalink" href="#Distributions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" href="#GEMPIC.CosGaussianParams" id="GEMPIC.CosGaussianParams"><code>GEMPIC.CosGaussianParams</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CosGaussianParams( dims, k, α, σ, μ, δ )</code></pre><p>Parameters of a distribution with is a product of a Cosine distribution along x and a Normal distribution along v.</p><ul><li><code>n_gaussians</code> : Number of Gaussians</li><li><code>n_cos</code> : Number of cosines</li><li><code>normal</code> : Normalization constant of each Gaussian</li></ul></div><a class="docs-sourcelink" href="https://github.com/JuliaVlasov/GEMPIC.jl/blob/80eaebcf8888a2bafef4b1f91b429849fc5faad4/src/distributions.jl#L3-L12" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-binding" href="#GEMPIC.CosSumGaussian" id="GEMPIC.CosSumGaussian"><code>GEMPIC.CosSumGaussian</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CosSumGaussian{D,V}( n_cos, n_gaussians, k, α, σ, μ, δ )</code></pre><p>Data type for parameters of initial distribution</p><p class="math-container">\[(1+ \cos( \sum^{n_{cos}}_{i=1} k_i x))
0 commit comments