FlaredDiskDensityProfile

class profiles.density.FlaredDiskDensityProfile(**kwargs)

Flared Exponential Disk Density Profile.

Extends the exponential disk by allowing the vertical scale height to increase with radius:

\[\rho(r, z) = \rho_0 \, \exp\left( -\frac{r}{r_s} \right) \, \exp\left( -\frac{|z|}{z_s(r)} \right)\]

where the scale height grows with radius as:

\[z_s(r) = z_0 \left( 1 + \frac{r}{r_f} \right)^{\delta}\]

This profile captures disk thickening (“flaring”) at large radii, as seen in stellar and gas disks.

Parameters

Name	Symbol	Description
rho_0	\(\rho_0\)	Central density
r_s	\(r_s\)	Radial scale length
z_0	\(z_0\)	Base vertical scale height
r_f	\(r_f\)	Flare radius
delta	\(\delta\)	Flare steepness

Example

>>> from pisces.profiles.density import (
...     FlaredDiskDensityProfile,
... )
>>> r, z = np.meshgrid(
...     np.linspace(0, 15, 200),
...     np.linspace(-3, 3, 200),
... )
>>> profile = FlaredDiskDensityProfile(
...     rho_0=1.0,
...     r_s=3.0,
...     z_0=0.3,
...     r_f=5.0,
...     delta=0.5,
... )
>>> rho = profile(r, z)

(Source code)

Methods

__init__(**kwargs)	Initialize a profile instance with specific parameter values.
from_dict(data)	Reconstruct a profile instance from a dictionary.
from_hdf5(h5obj[, name])	Reconstruct a profile from HDF5 attributes.
from_json(filepath)	Reconstruct a profile from a JSON file.
from_yaml(filepath)	Reconstruct a profile from a YAML file.
get_derived_profile(profile_name, **kwargs)	Access and instantiate a derived profile by name.
get_expression_latex([substitute])	Return the LaTeX representation of the profile's symbolic expression.
get_output_units(*argu)	Determine the output units of the operation given some set of input units.
get_parameters_latex()	Return a LaTeX table of the profile parameters.
lambdify_expression(expression)	Convert a symbolic expression into a callable function.
list_derived_profiles()	List all available derived profiles for this instance.
substitute_expression(expression)	Replace symbolic parameters with numerical values in an expression.
to_dict()	Serialize this profile to a minimal dictionary representation.
to_hdf5(h5obj[, name])	Store profile metadata into an HDF5 object as attributes.
to_json(filepath, **kwargs)	Serialize the profile to a JSON file.
to_yaml(filepath, **kwargs)	Serialize the profile to a YAML file.

Attributes

derived_profile_classes	Get the available derived profile classes for this instance.
parameter_symbols	Get the symbolic representations of the coordinate system parameters.
parameters	The parameters of this coordinate system.
variable_symbols	The symbols representing each of the coordinate axes in this coordinate system.
variables	The axes names present in this coordinate system.