/*
 * SurfaceCorrelationAction.def
 *
 *  Created on: Aug 25, 2010
 *      Author: heber
 */

// all includes and forward declarations necessary for non-integral types below
#include <string>
#include <vector>
class element;
class molecule;

// i.e. there is an integer with variable name Z that can be found in
// ValueStorage by the token "Z" -> first column: int, Z, "Z"
// "undefine" if no parameters are required
#define paramtypes (std::vector<const element *>)(molecule *)(double)(double)(double)(std::string)(std::string)(bool)
#define paramreferences (elements)(Boundary)(BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(periodic)
#define paramtokens ("elements")("molecule-by-id")("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("periodic")
#define paramdescriptions ("set of elements") ("index of a molecule") ("start of the first bin") ("width of the bins") ("start of the last bin") ("name of the output file") ("name of the bin output file") ("system is constraint to periodic boundary conditions")

// some defines for all the names, you may use ACTION, STATE and PARAMS
#define CATEGORY Analysis
#define MENUNAME "analysis"
#define MENUPOSITION 4
#define ACTIONNAME SurfaceCorrelation
#define TOKEN "surface-correlation"

// finally the information stored in the ActionTrait specialization
#undef DEFAULTVALUE
#define DESCRIPTION "pair correlation analysis between element and surface"
#undef SHORTFORM
#define TYPEINFO &typeid(void)