From c20141617417f0e37ca468ccf0517a1dfef82b27 Mon Sep 17 00:00:00 2001 From: Annie Hughes Date: Wed, 12 Apr 2023 11:14:44 +0200 Subject: [PATCH] updated help --- src/idl/dustem_create_rfield.pro | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------------- 1 file changed, 89 insertions(+), 28 deletions(-) diff --git a/src/idl/dustem_create_rfield.pro b/src/idl/dustem_create_rfield.pro index 402ede7..7cb46ae 100755 --- a/src/idl/dustem_create_rfield.pro +++ b/src/idl/dustem_create_rfield.pro @@ -1,34 +1,94 @@ FUNCTION DUSTEM_CREATE_RFIELD, temp, x=x, isrf=isrf, wdil=wdil, wcut=wcut, g0=g0, chi=chi, fname=fname, help=help +;+ +; NAME: +; dustem_create_rfield +; +; PURPOSE: +; generates a file with the radiation field in format suitable for +; DUSTEM (ISRF.DAT). Units erg/cm2/s/Hz (4*!pi*I_nu) +; RFIELD = ISRF + WDIL*PI*BB(TEMP) ' +; +; CATEGORY: +; DustEMWrap, Distributed, LowLevel, Helper +; +; CALLING SEQUENCE: +; mathis = DUSTEM_MATHIS_FIELD(x,unit=unit) +; +; INPUTS: +; TEMP -- blackbody temperature (can be an array). If 0 only ISRF. +; +; OPTIONAL INPUT PARAMETERS: +; X -- wavelength -grid for the ISRF in microns. Default is 200 pts over 0.01-10^5 microns. +; (including WCUT point). You want to include WCUT for accurate edges. +; ISRF -- if set to 0 no ISRF is added, 1 is Mathis (default), 2 is Habing +; WDIL -- blackbody dilution factor (can be an array) +; FNAME -- filename for ISRF.DAT +; WCUT --- for wave < wcut radiation field is 0 +; +; OUTPUTS: +; +; OPTIONAL OUTPUT PARAMETERS: +; G0 -- factor flux(6-13.6eV) wrt. Mathis field +; CHI -- scaling factor at 100nm wrt. Mathis field +; +; ACCEPTED KEY-WORDS: +; help = print this help +; +; COMMON BLOCKS: +; None +; +; SIDE EFFECTS: +; +; RESTRICTIONS: +; +; PROCEDURES AND SUBROUTINES USED: +; +; EXAMPLES +; tt = dustem_create_rfield([2d4,5d4],wdil=[1.d-14,1.d-16],x=x,fname='ISRF.DAT') +; +; MODIFICATION HISTORY: +; Written by LV 2009 +; Initially distributed with the Fortran, incorporated into DustEMWrap 2022 +; Evolution details on the DustEMWrap gitlab. +; See http://dustemwrap.irap.omp.eu/ for FAQ and help. +;- + + if N_PARAMS() LT 1 or keyword_set(help) then begin - print,'------------------------------------------------------------------------------------------------------' - print,'FUNCTION DUSTEM_CREATE_RFIELD, temp, x=x, isrf=isrf, wdil=wdil, wcut=wcut, g0=g0, chi=chi, fname=fname' - print,'------------------------------------------------------------------------------------------------------' - print,'' - print,' generates the radiation field for DUSTEM (ISRF.DAT)' - print,' in erg/cm2/s/Hz (4*!pi*I_nu)' - print,' RFIELD = ISRF + WDIL*PI*BB(TEMP) ' - print,' ISRF from Mathis et al. 1983, A&A 128, 212' - print,' NB: if blackbody is isotropic set WDIL to 4 (to get 4*!pi factor)' - print,'' - print,' TEMP (I): blackbody temperature (can be an array). If 0 only ISRF.' - print,' X (I): X-grid for the ISRF in microns. Default is 200 pts over 0.01-10^5 microns.' - print,' (including WCUT point). You want to include WCUT for accurate edges.' - print,' ISRF (I): if set to 0 no ISRF is added, 1 is Mathis (default), 2 is Habing' - print,' WDIL (I): blackbody dilution factor (can be an array)' - print,' FNAME(I): filename for ISRF.DAT' - print,' WCUT (I): for wave < wcut radiation field is 0 ' - print,' G0 (O): factor flux(6-13.6eV) wrt. Mathis field ' - print,' CHI (O): scaling factor at 100nm wrt. Mathis field' - print,'' - print,'Example: tt = dustem_create_rfield([2d4,5d4],wdil=[1.d-14,1.d-16],x=x,fname=''ISRF.DAT'')' - print,'' - print,' Created Aug. 2009, L. Verstraete, IAS' - print,' Force the WCUT point, May 2011, LV' - print,'' - print,'------------------------------------------------------------------------------------------------------' - RETURN,0 - endif + doc_library,'dustem_create_rfield' + rfield=0 + goto, the_end + end + + ;; print,'------------------------------------------------------------------------------------------------------' + ;; print,'FUNCTION DUSTEM_CREATE_RFIELD, temp, x=x, isrf=isrf, wdil=wdil, wcut=wcut, g0=g0, chi=chi, fname=fname' + ;; print,'------------------------------------------------------------------------------------------------------' + ;; print,'' + ;; print,' generates the radiation field for DUSTEM (ISRF.DAT)' + ;; print,' in erg/cm2/s/Hz (4*!pi*I_nu)' + ;; print,' RFIELD = ISRF + WDIL*PI*BB(TEMP) ' + ;; print,' ISRF from Mathis et al. 1983, A&A 128, 212' + ;; print,' NB: if blackbody is isotropic set WDIL to 4 (to get 4*!pi factor)' + ;; print,'' + ;; print,' TEMP (I): blackbody temperature (can be an array). If 0 only ISRF.' + ;; print,' X (I): X-grid for the ISRF in microns. Default is 200 pts over 0.01-10^5 microns.' + ;; print,' (including WCUT point). You want to include WCUT for accurate edges.' + ;; print,' ISRF (I): if set to 0 no ISRF is added, 1 is Mathis (default), 2 is Habing' + ;; print,' WDIL (I): blackbody dilution factor (can be an array)' + ;; print,' FNAME(I): filename for ISRF.DAT' + ;; print,' WCUT (I): for wave < wcut radiation field is 0 ' + ;; print,' G0 (O): factor flux(6-13.6eV) wrt. Mathis field ' + ;; print,' CHI (O): scaling factor at 100nm wrt. Mathis field' + ;; print,'' + ;; print,'Example: tt = dustem_create_rfield([2d4,5d4],wdil=[1.d-14,1.d-16],x=x,fname=''ISRF.DAT'')' + ;; print,'' + ;; print,' Created Aug. 2009, L. Verstraete, IAS' + ;; print,' Force the WCUT point, May 2011, LV' + ;; print,'' + ;; print,'------------------------------------------------------------------------------------------------------' + ;; RETURN,0 + ;; endif ; inits unit='W' @@ -143,5 +203,6 @@ FUNCTION DUSTEM_CREATE_RFIELD, temp, x=x, isrf=isrf, wdil=wdil, wcut=wcut, g0=g0 print,'(W) DUSTEM_CREATE_RFIELD: radiation field written in ', strtrim(fname,2) ENDIF + the_end: RETURN, RFIELD END -- libgit2 0.21.2