This class implements the density structure for a bipolar cavity in an envelope, with a density given by:
inside a volume defined by two parabolic surfaces with half-opening angle theta_0 at r_0.
Once the BipolarCavity class has been instantiated, the parameters for the density structure can be set via attributes:
>>> cavity = BipolarCavity()
>>> cavity.theta_0 = 10.
>>> cavity.power = 0.
In most cases however, you should not have to instantiate a BipolarCavity class directly, but instead you should use the add_bipolar_cavity method on the Envelope classes (see for example UlrichEnvelope or PowerLawEnvelope classes).
Attributes
r_0 | radius at which theta_0 and rho_0 are defined (cm) |
theta_0 | Cavity half-opening angle at r_0 |
rho_0 | density at r_0 (g/cm^3) |
power | Power of the cavity shape |
rho_exp | density power-law exponent |
dust | dust properties (filename or dust object) |
Methods
density(grid) | Return the density grid |
mask(grid) | Compute the shape of the bipolar cavity. |
Methods (detail)
Return the density grid
Parameters : | grid : SphericalPolarGrid or CylindricalPolarGrid instance.
|
---|---|
Returns : | rho : np.ndarray
|
Compute the shape of the bipolar cavity.
Parameters : | grid : SphericalPolarGrid or CylindricalPolarGrid instance.
|
---|---|
Returns : | mask : np.ndarray
|