AnalyticalYSOModel inherits from Model, so all methods and attributes present in the latter can be used with the former, but they are not listed here.
Adding density structures
add_flared_disk() | Add a flared disk to the model |
add_alpha_disk() | Add an alpha disk to the geometry |
add_power_law_envelope() | Add a spherically symmetric power-law envelope to the model |
add_ulrich_envelope() | Add an infalling rotationally flatted envelope to the model |
add_ambient_medium() | Add an infalling rotationally flatted envelope to the model |
Setting the grid automatically
set_spherical_polar_grid_auto(n_r, n_theta, ...) | Set the grid to be spherical polar with automated resolution. |
set_cylindrical_polar_grid_auto(n_w, n_z, n_phi) | Set the grid to be cylindrical polar with automated resolution. |
Miscellaneous
setup_magnetospheric_accretion(mdot, rtrunc, ...) | Set up the model for magnetospheric accretion |
Writing
write([filename, compression, copy, ...]) | Write the model input parameters to an HDF5 file |
Methods (detail)
Add a flared disk to the model
Returns : | disk : FlaredDisk
|
---|
Examples
To add a flared disk to the model, you can do:
>>> disk = m.add_flared_disk()
then set the disk properties using e.g.:
>>> disk.mass = 1.e30 # g
>>> disk.rmin = 1e10 # cm
>>> disk.rmax = 1e14 # cm
See the FlaredDisk documentation to see which parameters can be set.
Add an alpha disk to the geometry
This is similar to a flared disk, but with accretion luminosity. See AlphaDisk for more details.
Returns : | disk : AlphaDisk
|
---|
Examples
To add an alpha disk to the model, you can do:
>>> disk = m.add_alpha_disk()
then set the disk properties using e.g.:
>>> disk.mass = 1.e30 # g
>>> disk.rmin = 1e10 # cm
>>> disk.rmax = 1e14 # cm
See the AlphaDisk documentation to see which parameters can be set.
Add a spherically symmetric power-law envelope to the model
Returns : | env : PowerLawEnvelope
|
---|
Examples
To add a power-law envelope to the model, you can do:
>>> env = m.add_power_law_envelope()
then set the envelope properties using e.g.:
>>> from hyperion.util.constants import msun, au
>>> env.mass = 0.1 * msun # g/s
>>> env.rmin = 0.1 * au # cm
>>> env.rmax = 10000. * au # cm
See the PowerLawEnvelope documentation to see which parameters can be set.
Add an infalling rotationally flatted envelope to the model
Returns : | env : UlrichEnvelope
|
---|
Examples
To add an infalling envelope to the model, you can do:
>>> env = m.add_ulrich_envelope()
then set the envelope properties using e.g.:
>>> from hyperion.util.constants import msun, yr, au
>>> env.mdot = 1.e-6 * msun / yr # g/s
>>> env.rmin = 0.1 * au # cm
>>> env.rmax = 10000. * au # cm
See the UlrichEnvelope documentation to see which parameters can be set.
Add an infalling rotationally flatted envelope to the model
Returns : | ambient : AmbientMedium
|
---|
Notes
Unlike other density structures, the ambient medium is not added to the whole density structure, but it is instead used as a minimum threshold. That is, anywhere within ambient.rmin and ambient.rmax, the density is reset to ambient.rho if it was initially lower.
Examples
To add an ambient medium to the model, you can do:
>>> ambient = m.add_ambient_medium()
then set the ambient medium properties using e.g.:
>>> from hyperion.util.constants import au, pc
>>> ambient.rho = 1.e-20 # cgs
>>> ambient.rmin = 0.1 * au # cm
>>> ambient.rmax = pc # cm
See the AmbientMedium documentation to see which parameters can be set.
Set the grid to be spherical polar with automated resolution.
Parameters : | n_r, n_theta, n_phi : int
rmax : float, optional
|
---|
Set the grid to be cylindrical polar with automated resolution.
Parameters : | n_w, n_z, n_phi : int
wmax : float, optional
zmax : float, optional
|
---|
Set up the model for magnetospheric accretion
Parameters : | mdot : float
rtrunc : float
fspot : float
|
---|
Notes
This method only takes into account the hot spot and X-ray emission from the stellar surface. To simulate the viscous accretion luminosity in the disk, add an AlphaDisk to the model using add_alpha_disk() and set the accretion rate or luminosity accordingly.
Write the model input parameters to an HDF5 file
Parameters : | filename : str
compression : bool
copy : bool
absolute_paths : bool
wall_dtype : type
physics_dtype : type
overwrite : bool
merge_if_possible : bool
|
---|