FDTDSolverBase.h

Go to the documentation of this file.

#ifndef IPPL_FDTD_H
#define IPPL_FDTD_H
#include <cstddef>
using std::size_t;
#include "Types/Vector.h"
 
#include "FieldLayout/FieldLayout.h"
#include "MaxwellSolvers/AbsorbingBC.h"
#include "MaxwellSolvers/Maxwell.h"
#include "Meshes/UniformCartesian.h"
#include "Particle/ParticleBase.h"
 
namespace ippl {
    enum fdtd_bc {
        periodic,
        absorbing
    };

    template <typename EMField, typename SourceField, fdtd_bc boundary_conditions>
    class FDTDSolverBase : public Maxwell<EMField, SourceField> {
    public:
        constexpr static unsigned Dim = EMField::dim;
        using scalar                  = typename EMField::value_type::value_type;
        using Vector_t                = Vector<typename EMField::value_type::value_type, Dim>;
        using SourceVector_t          = typename SourceField::value_type;

        FDTDSolverBase(SourceField& source, EMField& E, EMField& B);

        void solve() override;

        void setPeriodicBoundaryConditions();

        scalar getDt() const { return dt; }
 
        SourceField A_n;    // Current field.
        SourceField A_np1;  // Field at the next time step.
        SourceField A_nm1;  // Field at the previous time step.

        void timeShift();

        virtual void step() = 0;
        void evaluate_EB();
    
        virtual void initialize() = 0;
 
    protected:
        void applyBCs();
 
        typename SourceField::Mesh_t* mesh_mp;  // Pointer to the mesh.
        FieldLayout<Dim>* layout_mp;            // Pointer to the layout
        NDIndex<Dim> domain_m;                  // Domain of the mesh.
        Vector_t hr_m;                          // Mesh spacing.
 
        Vector<int, Dim> nr_m;  // Number of grid points in each direction.
        scalar dt;              // Time step size.
    };
}  // namespace ippl
 
#include "FDTDSolverBase.hpp"
#endif