| [1a48d2] | 1 | /*
 | 
|---|
 | 2 |  * ForceAnnealingAction.def
 | 
|---|
 | 3 |  *
 | 
|---|
 | 4 |  *  Created on: Aug 02, 2014
 | 
|---|
 | 5 |  *      Author: heber
 | 
|---|
 | 6 |  */
 | 
|---|
 | 7 | 
 | 
|---|
 | 8 | // all includes and forward declarations necessary for non-integral types below
 | 
|---|
| [95cfac] | 9 | #include <boost/filesystem/path.hpp>
 | 
|---|
 | 10 | 
 | 
|---|
| [1a48d2] | 11 | #include "Parameters/Validators/DummyValidator.hpp"
 | 
|---|
 | 12 | #include "Parameters/Validators/GenericValidators.hpp"
 | 
|---|
 | 13 | #include "Parameters/Validators/Ops_Validator.hpp"
 | 
|---|
 | 14 | 
 | 
|---|
 | 15 | // i.e. there is an integer with variable name Z that can be found in
 | 
|---|
 | 16 | // ValueStorage by the token "Z" -> first column: int, Z, "Z"
 | 
|---|
 | 17 | // "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
 | 
|---|
| [1b64b2f] | 18 | #define paramtypes (boost::filesystem::path)(unsigned int)(bool)
 | 
|---|
 | 19 | #define paramtokens ("forces-file")("steps")("output-every-step")
 | 
|---|
 | 20 | #define paramdescriptions ("file containing")("fixed number of optimization steps to be performed")("whether WorldTime should be increased and output written after every step, useful if optimization might hang")
 | 
|---|
 | 21 | #define paramdefaults (PARAM_DEFAULT(""))(NOPARAM_DEFAULT)(PARAM_DEFAULT("0"))
 | 
|---|
 | 22 | #define paramreferences (forcesfile)(steps)(DoOutput)
 | 
|---|
| [1a48d2] | 23 | #define paramvalids \
 | 
|---|
 | 24 | (DummyValidator< boost::filesystem::path >()) \
 | 
|---|
 | 25 | (NotZeroValidator< unsigned int >()) \
 | 
|---|
 | 26 | (DummyValidator<bool>())
 | 
|---|
 | 27 | 
 | 
|---|
 | 28 | #define statetypes (std::vector<AtomicInfo>)(std::vector<AtomicInfo>)
 | 
|---|
 | 29 | #define statereferences (UndoInfo)(RedoInfo)
 | 
|---|
 | 30 | 
 | 
|---|
 | 31 | // some defines for all the names, you may use ACTION, STATE and PARAMS
 | 
|---|
 | 32 | #define CATEGORY Molecule
 | 
|---|
 | 33 | #define MENUNAME "molecule"
 | 
|---|
 | 34 | #define MENUPOSITION 12
 | 
|---|
 | 35 | #define ACTIONNAME ForceAnnealing
 | 
|---|
 | 36 | #define TOKEN "force-annealing"
 | 
|---|
 | 37 | 
 | 
|---|
 | 38 | // finally the information stored in the ActionTrait specialization
 | 
|---|
 | 39 | #define DESCRIPTION "perform a single step optimizing the current forces acting on the atoms"
 | 
|---|
 | 40 | #undef SHORTFORM
 | 
|---|