dbpp_SweRhsAlgorithm.h

Go to the documentation of this file.

#pragma once
 
// C++ include
#include <string>
// SfxBase19 include
#include "include/Sfx_DefineTypes.h"
// 
#include "SimulationConfig.h"  //CalculFF ptr2F
#include "dbpp_SweRhsData.hpp"
 
// forward declarations
namespace Sfx { class StateVectorField; }
namespace dbpp { 
  class FluxAlgorithm;
  class PhysicalBoundaryCnd;
  class SrcNumericalTreatment;
  class FiniteVolumeDiscretization;
}
 
namespace dbpp 
{
  class SweRhsAlgorithm 
  {
  public:
    virtual ~SweRhsAlgorithm() = default;
    virtual SweRhsData<> calculate( const Sfx::StateVectorField& aU,
      const std::shared_ptr<FiniteVolumeDiscretization>& aGblDiscr) = 0;
    virtual SweRhsData<> calculate( const Sfx::StateVectorField& aU)= 0;
    virtual std::string name() const { return std::string{ "SweRhsAlgorithm" }; }
    virtual void setPhysicalBoundaryCnd( const PhysicalBoundaryCnd& aPhyBnd) = 0;
    virtual PhysicalBoundaryCnd getPhysicalBoundaryCnd() const = 0;
    virtual void setFluxAlgorithm( FluxAlgorithm* aFluxAlgo, 
      bool useIncompleteFlux=true) {}

    virtual void setPtr2FuncAlgo(CalculFF aPtr2Func) {}
    virtual void setSourceTermDiscr( SrcNumericalTreatment* aSrcTreatmnt,
      bool useManningFormula=true) {}

    virtual void setPressureTermDiscr() {}
    virtual bool useReconstruction() const noexcept { return false; }
    virtual bool useSourceTerms()    const noexcept { return true;  }
    virtual bool usePressureTerm()   const noexcept { return false; }
    virtual bool useManningFormula() const noexcept { return true;  }
    virtual bool useIncompleteFlux() const noexcept { return true;  }
    virtual bool isFrictionLess()    const noexcept { return true;  }
    virtual bool usePtr2FuncLegacy() const noexcept { return false; }
 
  protected:
    SweRhsAlgorithm& operator= (const SweRhsAlgorithm&) = delete;
    SweRhsAlgorithm& operator= (      SweRhsAlgorithm&&) = delete;
  };
} // End of namespace