source: src/Actions/FragmentationAction/StoreSaturatedFragmentAction.def

stable v1.7.0
Last change on this file was 26062f, checked in by Frederik Heber <frederik.heber@…>, 5 years ago

StoreSaturatedFragmentAction may now export to FragmentQueue as well.

  • Property mode set to 100644
File size: 2.1 KB
Line 
1/*
2 * StoreSaturatedFragmentAction.def
3 *
4 * Created on: Feb 26, 2013
5 * Author: heber
6 */
7
8// all includes and forward declarations necessary for non-integral types below
9#include <string>
10#include <vector>
11
12#include "Parameters/Validators/DummyValidator.hpp"
13#include "Parameters/Validators/RangeValidator.hpp"
14#include "Parameters/Validators/STLVectorValidator.hpp"
15#include "Parameters/Validators/Specific/BoxLengthValidator.hpp"
16#include "Parameters/Validators/Specific/ParserTypeValidator.hpp"
17
18// i.e. there is an integer with variable name Z that can be found in
19// ValueStorage by the token "Z" -> first column: int, Z, "Z"
20// "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
21#define paramtypes (std::string)(bool)(std::vector<std::string>)(double)(unsigned int)
22#define paramtokens ("store-saturated-fragment")("DoSaturate")("output-types")("max-meshwidth")("grid-level")
23#define paramdescriptions ("name of fragment file")("do saturate dangling bonds with hydrogen")("type(s) of parsers that output fragment config files")("maximum allowed mesh width, i.e. discrete points may be at most that far apart on the fragment grids")("resolution of density sampling multigrid")
24#define paramdefaults (NOPARAM_DEFAULT)(PARAM_DEFAULT(true))(PARAM_DEFAULT(std::vector<std::string>()))(PARAM_DEFAULT(0.))(PARAM_DEFAULT(5))
25#define paramreferences (prefix)(DoSaturation)(types)(max_meshwidth)(level)
26#define paramvalids \
27(DummyValidator< std::string >()) \
28(DummyValidator< bool >()) \
29(STLVectorValidator< std::vector<std::string> >(0, 10, ParserTypeValidator())) \
30(BoxLengthValidator()) \
31(RangeValidator< unsigned int >(1, 10))
32
33#undef statetypes
34#undef statereferences
35
36// some defines for all the names, you may use ACTION, STATE and PARAMS
37#define CATEGORY Fragmentation
38#define MENUNAME "fragmentation"
39#define MENUPOSITION 4
40#define ACTIONNAME StoreSaturatedFragment
41#define TOKEN "store-saturated-fragment"
42
43
44// finally the information stored in the ActionTrait specialization
45#define DESCRIPTION "store all selected atoms as a single fragment with dangling bonds satured by hydrogen"
46#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.