00001 #ifndef __ACDIVA_SELFDOC__
00002 #define __ACDIVA_SELFDOC__
00003
00004 const char * sdoc[] = {
00005 " Inversion velocity analysis based on acoustic constant density centered",
00006 " difference modeling in 2D or 3D.",
00007 " ",
00008 " Authors: Muhong Zhou, Yin Huang, William W. Symes",
00009 " ",
00010 " Typical parameter list. May be copied, edited, and used for input: either",
00011 " include parameters on command line (for example in Flow), or place",
00012 " in file <foo> and include \"par=<foo>\" on command line. Any parameter",
00013 " included explicitly in command line overrides parameter with same key",
00014 " in par file.",
00015 " ",
00016 " Invoke single threaded execution by ",
00017 " ",
00018 " \"sfacdiva [parameters] [Madagascar install]\"",
00019 " ",
00020 " or ",
00021 " ",
00022 " \"acdiva.x [parameters] [standalone install]\"",
00023 " ",
00024 " or multi-threaded execution using interactive or batch MPI (for which",
00025 " code must be compiled with MPI enabled).",
00026 " ",
00027 " Given values are defaults; non-optional values indicated by corner brackets.",
00028 " ",
00029 " --------------------------- begin parameters ---------------------------",
00030 " ",
00031 " FD info:",
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 " ",
00038 " ------------------------------------------------------------------------",
00039 " Source info:",
00040 " ",
00041 " source = <path> path to input source data file (traces), ",
00042 " SU format, source position(s) indicated by",
00043 " RECEIVER coordinates (gx, gy, gelev) - may",
00044 " prepare input source with correct headers",
00045 " using trace/main/towed_array.x",
00046 " sampord = 1 spatial interp order - 0 (nr nbr) or ",
00047 " 1 (multilin)",
00048 " ",
00049 " ------------------------------------------------------------------------",
00050 " Trace info:",
00051 " ",
00052 " data = <path> input data file, SU format - must exist ",
00053 " headers establish acquisition geometry",
00054 " ",
00055 " ------------------------------------------------------------------------",
00056 " Model info:",
00057 " ",
00058 " csq = <path> input vel-squared reference file, ",
00059 " determines simulation spatial grid,",
00060 " only headers used in this application",
00061 " but can name same file as initial vel-",
00062 " squared model"
00063 " ",
00064 " csqext = <path> input extended vel-squared reference file,",
00065 " determines extended spatial grid - must be",
00066 " compatible with csq [in this version - soon",
00067 " to come: autogeneration from csq and data]",
00068 " can name same file as output reflectivity",
00069 " ",
00070 " init_velsq = <path> input initial vel-squared",
00071 " ",
00072 " final_velsq = <path> output final WEMVA vel-squared estimate",
00073 " ",
00074 " reflectivity = <path> output vel-squared perturbation",
00075 " aka true-amplitude migration",
00076 " ",
00077 " DSWeight = 0.0 differential semblance penalty weight",
00078 " ",
00079 " ------------------------------------------------------------------------",
00080 " MPI info:",
00081 " ",
00082 " mpi_np1 = 1 number of subdomains along axis 1",
00083 " mpi_np2 = 1 number of subdomains along axis 2",
00084 " mpi_np3 = 1 number of subdomains along axis 3",
00085 " partask = 1 number of shots to execute in parallel",
00086 " ",
00087 " ------------------------------------------------------------------------",
00088 " Conjugate Gradient info (inner linear inversion)",
00089 " ",
00090 " ResidualTol = 100.0*numeric_limits<float>::epsilon()",
00091 " relative residual reduction thresshold",
00092 " GradientTol = 100.0*numeric_limits<float>::epsilon()",
00093 " relative gradient reduction threshhold",
00094 " MaxStep = numeric_limits<float>::max()",
00095 " max permitted step length",
00096 " MaxIter = 10 CG iteration limit",
00097 " ",
00098 " ------------------------------------------------------------------------",
00099 " LBFGS info (outer nonlinear inversion)",
00100 " ",
00101 " InvHessianScale = 1.0f",
00102 " overall inverse Hessian scale",
00103 " MaxInvHessianUpdates = 5",
00104 " dimension of BFGS subspace",
00105 " MaxLineSrchSteps = 10",
00106 " max linesearch steps permitted",
00107 " VerboseDisplay = true",
00108 " false = no output, true = function",
00109 " value, gradient norm at each iteration,",
00110 " report of line search",
00111 " FirstStepLength = 1.0f",
00112 " initial step length, fraction of gradient",
00113 " GAStepAcceptThresh = 0.1f",
00114 " first Goldstein-Armijo param",
00115 " GAStepDoubleThresh = 0.9f",
00116 " second Goldstein-Armijo param",
00117 " LSBackTrackFac = 0.5f",
00118 " step decrease factor for line search",
00119 " LSDoubleFac = 1.8f",
00120 " step increase factor for line search",
00121 " MaxFracDistToBdry = 1.0",
00122 " fraction of max step to boundary permitted",
00123 " LSMinStepFrac = 1.e-06",
00124 " minimum fraction of step permitted",
00125 " MaxLBFGSIter = 3",
00126 " iteration limit for BFGS steps",
00127 " AbsGradThresh = 0.0",
00128 " absolute stopping tolerance for gradient",
00129 " RelGradThresh = 1.e-2",
00130 " relative stopping tolerance for gradient",
00131 " ",
00132 " ------------------------------------------------------------------------",
00133 " Output info:",
00134 " ",
00135 " outfile = \"\" output filename for optimization - if empty",
00136 " string, then output goes to terminal",
00137 " ",
00138 " FD ouput - written to coutxxx.txt on rank xxx",
00139 " printact = 0 output at every time step",
00140 " 0 - none",
00141 " 1 - time step index",
00142 " 2 - diagnostic messages from main routines",
00143 " > 2 - much more, useful only for serious ",
00144 " debugging",
00145 " dump_pi = 0 dump parallel/dom. decomp info",
00146 " dump_lda = 0 dump grid data for allocated arrays",
00147 " dump_ldc = 0 dump grid data for computational arrays",
00148 " dump_ldr = 0 dump grid data for receive buffers",
00149 " dump_lds = 0 dump grid data for send buffers",
00150 " dump_term = 0 dump trace header data",
00151 " ",
00152 " ---------------------------end parameters ------------------------------",
00153 NULL };
00154
00155 #endif
