ModelEvaluator.hpp

Go to the documentation of this file.

#pragma once
 
// NOTE: ModelEvaluator is a concrete advection-diffusion test physics model.
// It does not belong in the physics-agnostic CFV module, but is kept here for
// now because the Python bindings (CFV.ModelEvaluator) and test code depend on
// its current location. A future refactoring phase should move it to src/Model/
// and decouple the pybind11 registration from cfv_pybind11.cpp.
 
#include <nlohmann/json.hpp>
#include <utility>
 
#include "DNDS/Defines.hpp"
#include "DNDS/Config/ConfigParam.hpp"
#include "VariationalReconstruction.hpp"
 
namespace DNDS::CFV
{
    struct ModelSettings
    {
        real ax = 1.0;
        real ay = 0.0;
        real sigma = 0.0;
 
        DNDS_DECLARE_CONFIG(ModelSettings)
        {
            // clang-format off
            DNDS_FIELD(ax,    "Advection velocity x-component");
            DNDS_FIELD(ay,    "Advection velocity y-component");
            DNDS_FIELD(sigma, "Diffusion coefficient",
                       DNDS::Config::range(0.0));
            // clang-format on
        }
    };
 
    class ModelEvaluator
    {
    public:
        static const int nVarsFixed = DynamicSize;
        static const int dim = 2;
        using tvfv = CFV::VariationalReconstruction<dim>;
 
    private:
        ssp<Geom::UnstructuredMesh> mesh;
        ssp<tvfv> vfv;
        ModelSettings settings;
 
        tUGrad<nVarsFixed, dim> uGradBuf;
 
    public:
        using TVec = Eigen::Matrix<real, dim, 1>;
        using TMat = Eigen::Matrix<real, dim, dim>;
        using TU = Eigen::Matrix<real, nVarsFixed, 1>;
        using TDiffU = Eigen::Matrix<real, dim, nVarsFixed>;
        using Tvfv_FBoundary = typename tvfv::TFBoundary<nVarsFixed>;
 
        ModelEvaluator(decltype(mesh) mesh_, decltype(vfv) vfv_,
                       const ModelSettings &settings_, int nVars)
            : mesh(std::move(mesh_)), vfv(std::move(vfv_)), settings(settings_)
        {
            vfv->BuildUGrad(uGradBuf, nVars);
        }
 
        ModelSettings &get_settings() { return settings; }
 
        Tvfv_FBoundary get_FBoundary(real t)
        {
 
            return [this, t](const auto &u, const auto &uMean, index iCell, index iFace, int iG,
                             const Geom::tPoint &norm, const Geom::tPoint &pPhy, Geom::t_index fType)
            {
                static const auto Seq012 = Eigen::seq(Eigen::fix<0>, Eigen::fix<dim - 1>);
                TU uF = u;
                TVec normV = norm(Seq012);
                return generateBoundaryValue(
                    uF, uMean,
                    iCell, iFace, iG,
                    normV, Geom::NormBuildLocalBaseV<dim>(normV),
                    pPhy,
                    t, fType, false, 1);
            };
        }
 
        TU generateBoundaryValue(TU &ULxy, //! warning, possible that UL is also modified
                                 const TU &ULMeanXy,
                                 index iCell, index iFace, int iG,
                                 const TVec &uNorm,
                                 const TMat &normBase,
                                 const Geom::tPoint &pPhysics,
                                 real t,
                                 Geom::t_index btype,
                                 bool fixUL = false,
                                 int geomMode = 0,
                                 int linMode = 0)
        {
            TU ret;
            ret.resizeLike(ULxy);
            ret.setZero();
            return ret;
        }
 
        struct EvaluateRHSOptions
        {
            bool direct2ndRec = false;
            bool direct2ndRec1stConv = false;
            EvaluateRHSOptions() {}
        };
 
        void EvaluateRHS(tUDof<nVarsFixed> &rhs, tUDof<nVarsFixed> &u, tURec<nVarsFixed> &uRec, real t,
                         const EvaluateRHSOptions &options = EvaluateRHSOptions{});
 
        void DoReconstructionIter(tURec<nVarsFixed> &uRec,
                                  tURec<nVarsFixed> &uRecNew,
                                  tUDof<nVarsFixed> &u,
                                  real t,
                                  bool putIntoNew = false,
                                  bool recordInc = false,
                                  bool uRecIsZero = false)
        {
            vfv->DoReconstructionIter<nVarsFixed>(uRec, uRecNew, u,
                                                  get_FBoundary(t),
                                                  putIntoNew, recordInc, uRecIsZero);
        }
    };
}