Home > atmlab > arts > qartsCloudbox.m

qartsCloudbox

PURPOSE ^

QARTS_CLOUDBOX Defines setting fields for ARTS cloudbox calculations

SYNOPSIS ^

function [C,I] = qartsCloudbox

DESCRIPTION ^

 QARTS_CLOUDBOX   Defines setting fields for ARTS cloudbox calculations

    The function provides a description of each recognised field and sets
    the fields to {}.

    This function is organised in such way that *qcheck* and *qinfo*
    can be used.

 FORMAT   [C,I] = qartsCloudbox
        
 OUT   C  Setting structure with default values for all recognised fields.
       I  Includes same fields as C, where the content of each field
          is a description string (used by *qinfo*).

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

DOWNLOAD ^

qartsCloudbox.m

SOURCE CODE ^

0001 % QARTS_CLOUDBOX   Defines setting fields for ARTS cloudbox calculations
0002 %
0003 %    The function provides a description of each recognised field and sets
0004 %    the fields to {}.
0005 %
0006 %    This function is organised in such way that *qcheck* and *qinfo*
0007 %    can be used.
0008 %
0009 % FORMAT   [C,I] = qartsCloudbox
0010 %
0011 % OUT   C  Setting structure with default values for all recognised fields.
0012 %       I  Includes same fields as C, where the content of each field
0013 %          is a description string (used by *qinfo*).
0014 
0015 % 2005-03-14   Created by Patrick Eriksson.
0016 
0017 
0018 function [C,I] = qartsCloudbox
0019  
0020 %-----------------------------------------------------------------------------
0021 C.LIMITS = {};
0022 I.LIMITS = [ ...
0023 'Cloudbox limits. Given as a vector, with length 2-6 depending on the ',...
0024 'atmospheric dimensionality. Absolute units are used (not indices). ',...
0025 'Geometrical altitude is used for the vertical dimension. See further ',...
0026 'cloudboxSetManuallyAltitude. The vector can be longer than actually needed.'
0027 ];
0028 %-----------------------------------------------------------------------------
0029 C.METHOD = {};
0030 I.METHOD = [ ...
0031 'Calculation method for scattering. Allowed options are:',...
0032 '#   ''DOIT'' : Discrete ordinate iterative method',...
0033 '#   ''MC''   : Backward Monte Carlo',...
0034 '#   ''FOS''  : Fixed order of scattering',...
0035 '#   ''none'' : Scattering calculations handled differently.',...
0036 'A method must always be selected when Q_CLOUDBOX_DO=1.'
0037 ];
0038 %-----------------------------------------------------------------------------
0039 C.METHOD_PRMTRS = {};
0040 I.METHOD_PRMTRS = [ ...
0041 'Parameters and data for scattering calculation method, given as a ',...
0042 'structure. DATA must always be specified when Q_CLOUDBOX_DO=1. ',...
0043 'The set of fields of this structure depend on choosen METHOD:',...
0044 '# ',...
0045 '#*** MC ***',...
0046 '#   STD_ERR         : As the *MCGeneral* keyword argument with same name.',...
0047 '#                     The unit of this value is determined by Q.Y_UNIY.',...
0048 '#   MAX_TIME        : As the *MCGeneral* keyword argument with same name.',...
0049 '#   MAX_ITER        : As the *MCGeneral* keyword argument with same name.',...
0050 '#   MIN_ITER        : As the *MCGeneral* keyword argument with same name.',...
0051 '# ',...
0052 '#*** DOIT ***',...
0053 '#   N_ZA_GRID       : ',...
0054 '#As the keyword arguments of *DoitAngularGridsSet*.',...
0055 '#   N_AA_GRID       : ',...
0056 '#As the keyword arguments of *DoitAngularGridsSet*.',...
0057 '#   ZA_GRID_OPT_FILE: ',...
0058 '#As the keyword arguments of *DoitAngularGridsSet*.', ...
0059 ' If no filename is given (""), equidistant grids are used for RT', ...
0060 ' and scattering integral. This option can be used for down-looking', ...
0061 ' simulations.',...
0062 '#   SCAT_ZA_INTERP  : ',...
0063 '#As the WSV with same name. Set through *DoitAngularGridsSet*. Set to ',...
0064 'empty string ('''') if an equidistant grid shall be used based on ',...
0065 '*N_ZA_GRID*. String or vector input is possible when setting a specific ',...
0066 'grid.',...
0067 '#   EPSILON         : ',...
0068 '#As the keyword argument of *doit_conv_flagAbsBT*. ',...
0069 'Here given as a vector. Length of vector must be >= *STOKES_DIM*. ',...
0070 'The vector is truncated if longer.',...
0071 '#   ALL_F           : ',...
0072 '#As the keyword argument *all_frequencies* of *doit_i_fieldSetClearsky*. ',...
0073 'If true, the internal intensity field of the cloud box is reset to the ',...
0074 'clear sky field for each frequency. Otherwise, this is done only for the ',...
0075 'the first frequency, and the previous solution field is used as starting ',...
0076 'point for subsequent frequencies.',...
0077 '#   NORMALIZE       : ',...
0078 '#As the keyword argument *normalize* of *doit_i_fieldUpdateSeq1D*. ',...
0079 'Default is 0.',...
0080 '#   NORM_ERROR_THRESHOLD: ',...
0081 '#As the keyword argument *norm_error_threshold* of ',...
0082 '*doit_i_fieldUpdateSeq1D*. Must be set if NORMALIZE is an existing field.'
0083 ];
0084 %-----------------------------------------------------------------------------
0085 C.OPT_PROP_PART_AGENDA = {};
0086 I.OPT_PROP_PART_AGENDA = [ ...
0087 'List of WSMs to include in agenda *opt_prop_gas_agenda*. ', ...
0088 'WSMs are listed as an array of strings, with possible arguments. '
0089 ];
0090 %-----------------------------------------------------------------------------
0091 C.PARTICLE_MASSES = {};
0092 I.PARTICLE_MASSES = [ ...
0093 'As the WSM with the same name.'
0094 ];
0095 %-----------------------------------------------------------------------------
0096 C.PND_FIELD = {};
0097 I.PND_FIELD = [ ...
0098 'Raw fields of particle number densities. These are added by the WSM ',...
0099 'ParticleTypeAdd. Each raw field can be given as a file name or numeric ',...
0100 'data. The number of elements in *PND_FIELD* and *SCAT_DATA* must be ',...
0101 'identical. That is, both fields must be set, or both be {}.'
0102 ];
0103 %-----------------------------------------------------------------------------
0104 C.SCAT_DATA = {};
0105 I.SCAT_DATA = [ ...
0106 'Raw ingle scattering data. These are added by the WSM ',...
0107 'ParticleTypeAdd. Each raw field can be given as a file name or numeric ',...
0108 'data. The number of elements in *PND_FIELD* and *SCAT_DATA* must be ',...
0109 'identical. That is, both fields must be set, or both be {}.'
0110 ];
0111 %-----------------------------------------------------------------------------
0112 C.SPT_CALC_AGENDA = {};
0113 I.SPT_CALC_AGENDA = [ ...
0114 'List of WSMs to include in agenda *spt_calc_agenda*. ', ...
0115 'WSMs are listed as an array of strings, with possible arguments. This ',...
0116 'agenda is not used by the MC method.'
0117 ];
0118 %-----------------------------------------------------------------------------

Generated on Mon 15-Sep-2014 13:31:28 by m2html © 2005