source: src/Actions/WorldAction/SetBoundaryConditionsAction.def

Candidate_v1.6.1
Last change on this file was 2a7dbe, checked in by Frederik Heber <heber@…>, 9 years ago

FIX: Help on SetBoundaryConditionsAction did not have capitalized condition name.

  • Property mode set to 100644
File size: 1.4 KB
Line 
1/*
2 * SetBoundaryConditionsAction.def
3 *
4 * Created on: Jan 2, 2012
5 * Author: heber
6 */
7
8// all includes and forward declarations necessary for non-integral types below
9#include <vector>
10#include <string>
11
12#include "Parameters/Validators/STLVectorValidator.hpp"
13#include "Parameters/Validators/Specific/BoundaryConditionValidator.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
18#define paramtypes (std::vector< std::string >)
19#define paramtokens ("set-boundary-conditions")
20#define paramdescriptions ("new boundary conditions as list of three strings, e.g. 'Wrap Bounce Ignore'")
21#undef paramdefaults
22#define paramreferences (newconditions)
23#define paramvalids \
24(STLVectorValidator< std::vector< std::string > >(NDIM, NDIM, BoundaryConditionValidator()))
25
26#define statetypes (std::string)
27#define statereferences (undostate)
28
29// some defines for all the names, you may use ACTION, STATE and PARAMS
30#define CATEGORY World
31#define MENUNAME "world"
32#define MENUPOSITION 10
33#define ACTIONNAME SetBoundaryConditions
34#define TOKEN "set-boundary-conditions"
35
36
37// finally the information stored in the ActionTrait specialization
38#define DESCRIPTION "set the boundary conditions of the simulation domain"
39#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.