asg_selfdoc.h

Go to the documentation of this file.
00001 const char * sdoc[] = {
00002 " Driver for acoustic staggered grid modeling in 1D, 2D, or",
00003 " 3D. Outputs pressure traces at specified sample rates, arbitrary",
00004 " receiver positions, and/or movie frames of pressure and/or",
00005 " velocity. Point source at arbitrary location, or array sources with",
00006 " arbitrarily many traces. Uses staggered grid finite difference scheme",
00007 " of order 2 in time and 2k in space, k=1, 2, or 4, derived from",
00008 " pressure-velocity form of acoustodynamics. Either pressure-free",
00009 " (reflecting) or absorbing (PML) boundary conditions on boundary faces",
00010 " of simulation hypercube. Optionally parallelized at both loop (domain",
00011 " decomposition) and task (shot) levels.",
00012 " ",
00013 " Authors: Igor Terentyev, William W. Symes, Tetyana Vdovina, Xin Wang",
00014 " ",
00015 " Typical parameter list. May be copied, edited, and used for input: place",
00016 " in file 'parfile', invoke modeling command by ",
00017 " ",
00018 " sfasg par=parfile [Madagascar install] ",
00019 " ",
00020 " or ",
00021 " ",
00022 " asg.x par=parfile [standalone install]",
00023 " ",
00024 " Given values are defaults, non-optional values in corner brackets.",
00025 " ",
00026 " -------------------------------- cut here ------------------------------",
00027 " ",
00028 " INPUT DATA FOR iwave",
00029 " ",
00030 " ------------------------------------------------------------------------",
00031 " FD:",
00032 " ",
00033 "          order = 2          spatial half-order",
00034 "            cfl = 0.75       proportion of max dt/dx",
00035 "           cmin = 1.0        min permitted velocity (m/ms) - sanity check",
00036 "           cmax = 4.5        max permitted velocity (m/ms) - used in dt comp",
00037 "           dmin = 0.5        min permitted density (g/cm^3) - sanity check",
00038 "           dmax = 3.0        max permitted density (g/cm^3) - sanity check",
00039 "          fpeak = 0.010      nominal central frequency (KHz)",
00040 " ",
00041 " ------------------------------------------------------------------------",
00042 " PML info: layer thickness in WL at fpeak, cmax. Set = 0.0 for reflecting",
00043 " boundary",
00044 " ",
00045 "            nl1 = 0.0         axis 1 - low end",
00046 "            nr1 = 0.0         axis 1 - high end",
00047 "            nl2 = 0.0         axis 2 - low end",
00048 "            nr2 = 0.0         axis 2 - high end",
00049 "            nl3 = 0.0         axis 3 - low end",
00050 "            nr3 = 0.0         axis 3 - high end",
00051 " ",
00052 " ------------------------------------------------------------------------",
00053 " Source info:",
00054 " ",
00055 "        srctype = point       source type - point or array",
00056 "         source = <path>      path to input source data file (traces), ",
00057 "                        SU format - required for array source, ",
00058 "                optional for point source",
00059 "        sampord = 1           spatial interp order - 0 (nr nbr) or ",
00060 "                              1 (multilin)",
00061 " ",
00062 " point source only (ignored for array source):",
00063 " ",
00064 "                              if 'source' keyword not used, Ricker source ",
00065 "                              generated with central freq = fpeak",
00066 "          phase = zerophase   wavelet phase (Ricker option) - possible values",
00067 "                              are zerophase, minimumphase, maximumphase",
00068 "        refdist = 1000.0      reference distance (m) - if > 0, scale source",
00069 "                              to achieve target amplitude at this distance in",
00070 "                              homogeneous 3D medium.",
00071 "         refamp = 1.0         target amplitude at reference (GPa) ",
00072 " ",
00073 " ------------------------------------------------------------------------",
00074 " Trace info:",
00075 " ",
00076 "       hdrfile  = <path>      input prototype trace file, SU format",
00077 "      datafile  = <path>      output data file, SU format - headers",
00078 "                              from hdrfile, trace data from modeling",
00079 " ",
00080 " ------------------------------------------------------------------------",
00081 " Model info:",
00082 " ",
00083 "       velocity = <path>      path to input velocity file, RSF format",
00084 "        density = <path>      path to input density file, RSF format",
00085 " ",
00086 " ------------------------------------------------------------------------",
00087 " MPI info:",
00088 " ",
00089 "        mpi_np1 = 1           number of subdomains along axis 1",
00090 "        mpi_np2 = 1           number of subdomains along axis 2",
00091 "        mpi_np3 = 1           number of subdomains along axis 3",
00092 "        partask = 1           number of shots to execute in parallel",
00093 " ",
00094 " ------------------------------------------------------------------------",
00095 " Output info:",
00096 " ",
00097 "       printact = 0           output at every time step",
00098 "                              0 - none",
00099 "                              1 - time step index",
00100 "                              2 - diagnostic messages from main routines",
00101 "                              > 2 - much more, useful only for serious ",
00102 "                                 debugging",
00103 "        dump_pi = 0           dump parallel/dom. decomp info",
00104 "       dump_lda = 0           dump grid data for allocated arrays",
00105 "       dump_ldc = 0           dump grid data for computational arrays",
00106 "       dump_ldr = 0           dump grid data for receive buffers",
00107 "       dump_lds = 0           dump grid data for send buffers",
00108 "      dump_term = 0           dump trace header data",
00109 " ",
00110 " -------------------------------- cut here ------------------------------",
00111 NULL };

Generated on Thu Dec 6 10:01:27 2012 for IWAVE by  doxygen 1.4.7