Protocols.hpp
1 // Distributed under the MIT License.
2 // See LICENSE.txt for details.
3 
4 #pragma once
5 
6 namespace evolution {
7 /// \ref protocols related to evolution systems
8 namespace protocols {
9 
10 /*!
11  * \ingroup ProtocolsGroup
12  * \brief Indicates the `ConformingType` provides compile-time information for
13  * importing numeric initial data for an evolution.
14  *
15  * Requires the `ConformingType` has these type aliases:
16  * - `import_fields`: The list of tags that should be imported from a volume
17  * data file
18  *
19  * Here's an example of a class that conforms to this protocol:
20  *
21  * \snippet Evolution/Test_Protocols.cpp conforming_type_example
22  */
24  template <typename ConformingType>
25  struct test {
26  using import_fields = typename ConformingType::import_fields;
27  };
28 };
29 
30 } // namespace protocols
31 } // namespace evolution
evolution
Functionality for evolving hyperbolic partial differential equations.
Definition: AddMeshVelocityNonconservative.hpp:29
evolution::protocols::NumericInitialData
Indicates the ConformingType provides compile-time information for importing numeric initial data for...
Definition: Protocols.hpp:23
evolution::protocols::NumericInitialData::test
Definition: Protocols.hpp:25