From 9fb62d2d0bd984045007834005e957bedd9a7ec8 Mon Sep 17 00:00:00 2001 From: Thomas Fischer <thomas.fischer@ufz.de> Date: Tue, 19 Jun 2018 08:02:04 +0200 Subject: [PATCH] [PL] ConstraintDirichletBC: Docu for the website. --- .../c_ConstraintDirichletBoundaryCondition.md | 2 ++ .../t_constraining_process_variable.md | 2 ++ .../t_constraint_direction.md | 6 ++++++ .../t_constraint_threshold.md | 1 + .../t_constraint_type.md | 3 +++ .../ConstraintDirichletBoundaryCondition/t_parameter.md | 1 + 6 files changed, 15 insertions(+) create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/c_ConstraintDirichletBoundaryCondition.md create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraining_process_variable.md create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_direction.md create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_threshold.md create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_type.md create mode 100644 Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_parameter.md diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/c_ConstraintDirichletBoundaryCondition.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/c_ConstraintDirichletBoundaryCondition.md new file mode 100644 index 00000000000..02834b84b65 --- /dev/null +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/c_ConstraintDirichletBoundaryCondition.md @@ -0,0 +1,2 @@ +For the constraint Dirichlet-type boundary condition the type has to be +ConstraintDirichlet. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraining_process_variable.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraining_process_variable.md new file mode 100644 index 00000000000..e333bfb00a0 --- /dev/null +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/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/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_direction.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_direction.md new file mode 100644 index 00000000000..f1b350eb2b7 --- /dev/null +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_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/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_threshold.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_threshold.md new file mode 100644 index 00000000000..3f6784b236b --- /dev/null +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_threshold.md @@ -0,0 +1 @@ +Threshold value used in the constraint condition. diff --git a/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_type.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_constraint_type.md new file mode 100644 index 00000000000..11c0e76288a --- /dev/null +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/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/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_parameter.md b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_parameter.md new file mode 100644 index 00000000000..f36803a9dca --- /dev/null +++ b/Documentation/ProjectFile/prj/process_variables/process_variable/boundary_conditions/boundary_condition/ConstraintDirichletBoundaryCondition/t_parameter.md @@ -0,0 +1 @@ +The name of the parameter that defines the Dirichlet-type condition values. -- GitLab