.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/a_models/plot_spherical_galaxy_cluster_model.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_a_models_plot_spherical_galaxy_cluster_model.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_a_models_plot_spherical_galaxy_cluster_model.py:


=========================================
Build a Spherical Galaxy Cluster
=========================================

This example constructs a simple spherical galaxy cluster model using Pisces and visualizes
its thermodynamic profiles, including temperature, entropy, and pressure.

Unlike magnetized models, this cluster assumes pure thermal pressure support. The model
uses NFW profiles for both total and gas densities and solves for the hydrostatic temperature
profile under spherical symmetry.

.. GENERATED FROM PYTHON SOURCE LINES 15-21

Setup
-----
We begin by importing the required profiles and model class. This example uses:

- :class:`~pisces.models.galaxy_clusters.spherical.SphericalGalaxyClusterModel`
- :class:`~profiles.density.NFWDensityProfile`

.. GENERATED FROM PYTHON SOURCE LINES 21-31

.. code-block:: Python


    import tempfile

    import matplotlib.pyplot as plt
    import numpy as np
    import unyt

    from pisces.models.galaxy_clusters import SphericalGalaxyClusterModel
    from pisces.profiles import NFWDensityProfile








.. GENERATED FROM PYTHON SOURCE LINES 32-35

Density Profiles
----------------
We'll define NFW profiles for both the total matter and gas components.

.. GENERATED FROM PYTHON SOURCE LINES 35-48

.. code-block:: Python


    # Define the central density and scale radius for total mass.
    rho_tot = unyt.unyt_quantity(5e6, "Msun/kpc**3")
    r_s_tot = unyt.unyt_quantity(200, "kpc")

    # Define the central density and scale radius for gas.
    rho_gas = unyt.unyt_quantity(5e5, "Msun/kpc**3")
    r_s_gas = unyt.unyt_quantity(220, "kpc")

    # Create the profiles
    total_density = NFWDensityProfile(rho_0=rho_tot, r_s=r_s_tot)
    gas_density = NFWDensityProfile(rho_0=rho_gas, r_s=r_s_gas)








.. GENERATED FROM PYTHON SOURCE LINES 49-52

Model Construction
------------------
We'll construct the spherical galaxy cluster model over a logarithmic radial grid.

.. GENERATED FROM PYTHON SOURCE LINES 52-72

.. code-block:: Python


    # Create a temporary output file
    tmpdir = tempfile.TemporaryDirectory()
    filename = f"{tmpdir.name}/basic_cluster_model.h5"

    # Define the radial range
    rmin = unyt.unyt_quantity(1.0, "kpc")
    rmax = unyt.unyt_quantity(3.0, "Mpc")

    # Build the model
    model = SphericalGalaxyClusterModel.from_density_and_total_density(
        gas_density,
        total_density,
        filename,
        min_radius=rmin,
        max_radius=rmax,
        num_points=500,
        overwrite=True,
    )





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    Preparing metadata...:   0%|          | 0/7 [00:00<?, ?it/s]
    Generating grid...:  14%|█▍        | 1/7 [00:00<00:00, 99864.38it/s]
    Building density...:  29%|██▊       | 2/7 [00:00<00:00, 1973.79it/s]
    Computing masses...:  43%|████▎     | 3/7 [00:00<00:00, 1853.15it/s]
    Calculating potential...:  57%|█████▋    | 4/7 [00:00<00:00, 210.15it/s]
    Calculating potential...:  71%|███████▏  | 5/7 [00:00<00:00, 16.95it/s] 
    Calculating temperature...:  71%|███████▏  | 5/7 [00:00<00:00, 16.95it/s]
    Performing additional computations...:  86%|████████▌ | 6/7 [00:08<00:00, 16.95it/s]
    COMPLETE:  86%|████████▌ | 6/7 [00:08<00:00, 16.95it/s]                             
    COMPLETE: 100%|██████████| 7/7 [00:08<00:00,  1.46s/it]
                                                       



.. GENERATED FROM PYTHON SOURCE LINES 73-76

Plot Results
------------
We'll now extract and plot the thermodynamic quantities.

.. GENERATED FROM PYTHON SOURCE LINES 76-98

.. code-block:: Python


    fields = ["temperature", "entropy", "pressure"]
    labels = {
        "temperature": r"Temperature [$\mathrm{keV}$]",
        "entropy": r"Entropy [$\mathrm{keV\ cm^2}$]",
        "pressure": r"Pressure [$\mathrm{erg/cm^3}$]",
    }
    units = ["keV", "keV*cm**2", "erg/cm**3"]

    fig, axes = plt.subplots(1, 3, figsize=(12, 4), sharex=True)
    radii = model.grid["r"].to("kpc").value

    for ax, field, unit in zip(axes, fields, units):
        ax.plot(radii, model[field].to_value(unit), lw=2)
        ax.set_yscale("log")
        ax.set_title(labels[field])
        ax.set_xlabel("Radius [kpc]")
        ax.grid(True)

    axes[0].set_ylabel("Log-scaled value")
    plt.tight_layout()
    plt.show()



.. image-sg:: /auto_examples/a_models/images/sphx_glr_plot_spherical_galaxy_cluster_model_001.png
   :alt: Temperature [$\mathrm{keV}$], Entropy [$\mathrm{keV\ cm^2}$], Pressure [$\mathrm{erg/cm^3}$]
   :srcset: /auto_examples/a_models/images/sphx_glr_plot_spherical_galaxy_cluster_model_001.png
   :class: sphx-glr-single-img






.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 8.995 seconds)


.. _sphx_glr_download_auto_examples_a_models_plot_spherical_galaxy_cluster_model.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_spherical_galaxy_cluster_model.ipynb <plot_spherical_galaxy_cluster_model.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_spherical_galaxy_cluster_model.py <plot_spherical_galaxy_cluster_model.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_spherical_galaxy_cluster_model.zip <plot_spherical_galaxy_cluster_model.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_