Sfx_DamBreakInitialCnd.h

Go to the documentation of this file.

 
#pragma once
 
// BaseNumTypes includes
#include "Sfx/Sfx_StateVectorField.h"
// App includes
#include "Sfx_DamBreakData.h"
#include "include/Sfx_WaveFunc.h"
 
namespace Sfx 
{
  class DamBreakInitialCnd
  {
    using wavfuncptr = std::shared_ptr<Sfx::WaveFunc>;
  public:
    DamBreakInitialCnd(const DamBreakData& aDbData);    
    ~DamBreakInitialCnd();
    DamBreakInitialCnd(const DamBreakInitialCnd& aOther);
    DamBreakInitialCnd& operator= (const DamBreakInitialCnd& aOther);
    DamBreakInitialCnd( DamBreakInitialCnd&& aOther) noexcept;
    DamBreakInitialCnd& operator= ( DamBreakInitialCnd&& aOther) noexcept;
    // Default ctor (dam break problem type condition)
    // The only one supported for now
    void setIC( DamBreakData aData);
    bool isUsingFlatBed()     const noexcept { return m_dbData.isFlatBed();          }
    bool isFrictionLess()     const noexcept { return m_dbData.isFrictionLess();     }
    bool isSectionUnitWidth() const noexcept { return m_dbData.isUnitSectionWidth(); }
    void save2File() {/*Not implemented yet*/}
    std::vector<float64> xcoordVector() const
    {
      return std::vector<float64>{&X[0], &X[0] + NbSections};
    }

    std::vector<float64> ncoefVector() const
    {
      return std::vector<float64>{&n[0], &n[0] + NbSections};
    }

    std::vector<float64> zbathyVector() const
    {
      return std::vector<float64>{&Z[0], &Z[0] + NbSections};
    }
    // See Scott Meyers items "Facilitate the Returns Value Optimization" 
    // Actually the function below should return a const object
    // By returning the vector ctor, we avoid temporary object 
    // New compiler construct the object returned inside the memory of left side
    // vector vec = XCoord();  copy elison is mandatory C++17
    std::vector<float64> Xcoord()   const noexcept { return std::vector<float64>(&X[0], &X[0] + NbSections); }
    std::vector<float64> Zvalues()  const { return std::vector<float64>(&Z[0], &Z[0] + NbSections); }
    std::vector<float64> U1values() const { return std::vector<float64>(&U1[0], &U1[0] + NbSections); }
    std::vector<float64> U2values() const { return std::vector<float64>(&U2[0], &U2[0] + NbSections); }
    std::vector<float64> Hvalues()  const { return std::vector<float64>(&H[0], &H[0] + NbSections); }
    std::vector<float64> nValues()  const { return std::vector<float64>(&n[0], &n[0] + NbSections); }
    void setManningCoefficients( const std::vector<float64>& aNvec);
    void setBathyValues( const std::vector<float64>& aNvec);
    Sfx::StateVectorField setIC(); // temporary fix, shall return
    template<typename T, typename CONT = std::vector<T>>
    void setIC( CONT aContOfObj) 
    {
      /*Not implemented yet*/
      std::add_lvalue_reference<CONT>; // not sure about this one
    }

    std::unique_ptr<scalarField1D> setH();
    DamBreakData::eDataTypes getICtype() const { return DamBreakData::eDataTypes::emcneil; }
  private:
    DamBreakData m_dbData;  
    bool m_flatBed{true};    
    bool m_frictionLess{ true }; 
    bool m_sectionUnit{ true };     
    wavfuncptr m_z;   
    wavfuncptr m_h; // Water depth profile
    float64* U1; 
    float64* U2; 
    float64* X; 
    float64* H; 
    float64* h; 
    float64 *Z, *n; 
    int32 NbSections; 
    float64 B; 
    float64 dx; 
    float64 m_shockLocation; 
    float64 S0am; 
    float64 S0av; 
    void initMcNeil1D();
    void freeDiscrParams();
    void allocateDiscrParams();
  };
} // End of namespace