source: src/Actions/PotentialAction/FitPotentialAction.def

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

Added option error-file to fit potential actions.

  • Property mode set to 100644
File size: 2.8 KB
RevLine 
[48d20d]1/*
2 * FitPotentialAction.def
3 *
4 * Created on: Apr 08, 2013
5 * Author: heber
6 */
7
8// all includes and forward declarations necessary for non-integral types below
9#include <boost/filesystem/path.hpp>
10#include <string>
11#include <vector>
12
[baccf6]13#include "Parameters/Validators/DummyValidator.hpp"
[4792ab]14#include "Parameters/Validators/GenericValidators.hpp"
[a315e8]15#include "Parameters/Validators/Ops_Validator.hpp"
[48d20d]16#include "Parameters/Validators/RangeValidator.hpp"
17#include "Parameters/Validators/STLVectorValidator.hpp"
18#include "Parameters/Validators/Specific/ElementValidator.hpp"
[a315e8]19#include "Parameters/Validators/Specific/EmptyStringValidator.hpp"
[48d20d]20#include "Parameters/Validators/Specific/PotentialTypeValidator.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
[82e5fb]25#define paramtypes (boost::filesystem::path)(boost::filesystem::path)(std::string)(std::vector<const element *>)(std::vector<const element *>)(unsigned int)(double)(unsigned int)
26#define paramtokens ("training-file")("error-file")("potential-type")("potential-charges")("fragment-charges")("take-best-of")("set-threshold")("set-max-iterations")
27#define paramdescriptions ("optional file to write training data to")("optional file to write error data to")("potential type to fit")("charges specifying the potential")("charges specifying the fragment")("take the best among this many approximations")("Require L2 error to be smaller than threshold, overrides number of attempts")("sets the maximum number of iterations spent on the optimization of parameters")
28#define paramdefaults (PARAM_DEFAULT(""))(PARAM_DEFAULT(""))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(3))(PARAM_DEFAULT(1.))(PARAM_DEFAULT(100))
29#define paramreferences (training_file)(error_file)(potentialtype)(charges)(fragment)(best_of_howmany)(threshold)(max_iterations)
[48d20d]30#define paramvalids \
[a504946]31(DummyValidator<boost::filesystem::path>()) \
[82e5fb]32(DummyValidator<boost::filesystem::path>()) \
[98d166]33(PotentialTypeValidator()) \
[baccf6]34(STLVectorValidator< std::vector<const element *> >(0,99, ElementValidator())) \
[48d20d]35(STLVectorValidator< std::vector<const element *> >(1,99, ElementValidator())) \
[4792ab]36(PositiveValidator<unsigned int>()) \
[b40690]37(PositiveValidator<double>()) \
38(PositiveValidator<unsigned int>())
[48d20d]39
40#undef statetypes
41#undef statereferences
42
43// some defines for all the names, you may use ACTION, STATE and PARAMS
[f5724f]44#define CATEGORY Potential
45#define MENUNAME "potential"
46#define MENUPOSITION 3
[48d20d]47#define ACTIONNAME FitPotential
48#define TOKEN "fit-potential"
49
50
51// finally the information stored in the ActionTrait specialization
52#define DESCRIPTION "fit an empirical potential to the given part of a specified fragment"
53#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.