dbpp_SrcNumericalTreatment.h

Go to the documentation of this file.

#pragma once
 
//C++ includes
#include <ranges>
// C++ include
#include <valarray>
 
namespace Sfx { 
  class scalarField1D; 
  class StateVectorField;
}
namespace dbpp { 
  class ListSectionsFlow; 
  class PhysicalBoundaryCnd;
}
 
// DESIGN NOTE: under construction (base class should be abstract)
//  Need to do some refactoring and clean-up 
namespace dbpp 
{
  class SrcNumericalTreatment 
  {
  public:
    enum class eDerivativeType 
    {
      centered_2nd, 
      noncentered   
    };

    enum class eDerivativeBCType
    {
      periodic,     
      noncentered   
    };
    //enum class eSfSbAlgo {
    //  // ????
    //};
  public:
    virtual std::valarray<double> TraitementTermeSource0( const Sfx::scalarField1D& aA,
      const ListSectionsFlow* aListSectF, const PhysicalBoundaryCnd& aBC);
    virtual std::valarray<double> TraitementTermeSource2( const Sfx::StateVectorField& aStateVec,
      const ListSectionsFlow& aListSectF, const PhysicalBoundaryCnd& aBC);
    void setManningRoughnessCoeff(float64 aN) noexcept { m_roughns = aN; }
    float64 getManningRoughnessCoeff() const noexcept { return m_roughns; }
    void setHAverage( bool useHavrg) noexcept { m_useHavrg = useHavrg; }
    void setSfSbNumericalTreatment( std::string aSfSbTreamnent = "Nujic(1995)") noexcept { m_sfsb = aSfSbTreamnent; }
    void setHderivativeType( const eDerivativeType& aDxType) noexcept { m_dxType = aDxType; }
    void setSpatialDerivativeOrder( uint32 aDxOrdr) noexcept { m_dxOrder = aDxOrdr; } //bottom term d_xZ
    // getters
    virtual std::string getSfSbNumericalTreatment() const noexcept { return m_sfsb; }
    const eDerivativeType& getHderivativeType() const noexcept { return m_dxType; }
    uint32 getSpatialDerivativeOrder() const noexcept { return m_dxOrder; } //bottom term d_xZ
    virtual bool useFriction() const noexcept { return false; }
    virtual bool isUnitWidth() const noexcept { return true; }
    virtual bool useManningFormula() const noexcept { return true; }
  protected:
    SrcNumericalTreatment& operator= (const SrcNumericalTreatment&) = delete;
    SrcNumericalTreatment& operator= ( SrcNumericalTreatment&&) = delete;
 
  private:
    uint32 m_dxOrder{2};                                      
    float64 m_roughns{ 0. };                                  
    bool m_useHavrg{true};                                    
    std::string m_sfsb{ "Nujic(1995)" };                      
    eDerivativeType m_dxType{ eDerivativeType::centered_2nd}; 
 //   ManningFormula m_Nformula{0.};                          /**< Manning formula */
  };
} // End of namespace