PanelClampLog.h

#pragma once
 
#include "PanelLoadTypes.h"
 
#include <atomic>
#include <fhsim/ISimObjectLogger.h>
#include <string>
 
namespace hydrodynamics
{
 
constexpr unsigned kReportedClampFlags = kPanelFlagSolidityClamped | kPanelFlagReynoldsClamped | kPanelFlagFlowNotFinite;
 
class PanelClampLog
{
public:
   void Note(unsigned flags) const
   {
      const unsigned relevant = flags & kReportedClampFlags;
      if (relevant != 0 && (m_seen.load(std::memory_order_relaxed) | relevant) != m_seen.load(std::memory_order_relaxed))
         m_seen.fetch_or(relevant, std::memory_order_relaxed);
   }
 
   void Report(ISimObjectLogger& logger, const std::string& name)
   {
      const unsigned fresh = m_seen.load(std::memory_order_relaxed) & ~m_reported;
      if (fresh & kPanelFlagSolidityClamped)
         logger.LogInfo(name + ": Warning: a panel's solidity was clamped into its load law's range, so its load is capped. Check KnotFactor and Solidity, and whether the mesh has closed up. Logged once per run.");
      if (fresh & kPanelFlagReynoldsClamped)
         logger.LogInfo(name + ": a panel's Reynolds number was clamped into its load law's fit range, so its drag coefficient is held at the bound. Logged once per run.");
      if (fresh & kPanelFlagFlowNotFinite)
         logger.LogInfo(name + ": Warning: a panel's relative water velocity was not finite, so its load was set to zero. The state is diverging; reduce the step size or check the inputs. Logged once per run.");
      m_reported |= fresh;
   }
 
private:
   mutable std::atomic<unsigned> m_seen {0}; 
   unsigned                      m_reported = 0; 
};
 
} // namespace hydrodynamics