Skip to content

Commit

Permalink
Merge pull request #5974 from bangerth/manager-check
Browse files Browse the repository at this point in the history 
Test that manager classes fill both base class member variables consistently.
  • Loading branch information
@gassmoeller
gassmoeller authored Jul 18, 2024
2 parents 2f514b4 + 3c78126 commit 994f686
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 31 deletions.
6 changes: 1 addition & 5 deletions include/aspect/plugins.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -294,11 +294,7 @@ namespace aspect
template <typename InterfaceType>
ManagerBase<InterfaceType>::~ManagerBase()
{
// Not all derived manager classes currently set the 'plugin_names'
// variable, but for those that do, they better have as many names
// as there are plugins.
if (plugin_names.size() > 0)
Assert (plugin_names.size() == plugin_objects.size(), ExcInternalError());
Assert (plugin_names.size() == plugin_objects.size(), ExcInternalError());
}


Expand Down
52 changes: 26 additions & 26 deletions source/postprocess/interface.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,11 @@ namespace aspect
ExcMessage ("No postprocessors registered!?"));

// first find out which postprocessors are requested
std::vector<std::string> postprocessor_names;
prm.enter_subsection("Postprocess");
{
postprocessor_names
this->plugin_names
= Utilities::split_string_list(prm.get("List of postprocessors"));
AssertThrow(Utilities::has_unique_entries(postprocessor_names),
AssertThrow(Utilities::has_unique_entries(this->plugin_names),
ExcMessage("The list of strings for the parameter "
"'Postprocess/List of postprocessors' contains entries more than once. "
"This is not allowed. Please check your parameter file."));
Expand All @@ -197,37 +196,37 @@ namespace aspect

// see if 'all' was selected (or is part of the list). if so
// simply replace the list with one that contains all names
if (std::find (postprocessor_names.begin(),
postprocessor_names.end(),
"all") != postprocessor_names.end())
if (std::find (this->plugin_names.begin(),
this->plugin_names.end(),
"all") != this->plugin_names.end())
{
postprocessor_names.clear();
this->plugin_names.clear();
for (typename std::list<typename aspect::internal::Plugins::PluginList<Interface<dim>>::PluginInfo>::const_iterator
p = std::get<dim>(registered_plugins).plugins->begin();
p != std::get<dim>(registered_plugins).plugins->end(); ++p)
postprocessor_names.push_back (std::get<0>(*p));
this->plugin_names.push_back (std::get<0>(*p));
}

// see if the user specified "global statistics" somewhere; if so, remove
// it from the list because we will *always* want to have it and so
// whether or not it has been explicitly provided by the user makes no
// difference.
std::vector<std::string>::iterator new_end
= std::remove (postprocessor_names.begin(),
postprocessor_names.end(),
= std::remove (this->plugin_names.begin(),
this->plugin_names.end(),
"global statistics");
if (new_end != postprocessor_names.end())
postprocessor_names.erase (new_end, postprocessor_names.end());
if (new_end != this->plugin_names.end())
this->plugin_names.erase (new_end, this->plugin_names.end());

// in any case, put the global statistics postprocessor at the front:
postprocessor_names.insert(postprocessor_names.begin(), "global statistics");
this->plugin_names.insert(this->plugin_names.begin(), "global statistics");

// then go through the list, create objects and let them parse
// their own parameters
for (unsigned int name=0; name<postprocessor_names.size(); ++name)
for (unsigned int name=0; name<this->plugin_names.size(); ++name)
{
this->plugin_objects.emplace_back (std::get<dim>(registered_plugins)
.create_plugin (postprocessor_names[name],
.create_plugin (this->plugin_names[name],
"Postprocessor plugins"));
if (SimulatorAccess<dim> *sim = dynamic_cast<SimulatorAccess<dim>*>(&*this->plugin_objects.back()))
sim->initialize_simulator (this->get_simulator());
Expand All @@ -245,27 +244,27 @@ namespace aspect
{
AssertThrow (Patterns::Selection(std::get<dim>(registered_plugins).get_pattern_of_names ())
.match (p) == true,
ExcMessage ("Postprocessor <" + postprocessor_names[name] +
ExcMessage ("Postprocessor <" + this->plugin_names[name] +
"> states that it depends on another postprocessor, <"
+ p +
">, but the latter is not a valid name."));

bool already_present = false;
for (const auto &postprocessor_name : postprocessor_names)
for (const auto &postprocessor_name : this->plugin_names)
if (postprocessor_name == p)
{
already_present = true;
break;
}

if (already_present == false)
postprocessor_names.push_back (p);
this->plugin_names.push_back (p);
}
}
Assert (postprocessor_names.size() == this->plugin_objects.size(),
Assert (this->plugin_names.size() == this->plugin_objects.size(),
ExcInternalError());

// we now have matching lists 'this->plugin_objects' and 'postprocessor_names'
// we now have matching lists 'this->plugin_objects' and 'this->plugin_names'
// that define which postprocessors we have. we just need to bring them
// into an order so that dependencies run first, and dependents after
// them. the algorithm for creating a sorted list for this works as follows:
Expand All @@ -290,7 +289,7 @@ namespace aspect
{
typename std::list<std::unique_ptr<Interface<dim>>>::iterator
pp = this->plugin_objects.begin();
for (unsigned int i=0; i<postprocessor_names.size(); ++i, ++pp)
for (unsigned int i=0; i<this->plugin_names.size(); ++i, ++pp)
if (already_assigned[i] == false)
{
// for this postprocessor, check if all of its dependencies
Expand All @@ -315,7 +314,7 @@ namespace aspect
// function.
if (unmet_dependencies == false)
{
sorted_names.push_back (postprocessor_names[i]);
sorted_names.push_back (this->plugin_names[i]);
sorted_postprocessors.emplace_back (std::move(*pp));
already_assigned[i] = true;
at_least_one_element_added = true;
Expand All @@ -332,10 +331,10 @@ namespace aspect
"postprocessors are involved:\n";
typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator
pp = this->plugin_objects.begin();
for (unsigned int i=0; i<postprocessor_names.size(); ++i, ++pp)
for (unsigned int i=0; i<this->plugin_names.size(); ++i, ++pp)
if (already_assigned[i] == false)
{
out << " " << postprocessor_names[i] << " -> ";
out << " " << this->plugin_names[i] << " -> ";
const std::list<std::string> deps = (*pp)->required_other_postprocessors();
for (const auto &p : deps)
out << "'" << p << "' ";
Expand All @@ -344,16 +343,17 @@ namespace aspect
AssertThrow (false, ExcMessage(out.str()));
}
}
Assert (postprocessor_names.size() == sorted_names.size(),
Assert (this->plugin_names.size() == sorted_names.size(),
ExcInternalError());
Assert (sorted_postprocessors.size() == sorted_names.size(),
ExcInternalError());
Assert (std::find (already_assigned.begin(), already_assigned.end(), false) == already_assigned.end(),
ExcInternalError());

// finally swap the unsorted list with the sorted list and only
// finally swap the unsorted lists with the sorted lists and only
// keep the latter
this->plugin_objects.swap (sorted_postprocessors);
this->plugin_names.swap (sorted_names);
}


Expand Down

0 comments on commit 994f686

Please sign in to comment.