diag_f0_df.hpp

Go to the documentation of this file.

#ifndef DIAG_F0_DF_HPP
#define DIAG_F0_DF_HPP

#include "sml.hpp"
#include "grid.hpp"
#include "plasma.hpp"
#include "diagnostic.hpp"

class DiagF0DF : public Diagnostic{

    std::vector<std::string> source_names;

    View<double****, CLayout, HostType> pv_grid;
    View<double****, CLayout, HostType> pv_ptl;

    int tindex_period; // Saving this for tindex backwards compatibility

    // Returns number of sources that have been recorded since the last write.
    int n_active_sources() const{
        return source_names.size();
    }

    // Adds a new active source (i.e., recorded since the last write)
    void add_active_source(const std::string& new_source_name){
        source_names.push_back(new_source_name);
    }

    void clear_active_sources(){
        source_names.clear();
    }

    public:

    enum{
        Volume=0,
        Density,
        DensityChange,
        EnergyChange,
        MomentumChange,
        N
    };

    DiagF0DF() : Diagnostic() {}

    void init(NLReader::NamelistReader& nlr, const Simulation<DeviceType> &sml, const Grid<DeviceType>& grid, const Plasma& plasma, int f_source_period){
        tindex_period = f_source_period;

        bool is_on_default = (plasma.f0_grid() && !sml.is_XGCa); // On by default for total-f XGC1
        int period_default = (sml.is_XGCa ? 10 : 1);

        nlr.use_namelist("diag_param");
        bool is_on = nlr.get<bool>("diag_f0_df_on", is_on_default); 
        int period = nlr.get<int>("diag_f0_df_period", period_default); 

        if (is_on){
            std::string name = "diagnosis.fsource";
            Diagnostic::init(name, period);

            int n_initial_sources = 1; // This view is resized as needed
            pv_grid = View<double****, CLayout, HostType>("diag_f0_df_pv_grid", n_initial_sources, plasma.n_nonadiabatic_species, grid.nnode, N);

#ifdef USE_GPU
            int nthreads = 1;
#else   
            int nthreads = get_num_cpu_threads();
#endif
            pv_ptl = View<double****, CLayout, HostType>("diag_f0_df_pv_ptl", nthreads, plasma.n_nonadiabatic_species, grid.nnode, N);
        }
    }

    void set_ptl_baseline(const Simulation<DeviceType>& sml, const Grid<DeviceType>& grid,
                const MagneticField<DeviceType>& magnetic_field, Plasma& plasma,
                const VelocityGrid& vgrid, const DomainDecomposition<DeviceType>& pol_decomp);

    void calculate_ptl_change(const Simulation<DeviceType>& sml, const Grid<DeviceType>& grid,
                const MagneticField<DeviceType>& magnetic_field, Plasma& plasma,
                const VelocityGrid& vgrid, const DomainDecomposition<DeviceType>& pol_decomp);

    void port1(const DomainDecomposition<DeviceType>& pol_decomp, const Grid<DeviceType>& grid, const VelocityGrid& vgrid,
                     Plasma& plasma, const VGridDistribution<HostType>& f0_f_h, const VGridDistribution<HostType>& f0_df0g_h, std::string source_name);

    void write(const Simulation<DeviceType> &sml, const Grid<DeviceType>& grid,
                     const MagneticField<DeviceType>& magnetic_field,
                     Plasma& plasma);
};

#endif