Skip to content

Commit 73656aa

Browse files
authored
Merge pull request #6207 from jdannberg/composition_threshold_documentation
Make composition threshold plugin documentation more correct and less…
2 parents 0f9a74b + 8975795 commit 73656aa

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

source/mesh_refinement/composition_threshold.cc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ namespace aspect
9191
prm.declare_entry("Compositional field thresholds",
9292
"",
9393
Patterns::List (Patterns::Double()),
94-
"A list of thresholds that every individual compositional "
95-
"field will be evaluated against.");
94+
"A list of thresholds, one for each compositional field "
95+
"to be evaluated against.");
9696
}
9797
prm.leave_subsection();
9898
}
@@ -113,7 +113,7 @@ namespace aspect
113113

114114
AssertThrow (composition_thresholds.size() == this->n_compositional_fields(),
115115
ExcMessage ("The number of thresholds given here must be "
116-
"equal to the number of chosen refinement criteria."));
116+
"equal to the number of compositional fields."));
117117
}
118118
prm.leave_subsection();
119119
}
@@ -130,8 +130,9 @@ namespace aspect
130130
ASPECT_REGISTER_MESH_REFINEMENT_CRITERION(CompositionThreshold,
131131
"composition threshold",
132132
"A mesh refinement criterion that computes refinement "
133-
"indicators from the compositional fields. If any field "
134-
"exceeds the threshold given in the input file, the cell "
135-
"is marked for refinement.")
133+
"indicators from the compositional fields. One threshold "
134+
"per compositional is given in the input file, and if any "
135+
"field exceeds its threshold, the cell is marked for "
136+
"refinement.")
136137
}
137138
}

0 commit comments

Comments
 (0)