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