Remove last else-cases in FF and CHT (#197)

Fixes a bug that is not allowing more than one module at the same time and adds an error message for the case when a dataset is not known by any or too many modules. Co-authored-by: Gerasimos Chourdakis <[email protected]> Co-authored-by: David Schneider <[email protected]>
precice · Dec 3, 2021 · 49b6267 · 49b6267
1 parent 88be6ae
commit 49b6267
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 32 deletions.
diff --git a/Adapter.C b/Adapter.C
@@ -259,22 +259,37 @@ void preciceAdapter::Adapter::configure()
             {
                 std::string dataName = interfacesConfig_.at(i).writeData.at(j);
 
+                unsigned int inModules = 0;
+
                 // Add CHT-related coupling data writers
-                if (CHTenabled_)
+                if (CHTenabled_ && CHT_->addWriters(dataName, interface))
                 {
-                    CHT_->addWriters(dataName, interface);
+                    inModules++;
                 }
 
                 // Add FSI-related coupling data writers
-                if (FSIenabled_)
+                if (FSIenabled_ && FSI_->addWriters(dataName, interface))
                 {
-                    FSI_->addWriters(dataName, interface);
+                    inModules++;
                 }
 
                 // Add FF-related coupling data writers
-                if (FFenabled_)
+                if (FFenabled_ && FF_->addWriters(dataName, interface))
                 {
-                    FF_->addWriters(dataName, interface);
+                    inModules++;
+                }
+
+                if (inModules == 0)
+                {
+                    adapterInfo("I don't know how to write \"" + dataName
+                                    + "\". Maybe this is a typo or maybe you need to enable some adapter module?",
+                                "error-deferred");
+                }
+                else if (inModules > 1)
+                {
+                    adapterInfo("It looks like more than one modules can write \"" + dataName
+                                    + "\" and I don't know how to choose. Try disabling one of the modules.",
+                                "error-deferred");
                 }
 
                 // NOTE: Add any coupling data writers for your module here.
@@ -285,22 +300,28 @@ void preciceAdapter::Adapter::configure()
             {
                 std::string dataName = interfacesConfig_.at(i).readData.at(j);
 
+                unsigned int inModules = 0;
+
                 // Add CHT-related coupling data readers
-                if (CHTenabled_)
-                {
-                    CHT_->addReaders(dataName, interface);
-                }
+                if (CHTenabled_ && CHT_->addReaders(dataName, interface)) inModules++;
 
                 // Add FSI-related coupling data readers
-                if (FSIenabled_)
-                {
-                    FSI_->addReaders(dataName, interface);
-                }
+                if (FSIenabled_ && FSI_->addReaders(dataName, interface)) inModules++;
 
                 // Add FF-related coupling data readers
-                if (FFenabled_)
+                if (FFenabled_ && FF_->addReaders(dataName, interface)) inModules++;
+
+                if (inModules == 0)
+                {
+                    adapterInfo("I don't know how to read \"" + dataName
+                                    + "\". Maybe this is a typo or maybe you need to enable some adapter module?",
+                                "error-deferred");
+                }
+                else if (inModules > 1)
                 {
-                    FF_->addReaders(dataName, interface);
+                    adapterInfo("It looks like more than one modules can read \"" + dataName
+                                    + "\" and I don't know how to choose. Try disabling one of the modules.",
+                                "error-deferred");
                 }
 
                 // NOTE: Add any coupling data readers for your module here.

diff --git a/CHT/CHT.C b/CHT/CHT.C
@@ -118,8 +118,10 @@ std::string preciceAdapter::CHT::ConjugateHeatTransfer::determineSolverType()
     return solverType;
 }
 
-void preciceAdapter::CHT::ConjugateHeatTransfer::addWriters(std::string dataName, Interface* interface)
+bool preciceAdapter::CHT::ConjugateHeatTransfer::addWriters(std::string dataName, Interface* interface)
 {
+    bool found = true; // Set to false later, if needed.
+
     if (dataName.find("Sink-Temperature") == 0)
     {
         interface->addCouplingDataWriter(
@@ -194,18 +196,22 @@ void preciceAdapter::CHT::ConjugateHeatTransfer::addWriters(std::string dataName
     }
     else
     {
-        adapterInfo("Unknown data type - cannot add " + dataName + ".", "error");
+        found = false;
     }
 
     // NOTE: If you want to couple another variable, you need
     // to add your new coupling data user as a coupling data
     // writer here (and as a reader below).
     // The argument of the dataName.compare() needs to match
     // the one provided in the adapter's configuration file.
+
+    return found;
 }
 
-void preciceAdapter::CHT::ConjugateHeatTransfer::addReaders(std::string dataName, Interface* interface)
+bool preciceAdapter::CHT::ConjugateHeatTransfer::addReaders(std::string dataName, Interface* interface)
 {
+    bool found = true; // Set to false later, if needed.
+
     if (dataName.find("Sink-Temperature") == 0)
     {
         interface->addCouplingDataReader(
@@ -280,12 +286,14 @@ void preciceAdapter::CHT::ConjugateHeatTransfer::addReaders(std::string dataName
     }
     else
     {
-        adapterInfo("Unknown data type - cannot add " + dataName + ".", "error");
+        found = false;
     }
 
     // NOTE: If you want to couple another variable, you need
     // to add your new coupling data user as a coupling data
     // reader here (and as a writer above).
     // The argument of the dataName.compare() needs to match
     // the one provided in the adapter's configuration file.
+
+    return found;
 }
diff --git a/CHT/CHT.H b/CHT/CHT.H
@@ -60,10 +60,10 @@ public:
     bool configure(const IOdictionary& adapterConfig);
 
     //- Add coupling data writers
-    void addWriters(std::string dataName, Interface* interface);
+    bool addWriters(std::string dataName, Interface* interface);
 
     //- Add coupling data readers
-    void addReaders(std::string dataName, Interface* interface);
+    bool addReaders(std::string dataName, Interface* interface);
 };
 
 }

diff --git a/FF/FF.C b/FF/FF.C
@@ -97,8 +97,10 @@ std::string preciceAdapter::FF::FluidFluid::determineSolverType()
     return solverType;
 }
 
-void preciceAdapter::FF::FluidFluid::addWriters(std::string dataName, Interface* interface)
+bool preciceAdapter::FF::FluidFluid::addWriters(std::string dataName, Interface* interface)
 {
+    bool found = true; // Set to false later, if needed.
+
     if (dataName.find("VelocityGradient") == 0)
     {
         interface->addCouplingDataWriter(
@@ -129,18 +131,22 @@ void preciceAdapter::FF::FluidFluid::addWriters(std::string dataName, Interface*
     }
     else
     {
-        adapterInfo("Unknown data type - cannot add " + dataName + ".", "error");
+        found = false;
     }
 
     // NOTE: If you want to couple another variable, you need
     // to add your new coupling data user as a coupling data
     // writer here (and as a reader below).
     // The argument of the dataName.compare() needs to match
     // the one provided in the adapter's configuration file.
+
+    return found;
 }
 
-void preciceAdapter::FF::FluidFluid::addReaders(std::string dataName, Interface* interface)
+bool preciceAdapter::FF::FluidFluid::addReaders(std::string dataName, Interface* interface)
 {
+    bool found = true; // Set to false later, if needed.
+
     if (dataName.find("VelocityGradient") == 0)
     {
         interface->addCouplingDataReader(
@@ -171,12 +177,14 @@ void preciceAdapter::FF::FluidFluid::addReaders(std::string dataName, Interface*
     }
     else
     {
-        adapterInfo("Unknown data type - cannot add " + dataName + ".", "error");
+        found = false;
     }
 
     // NOTE: If you want to couple another variable, you need
     // to add your new coupling data user as a coupling data
     // reader here (and as a writer above).
     // The argument of the dataName.compare() needs to match
     // the one provided in the adapter's configuration file.
+
+    return found;
 }
diff --git a/FF/FF.H b/FF/FF.H
@@ -47,10 +47,10 @@ public:
     bool configure(const IOdictionary& adapterConfig);
 
     //- Add coupling data writers
-    void addWriters(std::string dataName, Interface* interface);
+    bool addWriters(std::string dataName, Interface* interface);
 
     //- Add coupling data readers
-    void addReaders(std::string dataName, Interface* interface);
+    bool addReaders(std::string dataName, Interface* interface);
 };
 
 }

diff --git a/FSI/FSI.C b/FSI/FSI.C
@@ -109,8 +109,10 @@ std::string preciceAdapter::FSI::FluidStructureInteraction::determineSolverType(
 }
 
 
-void preciceAdapter::FSI::FluidStructureInteraction::addWriters(std::string dataName, Interface* interface)
+bool preciceAdapter::FSI::FluidStructureInteraction::addWriters(std::string dataName, Interface* interface)
 {
+    bool found = true; // Set to false later, if needed.
+
     if (dataName.find("Force") == 0)
     {
         interface->addCouplingDataWriter(
@@ -141,16 +143,24 @@ void preciceAdapter::FSI::FluidStructureInteraction::addWriters(std::string data
         );
         DEBUG(adapterInfo("Added writer: Stress."));
     }
+    else
+    {
+        found = false;
+    }
 
     // NOTE: If you want to couple another variable, you need
     // to add your new coupling data user as a coupling data
     // writer here (and as a reader below).
     // The argument of the dataName.compare() needs to match
     // the one provided in the adapter's configuration file.
+
+    return found;
 }
 
-void preciceAdapter::FSI::FluidStructureInteraction::addReaders(std::string dataName, Interface* interface)
+bool preciceAdapter::FSI::FluidStructureInteraction::addReaders(std::string dataName, Interface* interface)
 {
+    bool found = true; // Set to false later, if needed.
+
     if (dataName.find("Force") == 0)
     {
         interface->addCouplingDataReader(
@@ -181,10 +191,16 @@ void preciceAdapter::FSI::FluidStructureInteraction::addReaders(std::string data
         );
         DEBUG(adapterInfo("Added reader: Stress."));
     }
+    else
+    {
+        found = false;
+    }
 
     // NOTE: If you want to couple another variable, you need
     // to add your new coupling data user as a coupling data
     // writer here (and as a writer above).
     // The argument of the dataName.compare() needs to match
     // the one provided in the adapter's configuration file.
+
+    return found;
 }
diff --git a/FSI/FSI.H b/FSI/FSI.H
@@ -56,10 +56,10 @@ public:
     bool configure(const IOdictionary& adapterConfig);
 
     //- Add coupling data writers
-    void addWriters(std::string dataName, Interface* interface);
+    bool addWriters(std::string dataName, Interface* interface);
 
     //- Add coupling data readers
-    void addReaders(std::string dataName, Interface* interface);
+    bool addReaders(std::string dataName, Interface* interface);
 };
 
 }

diff --git a/changelog-entries/197.md b/changelog-entries/197.md
@@ -0,0 +1 @@
+- Fixed a bug that was not allowing more than one module at the same time and added an error message for the case when a dataset is not known by any or too many modules. [#197](https://github.com/precice/openfoam-adapter/pull/197)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		- Fixed a bug that was not allowing more than one module at the same time and added an error message for the case when a dataset is not known by any or too many modules. [#197](https://github.com/precice/openfoam-adapter/pull/197)