.. _all_models: Vlasov Family ------------- Models for the Vlasov equation of one kinetic species in 6D phase space (full orbits). Each model extends its parent by new terms of the equations and inherits its species, propagators and scalars (see :ref:`model_anatomy`). * :class:`~struphy.models.Vlasov` * :class:`~struphy.models.VlasovAmpereOneSpecies` * :class:`~struphy.models.VlasovMaxwellOneSpecies` * :class:`~struphy.models.VlasovMaxwellQuasiNeutral` * :class:`~struphy.models.VlasovPoissonAdiabatic` * :class:`~struphy.models.VlasovPoissonAdiabaticPauli` * :class:`~struphy.models.VlasovPauli` * :class:`~struphy.models.LinearVlasovAmpereOneSpecies` * :class:`~struphy.models.LinearVlasovMaxwellOneSpecies` .. autoclass:: struphy.models.Vlasov :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VlasovAmpereOneSpecies :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VlasovMaxwellOneSpecies :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VlasovMaxwellQuasiNeutral :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VlasovPoissonAdiabatic :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VlasovPoissonAdiabaticPauli :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VlasovPauli :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearVlasovAmpereOneSpecies :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearVlasovMaxwellOneSpecies :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: Guiding-Center Family --------------------- Models for the guiding-center (drift-kinetic) equation of one kinetic species in 5D phase space. Each model extends its parent by new terms of the equations and inherits its species, propagators and scalars (see :ref:`model_anatomy`). * :class:`~struphy.models.GuidingCenter` * :class:`~struphy.models.DriftKineticElectrostaticAdiabatic` * :class:`~struphy.models.DriftKineticMaxwell` .. autoclass:: struphy.models.GuidingCenter :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.DriftKineticElectrostaticAdiabatic :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.DriftKineticMaxwell :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: LinearEuler Family ------------------ Models for small perturbations of a static (zero-flow) fluid or plasma equilibrium. Each model extends its parent by new terms of the equations and inherits its species, propagators and scalars (see :ref:`model_anatomy`). * :class:`~struphy.models.LinearEuler` * :class:`~struphy.models.LinearMHD` * :class:`~struphy.models.LinearMHDVlasovCC` * :class:`~struphy.models.LinearMHDVlasovPC` * :class:`~struphy.models.LinearMHDDriftkineticCC` .. autoclass:: struphy.models.LinearEuler :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearMHD :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearMHDVlasovCC :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearMHDVlasovPC :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearMHDDriftkineticCC :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: LinearEulerWithQ Family ----------------------- The equations of the LinearEuler family written with the square root of the pressure, :math:`q = \sqrt p`, as thermodynamic variable (pressure perturbation :math:`\tilde p = 2 q_0 \tilde q`). The magnetic field of :class:`~struphy.models.LinearMHDWithQ` is the one of :class:`~struphy.models.LinearMHD`. * :class:`~struphy.models.LinearEulerWithQ` * :class:`~struphy.models.LinearMHDWithQ` * :class:`~struphy.models.PerturbativeMHDWithQ` * :class:`~struphy.models.PerturbativeEulerWithQ` The perturbative models add the terms that are nonlinear in the perturbations, each in its own energy conserving step, to the steps of their linear parent. .. autoclass:: struphy.models.LinearEulerWithQ :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.LinearMHDWithQ :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.PerturbativeEulerWithQ :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.PerturbativeMHDWithQ :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: Maxwell Family -------------- Maxwell's equations and their extensions by plasma currents. Each model extends its parent by new terms of the equations and inherits its species, propagators and scalars (see :ref:`model_anatomy`). * :class:`~struphy.models.Maxwell` * :class:`~struphy.models.ColdPlasma` * :class:`~struphy.models.ColdPlasmaVlasov` .. autoclass:: struphy.models.Maxwell :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.ColdPlasma :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.ColdPlasmaVlasov :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: SPH Family ---------- Fluid models discretized with smoothed particle hydrodynamics (SPH). Each model extends its parent by new terms of the equations and inherits its species, propagators and scalars (see :ref:`model_anatomy`). * :class:`~struphy.models.ColdEulerSPH` * :class:`~struphy.models.EulerSPH` * :class:`~struphy.models.ViscousEulerSPH` * :class:`~struphy.models.IncompressibleNavierStokesSPH` .. autoclass:: struphy.models.ColdEulerSPH :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.EulerSPH :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.ViscousEulerSPH :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.IncompressibleNavierStokesSPH :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: Other models ------------ Models that are not yet arranged in families of inherited models. Gyrokinetic ^^^^^^^^^^^ .. autoclass:: struphy.models.ToyDrift :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: MHD ^^^ .. autoclass:: struphy.models.LinearExtendedMHDuniform :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.ShearAlfven :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalMHD :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalMHD_with_p :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalMHD_with_q :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalPerturbativeMHD :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalPerturbativeMHD_with_q :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: Multi-fluid ^^^^^^^^^^^ .. autoclass:: struphy.models.TwoFluidQuasiNeutralToy :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.HasegawaWakatani :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.ViscousFluid :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalBarotropicFluid :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalCompressibleFluid :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.VariationalPressurelessFluid :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: Particle diffusion ^^^^^^^^^^^^^^^^^^ .. autoclass:: struphy.models.DeterministicParticleDiffusion :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.RandomParticleDiffusion :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: Pure fields ^^^^^^^^^^^ .. autoclass:: struphy.models.Poisson :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.CurlCurl :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: .. autoclass:: struphy.models.GyrokineticPoisson :members: doc_pde, doc_scalar_quantities, doc_normalization, doc_discretization, doc_long_description, doc_examples, doc_use_cases, doc_cannot_be_used_for :undoc-members: :show-inheritance: