Integrator.H

Go to the documentation of this file.

//
// Pure abstract class for managing data structures, time integration (with substepping),
// mesh refinement, and I/O. 
//
// Native input file parameters:
//
// .. code-block:: make
//
//     max_step  = [maximum number of timesteps]
//     stop_time = [maximum simulation time]
//     timestep  = [time step for coarsest level]
//
//     amr.regrid_int = [number of timesteps between regridding]
//     amr.plot_int   = [number of timesteps between dumping output]
//     amr.plot_file  = [base name of output directory]
//     
//     amr.nsubsteps  = [number of temporal substeps at each level. This can be
//                       either a single int (which is then applied to every refinement
//                       level) or an array of ints (equal to amr.max_level) 
//                       corresponding to the refinement for each level.]
//
// Inherited input file parameters (from amrex AmrMesh class):
//
// .. code-block:: make
//
//     amr.v                  = [verbosity level]
//     amr.max_level          = [maximum level of refinement]
//     amr.n_proper           = 
//     amr.grid_eff           = 
//     amr.n_error_buff       = 
//     amr.ref_ratio_vect     = [refinement ratios in each direction]
//     amr.ref_ratio          = [refinement ratio in all directions (cannot be used with ref_ratio_vect)]
//     amr.max_grid_x         = 
//     amr.blocking_factor    =
//     amr.n_cell             = [number of cells on coarsest level]
//     amr.refine_grid_layout = 
//     amr.check_input        = 
//
 
#ifndef INTEGRATOR_INTEGRATOR_H
#define INTEGRATOR_INTEGRATOR_H
 
#include <chrono>
#include <ctime>
#include <string>
#include <limits>
#include <memory>
 
#ifdef _OPENMP
#include <omp.h>
#endif
 
#include <AMReX_ParallelDescriptor.H>
#include <AMReX_ParmParse.H>
#include <AMReX_MultiFabUtil.H>
#include <AMReX_FillPatchUtil.H>
#include <AMReX_BC_TYPES.H>
#include <AMReX_AmrCore.H>
#include <AMReX_FluxRegister.H>
#include <AMReX_Utility.H>
#include <AMReX_PlotFileUtil.H>
 
#include "Set/Set.H"
#include "BC/BC.H"
#include "BC/Nothing.H"
#include "IO/WriteMetaData.H"
#include "BaseField.H"
 
/// \brief Collection of numerical integrator objects
namespace Integrator
{
 
class Integrator
    : public amrex::AmrCore
{
public:
 
    /// \function Integrator
    /// \brief Constructor
    ///
    /// Does the following things:
    ///    - Read in simulation TIME(STEP) information
    ///    - Read in simulation output and AMR information
    ///    - Initalize timestep substep information
    ///    - Create a clean directory
    /// For derived classes this **must** be called for the derived constructor. For instance: `code`
    /// ```cpp
    /// class MyDerivedClass : Integrator
    /// {
    ///    MyDerivedClass() : Integrator() { ... }
    ///    ...
    /// }
    /// ```
    Integrator();
 
    virtual ~Integrator();
 
    /// \fn    FrontData
    /// \brief Front-end method to initialize simulation
    void InitData();
 
    void Restart(std::string restartfile, bool a_node = false);
 
    /// \fn    Evolve
    /// \brief Front-end method to start simulation
    void Evolve();
 
    void SetFilename(std::string _plot_file) { plot_file = _plot_file; };
    std::string GetFilename() { return plot_file; };
 
    void regrid(int lbase, Set::Scalar time, bool initial = false) override
    {
        if (!explicitmesh.on)
            AmrCore::regrid(lbase, time, initial);
    }
 
    void InitFromScratch(Set::Scalar time)
    {
        if (!explicitmesh.on) AmrCore::InitFromScratch(time);
        else
        {
            // Generate the coarse level mesh.
            {
                finest_level = 0;
                const amrex::BoxArray& ba = MakeBaseGrids();
                amrex::DistributionMapping dm(ba);
                const auto old_num_setdm = num_setdm;
                const auto old_num_setba = num_setba;
                MakeNewLevelFromScratch(0, time, ba, dm);
                if (old_num_setba == num_setba) SetBoxArray(0, ba);
                if (old_num_setdm == num_setdm) SetDistributionMap(0, dm);
            }
            // Generate subsequent level meshes based on user input
            for (int ilev = 0; ilev < maxLevel(); ++ilev)
            {
                finest_level = ilev + 1;
                amrex::BoxArray grids(explicitmesh.box[ilev]);
                ChopGrids(ilev + 1, grids, amrex::ParallelDescriptor::NProcs());
                amrex::DistributionMapping dmap(grids);
                SetBoxArray(ilev + 1, grids);
                SetDistributionMap(ilev + 1, dmap);
                MakeNewLevelFromScratch(ilev + 1, time, grids, dmap);
            }
 
        }
    }
 
protected:
 
    /// \fn    Initialize
    /// \brief Apply initial conditions
    ///
    /// You **must** override this function to inherit this class.
    /// This function is called before the simulation begins, and is where
    /// initial conditions should be applied.
    virtual void Initialize(int lev ///<[in] AMR Level
    ) = 0;
 
    /// \fn    Advance
    /// \brief Perform computation
    ///
    /// You **must** override this function to inherit this class.
    /// Advance is called every time(sub)step, and implements the evolution of 
    /// the system in time.
    /// 
    virtual void Advance(int lev,          ///<[in] AMR Level
        amrex::Real time, ///< [in] System time
        amrex::Real dt    ///< [in] Timestep for this level
    ) = 0;
 
    /// \fn    TagCellsForRefinement
    /// \brief Tag cells where mesh refinement is needed
    ///
    /// You **must** override this function to inherit this class.
    /// Advance is called every time(sub)step, and implements the evolution of 
    /// the system in time.
    /// 
    virtual void TagCellsForRefinement(int lev, amrex::TagBoxArray& tags, amrex::Real time,
        int ngrow) = 0;
 
    /// \fn    TimeStepBegin
    /// \brief Run another system calculation (e.g. implicit solve) before integration step
    ///
    /// This function is called at the beginning of every timestep. This function can be used
    /// to complete additional global solves, e.g. a MLMG implicit solve.
    ///
    /// Overriding is optional; the default is to do nothing.
    ///
    virtual void TimeStepBegin(Set::Scalar /*time*/, int /*iter*/) {};
 
    /// \fn    TimeStepComplete
    /// \brief Run another system calculation (e.g. implicit solve) after integration step
    ///
    /// This function is called at the end of every timestep. This function can be used
    /// to complete additional global solves, e.g. a MLMG implicit solve.
    ///
    /// Overriding is optional; the default is to do nothing.
    ///
    virtual void TimeStepComplete(Set::Scalar /*time*/, int /*iter*/) {};
 
    /// \fn    Integrate
    /// \brief Perform an integration to compute integrated quantities
    ///
    /// This is a function that is called by `Integrator` to update the variables registered in
    /// RegisterIntegratedVariable.
    /// The following variables are used:
    ///   -  amrlev: current amr level
    ///   -  time: current simulation time
    ///   -  iter: current simulation iteration
    ///   -  mfi:  current MFIter object (used to get FArrayBox from MultiFab)
    ///   -  box:  Use this box (not mfi.tilebox). This box covers only cells on this level that are
    ///            not also on a finer level.
    virtual void Integrate(int /*amrlev*/, Set::Scalar /*time*/, int /*iter*/,
        const amrex::MFIter&/*mfi*/, const amrex::Box&/*box*/)
    {
        if (thermo.number > 0)
            Util::Warning(INFO, "integrated variables registered, but no integration implemented!");
    }
 
    virtual void Regrid(int /* amrlev */, Set::Scalar /* time */)
    {}
 
 
 
 
    /// \fn    RegisterNewFab
    /// \brief Register a field variable for AMR with this class 
    void RegisterNewFab(Set::Field<Set::Scalar>& new_fab, BC::BC<Set::Scalar>* new_bc, int ncomp, int nghost, std::string name, bool writeout);
    void RegisterNewFab(Set::Field<Set::Scalar>& new_fab, int ncomp, std::string name, bool writeout);
    void RegisterNodalFab(Set::Field<Set::Scalar>& new_fab, int ncomp, int nghost, std::string name, bool writeout);
    void RegisterNodalFab(Set::Field<Set::Scalar>& new_fab, BC::BC<Set::Scalar>* new_bc, int ncomp, int nghost, std::string name, bool writeout);
    template<class T>
    void RegisterGeneralFab(Set::Field<T>& new_fab, int ncomp, int nghost, bool evolving = true);
    template<class T>
    void RegisterGeneralFab(Set::Field<T>& new_fab, int ncomp, int nghost, std::string a_name, bool evolving = true);
    template<class T>
    void RegisterGeneralFab(Set::Field<T>& new_fab, int ncomp, int nghost, bool writeout, std::string a_name, bool evolving = true);
 
    template<class T, int d>
    void AddField(Set::Field<T>& new_field, BC::BC<T>* new_bc, int ncomp, int nghost, std::string, bool writeout, bool evolving);
 
    void SetFinestLevel(const int a_finestlevel)
    {
        for (unsigned int i = 0; i < cell.fab_array.size(); i++)
            cell.fab_array[i]->finest_level = a_finestlevel;
        for (unsigned int i = 0; i < node.fab_array.size(); i++)
            node.fab_array[i]->finest_level = a_finestlevel;
        for (unsigned int i = 0; i < m_basefields_cell.size(); i++)
            m_basefields_cell[i]->SetFinestLevel(finest_level);
        for (unsigned int i = 0; i < m_basefields.size(); i++)
            m_basefields[i]->SetFinestLevel(finest_level);
    }
 
    void RegisterIntegratedVariable(Set::Scalar* integrated_variable, std::string name, bool extensive=true);
 
    void SetTimestep(Set::Scalar _timestep);
    void SetPlotInt(int plot_int);
    void SetThermoInt(int a_thermo_int) { thermo.interval = a_thermo_int; }
    void SetThermoPlotInt(int a_thermo_plot_int) { thermo.plot_int = a_thermo_plot_int; }
    void SetStopTime(Set::Scalar a_stop_time) { stop_time = a_stop_time; }
 
    amrex::Vector<amrex::Real> t_new;         ///< Keep track of current old simulation time on each level
    amrex::Vector<int> istep;           ///< Keep track of where each level is
    // PLOT FILES
    std::string plot_file{ "plt" };   ///< Plotfile name
 
private:
    virtual void MakeNewLevelFromScratch(int lev, amrex::Real time, const amrex::BoxArray& ba,
        const amrex::DistributionMapping& dm) override;
    virtual void MakeNewLevelFromCoarse(int lev, amrex::Real time, const amrex::BoxArray& ba,
        const amrex::DistributionMapping& dm) override;
    virtual void RemakeLevel(int lev, amrex::Real time, const amrex::BoxArray& ba,
        const amrex::DistributionMapping& dm) override;
    virtual void ClearLevel(int lev) override;
    virtual void ErrorEst(int lev, amrex::TagBoxArray& tags, amrex::Real time, int ngrow) override;
 
 
    void FillPatch(int lev, amrex::Real time,
        amrex::Vector<std::unique_ptr<amrex::MultiFab>>& source_mf,
        amrex::MultiFab& destination_multifab,
        BC::BC<Set::Scalar>& physbc,
        int icomp);
    long CountCells(int lev);
    void TimeStep(int lev, amrex::Real time, int iteration);
    void FillCoarsePatch(int lev, amrex::Real time, Set::Field<Set::Scalar>& mf, BC::BC<Set::Scalar>& physbc, int icomp, int ncomp);
    void GetData(const int lev, const amrex::Real time, amrex::Vector<amrex::MultiFab*>& data, amrex::Vector<amrex::Real>& datatime);
 
    std::vector<std::string> PlotFileName(int lev, std::string prefix = "") const;
protected:
    void IntegrateVariables(Set::Scalar cur_time, int step);
    void WritePlotFile(bool initial = false) const;
    void WritePlotFile(std::string prefix, Set::Scalar time, int step) const;
    void WritePlotFile(Set::Scalar time, amrex::Vector<int> iter, bool initial = false, std::string prefix = "") const;
 
    //
    // MEMBER VARIABLES
    //
 
    // TIME (STEP) KEEPINGamrex::Vector<std::unique_ptr<amrex::MultiFab> >
protected:
    amrex::Real timestep = NAN;   ///< Timestep for the base level of refinement
private:
    amrex::Vector<amrex::Real> dt;  ///< Timesteps for each level of refinement
    amrex::Vector<int> nsubsteps;   ///< how many substeps on each level?
    int max_plot_level = -1;
 
    amrex::Vector<amrex::Real> t_old;///< Keep track of current old simulation time on each level
    int max_step = std::numeric_limits<int>::max(); ///< Maximum allowable timestep
    amrex::Real tstart = 0; ///< Default start time (default: 0)
    amrex::Real stop_time = NAN; ///< Default stop time 
 
protected:
    bool integrate_variables_before_advance = true;
    bool integrate_variables_after_advance = false;
 
protected:
    struct {
        int number_of_fabs = 0;
        std::vector<Set::Field<Set::Scalar>*> fab_array;
        std::vector<int> ncomp_array;
        std::vector<int> nghost_array;
        std::vector<std::string> name_array;
        std::vector<BC::BC<Set::Scalar>*> physbc_array;
        std::vector<bool> writeout_array;
        bool any = true;
        bool all = false;
    } node;
 
    struct {
        int number_of_fabs = 0;
        std::vector<Set::Field<Set::Scalar>*> fab_array;
        std::vector<int> ncomp_array;
        std::vector<int> nghost_array;
        std::vector<std::string> name_array;
        std::vector<BC::BC<Set::Scalar>*> physbc_array;
        std::vector<bool> writeout_array;
        bool any = true;
        bool all = false;
    } cell;
 
    std::vector<BaseField*> m_basefields;
    std::vector<BaseField*> m_basefields_cell;
 
    BC::Nothing bcnothing;
 
    // KEEP TRACK OF ALL INTEGRATED VARIABLES
    struct {
        int interval = -1;
        Set::Scalar dt = NAN;
        int plot_int = -1;
        Set::Scalar plot_dt = NAN;
        int number = 0;
        std::vector<Set::Scalar*> vars;
        std::vector<std::string> names;
        std::vector<bool> extensives;
    } thermo;
 
    // REGRIDDING
    int regrid_int = -1;       ///< Determine how often to regrid (default: 2)
    int base_regrid_int = -1; ///< Determine how often to regrid based on coarse level only (default: 0)
 
    std::string restart_file_cell = "";
    std::string restart_file_node = "";
 
    struct {
        int on = 0;
        std::vector<amrex::Box> box;
    } explicitmesh;
 
protected:
    int plot_int = -1;               ///< How frequently to dump plot file (default: never)
    Set::Scalar plot_dt = -1.0;
 
    int abort_on_nan = true;
};
 
 
template<>
ALAMO_SINGLE_DEFINITION
void Integrator::AddField<Set::Scalar, Set::Hypercube::Cell>(Set::Field<Set::Scalar>& new_field,
    BC::BC<Set::Scalar>* new_bc,
    int ncomp,
    int nghost,
    std::string name,
    bool writeout,
    bool /*evolving*/)
{
    int nlevs_max = maxLevel() + 1;
    new_field.resize(nlevs_max);
    cell.fab_array.push_back(&new_field);
    if (new_bc != nullptr) cell.physbc_array.push_back(new_bc);
    else                   cell.physbc_array.push_back(&bcnothing);
    cell.ncomp_array.push_back(ncomp);
    cell.nghost_array.push_back(nghost);
    cell.name_array.push_back(name);
    cell.writeout_array.push_back(writeout);
    cell.number_of_fabs++;
}
 
template<>
ALAMO_SINGLE_DEFINITION
void Integrator::AddField<Set::Scalar, Set::Hypercube::Node>(Set::Field<Set::Scalar>& new_field,
    BC::BC<Set::Scalar>* new_bc,
    int ncomp,
    int nghost,
    std::string name,
    bool writeout,
    bool /*evolving*/)
{
    BL_PROFILE("Integrator::RegisterNodalFab");
    Util::Assert(INFO, TEST(new_bc == nullptr));
    int nlevs_max = maxLevel() + 1;
    new_field.resize(nlevs_max);
    node.fab_array.push_back(&new_field);
    node.physbc_array.push_back(&bcnothing);
    node.ncomp_array.push_back(ncomp);
    node.nghost_array.push_back(nghost);
    node.name_array.push_back(name);
    node.writeout_array.push_back(writeout);
    node.number_of_fabs++;
}
 
template<class T, int d>
ALAMO_SINGLE_DEFINITION
void Integrator::AddField(Set::Field<T>& new_field, BC::BC<T>* new_bc, int ncomp, int nghost, std::string name, bool writeout, bool evolving)
{
    if (d == Set::Hypercube::Node)
    {
        Util::Assert(INFO, TEST(new_bc == nullptr));
        int nlevs_max = maxLevel() + 1;
        new_field.resize(nlevs_max);
        m_basefields.push_back(new Field<T>(new_field, geom, refRatio(), ncomp, nghost));
        m_basefields.back()->evolving = evolving;
        m_basefields.back()->writeout = writeout;
        m_basefields.back()->setName(name);
        m_basefields.back()->evolving = evolving;
        m_basefields.back()->m_gridtype = Set::Hypercube::Node;
    }
    else if (d == Set::Hypercube::Cell)
    {
        int nlevs_max = maxLevel() + 1;
        new_field.resize(nlevs_max);
        m_basefields_cell.push_back(new Field<T>(new_field, geom, refRatio(), ncomp, nghost));
        m_basefields_cell.back()->evolving = evolving;
        m_basefields_cell.back()->writeout = writeout;
        m_basefields_cell.back()->setName(name);
        m_basefields_cell.back()->evolving = evolving;
        if (new_bc) m_basefields_cell.back()->setBC(new_bc);
        else m_basefields_cell.back()->setBC(&bcnothing);
        m_basefields_cell.back()->m_gridtype = Set::Hypercube::Cell;
    }
    else
    {
        Util::Abort(INFO, "Only node and cell based fields can be added at this time");
    }
}
 
 
 
template<class T>
ALAMO_SINGLE_DEFINITION
void Integrator::RegisterGeneralFab(Set::Field<T>& new_fab, int ncomp, int nghost, bool evolving) 
{
    //Util::Warning(INFO, "RegisterGeneralFab is depricated. Please replace with AddField");
    AddField<T, Set::Hypercube::Node>(new_fab, nullptr, ncomp, nghost, "", true, evolving);
}
template<class T>
ALAMO_SINGLE_DEFINITION
void Integrator::RegisterGeneralFab(Set::Field<T>& new_fab, int ncomp, int nghost, std::string a_name, bool evolving)
{
    //Util::Warning(INFO, "RegisterGeneralFab is depricated. Please replace with AddField");
    AddField<T, Set::Hypercube::Node>(new_fab, nullptr, ncomp, nghost, a_name, true, evolving);
}
template<class T>
AMREX_ATTRIBUTE_WEAK
void Integrator::RegisterGeneralFab(Set::Field<T>& new_fab, int ncomp, int nghost, bool writeout, std::string a_name, bool evolving)
{
    //Util::Warning(INFO, "RegisterGeneralFab is depricated. Please replace with AddField");
    AddField<T, Set::Hypercube::Node>(new_fab, nullptr, ncomp, nghost, a_name, writeout, evolving);
}
 
}
#endif