dc_sweep_n_slice_args.h

Go to the documentation of this file.

/**Args for dc_sweep_n_slice


    Copyright (C) 2011 Joseph Pingenot

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#include <libdotcode/dotcode_data.h>
#include <libpostproc/lp_wavefunction.h>
#include <glib-2.0/glib.h>

struct args {
  /**If true, x is (110) and y is (-110)*/
  gboolean use_110_coordinates;
  gboolean sweeps[3];
  /**Axes to print out; 0->X 1->Y 2->z*/
  gboolean axes[3];
  /**Planes to print out; 0->XY 1->XZ 2->Yz*/
  gboolean planes[3];
  /**If true, print out the point of max probability.  Otherwise, print the requested point.  */
  gboolean use_max_probability_point;
  /**If true, use the requested gridsite, else use the requested point*/
  gboolean use_gridsite;
  /**Grid site at which to get the wavefunction*/
  int gridsite[3];
  /**Point site at which to get the wavefunction*/
  double point[3];
  /**If NULL, use the straight probability density.  Else print out the requested point for each requested band.*/
  GList* bands;
  /**List of struct wavefunction* containing the list of wavefunctions to print.*/
  GList* wavefunctions;
};


/**Parses the options and sets up the args struct.
 *\param argc from main
 *\param argv from main
 *\param args pointer to struct to initialize
 *\param err pointer to pointer to GError to return error information (if any)
 *\not GError code will be set to 1 if the user requested version information.
 */
void get_args(int argc, char** argv, struct args* args, GError **err);