source: src/Actions/AnalysisAction/PairCorrelationAction.def@ 91c409

Candidate_v1.7.0 stable
Last change on this file since 91c409 was d9e1d1, checked in by Frederik Heber <frederik.heber@…>, 5 years ago

Extending PairCorrelation to correlate element and set of atoms.

  • one may also correlate an element with a selected set of atoms.
  • TEST: Added regression test case.
  • Property mode set to 100644
File size: 2.3 KB
Line 
1/*
2 * PairCorrelationAction.def
3 *
4 * Created on: Aug 25, 2010
5 * Author: heber
6 */
7
8// all includes and forward declarations necessary for non-integral types below
9#include <string>
10#include <vector>
11class element;
12
13#include "Parameters/Validators/DummyValidator.hpp"
14#include "Parameters/Validators/Ops_Validator.hpp"
15#include "Parameters/Validators/STLVectorValidator.hpp"
16#include "Parameters/Validators/Specific/BoxLengthValidator.hpp"
17#include "Parameters/Validators/Specific/ElementValidator.hpp"
18#include "Parameters/Validators/Specific/FilePresentValidator.hpp"
19
20#include "Parameters/Validators/DummyValidator.hpp"
21
22// i.e. there is an integer with variable name Z that can be found in
23// ValueStorage by the token "Z" -> first column: int, Z, "Z"
24// "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
25#define paramtypes (std::vector<const element *>)(double)(double)(double)(boost::filesystem::path)(boost::filesystem::path)(bool)
26#define paramreferences (elements)(BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(periodic)
27#define paramtokens ("elements")("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("periodic")
28#define paramdescriptions ("set of elements")("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")
29#define paramdefaults (NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0.5))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(false))
30#define paramvalids \
31(STLVectorValidator< std::vector<const element *> >(1,2, ElementValidator())) \
32(BoxLengthValidator()) \
33(BoxLengthValidator()) \
34(BoxLengthValidator()) \
35(!FilePresentValidator()) \
36(!FilePresentValidator()) \
37(DummyValidator<bool>())
38
39// some defines for all the names, you may use ACTION, STATE and PARAMS
40#define CATEGORY Analysis
41#define MENUNAME "analysis"
42#define MENUPOSITION 2
43#define ACTIONNAME PairCorrelation
44#define TOKEN "pair-correlation"
45
46// finally the information stored in the ActionTrait specialization
47#define DESCRIPTION "pair correlation analysis between all atoms of two given elements, or between the selected atoms and the atoms of the single given element"
48#define SHORTFORM "C"
Note: See TracBrowser for help on using the repository browser.