00001 #ifndef __ACDIVA_SELFDOC__
00002 #define __ACDIVA_SELFDOC__
00003
00004 const char * sdoc[] = {
00005 " Acoustic constant density centered difference modeling, linearized modeling,",
00006 " and adjoint linearized modeling (RTM) 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 " \"sfacd [parameters] [Madagascar install]\"",
00019 " ",
00020 " or ",
00021 " ",
00022 " \"acd.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 " Mapping Selection:",
00032 " ",
00033 " deriv = 0 order of derivative of forward map to compute",
00034 " adjoint = 0 0: forward, 1: adjoint ",
00035 " ",
00036 " ------------------------------------------------------------------------",
00037 " FD info:",
00038 " ",
00039 " order = 2 spatial half-order",
00040 " cfl = 0.75 proportion of max dt/dx",
00041 " cmin = 1.0 min permitted velocity (m/ms) - sanity check",
00042 " cmax = 4.5 max permitted velocity (m/ms) - used in dt comp",
00043 " ",
00044 " ------------------------------------------------------------------------",
00045 " Source info:",
00046 " ",
00047 " source = <path> path to input source data file (traces), ",
00048 " SU format, source position(s) indicated by",
00049 " RECEIVER coordinates (gx, gy, gelev) - may",
00050 " prepare input source with correct headers",
00051 " using trace/main/towed_array.x",
00052 " sampord = 1 spatial interp order for sampling or adjoint",
00053 " sampling trace data to/from grid - 0 (nr nbr) ",
00054 " or 1 (multilin)",
00055 " ",
00056 " ------------------------------------------------------------------------",
00057 " Trace info:",
00058 " ",
00059 " data = <path> data file, SU format - must exist ",
00060 " headers establish acquisition geometry",
00061 " output for forward modeling (including all",
00062 " orders of derivative), input for adjoint",
00063 " taperwidth = 0 width of taper for each side of a single",
00064 " shot in (# of traces)",
00065 " timewidth = 0 width of time to taper at the end of ",
00066 " simulation in (ms) ",
00067 " ",
00068 " ------------------------------------------------------------------------",
00069 " Model info:",
00070 " ",
00071 " csq = <path> input vel-squared reference file, ",
00072 " determines simulation spatial grid,",
00073 " csq_d1 = <path> input vel-squared perturbation for ",
00074 " derivative (born) modeling - required",
00075 " for deriv>0, adjoint=0, or deriv>1, ",
00076 " admoint=1, otherwise ignored",
00077 " csq_b1 = <path> output vel-squared perturbation (RTM image)",
00078 " for adjoint modeling, required for deriv=1,",
00079 " adjoint=1, otherwise ignored",
00080 " csq_d2 = <path> input vel-squared perturbation for deriv=2,",
00081 " adjoint=0 or deriv>2 adjoint=1, otherwise ",
00082 " ignored",
00083 " csq_b2 = <path> output vel-squared perturbation for deriv=2,",
00084 " adjoint=1, otherwise ignored",
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 " FD ouput - written to coutxxx.txt on rank xxx",
00098 " printact = 0 monitor output:",
00099 " < 0 - none",
00100 " 0 - announce each shot simulation",
00101 " 1 - print time step index",
00102 " 2 - diagnostic messages from main routines",
00103 " > 2 - much more, useful only for serious ",
00104 " debugging",
00105 " dump_pi = 0 dump parallel/dom. decomp info",
00106 " dump_lda = 0 dump grid data for allocated arrays",
00107 " dump_ldc = 0 dump grid data for computational arrays",
00108 " dump_ldr = 0 dump grid data for receive buffers",
00109 " dump_lds = 0 dump grid data for send buffers",
00110 " dump_term = 0 dump trace header data",
00111 " ",
00112 " ---------------------------end parameters ------------------------------",
00113 NULL };
00114
00115 #endif
