control_system::protocols::ControlError Struct Reference

Definition of a control error. More...

#include <ControlError.hpp>

Classes
struct	test

Detailed Description

Definition of a control error.

A control error is used within a control system to compute how far off the the value you are controlling is from its expected value.

A conforming type must specify:

• a call operator that returns a DataVector with a signature the same as in the example shown here:
• a static constexpr size_t expected_number_of_excisions which specifies the number of excisions necessary in order to compute the control error.

• a type alias object_centers to a domain::object_list of domain::ObjectLabels. These are the objects that will require the domain::Tags::ObjectCenters tags to be in the GlobalCache for this control system to work.

  struct ExampleControlError
      : tt::ConformsTo<control_system::protocols::ControlError> {
    static constexpr size_t expected_number_of_excisions = 1;
   
    using object_centers = domain::object_list<domain::ObjectLabel::A>;
   
    void pup(PUP::er& /*p*/) {}
   
    template <typename Metavariables, typename... QueueTags>
    DataVector operator()(const Parallel::GlobalCache<Metavariables>& cache,
                          const double time,
                          const std::string& function_of_time_name,
                          const tuples::TaggedTuple<QueueTags...>& measurements) {
      const auto& functions_of_time =
          Parallel::get<domain::Tags::FunctionsOfTime>(cache);
      const double current_map_value =
          functions_of_time.at(function_of_time_name)->func(time)[0][0];
      const double measured_value = 0.0;
      // Would do something like get<QueueTag>(measurements) here
      (void)measurements;
   
      return {current_map_value - measured_value};
    }
  };

---

The documentation for this struct was generated from the following file:

• src/ControlSystem/Protocols/ControlError.hpp