diag_diffusion_profiles.hpp

Go to the documentation of this file.

#ifndef DIAG_DIFFUSION_PROFILES_HPP
#define DIAG_DIFFUSION_PROFILES_HPP

#include "globals.hpp"
#include "space_settings.hpp"
#include "sml.hpp"
#include "moments.hpp"
#include "diagnostic.hpp"   // Base diagnostic class interface

class DiffusionProfilesDiag : public Diagnostic {
    //bool is_on;                       //!< Flag to indicate if this diagnostic is active.
    int output_rate;                  
    int sampling_rate;                
    StepTrigger step_trigger_output;  
    int n_species;                    //<! Number of species to buffer and write out
    int n_surf;                       //<! Number of flux-surfaces to sample
    int n_samples;                    //<! Number of sampled time slices
    int sample_count;                 //<! Index of current sample (buffer position)

public:
    bool is_on;                       
    View<double***,CLayout,HostType> profiles_buffer_n;  //<! Buffer for the time evolution of the density profile
    View<double***,CLayout,HostType> profiles_buffer_u;  //<! Buffer for the time evolution of the parallel mean flow profile
    View<double***,CLayout,HostType> profiles_buffer_T;  //<! Buffer for the time evolution of the temperature profile
    View<double*,CLayout,HostType>   psi_grid;           
    View<double*,CLayout,HostType>   time_buffer;        
    View<int*,CLayout,HostType>   step_buffer;           

    // Default constructor is mapped to the parent class
    DiffusionProfilesDiag() : Diagnostic() {}

    /*
     *
     * This function initializes the diffusion profiles diagnostic by reading configuration options,
     * setting up the internal state, allocating buffers for the profile data, and initializing the output trigger.
     *
     */
    void init(NLReader::NamelistReader& nlr, const Simulation<DeviceType>& sml,
              const Grid<DeviceType>& grid, const Plasma& plasma, int f_source_period);

    // * @brief Return whether the diffusion diagnostic is on
    // *
    // * @return Whether the diffusion diagnostic is on
    // *
    // */
    //bool is_on() const {return is_on;}
    int get_n_species() const {return n_species;}
    int get_n_surf() const {return n_surf;}
    int get_n_samples() const {return n_samples;}

    bool is_triggered_output(int step){
        return step_trigger_output.is_triggered(step);
    }

    /*
     *
     * This function collects a new sample of diffusion profile data from the simulation,
     * averaging over toroidal and flux surfaces, and stores it in the internal buffers.
     *
     */
    void collect_sample(const Simulation<DeviceType>& sml,
                        const Grid<DeviceType>& grid, Plasma& plasma,
                        const Moments& f0_moments,
                        const DomainDecomposition<DeviceType>& pol_decomp);

    /*
     * This function writes the buffered diffusion profile data to disk or stream
     * using the configured IO mechanism. The output is performed on the appropriate
     * simulation step as determined by the output trigger.
     */
    void write();

    void reset_buffer(){
        sample_count = 0;
        Kokkos::deep_copy(profiles_buffer_n,0.0);
        Kokkos::deep_copy(profiles_buffer_u,0.0);
        Kokkos::deep_copy(profiles_buffer_T,0.0);
        Kokkos::deep_copy(time_buffer,0.0);
        Kokkos::deep_copy(step_buffer,0);
    }
};

#endif // DIAG_DIFFUSION_PROFILES_HPP