Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make composition threshold plugin documentation more correct and less… #6207

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Make composition threshold plugin documentation more correct and less… #6207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions source/mesh_refinement/composition_threshold.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ namespace aspect
prm.declare_entry("Compositional field thresholds",
"",
Patterns::List (Patterns::Double()),
"A list of thresholds that every individual compositional "
"field will be evaluated against.");
"A list of thresholds, one for each compositional field "
"to be evaluated against.");
}
prm.leave_subsection();
}
Expand All @@ -113,7 +113,7 @@ namespace aspect

AssertThrow (composition_thresholds.size() == this->n_compositional_fields(),
ExcMessage ("The number of thresholds given here must be "
"equal to the number of chosen refinement criteria."));
"equal to the number of compositional fields."));
}
prm.leave_subsection();
}
Expand All @@ -130,8 +130,9 @@ namespace aspect
ASPECT_REGISTER_MESH_REFINEMENT_CRITERION(CompositionThreshold,
"composition threshold",
"A mesh refinement criterion that computes refinement "
"indicators from the compositional fields. If any field "
"exceeds the threshold given in the input file, the cell "
"is marked for refinement.")
"indicators from the compositional fields. One threshold "
"per compositional is given in the input file, and if any "
"field exceeds its threshold, the cell is marked for "
"refinement.")
}
}
Loading