From 2dff52cd17036ddfc8752827a13435c5f65c5557 Mon Sep 17 00:00:00 2001 From: Kulindu Cooray Date: Fri, 20 Oct 2023 12:52:44 -0400 Subject: [PATCH 01/15] Python api and handle structs --- src/pcms/capi/client.cpp | 86 +++++++++++------------ src/pcms/capi/client.h | 49 ++++++------- src/pcms/client.h | 5 ++ src/pcms/pythonapi/CMakeLists.txt | 4 ++ src/pcms/pythonapi/c_client_pybind.cpp | 97 ++++++++++++++++++++++++++ src/pcms/pythonapi/client_pybind.cpp | 42 +++++++++++ src/pcms/pythonapi/kokkos_pybind.cpp | 15 ++++ test/test_proxy_coupling_xgc_client.c | 10 +-- 8 files changed, 236 insertions(+), 72 deletions(-) create mode 100644 src/pcms/pythonapi/CMakeLists.txt create mode 100644 src/pcms/pythonapi/c_client_pybind.cpp create mode 100644 src/pcms/pythonapi/client_pybind.cpp create mode 100644 src/pcms/pythonapi/kokkos_pybind.cpp diff --git a/src/pcms/capi/client.cpp b/src/pcms/capi/client.cpp index 23713af7..0d7f22e3 100644 --- a/src/pcms/capi/client.cpp +++ b/src/pcms/capi/client.cpp @@ -26,30 +26,30 @@ using FieldAdapterVariant = } // namespace pcms -[[nodiscard]] PcmsClientHandle* pcms_create_client(const char* name, +[[nodiscard]] PcmsClientHandle pcms_create_client(const char* name, MPI_Comm comm) { auto* client = new pcms::CouplerClient(name, comm); - return reinterpret_cast(client); + return {reinterpret_cast(client)}; } -void pcms_destroy_client(PcmsClientHandle* client) +void pcms_destroy_client(PcmsClientHandle client) { - if (client != nullptr) - delete reinterpret_cast(client); + if (client.pointer != nullptr) + delete reinterpret_cast(client.pointer); } -PcmsReverseClassificationHandle* pcms_load_reverse_classification( +PcmsReverseClassificationHandle pcms_load_reverse_classification( const char* file, MPI_Comm comm) { //std::filesystem::path filepath{file}; auto* rc = new pcms::ReverseClassificationVertex{ pcms::ReadReverseClassificationVertex(file, comm)}; - return reinterpret_cast(rc); + return {reinterpret_cast(rc)}; } void pcms_destroy_reverse_classification( - PcmsReverseClassificationHandle* rc) + PcmsReverseClassificationHandle rc) { - if (rc != nullptr) - delete reinterpret_cast(rc); + if (rc.pointer != nullptr) + delete reinterpret_cast(rc.pointer); } struct AddFieldVariantOperators { @@ -71,15 +71,15 @@ struct AddFieldVariantOperators { bool participates_; }; -PcmsFieldHandle* pcms_add_field(PcmsClientHandle* client_handle, +PcmsFieldHandle pcms_add_field(PcmsClientHandle client_handle, const char* name, - PcmsFieldAdapterHandle* adapter_handle, + PcmsFieldAdapterHandle adapter_handle, int participates) { auto* adapter = - reinterpret_cast(adapter_handle); - auto* client = reinterpret_cast(client_handle); + reinterpret_cast(adapter_handle.pointer); + auto* client = reinterpret_cast(client_handle.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); PCMS_ALWAYS_ASSERT(adapter != nullptr); //pcms::CoupledField* field = std::visit( @@ -90,30 +90,30 @@ PcmsFieldHandle* pcms_add_field(PcmsClientHandle* client_handle, // }}, // *adapter); pcms::CoupledField* field = std::visit(AddFieldVariantOperators{name, client, participates},*adapter); - return reinterpret_cast(field); + return {reinterpret_cast(field)}; } -void pcms_send_field_name(PcmsClientHandle* client_handle, const char* name) +void pcms_send_field_name(PcmsClientHandle client_handle, const char* name) { - auto* client = reinterpret_cast(client_handle); + auto* client = reinterpret_cast(client_handle.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); client->SendField(name); } -void pcms_receive_field_name(PcmsClientHandle* client_handle, +void pcms_receive_field_name(PcmsClientHandle client_handle, const char* name) { - auto* client = reinterpret_cast(client_handle); + auto* client = reinterpret_cast(client_handle.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); client->ReceiveField(name); } -void pcms_send_field(PcmsFieldHandle* field_handle) +void pcms_send_field(PcmsFieldHandle field_handle) { - auto* field = reinterpret_cast(field_handle); + auto* field = reinterpret_cast(field_handle.pointer); PCMS_ALWAYS_ASSERT(field != nullptr); field->Send(); } -void pcms_receive_field(PcmsFieldHandle* field_handle) +void pcms_receive_field(PcmsFieldHandle field_handle) { - auto* field = reinterpret_cast(field_handle); + auto* field = reinterpret_cast(field_handle.pointer); PCMS_ALWAYS_ASSERT(field != nullptr); field->Receive(); } @@ -129,14 +129,14 @@ void pcms_create_xgc_field_adapter_t( field_adapter.emplace>( name, comm, data_view, reverse_classification, in_overlap); } -PcmsFieldAdapterHandle* pcms_create_xgc_field_adapter( +PcmsFieldAdapterHandle pcms_create_xgc_field_adapter( const char* name, MPI_Comm comm, void* data, int size, PcmsType data_type, - const PcmsReverseClassificationHandle* rc, in_overlap_function in_overlap) + const PcmsReverseClassificationHandle rc, in_overlap_function in_overlap) { auto* field_adapter = new pcms::FieldAdapterVariant{}; - PCMS_ALWAYS_ASSERT(rc != nullptr); + PCMS_ALWAYS_ASSERT(rc.pointer != nullptr); auto* reverse_classification = - reinterpret_cast(rc); + reinterpret_cast(rc.pointer); PCMS_ALWAYS_ASSERT(reverse_classification != nullptr); switch (data_type) { case PCMS_DOUBLE: @@ -159,27 +159,27 @@ PcmsFieldAdapterHandle* pcms_create_xgc_field_adapter( printf("tyring to create XGC adapter with invalid type! %d", data_type); std::abort(); } - return reinterpret_cast(field_adapter); + return {reinterpret_cast(field_adapter)}; } -PcmsFieldAdapterHandle* pcms_create_dummy_field_adapter() { +PcmsFieldAdapterHandle pcms_create_dummy_field_adapter() { auto* field_adapter = new pcms::FieldAdapterVariant{pcms::DummyFieldAdapter{}}; - return reinterpret_cast(field_adapter); + return {reinterpret_cast(field_adapter)}; } -void pcms_destroy_field_adapter(PcmsFieldAdapterHandle* adapter_handle) +void pcms_destroy_field_adapter(PcmsFieldAdapterHandle adapter_handle) { auto* adapter = - reinterpret_cast(adapter_handle); + reinterpret_cast(adapter_handle.pointer); if (adapter != nullptr) { delete adapter; adapter = nullptr; } } int pcms_reverse_classification_count_verts( - PcmsReverseClassificationHandle* rc) + PcmsReverseClassificationHandle rc) { auto* reverse_classification = - reinterpret_cast(rc); + reinterpret_cast(rc.pointer); PCMS_ALWAYS_ASSERT(reverse_classification != nullptr); return std::accumulate(reverse_classification->begin(), reverse_classification->end(), 0, @@ -187,23 +187,23 @@ int pcms_reverse_classification_count_verts( return current + verts.second.size(); }); } -void pcms_begin_send_phase(PcmsClientHandle* h) { - auto* client = reinterpret_cast(h); +void pcms_begin_send_phase(PcmsClientHandle h) { + auto* client = reinterpret_cast(h.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); client ->BeginSendPhase(); } -void pcms_end_send_phase(PcmsClientHandle* h) { - auto* client = reinterpret_cast(h); +void pcms_end_send_phase(PcmsClientHandle h) { + auto* client = reinterpret_cast(h.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); client ->EndSendPhase(); } -void pcms_begin_receive_phase(PcmsClientHandle* h ) { - auto* client = reinterpret_cast(h); +void pcms_begin_receive_phase(PcmsClientHandle h ) { + auto* client = reinterpret_cast(h.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); client ->BeginReceivePhase(); } -void pcms_end_receive_phase(PcmsClientHandle* h) { - auto* client = reinterpret_cast(h); +void pcms_end_receive_phase(PcmsClientHandle h) { + auto* client = reinterpret_cast(h.pointer); PCMS_ALWAYS_ASSERT(client != nullptr); client ->EndReceivePhase(); -} +} \ No newline at end of file diff --git a/src/pcms/capi/client.h b/src/pcms/capi/client.h index fdde48ca..72865037 100644 --- a/src/pcms/capi/client.h +++ b/src/pcms/capi/client.h @@ -6,15 +6,15 @@ #ifdef __cplusplus extern "C" { #endif -struct PcmsClientHandle; +struct PcmsClientHandle { void* pointer; }; typedef struct PcmsClientHandle PcmsClientHandle; -struct PcmsOmegaHMeshHandle; +struct PcmsOmegaHMeshHandle { void* pointer; }; typedef struct PcmsOmegaHMeshHandle PcmsOmegaHMeshHandle; -struct PcmsReverseClassificationHandle; +struct PcmsReverseClassificationHandle { void* pointer; }; typedef struct PcmsReverseClassificationHandle PcmsReverseClassificationHandle; -struct PcmsFieldAdapterHandle; +struct PcmsFieldAdapterHandle { void* pointer; }; typedef struct PcmsFieldAdapterHandle PcmsFieldAdapterHandle; -struct PcmsFieldHandle; +struct PcmsFieldHandle { void* pointer; }; typedef struct PcmsFieldHandle PcmsFieldHandle; enum PcmsAdapterType @@ -34,45 +34,46 @@ enum PcmsType }; typedef enum PcmsType PcmsType; -PcmsClientHandle* pcms_create_client(const char* name, MPI_Comm comm); -void pcms_destroy_client(PcmsClientHandle*); +//change to a struct holding a pointer +PcmsClientHandle pcms_create_client(const char* name, MPI_Comm comm); +void pcms_destroy_client(PcmsClientHandle); // returns a pointer to a handle to a reverse classification object -PcmsReverseClassificationHandle* pcms_load_reverse_classification( +PcmsReverseClassificationHandle pcms_load_reverse_classification( const char* file, MPI_Comm comm); -void pcms_destroy_reverse_classification(PcmsReverseClassificationHandle*); +void pcms_destroy_reverse_classification(PcmsReverseClassificationHandle); // this function is helpful for test cases so we can compute the total number of // vertexes in the mesh without reading additional files. This function is not // likely to be needed for production cases int pcms_reverse_classification_count_verts( - PcmsReverseClassificationHandle*); + PcmsReverseClassificationHandle); // takes in overlap function takes a geometric dimension and a geometric id // C doesn't have a builtin bool type, so we use int for compatability with C++ typedef int8_t (*in_overlap_function)(int, int); -PcmsFieldAdapterHandle* pcms_create_xgc_field_adapter( +PcmsFieldAdapterHandle pcms_create_xgc_field_adapter( const char* name, MPI_Comm plane_comm, void* data, int size, PcmsType data_type, - const PcmsReverseClassificationHandle* rc, in_overlap_function in_overlap); + const PcmsReverseClassificationHandle rc, in_overlap_function in_overlap); -PcmsFieldAdapterHandle* pcms_create_dummy_field_adapter(); +PcmsFieldAdapterHandle pcms_create_dummy_field_adapter(); -void pcms_destroy_field_adapter(PcmsFieldAdapterHandle*); +void pcms_destroy_field_adapter(PcmsFieldAdapterHandle); -PcmsFieldHandle* pcms_add_field(PcmsClientHandle* client_handle, +PcmsFieldHandle pcms_add_field(PcmsClientHandle client_handle, const char* name, - PcmsFieldAdapterHandle* adapter_handle, + PcmsFieldAdapterHandle adapter_handle, int participates); -void pcms_send_field_name(PcmsClientHandle*, const char* name); -void pcms_receive_field_name(PcmsClientHandle*, const char* name); +void pcms_send_field_name(PcmsClientHandle, const char* name); +void pcms_receive_field_name(PcmsClientHandle, const char* name); -void pcms_send_field(PcmsFieldHandle*); -void pcms_receive_field(PcmsFieldHandle*); +void pcms_send_field(PcmsFieldHandle); +void pcms_receive_field(PcmsFieldHandle); -void pcms_begin_send_phase(PcmsClientHandle*); -void pcms_end_send_phase(PcmsClientHandle*); -void pcms_begin_receive_phase(PcmsClientHandle*); -void pcms_end_receive_phase(PcmsClientHandle*); +void pcms_begin_send_phase(PcmsClientHandle); +void pcms_end_send_phase(PcmsClientHandle); +void pcms_begin_receive_phase(PcmsClientHandle); +void pcms_end_receive_phase(PcmsClientHandle); #ifdef __cplusplus } #endif diff --git a/src/pcms/client.h b/src/pcms/client.h index eaab5404..37021df1 100644 --- a/src/pcms/client.h +++ b/src/pcms/client.h @@ -3,6 +3,8 @@ #include "pcms/common.h" #include "pcms/field_communicator.h" #include "pcms/profile.h" + + namespace pcms { @@ -86,6 +88,9 @@ class CoupledField private: std::unique_ptr coupled_field_; }; + + + class CouplerClient { public: diff --git a/src/pcms/pythonapi/CMakeLists.txt b/src/pcms/pythonapi/CMakeLists.txt new file mode 100644 index 00000000..c6180711 --- /dev/null +++ b/src/pcms/pythonapi/CMakeLists.txt @@ -0,0 +1,4 @@ +find_package(pybind11) + +pybind11_add_module(pcms_client client_pybind.cpp) +target_link_libraries() \ No newline at end of file diff --git a/src/pcms/pythonapi/c_client_pybind.cpp b/src/pcms/pythonapi/c_client_pybind.cpp new file mode 100644 index 00000000..f06d9ec6 --- /dev/null +++ b/src/pcms/pythonapi/c_client_pybind.cpp @@ -0,0 +1,97 @@ +#include +#include +#include "../capi/client.h" +#include "pcms.h" +#include "pcms/xgc_field_adapter.h" +#include +#include +// #ifdef PCMS_HAS_OMEGA_H +// #include "pcms/omega_h_field.h" +// #endif +#include +#include "pcms/xgc_reverse_classification.h" +#include "pcms/dummy_field_adapter.h" +#include + +template +struct VALID_PCMS_TYPE : std::false_type {}; +template<> +struct VALID_PCMS_TYPE : std::true_type {}; +template<> +struct VALID_PCMS_TYPE : std::true_type {}; +template<> +struct VALID_PCMS_TYPE : std::true_type {}; +template<> +struct VALID_PCMS_TYPE : std::true_type {}; + + + +namespace py = pybind11; + + +template +PcmsFieldAdapterHandle xgc_field_adapter_numpy(const char* name, MPI_Comm comm, py::array_t data, +const PcmsReverseClassificationHandle rc, in_overlap_function in_overlap) { + //Check T typing (SFINAE) + static_assert(VALID_PCMS_TYPE::value, "Passed type is invalid"); + + auto buffer_info = data.request(); // Get information about the NumPy array + + int size = buffer_info.size; // Get the size of the NumPy array + + auto field_adapter = new pcms::FieldAdapterVariant{}; + PCMS_ALWAYS_ASSERT(rc.pointer != nullptr); + + auto reverse_classification = reinterpret_cast(rc.pointer); + PCMS_ALWAYS_ASSERT(reverse_classification != nullptr); + + pcms_create_xgc_field_adapter_t(name, comm, buffer_info.ptr, size, + *reverse_classification, in_overlap, *field_adapter); + + return PcmsFieldAdapterHandle{reinterpret_cast(field_adapter)}; +} + + +PYBIND11_MODULE(pcms_client, m) +{ + m.doc() = "Python bindings for C PCMS client functions"; + + py::enum_(m, "PcmsAdapterType") + .value("PCMS_ADAPTER_XGC", PCMS_ADAPTER_XGC) + .value("PCMS_ADAPTER_OMEGAH", PCMS_ADAPTER_OMEGAH) + .value("PCMS_ADAPTER_GENE", PCMS_ADAPTER_GENE) + .value("PCMS_ADAPTER_GEM", PCMS_ADAPTER_GEM); + + py::enum_(m, "PcmsType") + .value("PCMS_FLOAT", PCMS_FLOAT) + .value("PCMS_DOUBLE", PCMS_DOUBLE) + .value("PCMS_INT", PCMS_INT) + .value("PCMS_LONG_INT", PCMS_LONG_INT); + + + m.def("pcms_create_client", &pcms_create_client, "Create a PCMS client"); + m.def("pcms_destroy_client", &pcms_destroy_client, "Destroy a PCMS client"); + m.def("pcms_load_reverse_classification", &pcms_load_reverse_classification, "Load reverse classification data"); + m.def("pcms_destroy_reverse_classification", &pcms_destroy_reverse_classification, "Destroy reverse classification data"); + m.def("pcms_reverse_classification_count_verts", &pcms_reverse_classification_count_verts, "Count vertices in reverse classification"); + + m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for double"); + m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for float"); + m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for int"); + m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for long int"); + + m.def("pcms_create_xgc_field_adapter", &pcms_create_xgc_field_adapter, "Create an XGC field adapter"); + m.def("pcms_create_dummy_field_adapter", &pcms_create_dummy_field_adapter, "Create a dummy field adapter"); + m.def("pcms_destroy_field_adapter", &pcms_destroy_field_adapter, "Destroy a field adapter"); + m.def("pcms_add_field", &pcms_add_field, "Add a field"); + m.def("pcms_send_field_name", &pcms_send_field_name, "Send field name"); + m.def("pcms_receive_field_name", &pcms_receive_field_name, "Receive field name"); + m.def("pcms_send_field", &pcms_send_field, "Send field"); + m.def("pcms_receive_field", &pcms_receive_field, "Receive field"); + m.def("pcms_begin_send_phase", &pcms_begin_send_phase, "Begin send phase"); + m.def("pcms_end_send_phase", &pcms_end_send_phase, "End send phase"); + m.def("pcms_begin_receive_phase", &pcms_begin_receive_phase, "Begin receive phase"); + m.def("pcms_end_receive_phase", &pcms_end_receive_phase, "End receive phase"); +} + + diff --git a/src/pcms/pythonapi/client_pybind.cpp b/src/pcms/pythonapi/client_pybind.cpp new file mode 100644 index 00000000..2f786953 --- /dev/null +++ b/src/pcms/pythonapi/client_pybind.cpp @@ -0,0 +1,42 @@ +#ifndef PCMS_COUPLING_CLIENT_H +#define PCMS_COUPLING_CLIENT_H +#include +#include +#include "pcms/common.h" +#include "pcms/field_communicator.h" +#include "pcms/profile.h" +#include "../client.h" + + +namespace py = pybind11; + +PYBIND11_MODULE(pcms_client, m) { + m.doc() = "CMS Coupling Client C++ Pybind11 Bindings"; + + py::enum_(m, "Mode") + .value("Deferred", Mode::Deferred); + .value("Synchronous", Mode::Synchronous); + + + py::class_(m, "CoupledField") + .def(py::init()); + .def("Send", &CoupledField::Send, py::arg("mode") = Mode::Synchronous); + .def("Receive", &CoupledField::Receive); + + py::class_(m, "CouplerClient") + .def(py::init()); + .def("GetPartition", &CouplerClient::GetPartition, py::return_value_policy::reference); //redev::Partition& + .def("AddField", &CouplerClient::AddField, py::arg("name"), py::arg("field_adapter"), py::arg("participates") = true, + py::return_value_policy::reference); //CoupledField* + .def("SendField", &CouplerClient::SendField, const std::string&, py::arg("mode") = Mode::Synchronous); //void + .def("ReceiveField", &CouplerClient::ReceiveField, const std::string&); //void + .def("InSendPhase", &CouplerClient::InSendPhase); //bool + .def("InReceivePhase", &CouplerClient::InReceivePhase); //bool + .def("BeginSendPhase", &CouplerClient::BeginSendPhase); //void + .def("EndSendPhase", &CouplerClient::EndSendPhase); //void + .def("BeginReceivePhase", &CouplerClient::BeginReceivePhase); //void + .def("EndReceivePhase", &CouplerClient::EndReceivePhase); //void +} + // namespace pcms + +#endif // PCMS_COUPLING_CLIENT_H diff --git a/src/pcms/pythonapi/kokkos_pybind.cpp b/src/pcms/pythonapi/kokkos_pybind.cpp new file mode 100644 index 00000000..4f029697 --- /dev/null +++ b/src/pcms/pythonapi/kokkos_pybind.cpp @@ -0,0 +1,15 @@ +#include +#include +#include + + +namespace py = pybind11; + + +PYBIND11_MODULE(pcms_kokkos_module, m) { + m.def("initialize_kokkos", &pcms_kokkos_initialize_without_args, "Initialize Kokkos"); + m.def("finalize_kokkos", &pcms_kokkos_finalize, "Finalize Kokkos"); +} + + + diff --git a/test/test_proxy_coupling_xgc_client.c b/test/test_proxy_coupling_xgc_client.c index 8ffc19be..38650500 100644 --- a/test/test_proxy_coupling_xgc_client.c +++ b/test/test_proxy_coupling_xgc_client.c @@ -2,7 +2,7 @@ #include #include #include -#include +#include int8_t in_overlap(int dimension, int id) { @@ -51,16 +51,16 @@ int main(int argc, char** argv) printf("world: %d %d; plane: %d %d ; client: %d %d\n", world_rank, world_size, plane_rank, plane_size, client_rank, client_size); - PcmsClientHandle* client = + PcmsClientHandle client = pcms_create_client("proxy_couple", client_comm); const char* rc_file = argv[1]; - PcmsReverseClassificationHandle* rc = + PcmsReverseClassificationHandle rc = pcms_load_reverse_classification(rc_file, MPI_COMM_WORLD); const int nverts = pcms_reverse_classification_count_verts(rc); // long int* data[nplanes]; long int* data = calloc(nverts, sizeof(long int)); - PcmsFieldHandle* field[nplanes]; - PcmsFieldAdapterHandle* field_adapters[nplanes]; + PcmsFieldHandle field[nplanes]; + PcmsFieldAdapterHandle field_adapters[nplanes]; for (int i = 0; i < nplanes; ++i) { char field_name[100]; sprintf(field_name, "xgc_gids_plane_%d", i); From 86f32532eab885418a806a6e0723e6c134d53af2 Mon Sep 17 00:00:00 2001 From: Kulindu Cooray <102121038+KulinduC@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:42:21 -0400 Subject: [PATCH 02/15] Delete src/pcms/pythonapi directory --- src/pcms/pythonapi/CMakeLists.txt | 4 -- src/pcms/pythonapi/c_client_pybind.cpp | 97 -------------------------- src/pcms/pythonapi/client_pybind.cpp | 42 ----------- src/pcms/pythonapi/kokkos_pybind.cpp | 15 ---- 4 files changed, 158 deletions(-) delete mode 100644 src/pcms/pythonapi/CMakeLists.txt delete mode 100644 src/pcms/pythonapi/c_client_pybind.cpp delete mode 100644 src/pcms/pythonapi/client_pybind.cpp delete mode 100644 src/pcms/pythonapi/kokkos_pybind.cpp diff --git a/src/pcms/pythonapi/CMakeLists.txt b/src/pcms/pythonapi/CMakeLists.txt deleted file mode 100644 index c6180711..00000000 --- a/src/pcms/pythonapi/CMakeLists.txt +++ /dev/null @@ -1,4 +0,0 @@ -find_package(pybind11) - -pybind11_add_module(pcms_client client_pybind.cpp) -target_link_libraries() \ No newline at end of file diff --git a/src/pcms/pythonapi/c_client_pybind.cpp b/src/pcms/pythonapi/c_client_pybind.cpp deleted file mode 100644 index f06d9ec6..00000000 --- a/src/pcms/pythonapi/c_client_pybind.cpp +++ /dev/null @@ -1,97 +0,0 @@ -#include -#include -#include "../capi/client.h" -#include "pcms.h" -#include "pcms/xgc_field_adapter.h" -#include -#include -// #ifdef PCMS_HAS_OMEGA_H -// #include "pcms/omega_h_field.h" -// #endif -#include -#include "pcms/xgc_reverse_classification.h" -#include "pcms/dummy_field_adapter.h" -#include - -template -struct VALID_PCMS_TYPE : std::false_type {}; -template<> -struct VALID_PCMS_TYPE : std::true_type {}; -template<> -struct VALID_PCMS_TYPE : std::true_type {}; -template<> -struct VALID_PCMS_TYPE : std::true_type {}; -template<> -struct VALID_PCMS_TYPE : std::true_type {}; - - - -namespace py = pybind11; - - -template -PcmsFieldAdapterHandle xgc_field_adapter_numpy(const char* name, MPI_Comm comm, py::array_t data, -const PcmsReverseClassificationHandle rc, in_overlap_function in_overlap) { - //Check T typing (SFINAE) - static_assert(VALID_PCMS_TYPE::value, "Passed type is invalid"); - - auto buffer_info = data.request(); // Get information about the NumPy array - - int size = buffer_info.size; // Get the size of the NumPy array - - auto field_adapter = new pcms::FieldAdapterVariant{}; - PCMS_ALWAYS_ASSERT(rc.pointer != nullptr); - - auto reverse_classification = reinterpret_cast(rc.pointer); - PCMS_ALWAYS_ASSERT(reverse_classification != nullptr); - - pcms_create_xgc_field_adapter_t(name, comm, buffer_info.ptr, size, - *reverse_classification, in_overlap, *field_adapter); - - return PcmsFieldAdapterHandle{reinterpret_cast(field_adapter)}; -} - - -PYBIND11_MODULE(pcms_client, m) -{ - m.doc() = "Python bindings for C PCMS client functions"; - - py::enum_(m, "PcmsAdapterType") - .value("PCMS_ADAPTER_XGC", PCMS_ADAPTER_XGC) - .value("PCMS_ADAPTER_OMEGAH", PCMS_ADAPTER_OMEGAH) - .value("PCMS_ADAPTER_GENE", PCMS_ADAPTER_GENE) - .value("PCMS_ADAPTER_GEM", PCMS_ADAPTER_GEM); - - py::enum_(m, "PcmsType") - .value("PCMS_FLOAT", PCMS_FLOAT) - .value("PCMS_DOUBLE", PCMS_DOUBLE) - .value("PCMS_INT", PCMS_INT) - .value("PCMS_LONG_INT", PCMS_LONG_INT); - - - m.def("pcms_create_client", &pcms_create_client, "Create a PCMS client"); - m.def("pcms_destroy_client", &pcms_destroy_client, "Destroy a PCMS client"); - m.def("pcms_load_reverse_classification", &pcms_load_reverse_classification, "Load reverse classification data"); - m.def("pcms_destroy_reverse_classification", &pcms_destroy_reverse_classification, "Destroy reverse classification data"); - m.def("pcms_reverse_classification_count_verts", &pcms_reverse_classification_count_verts, "Count vertices in reverse classification"); - - m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for double"); - m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for float"); - m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for int"); - m.def("pcms_create_xgc_field_adapter",&xgc_field_adapter_numpy, "Create an XGC field adapter for long int"); - - m.def("pcms_create_xgc_field_adapter", &pcms_create_xgc_field_adapter, "Create an XGC field adapter"); - m.def("pcms_create_dummy_field_adapter", &pcms_create_dummy_field_adapter, "Create a dummy field adapter"); - m.def("pcms_destroy_field_adapter", &pcms_destroy_field_adapter, "Destroy a field adapter"); - m.def("pcms_add_field", &pcms_add_field, "Add a field"); - m.def("pcms_send_field_name", &pcms_send_field_name, "Send field name"); - m.def("pcms_receive_field_name", &pcms_receive_field_name, "Receive field name"); - m.def("pcms_send_field", &pcms_send_field, "Send field"); - m.def("pcms_receive_field", &pcms_receive_field, "Receive field"); - m.def("pcms_begin_send_phase", &pcms_begin_send_phase, "Begin send phase"); - m.def("pcms_end_send_phase", &pcms_end_send_phase, "End send phase"); - m.def("pcms_begin_receive_phase", &pcms_begin_receive_phase, "Begin receive phase"); - m.def("pcms_end_receive_phase", &pcms_end_receive_phase, "End receive phase"); -} - - diff --git a/src/pcms/pythonapi/client_pybind.cpp b/src/pcms/pythonapi/client_pybind.cpp deleted file mode 100644 index 2f786953..00000000 --- a/src/pcms/pythonapi/client_pybind.cpp +++ /dev/null @@ -1,42 +0,0 @@ -#ifndef PCMS_COUPLING_CLIENT_H -#define PCMS_COUPLING_CLIENT_H -#include -#include -#include "pcms/common.h" -#include "pcms/field_communicator.h" -#include "pcms/profile.h" -#include "../client.h" - - -namespace py = pybind11; - -PYBIND11_MODULE(pcms_client, m) { - m.doc() = "CMS Coupling Client C++ Pybind11 Bindings"; - - py::enum_(m, "Mode") - .value("Deferred", Mode::Deferred); - .value("Synchronous", Mode::Synchronous); - - - py::class_(m, "CoupledField") - .def(py::init()); - .def("Send", &CoupledField::Send, py::arg("mode") = Mode::Synchronous); - .def("Receive", &CoupledField::Receive); - - py::class_(m, "CouplerClient") - .def(py::init()); - .def("GetPartition", &CouplerClient::GetPartition, py::return_value_policy::reference); //redev::Partition& - .def("AddField", &CouplerClient::AddField, py::arg("name"), py::arg("field_adapter"), py::arg("participates") = true, - py::return_value_policy::reference); //CoupledField* - .def("SendField", &CouplerClient::SendField, const std::string&, py::arg("mode") = Mode::Synchronous); //void - .def("ReceiveField", &CouplerClient::ReceiveField, const std::string&); //void - .def("InSendPhase", &CouplerClient::InSendPhase); //bool - .def("InReceivePhase", &CouplerClient::InReceivePhase); //bool - .def("BeginSendPhase", &CouplerClient::BeginSendPhase); //void - .def("EndSendPhase", &CouplerClient::EndSendPhase); //void - .def("BeginReceivePhase", &CouplerClient::BeginReceivePhase); //void - .def("EndReceivePhase", &CouplerClient::EndReceivePhase); //void -} - // namespace pcms - -#endif // PCMS_COUPLING_CLIENT_H diff --git a/src/pcms/pythonapi/kokkos_pybind.cpp b/src/pcms/pythonapi/kokkos_pybind.cpp deleted file mode 100644 index 4f029697..00000000 --- a/src/pcms/pythonapi/kokkos_pybind.cpp +++ /dev/null @@ -1,15 +0,0 @@ -#include -#include -#include - - -namespace py = pybind11; - - -PYBIND11_MODULE(pcms_kokkos_module, m) { - m.def("initialize_kokkos", &pcms_kokkos_initialize_without_args, "Initialize Kokkos"); - m.def("finalize_kokkos", &pcms_kokkos_finalize, "Finalize Kokkos"); -} - - - From 7a3bbe9b8bd5504b087f5c1a637e72584fc9e5d1 Mon Sep 17 00:00:00 2001 From: Kulindu Cooray Date: Sat, 21 Oct 2023 15:44:47 -0400 Subject: [PATCH 03/15] Handle Structs --- src/pcms/capi/client.cpp | 1 + src/pcms/capi/client.h | 1 + test/test_proxy_coupling_xgc_client.c | 3 ++- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/pcms/capi/client.cpp b/src/pcms/capi/client.cpp index 0d7f22e3..1ba536f2 100644 --- a/src/pcms/capi/client.cpp +++ b/src/pcms/capi/client.cpp @@ -45,6 +45,7 @@ PcmsReverseClassificationHandle pcms_load_reverse_classification( pcms::ReadReverseClassificationVertex(file, comm)}; return {reinterpret_cast(rc)}; } + void pcms_destroy_reverse_classification( PcmsReverseClassificationHandle rc) { diff --git a/src/pcms/capi/client.h b/src/pcms/capi/client.h index 72865037..78a49f42 100644 --- a/src/pcms/capi/client.h +++ b/src/pcms/capi/client.h @@ -6,6 +6,7 @@ #ifdef __cplusplus extern "C" { #endif + struct PcmsClientHandle { void* pointer; }; typedef struct PcmsClientHandle PcmsClientHandle; struct PcmsOmegaHMeshHandle { void* pointer; }; diff --git a/test/test_proxy_coupling_xgc_client.c b/test/test_proxy_coupling_xgc_client.c index 38650500..6a2f857a 100644 --- a/test/test_proxy_coupling_xgc_client.c +++ b/test/test_proxy_coupling_xgc_client.c @@ -1,8 +1,9 @@ #include #include #include -#include #include +#include + int8_t in_overlap(int dimension, int id) { From da4092abf58e1ccb2f9c3e9dea3bad30ad4e2057 Mon Sep 17 00:00:00 2001 From: Kulindu Cooray Date: Sat, 21 Oct 2023 15:55:12 -0400 Subject: [PATCH 04/15] Handle changes --- src/pcms/capi/client.cpp | 1 - src/pcms/capi/client.h | 1 - test/test_proxy_coupling_xgc_client.c | 2 +- 3 files changed, 1 insertion(+), 3 deletions(-) diff --git a/src/pcms/capi/client.cpp b/src/pcms/capi/client.cpp index 1ba536f2..0d7f22e3 100644 --- a/src/pcms/capi/client.cpp +++ b/src/pcms/capi/client.cpp @@ -45,7 +45,6 @@ PcmsReverseClassificationHandle pcms_load_reverse_classification( pcms::ReadReverseClassificationVertex(file, comm)}; return {reinterpret_cast(rc)}; } - void pcms_destroy_reverse_classification( PcmsReverseClassificationHandle rc) { diff --git a/src/pcms/capi/client.h b/src/pcms/capi/client.h index 78a49f42..72865037 100644 --- a/src/pcms/capi/client.h +++ b/src/pcms/capi/client.h @@ -6,7 +6,6 @@ #ifdef __cplusplus extern "C" { #endif - struct PcmsClientHandle { void* pointer; }; typedef struct PcmsClientHandle PcmsClientHandle; struct PcmsOmegaHMeshHandle { void* pointer; }; diff --git a/test/test_proxy_coupling_xgc_client.c b/test/test_proxy_coupling_xgc_client.c index 6a2f857a..53773970 100644 --- a/test/test_proxy_coupling_xgc_client.c +++ b/test/test_proxy_coupling_xgc_client.c @@ -1,8 +1,8 @@ #include #include #include -#include #include +#include int8_t in_overlap(int dimension, int id) From b582124b4d6274c8e99e8ddc6801cf69c2895e29 Mon Sep 17 00:00:00 2001 From: Kulindu Cooray Date: Mon, 23 Oct 2023 12:56:20 -0400 Subject: [PATCH 05/15] Handle structs with pointers --- src/pcms/capi/client.cpp | 1 - src/pcms/capi/client.h | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pcms/capi/client.cpp b/src/pcms/capi/client.cpp index 0d7f22e3..3a6ec813 100644 --- a/src/pcms/capi/client.cpp +++ b/src/pcms/capi/client.cpp @@ -51,7 +51,6 @@ void pcms_destroy_reverse_classification( if (rc.pointer != nullptr) delete reinterpret_cast(rc.pointer); } - struct AddFieldVariantOperators { AddFieldVariantOperators(const char* name, pcms::CouplerClient* client, int participates) : name_(name), client_(client), participates_(participates) diff --git a/src/pcms/capi/client.h b/src/pcms/capi/client.h index 72865037..78a49f42 100644 --- a/src/pcms/capi/client.h +++ b/src/pcms/capi/client.h @@ -6,6 +6,7 @@ #ifdef __cplusplus extern "C" { #endif + struct PcmsClientHandle { void* pointer; }; typedef struct PcmsClientHandle PcmsClientHandle; struct PcmsOmegaHMeshHandle { void* pointer; }; From 2fee4761db74cf050f273fbc31030d01b74d1ca1 Mon Sep 17 00:00:00 2001 From: Jacob Merson Date: Thu, 9 Nov 2023 13:48:27 -0500 Subject: [PATCH 06/15] update fortran interface and fix fortran tests --- src/pcms/assert.h | 29 +- src/pcms/fortranapi/client.i | 70 +- src/pcms/fortranapi/client_wrap.c | 542 +++++++++++++-- src/pcms/fortranapi/pcms.f90 | 627 +++++++++++++++++- test/CMakeLists.txt | 22 +- ...test_proxy_coupling_xgc_client_fortran.f90 | 8 +- test/test_proxy_coupling_xgc_server.cpp | 12 +- 7 files changed, 1161 insertions(+), 149 deletions(-) diff --git a/src/pcms/assert.h b/src/pcms/assert.h index 4198ec54..f336a58c 100644 --- a/src/pcms/assert.h +++ b/src/pcms/assert.h @@ -1,14 +1,29 @@ #ifndef PCMS_COUPLING_ASSERT_H #define PCMS_COUPLING_ASSERT_H #include +#include -#define PCMS_ALWAYS_ASSERT(cond) do { \ - if (! (cond)) { \ - char omsg[2048]; \ - snprintf(omsg, 2048, "%s failed at %s + %d \n", \ - #cond, __FILE__, __LINE__); \ - pcms::Pcms_Assert_Fail(omsg); \ - } \ +// https://stackoverflow.com/questions/16683146/can-macros-be-overloaded-by-number-of-arguments +#define CAT(A, B) A##B +#define SELECT(NAME, NUM) CAT(NAME##_, NUM) + +#define GET_COUNT(_1, _2, _3, _4, _5, _6 /* ad nauseam */, COUNT, ...) COUNT +#define VA_SIZE(...) GET_COUNT(__VA_ARGS__, 6, 5, 4, 3, 2, 1) + +#define VA_SELECT(NAME, ...) SELECT(NAME, VA_SIZE(__VA_ARGS__))(__VA_ARGS__) + +#define PCMS_ALWAYS_ASSERT(...) VA_SELECT(PCMS_ALWAYS_ASSERT, __VA_ARGS__) +#define PCMS_ALWAYS_ASSERT_1(cond) PCMS_ALWAYS_ASSERT_2(cond, MPI_COMM_WORLD) +#define PCMS_ALWAYS_ASSERT_2(cond, comm) \ + do { \ + if (!(cond)) { \ + int rank = -1; \ + MPI_Comm_rank(comm, &rank); \ + char omsg[2048]; \ + snprintf(omsg, 2048, "%s failed at %s + %d on rank %d\n", #cond, \ + __FILE__, __LINE__, rank); \ + pcms::Pcms_Assert_Fail(omsg); \ + } \ } while (0) diff --git a/src/pcms/fortranapi/client.i b/src/pcms/fortranapi/client.i index 307a9b3f..f86dc731 100644 --- a/src/pcms/fortranapi/client.i +++ b/src/pcms/fortranapi/client.i @@ -28,40 +28,64 @@ enum PcmsType PCMS_LONG_INT }; +struct PcmsClientHandle +{ + void* pointer; +}; +typedef struct PcmsClientHandle PcmsClientHandle; +struct PcmsOmegaHMeshHandle +{ + void* pointer; +}; +typedef struct PcmsOmegaHMeshHandle PcmsOmegaHMeshHandle; +struct PcmsReverseClassificationHandle +{ + void* pointer; +}; +typedef struct PcmsReverseClassificationHandle PcmsReverseClassificationHandle; +struct PcmsFieldAdapterHandle +{ + void* pointer; +}; +typedef struct PcmsFieldAdapterHandle PcmsFieldAdapterHandle; +struct PcmsFieldHandle +{ + void* pointer; +}; +typedef struct PcmsFieldHandle PcmsFieldHandle; -PcmsClientHandle* pcms_create_client(const char* name, MPI_Comm comm); -void pcms_destroy_client(PcmsClientHandle*); +PcmsClientHandle pcms_create_client(const char* name, MPI_Comm comm); +void pcms_destroy_client(PcmsClientHandle); -PcmsReverseClassificationHandle* pcms_load_reverse_classification( +PcmsReverseClassificationHandle pcms_load_reverse_classification( const char* file, MPI_Comm comm); -void pcms_destroy_reverse_classification(PcmsReverseClassificationHandle*); +void pcms_destroy_reverse_classification(PcmsReverseClassificationHandle); -int pcms_reverse_classification_count_verts( - PcmsReverseClassificationHandle*); +int pcms_reverse_classification_count_verts(PcmsReverseClassificationHandle); typedef int8_t (*in_overlap_function)(int, int); -PcmsFieldAdapterHandle* pcms_create_xgc_field_adapter( - const char* name, MPI_Comm plane_comm, void* data, int size, PcmsType data_type, - const PcmsReverseClassificationHandle* rc, in_overlap_function in_overlap); +PcmsFieldAdapterHandle pcms_create_xgc_field_adapter( + const char* name, MPI_Comm plane_comm, void* data, int size, + PcmsType data_type, const PcmsReverseClassificationHandle rc, + in_overlap_function in_overlap); -PcmsFieldAdapterHandle* pcms_create_dummy_field_adapter(); +PcmsFieldAdapterHandle pcms_create_dummy_field_adapter(); -void pcms_destroy_field_adapter(PcmsFieldAdapterHandle*); +void pcms_destroy_field_adapter(PcmsFieldAdapterHandle); -PcmsFieldHandle* pcms_add_field(PcmsClientHandle* client_handle, - const char* name, - PcmsFieldAdapterHandle* adapter_handle, - int participates); -void pcms_send_field_name(PcmsClientHandle*, const char* name); -void pcms_receive_field_name(PcmsClientHandle*, const char* name); +PcmsFieldHandle pcms_add_field(PcmsClientHandle client_handle, const char* name, + PcmsFieldAdapterHandle adapter_handle, + int participates); +void pcms_send_field_name(PcmsClientHandle, const char* name); +void pcms_receive_field_name(PcmsClientHandle, const char* name); -void pcms_send_field(PcmsFieldHandle*); -void pcms_receive_field(PcmsFieldHandle*); +void pcms_send_field(PcmsFieldHandle); +void pcms_receive_field(PcmsFieldHandle); -void pcms_begin_send_phase(PcmsClientHandle*); -void pcms_end_send_phase(PcmsClientHandle*); -void pcms_begin_receive_phase(PcmsClientHandle*); -void pcms_end_receive_phase(PcmsClientHandle*); +void pcms_begin_send_phase(PcmsClientHandle); +void pcms_end_send_phase(PcmsClientHandle); +void pcms_begin_receive_phase(PcmsClientHandle); +void pcms_end_receive_phase(PcmsClientHandle); void pcms_kokkos_initialize_without_args(); void pcms_kokkos_finalize(); diff --git a/src/pcms/fortranapi/client_wrap.c b/src/pcms/fortranapi/client_wrap.c index 527d60dc..9b6275a8 100644 --- a/src/pcms/fortranapi/client_wrap.c +++ b/src/pcms/fortranapi/client_wrap.c @@ -149,7 +149,13 @@ enum { SWIG_MEM_RVALUE = 0x02, }; - +#define SWIG_check_nonnull(PTR, TYPENAME, FNAME, FUNCNAME, RETURNNULL) \ + if (!(PTR)) { \ + SWIG_exception_impl(FUNCNAME, SWIG_NullReferenceError, \ + "Cannot pass null " TYPENAME " (class " FNAME ") " \ + "as a reference", \ + RETURNNULL); \ + } #define SWIG_VERSION 0x040101 #define SWIGFORTRAN @@ -211,6 +217,41 @@ SWIGINTERN SwigClassWrapper SwigClassWrapper_uninitialized() { # endif #endif +#include + +SWIGINTERN void SWIG_assign(SwigClassWrapper* self, SwigClassWrapper other) +{ + if (self->cptr == NULL) { + /* LHS is unassigned */ + if (other.cmemflags & SWIG_MEM_RVALUE) { + /* Capture pointer from RHS, clear 'moving' flag */ + self->cptr = other.cptr; + self->cmemflags = other.cmemflags & (~SWIG_MEM_RVALUE); + } else { + /* Become a reference to the other object */ + self->cptr = other.cptr; + self->cmemflags = other.cmemflags & (~SWIG_MEM_OWN); + } + } else if (other.cptr == NULL) { + /* Replace LHS with a null pointer */ + free(self->cptr); + *self = SwigClassWrapper_uninitialized(); + } else if (self->cptr == other.cptr) { + /* Self-assignment: ignore */ + } else { + if (self->cmemflags & SWIG_MEM_OWN) { + free(self->cptr); + } + self->cptr = other.cptr; + if (other.cmemflags & SWIG_MEM_RVALUE) { + /* Capture RHS */ + self->cmemflags = other.cmemflags & ~SWIG_MEM_RVALUE; + } else { + /* Point to RHS */ + self->cmemflags = other.cmemflags & ~SWIG_MEM_OWN; + } + } +} typedef struct { void* data; @@ -225,29 +266,339 @@ SWIGINTERN SwigArrayWrapper SwigArrayWrapper_uninitialized() { return result; } +SWIGEXPORT void _wrap_PcmsClientHandle_pointer_set(SwigClassWrapper* farg1, + void const** farg2) +{ + struct PcmsClientHandle* arg1 = (struct PcmsClientHandle*)0; + void* arg2 = (void*)0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsClientHandle *", + "PcmsClientHandle", "PcmsClientHandle::pointer", return); + arg1 = (struct PcmsClientHandle*)farg1->cptr; + arg2 = (void*)(*farg2); + if (arg1) + (arg1)->pointer = arg2; +} + +SWIGEXPORT void* _wrap_PcmsClientHandle_pointer_get(SwigClassWrapper* farg1) +{ + void* fresult; + struct PcmsClientHandle* arg1 = (struct PcmsClientHandle*)0; + void* result = 0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsClientHandle *", + "PcmsClientHandle", "PcmsClientHandle::pointer", return 0); + arg1 = (struct PcmsClientHandle*)farg1->cptr; + result = (void*)((arg1)->pointer); + fresult = (void*)(result); + return fresult; +} + +SWIGEXPORT SwigClassWrapper _wrap_new_PcmsClientHandle() +{ + SwigClassWrapper fresult; + struct PcmsClientHandle* result = 0; + + result = (struct PcmsClientHandle*)calloc(1, sizeof(struct PcmsClientHandle)); + fresult.cptr = (void*)result; + fresult.cmemflags = SWIG_MEM_RVALUE | (1 ? SWIG_MEM_OWN : 0); + return fresult; +} + +SWIGEXPORT void _wrap_delete_PcmsClientHandle(SwigClassWrapper* farg1) +{ + struct PcmsClientHandle* arg1 = (struct PcmsClientHandle*)0; + + arg1 = (struct PcmsClientHandle*)farg1->cptr; + free((char*)arg1); +} + +SWIGEXPORT void _wrap_PcmsClientHandle_op_assign__(SwigClassWrapper* farg1, + SwigClassWrapper* farg2) +{ + struct PcmsClientHandle* arg1 = (struct PcmsClientHandle*)0; + struct PcmsClientHandle* arg2 = 0; + + (void)sizeof(arg1); + (void)sizeof(arg2); + SWIG_assign(farg1, *farg2); +} + +SWIGEXPORT void _wrap_PcmsOmegaHMeshHandle_pointer_set(SwigClassWrapper* farg1, + void const** farg2) +{ + struct PcmsOmegaHMeshHandle* arg1 = (struct PcmsOmegaHMeshHandle*)0; + void* arg2 = (void*)0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsOmegaHMeshHandle *", + "PcmsOmegaHMeshHandle", "PcmsOmegaHMeshHandle::pointer", + return); + arg1 = (struct PcmsOmegaHMeshHandle*)farg1->cptr; + arg2 = (void*)(*farg2); + if (arg1) + (arg1)->pointer = arg2; +} + +SWIGEXPORT void* _wrap_PcmsOmegaHMeshHandle_pointer_get(SwigClassWrapper* farg1) +{ + void* fresult; + struct PcmsOmegaHMeshHandle* arg1 = (struct PcmsOmegaHMeshHandle*)0; + void* result = 0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsOmegaHMeshHandle *", + "PcmsOmegaHMeshHandle", "PcmsOmegaHMeshHandle::pointer", + return 0); + arg1 = (struct PcmsOmegaHMeshHandle*)farg1->cptr; + result = (void*)((arg1)->pointer); + fresult = (void*)(result); + return fresult; +} + +SWIGEXPORT SwigClassWrapper _wrap_new_PcmsOmegaHMeshHandle() +{ + SwigClassWrapper fresult; + struct PcmsOmegaHMeshHandle* result = 0; + + result = (struct PcmsOmegaHMeshHandle*)calloc( + 1, sizeof(struct PcmsOmegaHMeshHandle)); + fresult.cptr = (void*)result; + fresult.cmemflags = SWIG_MEM_RVALUE | (1 ? SWIG_MEM_OWN : 0); + return fresult; +} + +SWIGEXPORT void _wrap_delete_PcmsOmegaHMeshHandle(SwigClassWrapper* farg1) +{ + struct PcmsOmegaHMeshHandle* arg1 = (struct PcmsOmegaHMeshHandle*)0; + + arg1 = (struct PcmsOmegaHMeshHandle*)farg1->cptr; + free((char*)arg1); +} + +SWIGEXPORT void _wrap_PcmsOmegaHMeshHandle_op_assign__(SwigClassWrapper* farg1, + SwigClassWrapper* farg2) +{ + struct PcmsOmegaHMeshHandle* arg1 = (struct PcmsOmegaHMeshHandle*)0; + struct PcmsOmegaHMeshHandle* arg2 = 0; + + (void)sizeof(arg1); + (void)sizeof(arg2); + SWIG_assign(farg1, *farg2); +} + +SWIGEXPORT void _wrap_PcmsReverseClassificationHandle_pointer_set( + SwigClassWrapper* farg1, void const** farg2) +{ + struct PcmsReverseClassificationHandle* arg1 = + (struct PcmsReverseClassificationHandle*)0; + void* arg2 = (void*)0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsReverseClassificationHandle *", + "PcmsReverseClassificationHandle", + "PcmsReverseClassificationHandle::pointer", return); + arg1 = (struct PcmsReverseClassificationHandle*)farg1->cptr; + arg2 = (void*)(*farg2); + if (arg1) + (arg1)->pointer = arg2; +} + +SWIGEXPORT void* _wrap_PcmsReverseClassificationHandle_pointer_get( + SwigClassWrapper* farg1) +{ + void* fresult; + struct PcmsReverseClassificationHandle* arg1 = + (struct PcmsReverseClassificationHandle*)0; + void* result = 0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsReverseClassificationHandle *", + "PcmsReverseClassificationHandle", + "PcmsReverseClassificationHandle::pointer", return 0); + arg1 = (struct PcmsReverseClassificationHandle*)farg1->cptr; + result = (void*)((arg1)->pointer); + fresult = (void*)(result); + return fresult; +} + +SWIGEXPORT SwigClassWrapper _wrap_new_PcmsReverseClassificationHandle() +{ + SwigClassWrapper fresult; + struct PcmsReverseClassificationHandle* result = 0; + + result = (struct PcmsReverseClassificationHandle*)calloc( + 1, sizeof(struct PcmsReverseClassificationHandle)); + fresult.cptr = (void*)result; + fresult.cmemflags = SWIG_MEM_RVALUE | (1 ? SWIG_MEM_OWN : 0); + return fresult; +} + +SWIGEXPORT void _wrap_delete_PcmsReverseClassificationHandle( + SwigClassWrapper* farg1) +{ + struct PcmsReverseClassificationHandle* arg1 = + (struct PcmsReverseClassificationHandle*)0; + + arg1 = (struct PcmsReverseClassificationHandle*)farg1->cptr; + free((char*)arg1); +} + +SWIGEXPORT void _wrap_PcmsReverseClassificationHandle_op_assign__( + SwigClassWrapper* farg1, SwigClassWrapper* farg2) +{ + struct PcmsReverseClassificationHandle* arg1 = + (struct PcmsReverseClassificationHandle*)0; + struct PcmsReverseClassificationHandle* arg2 = 0; + + (void)sizeof(arg1); + (void)sizeof(arg2); + SWIG_assign(farg1, *farg2); +} + +SWIGEXPORT void _wrap_PcmsFieldAdapterHandle_pointer_set( + SwigClassWrapper* farg1, void const** farg2) +{ + struct PcmsFieldAdapterHandle* arg1 = (struct PcmsFieldAdapterHandle*)0; + void* arg2 = (void*)0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsFieldAdapterHandle *", + "PcmsFieldAdapterHandle", + "PcmsFieldAdapterHandle::pointer", return); + arg1 = (struct PcmsFieldAdapterHandle*)farg1->cptr; + arg2 = (void*)(*farg2); + if (arg1) + (arg1)->pointer = arg2; +} + +SWIGEXPORT void* _wrap_PcmsFieldAdapterHandle_pointer_get( + SwigClassWrapper* farg1) +{ + void* fresult; + struct PcmsFieldAdapterHandle* arg1 = (struct PcmsFieldAdapterHandle*)0; + void* result = 0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsFieldAdapterHandle *", + "PcmsFieldAdapterHandle", + "PcmsFieldAdapterHandle::pointer", return 0); + arg1 = (struct PcmsFieldAdapterHandle*)farg1->cptr; + result = (void*)((arg1)->pointer); + fresult = (void*)(result); + return fresult; +} + +SWIGEXPORT SwigClassWrapper _wrap_new_PcmsFieldAdapterHandle() +{ + SwigClassWrapper fresult; + struct PcmsFieldAdapterHandle* result = 0; + + result = (struct PcmsFieldAdapterHandle*)calloc( + 1, sizeof(struct PcmsFieldAdapterHandle)); + fresult.cptr = (void*)result; + fresult.cmemflags = SWIG_MEM_RVALUE | (1 ? SWIG_MEM_OWN : 0); + return fresult; +} + +SWIGEXPORT void _wrap_delete_PcmsFieldAdapterHandle(SwigClassWrapper* farg1) +{ + struct PcmsFieldAdapterHandle* arg1 = (struct PcmsFieldAdapterHandle*)0; + + arg1 = (struct PcmsFieldAdapterHandle*)farg1->cptr; + free((char*)arg1); +} + +SWIGEXPORT void _wrap_PcmsFieldAdapterHandle_op_assign__( + SwigClassWrapper* farg1, SwigClassWrapper* farg2) +{ + struct PcmsFieldAdapterHandle* arg1 = (struct PcmsFieldAdapterHandle*)0; + struct PcmsFieldAdapterHandle* arg2 = 0; + + (void)sizeof(arg1); + (void)sizeof(arg2); + SWIG_assign(farg1, *farg2); +} + +SWIGEXPORT void _wrap_PcmsFieldHandle_pointer_set(SwigClassWrapper* farg1, + void const** farg2) +{ + struct PcmsFieldHandle* arg1 = (struct PcmsFieldHandle*)0; + void* arg2 = (void*)0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsFieldHandle *", "PcmsFieldHandle", + "PcmsFieldHandle::pointer", return); + arg1 = (struct PcmsFieldHandle*)farg1->cptr; + arg2 = (void*)(*farg2); + if (arg1) + (arg1)->pointer = arg2; +} + +SWIGEXPORT void* _wrap_PcmsFieldHandle_pointer_get(SwigClassWrapper* farg1) +{ + void* fresult; + struct PcmsFieldHandle* arg1 = (struct PcmsFieldHandle*)0; + void* result = 0; + + SWIG_check_nonnull(farg1->cptr, "struct PcmsFieldHandle *", "PcmsFieldHandle", + "PcmsFieldHandle::pointer", return 0); + arg1 = (struct PcmsFieldHandle*)farg1->cptr; + result = (void*)((arg1)->pointer); + fresult = (void*)(result); + return fresult; +} + +SWIGEXPORT SwigClassWrapper _wrap_new_PcmsFieldHandle() +{ + SwigClassWrapper fresult; + struct PcmsFieldHandle* result = 0; + + result = (struct PcmsFieldHandle*)calloc(1, sizeof(struct PcmsFieldHandle)); + fresult.cptr = (void*)result; + fresult.cmemflags = SWIG_MEM_RVALUE | (1 ? SWIG_MEM_OWN : 0); + return fresult; +} + +SWIGEXPORT void _wrap_delete_PcmsFieldHandle(SwigClassWrapper* farg1) +{ + struct PcmsFieldHandle* arg1 = (struct PcmsFieldHandle*)0; + + arg1 = (struct PcmsFieldHandle*)farg1->cptr; + free((char*)arg1); +} + +SWIGEXPORT void _wrap_PcmsFieldHandle_op_assign__(SwigClassWrapper* farg1, + SwigClassWrapper* farg2) +{ + struct PcmsFieldHandle* arg1 = (struct PcmsFieldHandle*)0; + struct PcmsFieldHandle* arg2 = 0; + + (void)sizeof(arg1); + (void)sizeof(arg2); + SWIG_assign(farg1, *farg2); +} + SWIGEXPORT SwigClassWrapper _wrap_pcms_create_client(SwigArrayWrapper *farg1, int const *farg2) { SwigClassWrapper fresult ; char *arg1 = (char *) 0 ; MPI_Comm arg2 ; - PcmsClientHandle *result = 0 ; - + PcmsClientHandle result; + arg1 = (char *)(farg1->data); #ifdef HAVE_MPI arg2 = MPI_Comm_f2c((MPI_Fint)*farg2); #else arg2 = *farg2; #endif - result = (PcmsClientHandle *)pcms_create_client((char const *)arg1,arg2); - fresult.cptr = (void*)result; - fresult.cmemflags = SWIG_MEM_RVALUE | (0 ? SWIG_MEM_OWN : 0); + result = pcms_create_client((char const*)arg1, arg2); + fresult.cptr = (PcmsClientHandle*)memcpy( + (PcmsClientHandle*)calloc(1, sizeof(PcmsClientHandle)), &result, + sizeof(PcmsClientHandle)); + fresult.cmemflags = SWIG_MEM_RVALUE | SWIG_MEM_OWN; return fresult; } SWIGEXPORT void _wrap_pcms_destroy_client(SwigClassWrapper *farg1) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + PcmsClientHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_destroy_client(PcmsClientHandle)", return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); pcms_destroy_client(arg1); } @@ -256,35 +607,48 @@ SWIGEXPORT SwigClassWrapper _wrap_pcms_load_reverse_classification(SwigArrayWrap SwigClassWrapper fresult ; char *arg1 = (char *) 0 ; MPI_Comm arg2 ; - PcmsReverseClassificationHandle *result = 0 ; - + PcmsReverseClassificationHandle result; + arg1 = (char *)(farg1->data); #ifdef HAVE_MPI arg2 = MPI_Comm_f2c((MPI_Fint)*farg2); #else arg2 = *farg2; #endif - result = (PcmsReverseClassificationHandle *)pcms_load_reverse_classification((char const *)arg1,arg2); - fresult.cptr = (void*)result; - fresult.cmemflags = SWIG_MEM_RVALUE | (0 ? SWIG_MEM_OWN : 0); + result = pcms_load_reverse_classification((char const*)arg1, arg2); + fresult.cptr = (PcmsReverseClassificationHandle*)memcpy( + (PcmsReverseClassificationHandle*)calloc( + 1, sizeof(PcmsReverseClassificationHandle)), + &result, sizeof(PcmsReverseClassificationHandle)); + fresult.cmemflags = SWIG_MEM_RVALUE | SWIG_MEM_OWN; return fresult; } SWIGEXPORT void _wrap_pcms_destroy_reverse_classification(SwigClassWrapper *farg1) { - PcmsReverseClassificationHandle *arg1 = (PcmsReverseClassificationHandle *) 0 ; - - arg1 = (PcmsReverseClassificationHandle *)farg1->cptr; + PcmsReverseClassificationHandle arg1; + + SWIG_check_nonnull( + farg1->cptr, "PcmsReverseClassificationHandle", + "PcmsReverseClassificationHandle", + "pcms_destroy_reverse_classification(PcmsReverseClassificationHandle)", + return); + arg1 = *((PcmsReverseClassificationHandle*)(farg1->cptr)); pcms_destroy_reverse_classification(arg1); } SWIGEXPORT int _wrap_pcms_reverse_classification_count_verts(SwigClassWrapper *farg1) { int fresult ; - PcmsReverseClassificationHandle *arg1 = (PcmsReverseClassificationHandle *) 0 ; + PcmsReverseClassificationHandle arg1; int result; - - arg1 = (PcmsReverseClassificationHandle *)farg1->cptr; + + SWIG_check_nonnull( + farg1->cptr, "PcmsReverseClassificationHandle", + "PcmsReverseClassificationHandle", + "pcms_reverse_classification_count_verts(PcmsReverseClassificationHandle)", + return 0); + arg1 = *((PcmsReverseClassificationHandle*)(farg1->cptr)); result = (int)pcms_reverse_classification_count_verts(arg1); fresult = (int)(result); return fresult; @@ -298,10 +662,10 @@ SWIGEXPORT SwigClassWrapper _wrap_pcms_create_xgc_field_adapter(SwigArrayWrapper void *arg3 = (void *) 0 ; int arg4 ; PcmsType arg5 ; - PcmsReverseClassificationHandle *arg6 = (PcmsReverseClassificationHandle *) 0 ; + PcmsReverseClassificationHandle arg6; in_overlap_function arg7 = (in_overlap_function) 0 ; - PcmsFieldAdapterHandle *result = 0 ; - + PcmsFieldAdapterHandle result; + arg1 = (char *)(farg1->data); #ifdef HAVE_MPI arg2 = MPI_Comm_f2c((MPI_Fint)*farg2); @@ -311,117 +675,159 @@ SWIGEXPORT SwigClassWrapper _wrap_pcms_create_xgc_field_adapter(SwigArrayWrapper arg3 = (void *)(*farg3); arg4 = (int)(*farg4); arg5 = (PcmsType)(*farg5); - arg6 = (PcmsReverseClassificationHandle *)farg6->cptr; + SWIG_check_nonnull( + farg6->cptr, "PcmsReverseClassificationHandle", + "PcmsReverseClassificationHandle", + "pcms_create_xgc_field_adapter(char const *,MPI_Comm,void " + "*,int,PcmsType,PcmsReverseClassificationHandle const,in_overlap_function)", + return SwigClassWrapper_uninitialized()); + arg6 = *((PcmsReverseClassificationHandle*)(farg6->cptr)); arg7 = (in_overlap_function)(*farg7); - result = (PcmsFieldAdapterHandle *)pcms_create_xgc_field_adapter((char const *)arg1,arg2,arg3,arg4,arg5,(PcmsReverseClassificationHandle const *)arg6,arg7); - fresult.cptr = (void*)result; - fresult.cmemflags = SWIG_MEM_RVALUE | (0 ? SWIG_MEM_OWN : 0); + result = pcms_create_xgc_field_adapter((char const*)arg1, arg2, arg3, arg4, + arg5, arg6, arg7); + fresult.cptr = (PcmsFieldAdapterHandle*)memcpy( + (PcmsFieldAdapterHandle*)calloc(1, sizeof(PcmsFieldAdapterHandle)), &result, + sizeof(PcmsFieldAdapterHandle)); + fresult.cmemflags = SWIG_MEM_RVALUE | SWIG_MEM_OWN; return fresult; } SWIGEXPORT SwigClassWrapper _wrap_pcms_create_dummy_field_adapter() { SwigClassWrapper fresult ; - PcmsFieldAdapterHandle *result = 0 ; - - result = (PcmsFieldAdapterHandle *)pcms_create_dummy_field_adapter(); - fresult.cptr = (void*)result; - fresult.cmemflags = SWIG_MEM_RVALUE | (0 ? SWIG_MEM_OWN : 0); + PcmsFieldAdapterHandle result; + + result = pcms_create_dummy_field_adapter(); + fresult.cptr = (PcmsFieldAdapterHandle*)memcpy( + (PcmsFieldAdapterHandle*)calloc(1, sizeof(PcmsFieldAdapterHandle)), &result, + sizeof(PcmsFieldAdapterHandle)); + fresult.cmemflags = SWIG_MEM_RVALUE | SWIG_MEM_OWN; return fresult; } SWIGEXPORT void _wrap_pcms_destroy_field_adapter(SwigClassWrapper *farg1) { - PcmsFieldAdapterHandle *arg1 = (PcmsFieldAdapterHandle *) 0 ; - - arg1 = (PcmsFieldAdapterHandle *)farg1->cptr; + PcmsFieldAdapterHandle arg1; + + SWIG_check_nonnull( + farg1->cptr, "PcmsFieldAdapterHandle", "PcmsFieldAdapterHandle", + "pcms_destroy_field_adapter(PcmsFieldAdapterHandle)", return); + arg1 = *((PcmsFieldAdapterHandle*)(farg1->cptr)); pcms_destroy_field_adapter(arg1); } SWIGEXPORT SwigClassWrapper _wrap_pcms_add_field(SwigClassWrapper *farg1, SwigArrayWrapper *farg2, SwigClassWrapper *farg3, int const *farg4) { SwigClassWrapper fresult ; - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; + PcmsClientHandle arg1; char *arg2 = (char *) 0 ; - PcmsFieldAdapterHandle *arg3 = (PcmsFieldAdapterHandle *) 0 ; + PcmsFieldAdapterHandle arg3; int arg4 ; - PcmsFieldHandle *result = 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + PcmsFieldHandle result; + + SWIG_check_nonnull( + farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_add_field(PcmsClientHandle,char const *,PcmsFieldAdapterHandle,int)", + return SwigClassWrapper_uninitialized()); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); arg2 = (char *)(farg2->data); - arg3 = (PcmsFieldAdapterHandle *)farg3->cptr; + SWIG_check_nonnull( + farg3->cptr, "PcmsFieldAdapterHandle", "PcmsFieldAdapterHandle", + "pcms_add_field(PcmsClientHandle,char const *,PcmsFieldAdapterHandle,int)", + return SwigClassWrapper_uninitialized()); + arg3 = *((PcmsFieldAdapterHandle*)(farg3->cptr)); arg4 = (int)(*farg4); - result = (PcmsFieldHandle *)pcms_add_field(arg1,(char const *)arg2,arg3,arg4); - fresult.cptr = (void*)result; - fresult.cmemflags = SWIG_MEM_RVALUE | (0 ? SWIG_MEM_OWN : 0); + result = pcms_add_field(arg1, (char const*)arg2, arg3, arg4); + fresult.cptr = (PcmsFieldHandle*)memcpy( + (PcmsFieldHandle*)calloc(1, sizeof(PcmsFieldHandle)), &result, + sizeof(PcmsFieldHandle)); + fresult.cmemflags = SWIG_MEM_RVALUE | SWIG_MEM_OWN; return fresult; } SWIGEXPORT void _wrap_pcms_send_field_name(SwigClassWrapper *farg1, SwigArrayWrapper *farg2) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; + PcmsClientHandle arg1; char *arg2 = (char *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_send_field_name(PcmsClientHandle,char const *)", + return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); arg2 = (char *)(farg2->data); pcms_send_field_name(arg1,(char const *)arg2); } SWIGEXPORT void _wrap_pcms_receive_field_name(SwigClassWrapper *farg1, SwigArrayWrapper *farg2) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; + PcmsClientHandle arg1; char *arg2 = (char *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_receive_field_name(PcmsClientHandle,char const *)", + return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); arg2 = (char *)(farg2->data); pcms_receive_field_name(arg1,(char const *)arg2); } SWIGEXPORT void _wrap_pcms_send_field(SwigClassWrapper *farg1) { - PcmsFieldHandle *arg1 = (PcmsFieldHandle *) 0 ; - - arg1 = (PcmsFieldHandle *)farg1->cptr; + PcmsFieldHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsFieldHandle", "PcmsFieldHandle", + "pcms_send_field(PcmsFieldHandle)", return); + arg1 = *((PcmsFieldHandle*)(farg1->cptr)); pcms_send_field(arg1); } SWIGEXPORT void _wrap_pcms_receive_field(SwigClassWrapper *farg1) { - PcmsFieldHandle *arg1 = (PcmsFieldHandle *) 0 ; - - arg1 = (PcmsFieldHandle *)farg1->cptr; + PcmsFieldHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsFieldHandle", "PcmsFieldHandle", + "pcms_receive_field(PcmsFieldHandle)", return); + arg1 = *((PcmsFieldHandle*)(farg1->cptr)); pcms_receive_field(arg1); } SWIGEXPORT void _wrap_pcms_begin_send_phase(SwigClassWrapper *farg1) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + PcmsClientHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_begin_send_phase(PcmsClientHandle)", return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); pcms_begin_send_phase(arg1); } SWIGEXPORT void _wrap_pcms_end_send_phase(SwigClassWrapper *farg1) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + PcmsClientHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_end_send_phase(PcmsClientHandle)", return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); pcms_end_send_phase(arg1); } SWIGEXPORT void _wrap_pcms_begin_receive_phase(SwigClassWrapper *farg1) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + PcmsClientHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_begin_receive_phase(PcmsClientHandle)", return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); pcms_begin_receive_phase(arg1); } SWIGEXPORT void _wrap_pcms_end_receive_phase(SwigClassWrapper *farg1) { - PcmsClientHandle *arg1 = (PcmsClientHandle *) 0 ; - - arg1 = (PcmsClientHandle *)farg1->cptr; + PcmsClientHandle arg1; + + SWIG_check_nonnull(farg1->cptr, "PcmsClientHandle", "PcmsClientHandle", + "pcms_end_receive_phase(PcmsClientHandle)", return); + arg1 = *((PcmsClientHandle*)(farg1->cptr)); pcms_end_receive_phase(arg1); } diff --git a/src/pcms/fortranapi/pcms.f90 b/src/pcms/fortranapi/pcms.f90 index 9d654eaa..8d431d80 100644 --- a/src/pcms/fortranapi/pcms.f90 +++ b/src/pcms/fortranapi/pcms.f90 @@ -35,30 +35,68 @@ module pcms type(C_PTR), public :: cptr = C_NULL_PTR integer(C_INT), public :: cmemflags = 0 end type + ! struct struct PcmsClientHandle + type, public :: PcmsClientHandle + type(SwigClassWrapper), public :: swigdata + contains + procedure :: set_pointer => swigf_PcmsClientHandle_pointer_set + procedure :: get_pointer => swigf_PcmsClientHandle_pointer_get + procedure :: release => swigf_PcmsClientHandle_release + procedure, private :: swigf_PcmsClientHandle_op_assign__ + generic :: assignment(=) => swigf_PcmsClientHandle_op_assign__ + end type PcmsClientHandle + ! struct struct PcmsOmegaHMeshHandle + type, public :: PcmsOmegaHMeshHandle + type(SwigClassWrapper), public :: swigdata + contains + procedure :: set_pointer => swigf_PcmsOmegaHMeshHandle_pointer_set + procedure :: get_pointer => swigf_PcmsOmegaHMeshHandle_pointer_get + procedure :: release => swigf_PcmsOmegaHMeshHandle_release + procedure, private :: swigf_PcmsOmegaHMeshHandle_op_assign__ + generic :: assignment(=) => swigf_PcmsOmegaHMeshHandle_op_assign__ + end type PcmsOmegaHMeshHandle + ! struct struct PcmsReverseClassificationHandle + type, public :: PcmsReverseClassificationHandle + type(SwigClassWrapper), public :: swigdata + contains + procedure :: set_pointer => swigf_PcmsReverseClassificationHandle_pointer_set + procedure :: get_pointer => swigf_PcmsReverseClassificationHandle_pointer_get + procedure :: release => swigf_PcmsReverseClassificationHandle_release + procedure, private :: swigf_PcmsReverseClassificationHandle_op_assign__ + generic :: assignment(=) => swigf_PcmsReverseClassificationHandle_op_assign__ + end type PcmsReverseClassificationHandle + ! struct struct PcmsFieldAdapterHandle + type, public :: PcmsFieldAdapterHandle + type(SwigClassWrapper), public :: swigdata + contains + procedure :: set_pointer => swigf_PcmsFieldAdapterHandle_pointer_set + procedure :: get_pointer => swigf_PcmsFieldAdapterHandle_pointer_get + procedure :: release => swigf_PcmsFieldAdapterHandle_release + procedure, private :: swigf_PcmsFieldAdapterHandle_op_assign__ + generic :: assignment(=) => swigf_PcmsFieldAdapterHandle_op_assign__ + end type PcmsFieldAdapterHandle + ! struct struct PcmsFieldHandle + type, public :: PcmsFieldHandle + type(SwigClassWrapper), public :: swigdata + contains + procedure :: set_pointer => swigf_PcmsFieldHandle_pointer_set + procedure :: get_pointer => swigf_PcmsFieldHandle_pointer_get + procedure :: release => swigf_PcmsFieldHandle_release + procedure, private :: swigf_PcmsFieldHandle_op_assign__ + generic :: assignment(=) => swigf_PcmsFieldHandle_op_assign__ + end type PcmsFieldHandle type, bind(C) :: SwigArrayWrapper type(C_PTR), public :: data = C_NULL_PTR integer(C_SIZE_T), public :: size = 0 end type - type, public :: SWIGTYPE_p_PcmsClientHandle - type(SwigClassWrapper), public :: swigdata - end type public :: pcms_create_client public :: pcms_destroy_client - type, public :: SWIGTYPE_p_PcmsReverseClassificationHandle - type(SwigClassWrapper), public :: swigdata - end type public :: pcms_load_reverse_classification public :: pcms_destroy_reverse_classification public :: pcms_reverse_classification_count_verts - type, public :: SWIGTYPE_p_PcmsFieldAdapterHandle - type(SwigClassWrapper), public :: swigdata - end type public :: pcms_create_xgc_field_adapter public :: pcms_create_dummy_field_adapter public :: pcms_destroy_field_adapter - type, public :: SWIGTYPE_p_PcmsFieldHandle - type(SwigClassWrapper), public :: swigdata - end type public :: pcms_add_field public :: pcms_send_field_name public :: pcms_receive_field_name @@ -70,6 +108,21 @@ module pcms public :: pcms_end_receive_phase public :: pcms_kokkos_initialize_without_args public :: pcms_kokkos_finalize + interface PcmsOmegaHMeshHandle + module procedure swigf_new_PcmsOmegaHMeshHandle + end interface + interface PcmsClientHandle + module procedure swigf_new_PcmsClientHandle + end interface + interface PcmsReverseClassificationHandle + module procedure swigf_new_PcmsReverseClassificationHandle + end interface + interface PcmsFieldAdapterHandle + module procedure swigf_new_PcmsFieldAdapterHandle + end interface + interface PcmsFieldHandle + module procedure swigf_new_PcmsFieldHandle + end interface ! FUNCTION POINTER DECLARATIONS abstract interface @@ -87,6 +140,206 @@ function in_overlap_func(dimension, id) & ! WRAPPER DECLARATIONS interface + subroutine swigc_PcmsClientHandle_pointer_set(farg1, farg2) & + bind(C, name = "_wrap_PcmsClientHandle_pointer_set") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR), intent(in) :: farg2 + end subroutine + + function swigc_PcmsClientHandle_pointer_get(farg1) & + bind(C, name = "_wrap_PcmsClientHandle_pointer_get") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR) :: fresult + end function + + function swigc_new_PcmsClientHandle() & + bind(C, name = "_wrap_new_PcmsClientHandle") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper) :: fresult + end function + + subroutine swigc_delete_PcmsClientHandle(farg1) & + bind(C, name = "_wrap_delete_PcmsClientHandle") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + end subroutine + + subroutine swigc_PcmsClientHandle_op_assign__(farg1, farg2) & + bind(C, name = "_wrap_PcmsClientHandle_op_assign__") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + type(SwigClassWrapper), intent(in) :: farg2 + end subroutine + + subroutine swigc_PcmsOmegaHMeshHandle_pointer_set(farg1, farg2) & + bind(C, name = "_wrap_PcmsOmegaHMeshHandle_pointer_set") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR), intent(in) :: farg2 + end subroutine + + function swigc_PcmsOmegaHMeshHandle_pointer_get(farg1) & + bind(C, name = "_wrap_PcmsOmegaHMeshHandle_pointer_get") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR) :: fresult + end function + + function swigc_new_PcmsOmegaHMeshHandle() & + bind(C, name = "_wrap_new_PcmsOmegaHMeshHandle") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper) :: fresult + end function + + subroutine swigc_delete_PcmsOmegaHMeshHandle(farg1) & + bind(C, name = "_wrap_delete_PcmsOmegaHMeshHandle") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + end subroutine + + subroutine swigc_PcmsOmegaHMeshHandle_op_assign__(farg1, farg2) & + bind(C, name = "_wrap_PcmsOmegaHMeshHandle_op_assign__") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + type(SwigClassWrapper), intent(in) :: farg2 + end subroutine + + subroutine swigc_PcmsReverseClassificationHandle_pointer_set(farg1, farg2) & + bind(C, name = "_wrap_PcmsReverseClassificationHandle_pointer_set") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR), intent(in) :: farg2 + end subroutine + + function swigc_PcmsReverseClassificationHandle_pointer_get(farg1) & + bind(C, name = "_wrap_PcmsReverseClassificationHandle_pointer_get") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR) :: fresult + end function + + function swigc_new_PcmsReverseClassificationHandle() & + bind(C, name = "_wrap_new_PcmsReverseClassificationHandle") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper) :: fresult + end function + + subroutine swigc_delete_PcmsReverseClassificationHandle(farg1) & + bind(C, name = "_wrap_delete_PcmsReverseClassificationHandle") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + end subroutine + + subroutine swigc_PcmsReverseClassificationHandle_op_assign__(farg1, farg2) & + bind(C, name = "_wrap_PcmsReverseClassificationHandle_op_assign__") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + type(SwigClassWrapper), intent(in) :: farg2 + end subroutine + + subroutine swigc_PcmsFieldAdapterHandle_pointer_set(farg1, farg2) & + bind(C, name = "_wrap_PcmsFieldAdapterHandle_pointer_set") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR), intent(in) :: farg2 + end subroutine + + function swigc_PcmsFieldAdapterHandle_pointer_get(farg1) & + bind(C, name = "_wrap_PcmsFieldAdapterHandle_pointer_get") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR) :: fresult + end function + + function swigc_new_PcmsFieldAdapterHandle() & + bind(C, name = "_wrap_new_PcmsFieldAdapterHandle") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper) :: fresult + end function + + subroutine swigc_delete_PcmsFieldAdapterHandle(farg1) & + bind(C, name = "_wrap_delete_PcmsFieldAdapterHandle") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + end subroutine + + subroutine swigc_PcmsFieldAdapterHandle_op_assign__(farg1, farg2) & + bind(C, name = "_wrap_PcmsFieldAdapterHandle_op_assign__") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + type(SwigClassWrapper), intent(in) :: farg2 + end subroutine + + subroutine swigc_PcmsFieldHandle_pointer_set(farg1, farg2) & + bind(C, name = "_wrap_PcmsFieldHandle_pointer_set") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR), intent(in) :: farg2 + end subroutine + + function swigc_PcmsFieldHandle_pointer_get(farg1) & + bind(C, name = "_wrap_PcmsFieldHandle_pointer_get") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(in) :: farg1 + type(C_PTR) :: fresult + end function + + function swigc_new_PcmsFieldHandle() & + bind(C, name = "_wrap_new_PcmsFieldHandle") & + result(fresult) + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper) :: fresult + end function + + subroutine swigc_delete_PcmsFieldHandle(farg1) & + bind(C, name = "_wrap_delete_PcmsFieldHandle") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + end subroutine + + subroutine swigc_PcmsFieldHandle_op_assign__(farg1, farg2) & + bind(C, name = "_wrap_PcmsFieldHandle_op_assign__") + use, intrinsic :: ISO_C_BINDING + import :: swigclasswrapper + type(SwigClassWrapper), intent(inout) :: farg1 + type(SwigClassWrapper), intent(in) :: farg2 + end subroutine + function swigc_pcms_create_client(farg1, farg2) & bind(C, name="_wrap_pcms_create_client") & result(fresult) @@ -251,6 +504,316 @@ subroutine swigc_pcms_kokkos_finalize() & contains ! MODULE SUBPROGRAMS + subroutine swigf_PcmsClientHandle_pointer_set(self, pointer) + use, intrinsic :: ISO_C_BINDING + class(PcmsClientHandle), intent(in) :: self + type(C_PTR), intent(in) :: pointer + type(SwigClassWrapper) :: farg1 + type(C_PTR) :: farg2 + + farg1 = self%swigdata + farg2 = pointer + call swigc_PcmsClientHandle_pointer_set(farg1, farg2) + end subroutine + + function swigf_PcmsClientHandle_pointer_get(self) & + result(swig_result) + use, intrinsic :: ISO_C_BINDING + type(C_PTR) :: swig_result + class(PcmsClientHandle), intent(in) :: self + type(C_PTR) :: fresult + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + fresult = swigc_PcmsClientHandle_pointer_get(farg1) + swig_result = fresult + end function + + function swigf_new_PcmsClientHandle() & + result(self) + use, intrinsic :: ISO_C_BINDING + type(PcmsClientHandle) :: self + type(SwigClassWrapper) :: fresult + + fresult = swigc_new_PcmsClientHandle() + self%swigdata = fresult + end function + + subroutine swigf_PcmsClientHandle_release(self) + use, intrinsic :: ISO_C_BINDING + class(PcmsClientHandle), intent(inout) :: self + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + if (btest(farg1%cmemflags, swig_cmem_own_bit)) then + call swigc_delete_PcmsClientHandle(farg1) + endif + farg1%cptr = C_NULL_PTR + farg1%cmemflags = 0 + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsClientHandle_op_assign__(self, other) + use, intrinsic :: ISO_C_BINDING + class(PcmsClientHandle), intent(inout) :: self + type(PcmsClientHandle), intent(in) :: other + type(SwigClassWrapper) :: farg1 + type(SwigClassWrapper) :: farg2 + + farg1 = self%swigdata + farg2 = other%swigdata + call swigc_PcmsClientHandle_op_assign__(farg1, farg2) + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsOmegaHMeshHandle_pointer_set(self, pointer) + use, intrinsic :: ISO_C_BINDING + class(PcmsOmegaHMeshHandle), intent(in) :: self + type(C_PTR), intent(in) :: pointer + type(SwigClassWrapper) :: farg1 + type(C_PTR) :: farg2 + + farg1 = self%swigdata + farg2 = pointer + call swigc_PcmsOmegaHMeshHandle_pointer_set(farg1, farg2) + end subroutine + + function swigf_PcmsOmegaHMeshHandle_pointer_get(self) & + result(swig_result) + use, intrinsic :: ISO_C_BINDING + type(C_PTR) :: swig_result + class(PcmsOmegaHMeshHandle), intent(in) :: self + type(C_PTR) :: fresult + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + fresult = swigc_PcmsOmegaHMeshHandle_pointer_get(farg1) + swig_result = fresult + end function + + function swigf_new_PcmsOmegaHMeshHandle() & + result(self) + use, intrinsic :: ISO_C_BINDING + type(PcmsOmegaHMeshHandle) :: self + type(SwigClassWrapper) :: fresult + + fresult = swigc_new_PcmsOmegaHMeshHandle() + self%swigdata = fresult + end function + + subroutine swigf_PcmsOmegaHMeshHandle_release(self) + use, intrinsic :: ISO_C_BINDING + class(PcmsOmegaHMeshHandle), intent(inout) :: self + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + if (btest(farg1%cmemflags, swig_cmem_own_bit)) then + call swigc_delete_PcmsOmegaHMeshHandle(farg1) + endif + farg1%cptr = C_NULL_PTR + farg1%cmemflags = 0 + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsOmegaHMeshHandle_op_assign__(self, other) + use, intrinsic :: ISO_C_BINDING + class(PcmsOmegaHMeshHandle), intent(inout) :: self + type(PcmsOmegaHMeshHandle), intent(in) :: other + type(SwigClassWrapper) :: farg1 + type(SwigClassWrapper) :: farg2 + + farg1 = self%swigdata + farg2 = other%swigdata + call swigc_PcmsOmegaHMeshHandle_op_assign__(farg1, farg2) + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsReverseClassificationHandle_pointer_set(self, pointer) + use, intrinsic :: ISO_C_BINDING + class(PcmsReverseClassificationHandle), intent(in) :: self + type(C_PTR), intent(in) :: pointer + type(SwigClassWrapper) :: farg1 + type(C_PTR) :: farg2 + + farg1 = self%swigdata + farg2 = pointer + call swigc_PcmsReverseClassificationHandle_pointer_set(farg1, farg2) + end subroutine + + function swigf_PcmsReverseClassificationHandle_pointer_get(self) & + result(swig_result) + use, intrinsic :: ISO_C_BINDING + type(C_PTR) :: swig_result + class(PcmsReverseClassificationHandle), intent(in) :: self + type(C_PTR) :: fresult + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + fresult = swigc_PcmsReverseClassificationHandle_pointer_get(farg1) + swig_result = fresult + end function + + function swigf_new_PcmsReverseClassificationHandle() & + result(self) + use, intrinsic :: ISO_C_BINDING + type(PcmsReverseClassificationHandle) :: self + type(SwigClassWrapper) :: fresult + + fresult = swigc_new_PcmsReverseClassificationHandle() + self%swigdata = fresult + end function + + subroutine swigf_PcmsReverseClassificationHandle_release(self) + use, intrinsic :: ISO_C_BINDING + class(PcmsReverseClassificationHandle), intent(inout) :: self + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + if (btest(farg1%cmemflags, swig_cmem_own_bit)) then + call swigc_delete_PcmsReverseClassificationHandle(farg1) + endif + farg1%cptr = C_NULL_PTR + farg1%cmemflags = 0 + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsReverseClassificationHandle_op_assign__(self, other) + use, intrinsic :: ISO_C_BINDING + class(PcmsReverseClassificationHandle), intent(inout) :: self + type(PcmsReverseClassificationHandle), intent(in) :: other + type(SwigClassWrapper) :: farg1 + type(SwigClassWrapper) :: farg2 + + farg1 = self%swigdata + farg2 = other%swigdata + call swigc_PcmsReverseClassificationHandle_op_assign__(farg1, farg2) + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsFieldAdapterHandle_pointer_set(self, pointer) + use, intrinsic :: ISO_C_BINDING + class(PcmsFieldAdapterHandle), intent(in) :: self + type(C_PTR), intent(in) :: pointer + type(SwigClassWrapper) :: farg1 + type(C_PTR) :: farg2 + + farg1 = self%swigdata + farg2 = pointer + call swigc_PcmsFieldAdapterHandle_pointer_set(farg1, farg2) + end subroutine + + function swigf_PcmsFieldAdapterHandle_pointer_get(self) & + result(swig_result) + use, intrinsic :: ISO_C_BINDING + type(C_PTR) :: swig_result + class(PcmsFieldAdapterHandle), intent(in) :: self + type(C_PTR) :: fresult + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + fresult = swigc_PcmsFieldAdapterHandle_pointer_get(farg1) + swig_result = fresult + end function + + function swigf_new_PcmsFieldAdapterHandle() & + result(self) + use, intrinsic :: ISO_C_BINDING + type(PcmsFieldAdapterHandle) :: self + type(SwigClassWrapper) :: fresult + + fresult = swigc_new_PcmsFieldAdapterHandle() + self%swigdata = fresult + end function + + subroutine swigf_PcmsFieldAdapterHandle_release(self) + use, intrinsic :: ISO_C_BINDING + class(PcmsFieldAdapterHandle), intent(inout) :: self + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + if (btest(farg1%cmemflags, swig_cmem_own_bit)) then + call swigc_delete_PcmsFieldAdapterHandle(farg1) + endif + farg1%cptr = C_NULL_PTR + farg1%cmemflags = 0 + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsFieldAdapterHandle_op_assign__(self, other) + use, intrinsic :: ISO_C_BINDING + class(PcmsFieldAdapterHandle), intent(inout) :: self + type(PcmsFieldAdapterHandle), intent(in) :: other + type(SwigClassWrapper) :: farg1 + type(SwigClassWrapper) :: farg2 + + farg1 = self%swigdata + farg2 = other%swigdata + call swigc_PcmsFieldAdapterHandle_op_assign__(farg1, farg2) + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsFieldHandle_pointer_set(self, pointer) + use, intrinsic :: ISO_C_BINDING + class(PcmsFieldHandle), intent(in) :: self + type(C_PTR), intent(in) :: pointer + type(SwigClassWrapper) :: farg1 + type(C_PTR) :: farg2 + + farg1 = self%swigdata + farg2 = pointer + call swigc_PcmsFieldHandle_pointer_set(farg1, farg2) + end subroutine + + function swigf_PcmsFieldHandle_pointer_get(self) & + result(swig_result) + use, intrinsic :: ISO_C_BINDING + type(C_PTR) :: swig_result + class(PcmsFieldHandle), intent(in) :: self + type(C_PTR) :: fresult + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + fresult = swigc_PcmsFieldHandle_pointer_get(farg1) + swig_result = fresult + end function + + function swigf_new_PcmsFieldHandle() & + result(self) + use, intrinsic :: ISO_C_BINDING + type(PcmsFieldHandle) :: self + type(SwigClassWrapper) :: fresult + + fresult = swigc_new_PcmsFieldHandle() + self%swigdata = fresult + end function + + subroutine swigf_PcmsFieldHandle_release(self) + use, intrinsic :: ISO_C_BINDING + class(PcmsFieldHandle), intent(inout) :: self + type(SwigClassWrapper) :: farg1 + + farg1 = self%swigdata + if (btest(farg1%cmemflags, swig_cmem_own_bit)) then + call swigc_delete_PcmsFieldHandle(farg1) + endif + farg1%cptr = C_NULL_PTR + farg1%cmemflags = 0 + self%swigdata = farg1 + end subroutine + + subroutine swigf_PcmsFieldHandle_op_assign__(self, other) + use, intrinsic :: ISO_C_BINDING + class(PcmsFieldHandle), intent(inout) :: self + type(PcmsFieldHandle), intent(in) :: other + type(SwigClassWrapper) :: farg1 + type(SwigClassWrapper) :: farg2 + + farg1 = self%swigdata + farg2 = other%swigdata + call swigc_PcmsFieldHandle_op_assign__(farg1, farg2) + self%swigdata = farg1 + end subroutine + subroutine SWIGTM_fin_char_Sm_(finp, iminp, temp) use, intrinsic :: ISO_C_BINDING @@ -272,7 +835,7 @@ subroutine SWIGTM_fin_char_Sm_(finp, iminp, temp) function pcms_create_client(name, comm) & result(swig_result) use, intrinsic :: ISO_C_BINDING -type(SWIGTYPE_p_PcmsClientHandle) :: swig_result +type(PcmsClientHandle) :: swig_result character(len=*), target :: name integer :: comm type(SwigClassWrapper) :: fresult @@ -288,7 +851,7 @@ function pcms_create_client(name, comm) & subroutine pcms_destroy_client(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -298,7 +861,7 @@ subroutine pcms_destroy_client(arg0) function pcms_load_reverse_classification(file, comm) & result(swig_result) use, intrinsic :: ISO_C_BINDING -type(SWIGTYPE_p_PcmsReverseClassificationHandle) :: swig_result +type(PcmsReverseClassificationHandle) :: swig_result character(len=*), target :: file integer :: comm type(SwigClassWrapper) :: fresult @@ -314,7 +877,7 @@ function pcms_load_reverse_classification(file, comm) & subroutine pcms_destroy_reverse_classification(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsReverseClassificationHandle), intent(in) :: arg0 +type(PcmsReverseClassificationHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -325,7 +888,7 @@ function pcms_reverse_classification_count_verts(arg0) & result(swig_result) use, intrinsic :: ISO_C_BINDING integer(C_INT) :: swig_result -class(SWIGTYPE_p_PcmsReverseClassificationHandle), intent(in) :: arg0 +type(PcmsReverseClassificationHandle), intent(in) :: arg0 integer(C_INT) :: fresult type(SwigClassWrapper) :: farg1 @@ -337,13 +900,13 @@ function pcms_reverse_classification_count_verts(arg0) & function pcms_create_xgc_field_adapter(name, plane_comm, data, size, data_type, rc, in_overlap) & result(swig_result) use, intrinsic :: ISO_C_BINDING -type(SWIGTYPE_p_PcmsFieldAdapterHandle) :: swig_result +type(PcmsFieldAdapterHandle) :: swig_result character(len=*), target :: name integer :: plane_comm type(C_PTR), intent(in) :: data integer(C_INT), intent(in) :: size integer(PcmsType), intent(in) :: data_type -class(SWIGTYPE_p_PcmsReverseClassificationHandle), intent(in) :: rc +type(PcmsReverseClassificationHandle), intent(in) :: rc procedure(in_overlap_func) :: in_overlap type(SwigClassWrapper) :: fresult character(kind=C_CHAR), dimension(:), allocatable, target :: farg1_temp @@ -369,7 +932,7 @@ function pcms_create_xgc_field_adapter(name, plane_comm, data, size, data_type, function pcms_create_dummy_field_adapter() & result(swig_result) use, intrinsic :: ISO_C_BINDING -type(SWIGTYPE_p_PcmsFieldAdapterHandle) :: swig_result +type(PcmsFieldAdapterHandle) :: swig_result type(SwigClassWrapper) :: fresult fresult = swigc_pcms_create_dummy_field_adapter() @@ -378,7 +941,7 @@ function pcms_create_dummy_field_adapter() & subroutine pcms_destroy_field_adapter(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsFieldAdapterHandle), intent(in) :: arg0 +type(PcmsFieldAdapterHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -388,10 +951,10 @@ subroutine pcms_destroy_field_adapter(arg0) function pcms_add_field(client_handle, name, adapter_handle, participates) & result(swig_result) use, intrinsic :: ISO_C_BINDING -type(SWIGTYPE_p_PcmsFieldHandle) :: swig_result -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: client_handle +type(PcmsFieldHandle) :: swig_result +type(PcmsClientHandle), intent(in) :: client_handle character(len=*), target :: name -class(SWIGTYPE_p_PcmsFieldAdapterHandle), intent(in) :: adapter_handle +type(PcmsFieldAdapterHandle), intent(in) :: adapter_handle integer(C_INT), intent(in) :: participates type(SwigClassWrapper) :: fresult type(SwigClassWrapper) :: farg1 @@ -410,7 +973,7 @@ function pcms_add_field(client_handle, name, adapter_handle, participates) & subroutine pcms_send_field_name(arg0, name) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 character(len=*), target :: name type(SwigClassWrapper) :: farg1 character(kind=C_CHAR), dimension(:), allocatable, target :: farg2_temp @@ -423,7 +986,7 @@ subroutine pcms_send_field_name(arg0, name) subroutine pcms_receive_field_name(arg0, name) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 character(len=*), target :: name type(SwigClassWrapper) :: farg1 character(kind=C_CHAR), dimension(:), allocatable, target :: farg2_temp @@ -436,7 +999,7 @@ subroutine pcms_receive_field_name(arg0, name) subroutine pcms_send_field(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsFieldHandle), intent(in) :: arg0 +type(PcmsFieldHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -445,7 +1008,7 @@ subroutine pcms_send_field(arg0) subroutine pcms_receive_field(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsFieldHandle), intent(in) :: arg0 +type(PcmsFieldHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -454,7 +1017,7 @@ subroutine pcms_receive_field(arg0) subroutine pcms_begin_send_phase(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -463,7 +1026,7 @@ subroutine pcms_begin_send_phase(arg0) subroutine pcms_end_send_phase(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -472,7 +1035,7 @@ subroutine pcms_end_send_phase(arg0) subroutine pcms_begin_receive_phase(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata @@ -481,7 +1044,7 @@ subroutine pcms_begin_receive_phase(arg0) subroutine pcms_end_receive_phase(arg0) use, intrinsic :: ISO_C_BINDING -class(SWIGTYPE_p_PcmsClientHandle), intent(in) :: arg0 +type(PcmsClientHandle), intent(in) :: arg0 type(SwigClassWrapper) :: farg1 farg1 = arg0%swigdata diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index 7da6949e..caef27ec 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -137,6 +137,11 @@ if (PCMS_ENABLE_OMEGA_H) endif() add_executable(proxy_coupling test_proxy_coupling.cpp) target_link_libraries(proxy_coupling PUBLIC pcms::core test_support) + tri_mpi_test(TESTNAME test_proxy_coupling_4p + TIMEOUT 10 + NAME1 rdv EXE1 ./proxy_coupling PROCS1 2 ARGS1 -1 ${d3d1p} ${d3d2p_cpn} + NAME2 client0 EXE2 ./proxy_coupling PROCS2 1 ARGS2 0 ${d3d1p} ignored + NAME3 client1 EXE3 ./proxy_coupling PROCS3 1 ARGS3 1 ${d3d1p} ignored) if(HOST_NPROC GREATER 13) tri_mpi_test(TESTNAME test_proxy_coupling_26p TIMEOUT 12 @@ -144,16 +149,13 @@ if (PCMS_ENABLE_OMEGA_H) NAME2 client0 EXE2 ./proxy_coupling PROCS2 16 ARGS2 0 ${d3d16p} ignored NAME3 client1 EXE3 ./proxy_coupling PROCS3 8 ARGS3 1 ${d3d8p} ignored) endif() - tri_mpi_test(TESTNAME test_proxy_coupling_4p - TIMEOUT 10 - NAME1 rdv EXE1 ./proxy_coupling PROCS1 2 ARGS1 -1 ${d3d1p} ${d3d2p_cpn} - NAME2 client0 EXE2 ./proxy_coupling PROCS2 1 ARGS2 0 ${d3d1p} ignored - NAME3 client1 EXE3 ./proxy_coupling PROCS3 1 ARGS3 1 ${d3d1p} ignored) - tri_mpi_test(TESTNAME test_proxy_coupling - TIMEOUT 12 - NAME1 rdv EXE1 ./proxy_coupling PROCS1 4 ARGS1 -1 ${d3d1p} ${d3d4p_cpn} - NAME2 client0 EXE2 ./proxy_coupling PROCS2 16 ARGS2 0 ${d3d16p} ignored - NAME3 client1 EXE3 ./proxy_coupling PROCS3 8 ARGS3 1 ${d3d8p} ignored) + if (HOST_NPROC GREATER 14) + tri_mpi_test(TESTNAME test_proxy_coupling_28p + TIMEOUT 12 + NAME1 rdv EXE1 ./proxy_coupling PROCS1 4 ARGS1 -1 ${d3d1p} ${d3d4p_cpn} + NAME2 client0 EXE2 ./proxy_coupling PROCS2 16 ARGS2 0 ${d3d16p} ignored + NAME3 client1 EXE3 ./proxy_coupling PROCS3 8 ARGS3 1 ${d3d8p} ignored) + endif () if(HOST_NPROC GREATER 16) tri_mpi_test(TESTNAME test_proxy_coupling_32p TIMEOUT 12 diff --git a/test/test_proxy_coupling_xgc_client_fortran.f90 b/test/test_proxy_coupling_xgc_client_fortran.f90 index cc15080b..ecd18811 100644 --- a/test/test_proxy_coupling_xgc_client_fortran.f90 +++ b/test/test_proxy_coupling_xgc_client_fortran.f90 @@ -29,10 +29,10 @@ Program main integer, parameter :: nplanes = 2 integer :: num_args, ix, nverts, ierror - type(SWIGTYPE_p_PcmsClientHandle) :: client - type(SWIGTYPE_p_PcmsReverseClassificationHandle) :: reverse_classification - type(SWIGTYPE_p_PcmsFieldHandle), dimension(2) :: fields - type(SWIGTYPE_p_PcmsFieldAdapterHandle), dimension(2) :: adapters + type(PcmsClientHandle) :: client + type(PcmsReverseClassificationHandle) :: reverse_classification + type(PcmsFieldHandle), dimension(2) :: fields + type(PcmsFieldAdapterHandle), dimension(2) :: adapters character(len = 80), dimension(:), allocatable :: args character(len = :), allocatable :: rc_file integer(C_LONG), allocatable, target :: data(:) diff --git a/test/test_proxy_coupling_xgc_server.cpp b/test/test_proxy_coupling_xgc_server.cpp index 1b953ae6..00b41d71 100644 --- a/test/test_proxy_coupling_xgc_server.cpp +++ b/test/test_proxy_coupling_xgc_server.cpp @@ -93,14 +93,16 @@ void omegah_coupler(MPI_Comm comm, Omega_h::Mesh& mesh, redev::Partition{ts::setupServerPartition(mesh, cpn_file)}, mesh); const auto partition = std::get(cpl.GetPartition()); auto* application = cpl.AddApplication("proxy_couple"); - ReverseClassificationVertex rc; std::string numbering; if (mesh.has_tag(0, "simNumbering")) { - rc = ConstructRCFromOmegaHMesh(mesh, "simNumbering"); numbering = "simNumbering"; } else { - rc = ConstructRCFromOmegaHMesh(mesh, "global", pcms::IndexBase::Zero); - numbering = "global"; + Omega_h::Write gids(mesh.nverts()); + auto globals = mesh.globals(0); + Omega_h::parallel_for( + mesh.nverts(), OMEGA_H_LAMBDA(int i) { gids[i] = globals[i] + 1; }); + mesh.add_tag(0, "simNumbering", 1, Omega_h::Read(gids)); + numbering = "simNumbering"; } auto is_overlap = @@ -158,7 +160,7 @@ int main(int argc, char** argv) const auto meshFile = argv[1]; const auto classPartitionFile = argv[2]; - int coupler_type = std::atoi(argv[3]); + int coupler_type = std::stoi(argv[3]); Omega_h::Mesh mesh(&lib); Omega_h::binary::read(meshFile, lib.world(), &mesh); From 65dd260b902b3e3229a860c94fcdaa83a347cc5a Mon Sep 17 00:00:00 2001 From: Jacob Merson Date: Thu, 11 Jan 2024 00:56:29 -0500 Subject: [PATCH 07/15] Create LICENSE (#141) --- LICENSE | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..e4c5022a --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2024, Rensselaer Polytechnic Institute, Scientific Computation Research Center + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. From 9394b27a6d4662c92d3f9cb0cef8aeed2348e4ea Mon Sep 17 00:00:00 2001 From: Angel Castillo Date: Wed, 13 Nov 2024 13:53:07 -0500 Subject: [PATCH 08/15] Weekly Perlmutter Test (#146) * all tests fixed * build kokkos * moved install repo * rename to action * hello world * check out * try install * try checkout * nested variable test * configure * added shell * try build * cache build * env name * remove id * config options * build adios2 * try using id * test cache * another cache test * format if * change format * test not * if true * if false * format false * format brackets * format variable * hello true false * if format true * true in quotes * format kokkos * format no quotes * if true * sanity * cache hit * build kokkos quotes * single quote * format brackets * simplify * invert * test cache * build perfstubs * build redev * removed kokkos ids * test just kokkos * test with id * check-cache id * test adios2 and perfstubs * build redev * always checkout * build omega_h * compile catch2 * build pcms * rename cache var * change pcms dep dir * change dir path * change pref dir * install fftw * test case path * pwd test cases * run pcms test * fixed ctest dir * omega_h use kokkos * initial perlmutter * install file * pwd * null conditional * write files * ls * try install * try ls * try just install * make file executable * try full install * write run file * try run test * run command * fixed omega test * machine variables * better spacing * fixed indent * write file * with quotes * python print * test endpoint * build and test * fixed tab * test env var * test with brackets * renaming * test workflow * type string * pass timeout * rename test * use outside repo * master repo * move to workflows * use main branch * small test * revert * try master * try no secret * try all caps * try main * lower case * remove test * public repo * public main * switch to local repo * typo * longer timeout * support file * try perlmutter run * longer timeout * hide unused files * remove unused globus files * seperate globus test * schedule * ls again * working ls * ls -a * simplify paths * typo * use globus again * find dir twice * stop cleaning * globus dir * use globus path * timeout 0 * remove env file * Change test time --- .github/actions/install-repo/action.yml | 44 +++++ .github/workflows/cmake-test.yml | 150 ++++++++++++++++++ .github/workflows/globus-tests.yml | 12 ++ .github/workflows/perlmutter/install.sh | 110 +++++++++++++ .github/workflows/perlmutter/run.sh | 11 ++ SUPPORT.md | 1 + test/CMakeLists.txt | 5 +- test/test_ohClassPtn.cpp | 2 +- test/test_ohClassPtn_appRibPtn.cpp | 2 +- test/test_ohOverlap.cpp | 30 +++- ...test_proxy_coupling_xgc_client_fortran.f90 | 4 +- test/test_twoClientOverlap.cpp | 54 +++++-- 12 files changed, 395 insertions(+), 30 deletions(-) create mode 100644 .github/actions/install-repo/action.yml create mode 100644 .github/workflows/cmake-test.yml create mode 100644 .github/workflows/globus-tests.yml create mode 100644 .github/workflows/perlmutter/install.sh create mode 100644 .github/workflows/perlmutter/run.sh create mode 100644 SUPPORT.md diff --git a/.github/actions/install-repo/action.yml b/.github/actions/install-repo/action.yml new file mode 100644 index 00000000..4f5f373e --- /dev/null +++ b/.github/actions/install-repo/action.yml @@ -0,0 +1,44 @@ +name: Install-Repo + +inputs: + repo-name: + required: true + repo-path: + required: true + repo-ref: + required: true + options: + required: true + cache: + required: true + +runs: + using: "composite" + steps: + + - name: Check Cache + if: ${{ inputs.cache == 'true'}} + uses: actions/cache@v3 + id: check-cache + with: + key: build-${{ inputs.repo-name }} + path: ${{ runner.temp }}/build-${{ inputs.repo-name }} + + - name: Checkout Repo + uses: actions/checkout@v3 + with: + repository: ${{inputs.repo-path }} + ref: ${{ inputs.repo-ref }} + path: ${{ inputs.repo-name }} + + - name: Configure CMake + if: ${{ !steps.check-cache.outputs.cache-hit }} + shell: bash + run: cmake -S $GITHUB_WORKSPACE/${{ inputs.repo-name }} -B ${{ runner.temp }}/build-${{ inputs.repo-name }} + -DCMAKE_INSTALL_PREFIX=${{ runner.temp }}/build-${{ inputs.repo-name }}/install + ${{ inputs.options }} + + - name: Build Cmake + if: ${{ !steps.check-cache.outputs.cache-hit }} + shell: bash + run: cmake --build ${{ runner.temp }}/build-${{ inputs.repo-name }} -j8 --target install \ No newline at end of file diff --git a/.github/workflows/cmake-test.yml b/.github/workflows/cmake-test.yml new file mode 100644 index 00000000..ed4e971c --- /dev/null +++ b/.github/workflows/cmake-test.yml @@ -0,0 +1,150 @@ +name: Test-Build +on: + push: + schedule: + - cron: '12 14 * * 3' + +jobs: + test-build: + runs-on: ubuntu-latest + + defaults: + run: + shell: bash + + strategy: + matrix: + build_type: [Release] + memory_test: [ON, OFF] + compiler: [g++] + language: ['cpp'] + exclude: + - build_type: Release + memory_test: ON + - build_type: RelWithDebInfo + memory_test: OFF + + steps: + + - name: Update packages + run: sudo apt-get update + + - name: Install mpi + run: sudo apt-get install -yq mpich libmpich-dev + + - uses: actions/checkout@v4 + + - name: build kokkos + uses: ./.github/actions/install-repo + with: + repo-name: 'kokkos' + repo-path: 'kokkos/kokkos' + repo-ref: '4.2.00' + cache: true + options: '-DCMAKE_CXX_COMPILER=${{ matrix.compiler }} + -DKokkos_ENABLE_SERIAL=ON + -DKokkos_ENABLE_OPENMP=off + -DKokkos_ENABLE_CUDA=off + -DKokkos_ENABLE_CUDA_LAMBDA=off + -DKokkos_ENABLE_DEBUG=on' + + - name: build ADIOS2 + uses: ./.github/actions/install-repo + with: + repo-name: 'ADIOS2' + repo-path: 'ornladios/ADIOS2' + repo-ref: '' + cache: true + options: '-DADIOS2_USE_CUDA=off + -DCMAKE_BUILD_TYPE=Release + -DCMAKE_CXX_COMPILER=mpicxx + -DCMAKE_C_COMPILER=mpicc' + + - name: build perfstubs + uses: ./.github/actions/install-repo + with: + repo-name: 'perfstubs' + repo-path: 'UO-OACISS/perfstubs' + repo-ref: '' + cache: true + options: '-DCMAKE_BUILD_TYPE=Release + -DCMAKE_CXX_COMPILER=mpicxx + -DCMAKE_C_COMPILER=mpicc' + + - name: build redev + uses: ./.github/actions/install-repo + with: + repo-name: 'redev' + repo-path: 'SCOREC/redev' + repo-ref: '' + cache: true + options: '-DCMAKE_BUILD_TYPE=Release + -DCMAKE_CXX_COMPILER=mpicxx + -DCMAKE_C_COMPILER=mpicc + -DMPIEXEC_EXECUTABLE=`which srun` + -Dperfstubs_DIR=${{ runner.temp }}/build-perfstubs + -DADIOS2_ROOT=${{ runner.temp }}/build-ADIOS2/install' + + - name: build omega_h + uses: ./.github/actions/install-repo + with: + repo-name: 'omega_h' + repo-path: 'SCOREC/omega_h' + repo-ref: '' + cache: true + options: '-DCMAKE_BUILD_TYPE=Release + -DBUILD_SHARED_LIBS=off + -DOmega_h_USE_Kokkos=on + -DOmega_h_USE_CUDA=off + -DOmega_h_USE_MPI=on + -DMPIEXEC_EXECUTABLE=srun + -DBUILD_TESTING=off + -DCMAKE_C_COMPILER=mpicc + -DCMAKE_CXX_COMPILER=mpicxx + -DKokkos_PREFIX=${{ runner.temp }}/build-kokkos/install/lib/cmake' + + - name: build Catch2 + uses: ./.github/actions/install-repo + with: + repo-name: 'Catch2' + repo-path: 'catchorg/Catch2' + repo-ref: '' + cache: true + options: '-DCMAKE_BUILD_TYPE=Release + -DCMAKE_CXX_COMPILER=mpicxx' + + - name: checkout pcms_testcases + uses: actions/checkout@v3 + with: + repository: jacobmerson/pcms_testcases + path: pcms_testcases + + - name: Install fftw3 + run: sudo apt-get install -yq fftw3 fftw3-dev pkg-config + + - name: build pcms + uses: ./.github/actions/install-repo + with: + repo-name: 'pcms' + repo-path: 'SCOREC/pcms' + repo-ref: '' + cache: false + options: '-DCMAKE_BUILD_TYPE=Release + -DCMAKE_C_COMPILER=mpicc + -DCMAKE_CXX_COMPILER=mpicxx + -Dredev_DIR=${{ runner.temp }}/build-redev/install/lib/cmake/redev + -Dperfstubs_DIR=${{ runner.temp }}/build-perfstubs + -DOmega_h_DIR=${{ runner.temp }}/build-omega_h/install/lib/cmake/Omega_h + -DKokkos_DIR=${{ runner.temp }}/build-kokkos/install/lib/cmake/Kokkos + -DCatch2_DIR=${{ runner.temp }}/build-Catch2/install/lib/cmake/Catch2 + -DPCMS_TEST_DATA_DIR=$PWD/pcms_testcases' + + # - name: Install Valgrind + # run: sudo apt-get install -yq valgrind + + # - name: Run CTest + # run: ctest --test-dir ${{ runner.temp }}/build-pcms + + # - name: Print Test + # if: always() + # run: cat ${{ runner.temp }}/build-pcms/Testing/Temporary/LastTest.log \ No newline at end of file diff --git a/.github/workflows/globus-tests.yml b/.github/workflows/globus-tests.yml new file mode 100644 index 00000000..4fe3dec2 --- /dev/null +++ b/.github/workflows/globus-tests.yml @@ -0,0 +1,12 @@ +name: Globus-Systems +on: + schedule: + # Monday 8:35 UTC or 04:35 EDT + - cron: '35 8 * * 1' + +jobs: + perlmutter-test: + uses: SCOREC/github-actions/.github/workflows/globus-test.yml@main + secrets: inherit + with: + machine: "perlmutter" diff --git a/.github/workflows/perlmutter/install.sh b/.github/workflows/perlmutter/install.sh new file mode 100644 index 00000000..fca68520 --- /dev/null +++ b/.github/workflows/perlmutter/install.sh @@ -0,0 +1,110 @@ +#!/bin/bash -e + +branch=$1 + +cd $SCRATCH/globus-compute/pcms-test + +module load cray-fftw + +# # kokkos +# rm build-kokkos -rf +# # rm kokkos -rf +# git clone -b 4.2.00 https://github.com/kokkos/kokkos.git +# cmake -S kokkos -B build-kokkos \ +# -DCMAKE_INSTALL_PREFIX=build-kokkos/install \ +# -DCMAKE_BUILD_TYPE="Release" \ +# -DCMAKE_CXX_COMPILER=$PWD/kokkos/bin/nvcc_wrapper \ +# -DKokkos_ARCH_AMPERE80=ON \ +# -DKokkos_ENABLE_SERIAL=ON \ +# -DKokkos_ENABLE_OPENMP=off \ +# -DKokkos_ENABLE_CUDA=on \ +# -DKokkos_ENABLE_CUDA_LAMBDA=on \ +# -DKokkos_ENABLE_CUDA_CONSTEXPR=on \ +# -DKokkos_ENABLE_DEBUG=off +# cmake --build build-kokkos -j 24 --target install + +# # ADIOS2 +# rm build-ADIOS2 -rf +# # rm ADIOS2 -rf +# git clone git@github.com:ornladios/ADIOS2.git +# cmake -S ADIOS2/ -B build-ADIOS2 \ +# -DCMAKE_INSTALL_PREFIX=build-ADIOS2/install \ +# -DADIOS2_USE_CUDA=on \ +# -DCMAKE_BUILD_TYPE=Release \ +# -DCMAKE_CXX_COMPILER=CC \ +# -DCMAKE_C_COMPILER=cc +# cmake --build build-ADIOS2 --target install -j8 + +# # perfstubs +# rm build-perfstubs -rf +# # rm perfstubs -rf +# git clone git@github.com:UO-OACISS/perfstubs.git +# cmake -S perfstubs -B build-perfstubs \ +# -DCMAKE_CXX_COMPILER=CC \ +# -DCMAKE_C_COMPILER=cc \ +# -DCMAKE_INSTALL_PREFIX=build-perfstubs/install +# cmake --build build-perfstubs -j2 --target install + +# # redev +# rm build-redev -rf +# # rm redev -rf +# git clone git@github.com:SCOREC/redev.git +# cmake -S redev -B build-redev \ +# -DCMAKE_CXX_COMPILER=CC \ +# -DCMAKE_C_COMPILER=cc \ +# -DMPIEXEC_EXECUTABLE=`which srun` \ +# -DCMAKE_BUILD_TYPE=Release \ +# -DCMAKE_INSTALL_PREFIX=build-redev/install \ +# -Dperfstubs_DIR=$PWD/build-perfstubs \ +# -DADIOS2_ROOT=build-ADIOS2/install +# cmake --build build-redev -j2 --target install + +# # omega_h +# rm build-omega_h -rf +# # rm omega_h -rf +# git clone git@github.com:SCOREC/omega_h.git +# cmake -S omega_h -B build-omega_h \ +# -DCMAKE_INSTALL_PREFIX=build-omega_h/install \ +# -DCMAKE_BUILD_TYPE=Release \ +# -DBUILD_SHARED_LIBS=off \ +# -DOmega_h_USE_Kokkos=ON \ +# -DOmega_h_USE_CUDA=on \ +# -DOmega_h_CUDA_ARCH=80 \ +# -DOmega_h_USE_MPI=on \ +# -DMPIEXEC_EXECUTABLE=srun \ +# -DBUILD_TESTING=off \ +# -DCMAKE_C_COMPILER=cc \ +# -DCMAKE_CXX_COMPILER=CC \ +# -DKokkos_PREFIX=build-kokkos/install/lib64/cmake +# cmake --build build-omega_h -j24 --target install + +# # Catch2 +# rm build-Catch2 -rf +# # rm Catch2 -rf +# git clone https://github.com/catchorg/Catch2 +# cmake -S Catch2 -B build-Catch2 \ +# -DCMAKE_INSTALL_PREFIX=$PWD/build-Catch2/install \ +# -DCMAKE_CXX_COMPILER=CC +# cmake --build build-Catch2 -j2 --target install + +# pcms +rm pcms -rf +rm build-pcms -rf +rm pcms_testcases -rf + +git clone git@github.com:jacobmerson/pcms_testcases.git +git clone https://github.com/SCOREC/pcms.git +cd pcms && git checkout $branch && cd - + +cmake -S pcms -B build-pcms \ + -DCMAKE_C_COMPILER=cc \ + -DCMAKE_CXX_COMPILER=CC \ + -DCMAKE_BUILD_TYPE=Release \ + -DPCMS_TIMEOUT=0 \ + -Dperfstubs_DIR=$PWD/build-perfstubs \ + -Dredev_DIR=$PWD/build-redev/install/lib64/cmake/redev \ + -DOmega_h_DIR=$PWD/build-omega_h/install/lib64/cmake/Omega_h/ \ + -DKokkos_DIR=$PWD/build-kokkos/install/lib64/cmake/Kokkos/ \ + -DCatch2_DIR=$PWD/build-Catch2/install/lib64/cmake/Catch2/ \ + -DPCMS_TEST_DATA_DIR=$PWD/pcms_testcases +cmake --build build-pcms -j8 \ No newline at end of file diff --git a/.github/workflows/perlmutter/run.sh b/.github/workflows/perlmutter/run.sh new file mode 100644 index 00000000..c12e9f77 --- /dev/null +++ b/.github/workflows/perlmutter/run.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +name=pcms + +cd $SCRATCH/globus-compute/$name-test + +module load cray-fftw + +cd build-$name +salloc --time 00:20:00 --constrain=gpu --qos=interactive --nodes=1 --ntasks-per-node=40 --cpus-per-task=1 --gpus=1 --account=m4564 ctest +cat $PWD/Testing/Temporary/LastTest.log \ No newline at end of file diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..9fa8e3b4 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1 @@ +If you have any issues please contact us at mersoj2@rpi.edu \ No newline at end of file diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index caef27ec..2a7cd5eb 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -45,6 +45,9 @@ function(increaseTimeoutForValgrind TIME TIME_VAR_OUT) math(EXPR TIME_OUT "${TIME} * ${factor}") set(${TIME_VAR_OUT} ${TIME_OUT} PARENT_SCOPE) endif () + if (DEFINED PCMS_TIMEOUT) + set(${TIME_VAR_OUT} ${PCMS_TIMEOUT} PARENT_SCOPE) + endif () endfunction() function(mpi_test TESTNAME PROCS EXE) @@ -236,4 +239,4 @@ if(PCMS_ENABLE_Fortran) endif() add_executable(xgc_n0_server xgc_n0_coupling_server.cpp) -target_link_libraries(xgc_n0_server PUBLIC pcms::core test_support) +target_link_libraries(xgc_n0_server PUBLIC pcms::core test_support) \ No newline at end of file diff --git a/test/test_ohClassPtn.cpp b/test/test_ohClassPtn.cpp index 42b737fb..5e653063 100644 --- a/test/test_ohClassPtn.cpp +++ b/test/test_ohClassPtn.cpp @@ -41,7 +41,7 @@ int main(int argc, char** argv) redev::Redev rdv(MPI_COMM_WORLD, redev::Partition{std::move(partition)}, static_cast(isRdv)); const std::string name = "meshVtxIds"; - adios2::Params params{{"Streaming", "On"}, {"OpenTimeoutSecs", "2"}}; + adios2::Params params{{"Streaming", "On"}, {"OpenTimeoutSecs", "60"}}; auto channel = rdv.CreateAdiosChannel(name, params, redev::TransportType::BP4); auto commPair = channel.CreateComm(name,rdv.GetMPIComm()); diff --git a/test/test_ohClassPtn_appRibPtn.cpp b/test/test_ohClassPtn_appRibPtn.cpp index 00eb87ad..612df09b 100644 --- a/test/test_ohClassPtn_appRibPtn.cpp +++ b/test/test_ohClassPtn_appRibPtn.cpp @@ -52,7 +52,7 @@ int main(int argc, char** argv) const int rdvRanks = 2; const int appRanks = 2; - adios2::Params params{{"Streaming", "On"}, {"OpenTimeoutSecs", "2"}}; + adios2::Params params{{"Streaming", "On"}, {"OpenTimeoutSecs", "60"}}; auto channel = rdv.CreateAdiosChannel(name, params, redev::TransportType::BP4); auto commPair = channel.CreateComm(name,rdv.GetMPIComm()); diff --git a/test/test_ohOverlap.cpp b/test/test_ohOverlap.cpp index 595c0375..c44dd37a 100644 --- a/test/test_ohOverlap.cpp +++ b/test/test_ohOverlap.cpp @@ -69,12 +69,6 @@ redev::ClassPtn setupServerPartition(Omega_h::Mesh& mesh, std::string_view cpnFi return redev::ClassPtn(MPI_COMM_WORLD, ptn.ranks, ptn.modelEnts); } -auto setupComms(redev::Redev& rdv, std::string name) { - adios2::Params params{ {"Streaming", "On"}, {"OpenTimeoutSecs", "12"}}; - auto channel = rdv.CreateAdiosChannel(std::move(name),params,redev::TransportType::BP4); - return channel.CreateComm(std::string(name),rdv.GetMPIComm()); -} - Omega_h::HostRead markMeshOverlapRegion(Omega_h::Mesh& mesh) { auto isOverlap = markOverlapMeshEntities(mesh); return Omega_h::HostRead(isOverlap); @@ -117,7 +111,9 @@ int main(int argc, char** argv) { std::string_view cpnFileName(argv[3]); auto partition = setupServerPartition(mesh,cpnFileName); auto rdv = redev::Redev(MPI_COMM_WORLD,redev::Partition{partition},static_cast(isRdv)); - auto comm = setupComms(rdv,name); + adios2::Params params{ {"Streaming", "On"}, {"OpenTimeoutSecs", "60"}}; + auto channel = rdv.CreateAdiosChannel(std::string(name),params,redev::TransportType::BP4); + auto comm = channel.CreateComm(std::string(name),rdv.GetMPIComm()); auto isOverlap_h = markMeshOverlapRegion(mesh); ts::OutMsg appOut = ts::OutMsg(); //FIXME is this needed? //TODO - Document why rendezvous needs two permutations but the app does not @@ -128,7 +124,9 @@ int main(int argc, char** argv) { //the non-rendezvous app sends global vtx ids to rendezvous ////////////////////////////////////////////////////// auto start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,name + " rdvRead",rank); //We have received the first input message in the rendezvous //processes. Using the meta data of the incoming message we will: @@ -163,7 +161,9 @@ int main(int argc, char** argv) { } } start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data(),redev::Mode::Synchronous); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,name + " rdvWrite",rank); ////////////////////////////////////////////////////// //communication loop @@ -172,7 +172,9 @@ int main(int argc, char** argv) { if(!rank) fprintf(stderr, "isRdv %d iter %d\n", isRdv, iter); //receive from client auto start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,name + " rdvRead",rank); ts::checkAndAttachIds(mesh, "inVtxGids", msgsIn, rdvInPermute); //send to client @@ -183,14 +185,18 @@ int main(int argc, char** argv) { } } start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data(),redev::Mode::Synchronous); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,name + " rdvWrite",rank); } //end iter loop } else { /////////////////// CLIENT ///////////////////////// auto partition = setupClientPartition(mesh); auto rdv = redev::Redev(MPI_COMM_WORLD,redev::Partition{std::move(partition)},static_cast(isRdv)); - auto comm = setupComms(rdv,name); + adios2::Params params{ {"Streaming", "On"}, {"OpenTimeoutSecs", "60"}}; + auto channel = rdv.CreateAdiosChannel(std::string(name),params,redev::TransportType::BP4); + auto comm = channel.CreateComm(std::string(name),rdv.GetMPIComm()); auto isOverlap_h = markMeshOverlapRegion(mesh); ////////////////////////////////////////////////////// //the non-rendezvous app sends global vtx ids to rendezvous @@ -210,13 +216,17 @@ int main(int argc, char** argv) { } } auto start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data(),redev::Mode::Synchronous); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,name + " appWrite",rank); ////////////////////////////////////////////////////// //the rendezvous app sends global vtx ids to non-rendezvous ////////////////////////////////////////////////////// start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,name + " appRead",rank); clientCheckIncomingMessages(mesh,isOverlap_h,msgsIn,appOut); ////////////////////////////////////////////////////// @@ -232,11 +242,15 @@ int main(int argc, char** argv) { } } auto start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data(),redev::Mode::Synchronous); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,name + " appWrite",rank); //receive from server start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,name + " appRead",rank); clientCheckIncomingMessages(mesh,isOverlap_h,msgsIn,appOut); } //end iter loop diff --git a/test/test_proxy_coupling_xgc_client_fortran.f90 b/test/test_proxy_coupling_xgc_client_fortran.f90 index ecd18811..dbb03b54 100644 --- a/test/test_proxy_coupling_xgc_client_fortran.f90 +++ b/test/test_proxy_coupling_xgc_client_fortran.f90 @@ -33,7 +33,7 @@ Program main type(PcmsReverseClassificationHandle) :: reverse_classification type(PcmsFieldHandle), dimension(2) :: fields type(PcmsFieldAdapterHandle), dimension(2) :: adapters - character(len = 80), dimension(:), allocatable :: args + character(len = 200), dimension(:), allocatable :: args character(len = :), allocatable :: rc_file integer(C_LONG), allocatable, target :: data(:) integer(C_LONG), pointer :: data_pointer(:) @@ -57,7 +57,7 @@ Program main end do rc_file = trim(args(1)) - plane = mod(world_rank, plane) + plane = mod(world_rank, nplanes) call MPI_Comm_split(MPI_COMM_WORLD, plane, world_rank, plane_comm, ierror) call MPI_Comm_rank(plane_comm, plane_rank, ierror) call MPI_Comm_size(plane_comm, plane_size, ierror) diff --git a/test/test_twoClientOverlap.cpp b/test/test_twoClientOverlap.cpp index e4036572..77dc1ea2 100644 --- a/test/test_twoClientOverlap.cpp +++ b/test/test_twoClientOverlap.cpp @@ -69,14 +69,11 @@ redev::ClassPtn setupServerPartition(Omega_h::Mesh& mesh, std::string_view cpnFi return redev::ClassPtn(MPI_COMM_WORLD, ptn.ranks, ptn.modelEnts); } -auto setupComms(redev::Redev& rdv, std::string_view name, const int clientId) { +auto setupComms(redev::Redev& rdv, std::string clientName, const int clientId) { const bool isSST = false; - adios2::Params params{ {"Streaming", "On"}, {"OpenTimeoutSecs", "12"}}; + adios2::Params params{ {"Streaming", "On"}, {"OpenTimeoutSecs", "60"}}; REDEV_ALWAYS_ASSERT(clientId == 0 || clientId ==1); - std::stringstream clientName; - clientName << name << "Client" << clientId; - auto channel = rdv.CreateAdiosChannel(clientName.str(), params,static_cast(isSST) ); - return channel.CreateComm(clientName.str(), rdv.GetMPIComm()); + return rdv.CreateAdiosChannel(clientName, params,static_cast(isSST) ); } Omega_h::HostRead markMeshOverlapRegion(Omega_h::Mesh& mesh) { @@ -107,7 +104,10 @@ void client(Omega_h::Mesh& mesh, std::string fieldName, const int clientId) { auto partition = setupClientPartition(mesh); auto rdv = redev::Redev(MPI_COMM_WORLD,redev::Partition{std::move(partition)},static_cast(isRdv)); - auto comm = setupComms(rdv,fieldName,clientId); + std::stringstream clientName; + clientName << fieldName << "Client" << clientId; + auto channel = setupComms(rdv,clientName.str(),clientId); + auto comm = channel.CreateComm(clientName.str(), rdv.GetMPIComm()); auto isOverlap_h = markMeshOverlapRegion(mesh); ////////////////////////////////////////////////////// @@ -128,13 +128,17 @@ void client(Omega_h::Mesh& mesh, std::string fieldName, const int clientId) { } } auto start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data(),redev::Mode::Synchronous); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,fieldName + " appWrite",rank); ////////////////////////////////////////////////////// //the rendezvous app sends global vtx ids to non-rendezvous ////////////////////////////////////////////////////// start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,fieldName + " appRead",rank); clientCheckIncomingMessages(mesh,isOverlap_h,msgsIn,appOut); ////////////////////////////////////////////////////// @@ -150,11 +154,15 @@ void client(Omega_h::Mesh& mesh, std::string fieldName, const int clientId) { } } auto start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data(),redev::Mode::Synchronous); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,fieldName + " appWrite",rank); //receive from server start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,fieldName + " appRead",rank); clientCheckIncomingMessages(mesh,isOverlap_h,msgsIn,appOut); } //end iter loop @@ -166,13 +174,15 @@ struct ClientMetaData { ts::OutMsg outMsg; }; -void serverReceiveFromClient(ClientMetaData& clientMeta, +void serverReceiveFromClient(ClientMetaData& clientMeta, redev::Channel& channel, redev::BidirectionalComm& comm, Omega_h::Mesh& mesh, std::string_view fieldName, const int rank, const int clientId) { std::stringstream ss; ss << fieldName << " rdvRead clientId " << clientId; auto start = std::chrono::steady_clock::now(); + channel.BeginReceiveCommunicationPhase(); const auto msgsIn = comm.Recv(redev::Mode::Synchronous); + channel.EndReceiveCommunicationPhase(); ts::getAndPrintTime(start,ss.str(),rank); auto rdvIn = comm.GetInMessageLayout(); //setup outbound meta data @@ -192,7 +202,7 @@ void serverReceiveFromClient(ClientMetaData& clientMeta, ts::checkAndAttachIds(mesh, ss.str(), msgsIn, clientMeta.inPermute); } -void serverSendToClient(ClientMetaData& clientMeta, +void serverSendToClient(ClientMetaData& clientMeta, redev::Channel& channel, redev::BidirectionalComm& comm, Omega_h::Mesh& mesh, Omega_h::HostRead& isOverlap_h, std::string_view fieldName, const int rank, const int clientId) { @@ -209,7 +219,9 @@ void serverSendToClient(ClientMetaData& clientMeta, std::stringstream ss; ss << fieldName << " rdvWrite clientId " << clientId; auto start = std::chrono::steady_clock::now(); + channel.BeginSendCommunicationPhase(); comm.Send(msgs.data()); + channel.EndSendCommunicationPhase(); ts::getAndPrintTime(start,ss.str(),rank); } @@ -219,20 +231,28 @@ void server(Omega_h::Mesh& mesh, std::string fieldName, std::string_view cpnFile const auto rank = ohComm->rank(); auto partition = setupServerPartition(mesh,cpnFileName); auto rdv = redev::Redev(MPI_COMM_WORLD,std::move(partition),static_cast(isRdv)); - auto commClient0 = setupComms(rdv,fieldName,0); - auto commClient1 = setupComms(rdv,fieldName,1); + + std::stringstream clientName0; + clientName0 << fieldName << "Client0"; + std::stringstream clientName1; + clientName1 << fieldName << "Client1"; + auto channel0 = setupComms(rdv,clientName0.str(),0); + auto channel1 = setupComms(rdv,clientName1.str(),1); + + auto commClient0 = channel0.CreateComm(clientName0.str(), rdv.GetMPIComm()); + auto commClient1 = channel1.CreateComm(clientName1.str(), rdv.GetMPIComm()); auto isOverlap_h = markMeshOverlapRegion(mesh); //TODO - Document why rendezvous needs two permutations but the app does not ClientMetaData client0; ClientMetaData client1; - serverReceiveFromClient(client0,commClient0,mesh,fieldName,rank,0); - serverReceiveFromClient(client1,commClient1,mesh,fieldName,rank,1); + serverReceiveFromClient(client0,channel0,commClient0,mesh,fieldName,rank,0); + serverReceiveFromClient(client1,channel1,commClient1,mesh,fieldName,rank,1); ts::writeVtk(mesh,"rdvInGids",0); - serverSendToClient(client0,commClient0,mesh,isOverlap_h,fieldName,rank,0); - serverSendToClient(client1,commClient1,mesh,isOverlap_h,fieldName,rank,1); + serverSendToClient(client0,channel0,commClient0,mesh,isOverlap_h,fieldName,rank,0); + serverSendToClient(client1,channel1,commClient1,mesh,isOverlap_h,fieldName,rank,1); ////////////////////////////////////////////////////// //communication loop ////////////////////////////////////////////////////// @@ -249,8 +269,8 @@ void server(Omega_h::Mesh& mesh, std::string fieldName, std::string_view cpnFile ts::getAndPrintTime(start,fieldName + " rdvRead clientId 1",rank); ts::checkAndAttachIds(mesh, "inVtxGidsClient1", msgsIn1, client1.inPermute); //send to clients - serverSendToClient(client0,commClient0,mesh,isOverlap_h,fieldName,rank,0); - serverSendToClient(client1,commClient1,mesh,isOverlap_h,fieldName,rank,1); + serverSendToClient(client0,channel0,commClient0,mesh,isOverlap_h,fieldName,rank,0); + serverSendToClient(client1,channel1,commClient1,mesh,isOverlap_h,fieldName,rank,1); } //end iter loop } From 31c33611a7c21c5dd2f5d87d34e2e2830fb1aa98 Mon Sep 17 00:00:00 2001 From: Angelyr Date: Mon, 25 Nov 2024 10:38:22 -0800 Subject: [PATCH 09/15] doxygen, version --- .github/workflows/update_doxygen_page.yml | 49 + CMakeLists.txt | 2 +- Doxyfile | 2736 +++++++++++++++++++++ src/CMakeLists.txt | 7 + src/pcms/print.h | 35 + src/pcms/version.h.in | 11 + 6 files changed, 2839 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/update_doxygen_page.yml create mode 100644 Doxyfile create mode 100644 src/pcms/print.h create mode 100644 src/pcms/version.h.in diff --git a/.github/workflows/update_doxygen_page.yml b/.github/workflows/update_doxygen_page.yml new file mode 100644 index 00000000..4f7e780b --- /dev/null +++ b/.github/workflows/update_doxygen_page.yml @@ -0,0 +1,49 @@ +name: Update Doxygen Page + +on: + push: + # branches: + # - master + +jobs: + doxygen: + runs-on: ubuntu-latest + permissions: + contents: write + + steps: + + - name: Install Doxygen + run: | + sudo apt-add-repository universe + sudo apt-get update + sudo apt-get install doxygen + + - name: Checkout Original + uses: actions/checkout@v4 + with: + path: original + + - name: Run Doxygen + working-directory: original + run: doxygen + + - name: Checkout Pages + uses: actions/checkout@v4 + with: + path: pages + + - name: Set up pages directory + working-directory: pages + run: | + git checkout --orphan gh-pages + git rm -rf . + cp -r ../original/html/. . + - name: Update Github + working-directory: pages + run: | + git config user.name "GitHub Actions Bot" + git config user.email "<>" + git add . + git commit -m "Update page from action" + git push -f origin gh-pages \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index e2851ebc..740f66f8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.19) -project(pcms VERSION 0.0.5 LANGUAGES CXX) +project(pcms VERSION 0.0.6 LANGUAGES CXX) include(GNUInstallDirs) include(CMakePackageConfigHelpers) diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 00000000..5639d67c --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2736 @@ +# Doxyfile 1.9.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Pcms" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /