00001 #ifndef __ACDDS_SCAN_SELFDOC__
00002 #define __ACDDS_SCAN_SELFDOC__
00003
00004 const char * sdoc[] = {
00005 " Differential Semblance objective function scan test based on acoustic ",
00006 " constant density centered difference modeling in 2D or 3D.",
00007 " ",
00008 " Authors: Muhong Zhou, Yin Huang, William W. Symes",
00009 " ",
00010 " Compute differential semblance objective function values along ling ",
00011 " segment in its domain: ",
00012 " start from csq_beg + HMin * (csq_end - csq_beg)",
00013 " end at csq_beg + HMax * (csq_end - csq_beg)",
00014 " ",
00015 " Typical parameter list. May be copied, edited, and used for input: either",
00016 " include parameters on command line (for example in Flow), or place",
00017 " in file <foo> and include \"par=<foo>\" on command line. Any parameter",
00018 " included explicitly in command line overrides parameter with same key",
00019 " in par file.",
00020 " ",
00021 " Invoke single threaded execution by ",
00022 " ",
00023 " \"sfacdds_scan [parameters] [Madagascar install]\"",
00024 " ",
00025 " or ",
00026 " ",
00027 " \"acdds_scan.x [parameters] [standalone install]\"",
00028 " ",
00029 " or multi-threaded execution using interactive or batch MPI (for which",
00030 " code must be compiled with MPI enabled).",
00031 " ",
00032 " Given values are defaults; non-optional values indicated by corner brackets.",
00033 " ",
00034 " --------------------------- begin parameters ---------------------------",
00035 " ",
00036 " FD info:",
00037 " ",
00038 " order = 2 spatial half-order",
00039 " cfl = 0.75 proportion of max dt/dx",
00040 " cmin = 1.0 min permitted velocity (m/ms) - sanity check",
00041 " cmax = 4.5 max permitted velocity (m/ms) - used in dt comp",
00042 " ",
00043 " ------------------------------------------------------------------------",
00044 " Source info:",
00045 " ",
00046 " source = <path> path to input source data file (traces), ",
00047 " SU format, source position(s) indicated by",
00048 " RECEIVER coordinates (gx, gy, gelev) - may",
00049 " prepare input source with correct headers",
00050 " using trace/main/towed_array.x",
00051 " sampord = 1 spatial interp order - 0 (nr nbr) or ",
00052 " 1 (multilin)",
00053 " ",
00054 " ------------------------------------------------------------------------",
00055 " Trace info:",
00056 " ",
00057 " datafile = <path> input data file, SU format - must exist ",
00058 " headers establish acquisition geometry",
00059 " ",
00060 " ------------------------------------------------------------------------",
00061 " Model info:",
00062 " ",
00063 " csq = <path> input vel-squared reference file, ",
00064 " determines simulation spatial grid,",
00065 " only headers used in this application",
00066 " but can name same file as initial vel-",
00067 " squared model"
00068 " ",
00069 " csqext = <path> input extended vel-squared reference file,",
00070 " determines extended spatial grid - must be",
00071 " compatible with csq [in this version - soon",
00072 " to come: autogeneration from csq and data]",
00073 " can name same file as output reflectivity",
00074 " ",
00075 " csq_beg = <path> input initial vel-squared",
00076 " ",
00077 " csq_end = <path> input final vel-squared for scan test",
00078 " ",
00079 " DSWeight = 0.0 differential semblance penalty weight",
00080 " ",
00081 " ------------------------------------------------------------------------",
00082 " SCAN test info:",
00083 " ",
00084 " NScan = 11 number of points along line segment ",
00085 " HMin = -1.0 ",
00086 " HMax = 1.0 ",
00087 " ",
00088 " ------------------------------------------------------------------------",
00089 " MPI info:",
00090 " ",
00091 " mpi_np1 = 1 number of subdomains along axis 1",
00092 " mpi_np2 = 1 number of subdomains along axis 2",
00093 " mpi_np3 = 1 number of subdomains along axis 3",
00094 " partask = 1 number of shots to execute in parallel",
00095 " ",
00096 " ------------------------------------------------------------------------",
00097 " Conjugate Gradient info (inner linear inversion)",
00098 " ",
00099 " ResidualTol = 100.0*numeric_limits<float>::epsilon()",
00100 " relative residual reduction thresshold",
00101 " GradientTol = 100.0*numeric_limits<float>::epsilon()",
00102 " relative gradient reduction threshhold",
00103 " MaxStep = numeric_limits<float>::max()",
00104 " max permitted step length",
00105 " MaxIter = 10 CG iteration limit",
00106 " ",
00107 " ------------------------------------------------------------------------",
00108 " Output info:",
00109 " ",
00110 " outfile = \"\" output filename for optimization - if empty",
00111 " string, then output goes to terminal",
00112 " ",
00113 " FD ouput - written to coutxxx.txt on rank xxx",
00114 " printact = 0 output at every time step",
00115 " 0 - none",
00116 " 1 - time step index",
00117 " 2 - diagnostic messages from main routines",
00118 " > 2 - much more, useful only for serious ",
00119 " debugging",
00120 " dump_pi = 0 dump parallel/dom. decomp info",
00121 " dump_lda = 0 dump grid data for allocated arrays",
00122 " dump_ldc = 0 dump grid data for computational arrays",
00123 " dump_ldr = 0 dump grid data for receive buffers",
00124 " dump_lds = 0 dump grid data for send buffers",
00125 " dump_term = 0 dump trace header data",
00126 " ",
00127 " ---------------------------end parameters ------------------------------",
00128 NULL };
00129
00130 #endif
