checkpoint_files.hpp

Go to the documentation of this file.

#ifndef CHECKPOINT_FILES_HPP
#define CHECKPOINT_FILES_HPP

#include "sml.hpp"
#include "plasma.hpp"
#include "electric_field.hpp"
#include "grid.hpp"
#include "domain_decomposition.hpp"
#include "DM_wrapper.hpp"
#include "diagnostics.hpp"
#include "sheath.hpp"
#include "charge.hpp"
#include "perturbed_B_field.hpp"
#include "increase_ptl_tor.hpp"

enum class RestartOption{
    Final,
    NotFinal
};

// These are initialized in xgc.cpp but accessed via ADIOS2 lookup.
class CheckpointFiles{
    XGC_IO_Stream stream;

    bool adios_stage_restart;    
    bool adios_stage_restart_f0; 

    bool increase_ptl_tor_on;
    IncreasePtlTorSettings increase_ptl_tor_settings;

    public:

    int restart_write_period;  
    int run_count;             

    CheckpointFiles(NLReader::NamelistReader& nlr){
        run_count = 1;
        nlr.use_namelist("sml_param");
        restart_write_period = nlr.get<int>("sml_restart_write_period",10000000); // Number of time steps between each simulation checkpoint. A checkpoint file is also written after the final time step of the simulation.

        increase_ptl_tor_on = nlr.get<bool>("sml_increase_ptl_tor", false); 
        if(increase_ptl_tor_on) increase_ptl_tor_settings = IncreasePtlTorSettings(nlr);

        nlr.use_namelist("adios_param");
        adios_stage_restart = nlr.get<bool>("adios_stage_restart",false); // Enable/disable Adios stage mode for checkpoint file
        adios_stage_restart_f0 = nlr.get<bool>("adios_stage_restartf0",false); // Enable/disable Adios stage mode for f0 checkpoint file


        // Initialize and open streams
        stream.Init("restart");
    }

    bool do_restart(NLReader::NamelistReader& nlr);

    bool write_restart_now(int gstep);

    void write(const Simulation<DeviceType>& sml,
        const Grid<DeviceType>& grid,
        const MagneticField<DeviceType>& magnetic_field,
        ElectricField<DeviceType>& electric_field,
        Plasma& plasma,             
        const Sheath<DeviceType>& sheath, 
        const Charges& charges,
        const PerturbedBField<DeviceType>& perturbed_B_field,
        const VelocityGrid& vgrid,
        const Neutrals<DeviceType>& neutrals,
        DomainDecomposition<DeviceType>& pol_decomp,
        DMWrapper& pseudo_inv_dm,
        Diagnostics& diagnostics,
        RestartOption restart_option=RestartOption::NotFinal);

    void read(Simulation<DeviceType>& sml,
                  Plasma& plasma,
                  ElectricField<DeviceType>& electric_field,
                  Sheath<DeviceType>& sheath,
                  Charges& charges,
                  PerturbedBField<DeviceType>& perturbed_B_field,
                  DomainDecomposition<DeviceType>& pol_decomp,
                  const Grid<DeviceType>& grid,
                  const MagneticField<DeviceType>& magnetic_field,
                  const VelocityGrid& vgrid,
                  Neutrals<DeviceType>& neutrals);

};

#endif