[PL] ConstraintDirichletBC: Docu for the website.

ufz · Jun 19, 2018 · 6210aeb · 6210aeb
1 parent 013e53a
commit 6210aeb
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 0 deletions.
diff --git a/.../ConstraintDirichletBoundaryCondition/c_ConstraintDirichletBoundaryCondition.md b/.../ConstraintDirichletBoundaryCondition/c_ConstraintDirichletBoundaryCondition.md
@@ -0,0 +1,2 @@
+For the constraint Dirichlet-type boundary condition the type has to be
+ConstraintDirichlet.
diff --git a/...ndition/ConstraintDirichletBoundaryCondition/t_constraining_process_variable.md b/...ndition/ConstraintDirichletBoundaryCondition/t_constraining_process_variable.md
@@ -0,0 +1,2 @@
+This tag specifies the process variable whose flux values constrain the current
+process variable.
diff --git a/...undary_condition/ConstraintDirichletBoundaryCondition/t_constraint_direction.md b/...undary_condition/ConstraintDirichletBoundaryCondition/t_constraint_direction.md
@@ -0,0 +1,6 @@
+The value of the tag determines the evaluation of the constraint condition.
+Possible values for the tag 'constraint_directions' are 'greater' or 'lower'.
+
+If the value 'greater' is given the condition 'calculated_flux_value >
+constraint_threshold' is evaluated. If the value 'less' is given the condition
+'calculated_flux_value < constraint_threshold' is evaluated.
diff --git a/...undary_condition/ConstraintDirichletBoundaryCondition/t_constraint_threshold.md b/...undary_condition/ConstraintDirichletBoundaryCondition/t_constraint_threshold.md
@@ -0,0 +1 @@
+Threshold value used in the constraint condition.
diff --git a/...ns/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_type.md b/...ns/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_type.md
@@ -0,0 +1,3 @@
+The constraint type has to be 'Flux', i.e., the constraint is based on the
+secondary variable. It is planned to add constraints based on the value of the
+primary variables.
diff --git a/...nditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_parameter.md b/...nditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_parameter.md
@@ -0,0 +1 @@
+The name of the parameter that defines the Dirichlet-type condition values.