.. _all_models:

Models
------

Full-orbit Vlasov
^^^^^^^^^^^^^^^^^

.. 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.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.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.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:

.. 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:

Gyrokinetic
^^^^^^^^^^^

.. 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:

.. 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.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.LinearMHDCurlCurl
    :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.LinearMHDCurlCurlwithProj
    :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.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.ShearAlfvenCurlCurl
    :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.ShearAlfvenCurlCurlwithProj
    :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.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.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.PressureLessSPH
    :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:

.. 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:

Fluid-kinetic hybrids
^^^^^^^^^^^^^^^^^^^^^

.. 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:

.. 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:

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:

.. 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:

Particle tracing
^^^^^^^^^^^^^^^^

.. 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.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: