FieldProbe.H

Go to the documentation of this file.

/* Copyright 2021 Lorenzo Giacomel, Neil Zaim, Yinjian Zhao
 *                Elisa Rheaume, Axel Huebl
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */

#ifndef WARPX_DIAGNOSTICS_REDUCEDDIAGS_FIELDPROBE_H_
#define WARPX_DIAGNOSTICS_REDUCEDDIAGS_FIELDPROBE_H_

#include "ReducedDiags.H"
#include "FieldProbeParticleContainer.H"

#include <AMReX.H>
#include <AMReX_Vector.H>

#include <unordered_map>
#include <string>
#include <vector>

enum struct DetectorGeometry
{
    Point = 0,
    Line,
    Plane
};

class FieldProbe : public ReducedDiags
{
public:

    FieldProbe (std::string rd_name);

    void InitData () override final;

    void LoadBalance () override final;

    void ComputeDiags (int step) override final;

    /*
     * Define constants used throughout FieldProbe
     */

    static constexpr int noutputs = FieldProbePIdx::nattribs + 3;

private:
    amrex::Real x_probe, y_probe, z_probe;
    amrex::Real x1_probe, y1_probe, z1_probe;
    amrex::Real target_normal_x, target_normal_y, target_normal_z;
    amrex::Real target_up_x, target_up_y, target_up_z;
    amrex::Real detector_radius;

    long m_valid_particles {0};

    int m_last_compute_step = 0;

    DetectorGeometry m_probe_geometry = DetectorGeometry::Point;

    int m_resolution = 0;

    amrex::Vector<amrex::Real> m_data;

    amrex::Vector<amrex::Real> m_data_out;

    FieldProbeParticleContainer m_probe;

    bool m_field_probe_integrate = false;

    int interp_order = 1;

    bool raw_fields = false;

    bool do_moving_window_FP = false;

    virtual void WriteToFile (int step) const override;

    bool ProbeInDomain () const;
};

#endif // WARPX_DIAGNOSTICS_REDUCEDDIAGS_FIELDPROBE_H_