SHDOM: Input Parameters

The parameters are input in the routine USER_INPUT or NAMELIST_INPUT. USER_INPUT uses READ statements from stdin in response to written messages. Because not all parameters are relevant at once, the complete list is not input. Run shdom interactively for the actual sequence. The USER_INPUT routine echos the input values so that a useful "log" file output is produced when run non-interactively. To use the namelist style input, comment in the call to NAMELIST_INPUT in the main routine. On some computers the NAMELIST input requires a space before the parameters. All file name strings are a maximum of 64 characters.

Parameter Description
RUNNAME label for the run (also for multiple processor log file names)
PROPFILE name of the input medium property file
SFCFILE name of the input surface property file (or NONE)
CKDFILE name of the input correlated k-distribution file (or NONE)
INSAVEFILE name of the input binary save file (or NONE)
OUTSAVEFILE name of the output binary save file (or NONE)
NX, NY, NZ base grid size in X, Y and Z (NZ is one more than the number grid cells vertically; NX and NY are the number of grid points horizontally; for periodic boundaries there is actually an extra plane of grid points on the horizontal boundaries)
NMU, NPHI number of discrete ordinates covering -1 < mu < 1 and 0 < phi < 2pi
BCFLAG
Bit flags to specify the horizontal boundary conditions:
0 for periodic in X & Y,
1 for open in X,
2 for open in Y,
3 for open in X & Y.
IPFLAG
Bit flags for independent pixel mode:
0 for 3D,
1 for independent (2D) scans in X,
2 for 2D scans in Y (X-Z planes),
3 for indepedent pixels (i.e. bit 0 for X and bit 1 for Y).
Bit 2 of IPFLAG means do the direct beam in 3D, e.g. IPFLAG=7 means 3D direct beam but IP diffuse radiative transfer.
DELTAM T (true) for delta-M scaling of medium and Nakajima and Tanaka method of computing radiances
GRIDTYPE
E for even Z base grid between bottom and top,
P for Z base grid levels from property file,
F for Z base grid levels from file: zgrid.inp.
SRCTYPE
'S' for solar source,
'T' for thermal source,
'B' for both
Following for Solar or Both source
SOLARFLUX top of medium solar flux on a horizontal surface (any units) For k-distribution this is a multiplier for the solar flux in the CKD file (i.e. normally should be 1).
SOLARMU cosine of the solar zenith angle (this represents the direction of travel of the solar beam, so is forced to be negative although it can be specified positive).
SOLARAZ solar beam azimuthal angle; specified in degrees but immediately converted to radians for use in code. 0 is beam going in positive X direction, 90 is positive Y.
SKYRAD isotropic diffuse radiance incident from above
GNDALBEDO bottom surface Lambertian albedo
Following for Thermal source
GNDTEMP ground temperature in Kelvin
GNDALBEDO the input emissivity for Lambertian surface is converted to albedo by GNDALBEDO=1-emissivity
SKYRAD blackbody temperature (Kelvin) of radiation incident from above
UNITS
'R' for radiance units (W/m^2 ster),
'T' for brightness temperature (Rayleigh-Jeans assumed)
WAVELEN wavelength in microns for 'R' units; WAVELEN not needed for solar sources. (GNDTEMP and WAVELEN used for Both source)
WAVENO(2) wavenumber range (cm^-1) for correlated k-distribution. This particular range must be in the CKD file. If KDIST then WAVELEN set to 10000/(average wavenumber), and UNITS='B' for band.
ACCELFLAG T (true) to do the sequence acceleration. An acceleration extrapolation of the source function is done every other iteration.
SOLACC solution accuracy - tolerance for solution criterion
MAXITER maximum number of iterations allowed
SPLITACC cell splitting accuracy; grid cells that have the adaptive splitting criterion above this value are split. This is an absolute measure, but cannot be easily associated with the resulting radiometric accuracy. Set to zero or negative for no adaptive cell splitting.
SHACC adaptive spherical harmonic truncation accuracy; the spherical harmonic source function series is truncated after the terms are below this level. Truncation can still happens if SHACC=0 (for 0 source terms). This is also an absolute measure, and is approximately the level of accuracy.
NUMOUT number of output files (different types usually). For each output file specify OUTTYPES, OUTPARMS, and OUTFILES.
OUTTYPES(*)
'R' - for radiance,
'V' - for visualization image output,
'F' - for hemispheric flux,
'H' - for heating rate (net flux convergence),
'S' - for spherical harmonic (mean radiance, net flux),
'J' - for source function for one direction,
'M' - for medium properties.
OUTPARMS(*) Type Values
R    Z level, X spacing, Y spacing, X offset, Y offset, num angles, mu1, phi1, mu2, phi2, . . .
Z level is the height of the output locations.
X/Y spacing is distance between output X/Y locations.
X/Y offset is extra distance beyond domain for locations.
Each outgoing angle is specified with -1 <= mu <= 1 (mu>0 is upwelling and mu must not be zero), and phi in degrees (0 is exitting in +X direction)

V   camera mode:   1, nbytes, scale, X,Y,Z, theta, phi, rotang, nlines, nsamps, delline, delsamp
nbytes is number of bytes per pixel in PDS output images.
scale is the scaling from radiance to pixel value in image.
X, Y, Z is the camera location.
theta is the zenith angle [deg] of the pointing direction.
phi is the azimuth angle [deg] of the pointing direction.
rotang is the angle [deg] camera is rotated around pointing.
nlines is the number of pixels in vertical.
nsamps is the number of pixels in horizontal.
delline is the angle [deg] between pixels in vertical.
delsamp is the angle [deg] between pixels in horizontal.
V   cross track mode:  2, nbytes, scale, X1,Y1,Z1, X2,Y2,Z2, spacing, scan1, scan2, delscan
nbytes is number of bytes per pixel in PDS output images.
scale is the scaling from radiance to pixel value in image.
X1, Y1, Z1 is the starting camera location.
X2, Y2, Z2 is the ending camera location.
spacing is the along track distance between scans.
scan1 is the min cross track scan angle [deg] (left side).
scan2 is the max cross track scan angle [deg] (right side).
delscan is the angle [deg] between pixels in the scan.

F    Format [, Z level, X spacing, Y spacing]
Format:
1 - flux at top (up) and bottom (down) of medium at horizontal base grid locations
2 - up and down flux at Z level height at locations with X and Y horizontal spacing,
3 - domain averaged vertical profile,
4 - output at every base grid point.
5 - output at every grid point.
Only format 2 inputs the parameters after the format.

H    Format
1 - domain averaged vertical profile.
2 - output every base grid point: -Div(Fnet).
3 - output every grid point

S    Format
1 - output every base grid point
2 - output every grid point
Output is mean radiance, X, Y, and Z net fluxes.

J    Format, mu, phi
1 - output every base grid point
2 - output every grid point
Source function in direction mu, phi(degrees), mu may be 0.

M    Format
1 - output every base grid point
2 - output every grid point
Output is medium properties: extinction, single scatter albedo, asymmetry parameter, temperature.
OUTFILES(*) output file name (or NONE for no ascii file)
OutFileNC netcdf output file name (or 'NONE' or '' for no netcdf file). The netcdf file has all NUMOUT outputs for the OUTTYPES(*) specified above.
Memory parameters (used only in shdom90.f90):
MAX_TOTAL_MB approximate maximum memory to use (MB for 4 byte reals)
ADAPT_GRID_FACTOR ratio of total grid points to base grid points
NUM_SH_TERM_FACTOR ratio of average number of spherical harmonic terms to total possible (NLM)
CELL_TO_POINT_RATIO ratio of number of grid cells to grid points