apps/transop-ewald/translations_ewald.ggo

   1 package "qpms-translations-ewald32"
   2 version "dev"
   3 purpose "Computes Ewald-summed VSWF translation matrix elements in arbitrary 2D-periodic infinite lattices."
   4 #versiontext ""
   5
   6 #args "<command line options>"
   7 args "--file-name=transop_ewald_cmdline"
   8
   9 # Options
  10
  11 option "output" o "Output file"
  12         details="Path to the output file. If not specified, print to the standard output."
  13         string
  14         default=""
  15         optional
  16
  17 option "base-vector" b "Base vector"
  18         details="Single base vector (two numbers separated by comma)"
  19         string
  20         typestr="X,Y"
  21         multiple(2) required # will be multiple(-3) when implemented 1d, 3d
  22
  23 option "error-estimate-output" E "Path to the output with error estimates"
  24         string
  25         optional
  26
  27 option "normalisation" N "VSWF normalisation convention"
  28         values="Power","None","SH" enum
  29         default="Power"
  30
  31 option "csphase" c "Whether the Condon-Shortley phase is included in VSWF definition (-1) or not (+1)"
  32         int
  33         values="+1","-1"
  34         default="-1"
  35
  36 option "Ewald-parameter" e "The value of Ewald parameter η"
  37         double
  38         optional
  39
  40 option "frequency-unit" u "Specifies the frequency unit is used for inputs."
  41         values="eV","scuff" enum
  42         default="scuff"
  43
  44 option "lMax" L "Maximum spherical multipole order to which the translation operator elements are calculated"
  45         int
  46         required
  47
  48 option "refractive-index" n "Medium refractive index"
  49         double
  50         required
  51
  52 option "particle" p "Specify the x and y coordinates of a single particle; If not specified, one particle per unit cell is assumed."
  53         string
  54         typestr="X,Y"
  55         multiple optional
  56
  57 defmode "k_omega_points" modedesc="Specifying each (ω, k) pair separately."
  58 defmode "k_omega_meshgrid" modedesc="Specifying lists of ω and k, from which all possible pairs are generated."
  59
  60 modeoption "pointfile" T "Path to a file containing frequency, k_x, k_y triples\
  61 (separated by white spaces). If not specified, read them from stdin."
  62         mode="k_omega_points"
  63         string
  64         multiple default="-"
  65
  66 modeoption "point" t "Specifies a frequency, k_x, k_y triple, separated by commas."
  67         mode="k_omega_points"
  68         string
  69         typestr="ω,k_x,k_y"
  70         multiple optional
  71
  72 modeoption "omegafile" F "Path to a file containing a list of frequencies\
  73 separated by whitespaces."
  74         mode="k_omega_meshgrid"
  75         string
  76         multiple optional
  77
  78 modeoption "omega" f "Specifies frequency (or multiple frequencies separated by commas) on the command line."
  79         mode="k_omega_meshgrid"
  80         string
  81         typestr="ω1[,ω2[,...]]"
  82         multiple optional
  83
  84 modeoption "kfile" K "Path to a file containing a list of k_x, k_y pairs."
  85         mode="k_omega_meshgrid"
  86         string
  87         multiple optional
  88         default="-"
  89
  90 modeoption "k" k "Specifies pair(s) of k_x, k_y values"
  91         mode="k_omega_meshgrid"
  92         string
  93         typestr="k1_x,k1_y[,k2_x,k2_y[,...]]"
  94         multiple optional
  95
  96
  97 #option <long> <short> "<desc>"
  98 #       {details="<detailed description>"}
  99 #       {argtype} {typestr="<type descr>"}
 100 #       {values="<value1>","<value2>",...}
 101 #       {default="<default value>"}
 102 #       {dependon="<other option>"}
 103 #       {required} {argoptional} {multiple}
 104 #       {hidden}
 105
 106 #option <long> <short> "<desc>" flag <on/off>
 107
 108 #section "section name" {sectiondesc="optional section description"}
 109
 110 #text "a textual sentence"