aboutsummaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorIan Hinder <ian.hinder@aei.mpg.de>2012-05-21 18:03:15 +0200
committerIan Hinder <ian.hinder@aei.mpg.de>2012-11-14 16:17:48 +0100
commit58eb73177f4ea930b8380772bd4c7fdaa663dc8f (patch)
treeedae7e5a91f87d56b38c614cc03345981b5d905b /Doc
parent4ac728ac483c7b1a488474f87ff097905466d7eb (diff)
Add ParameterConditions option for CreateThorn
This option allows the user to set certain conditions on parameters which must be satisfied otherwise the thorn aborts with a given error message (details in Doc/KrancDoc.tex).
Diffstat (limited to 'Doc')
-rw-r--r--Doc/KrancDoc.tex6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/KrancDoc.tex b/Doc/KrancDoc.tex
index a39cb74..c4f06bc 100644
--- a/Doc/KrancDoc.tex
+++ b/Doc/KrancDoc.tex
@@ -968,6 +968,12 @@ same arguments, but they can be tensorial in nature.
KeywordParameters & list of KeywordParameterDefinition structures & A list of parameter definition structures for all the keyword parameters which this thorn will define and use. (optional) & \{\} \\
+ ParameterConditions & list of parameter conditions & Each condition
+ is of the form \{\textit{condition}, \textit{message}\}, where
+ \textit{condition} is a boolean expression in parameter names, and
+ \textit{message} is the message for a fatal error which is generated
+ when the thorn starts if \textit{condition} is not satisfied & \{\} \\
+
InheritedImplementations & list of strings & A list of all the implementations which this thorn
will inherit from. This is necessary to use grid functions
provided by these implementations. (optional) & \{\} \\