aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/ComovingPsatdAlgorithm.H
diff options
context:
space:
mode:
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralAlgorithms/ComovingPsatdAlgorithm.H')
-rw-r--r--Source/FieldSolver/SpectralSolver/SpectralAlgorithms/ComovingPsatdAlgorithm.H92
1 files changed, 92 insertions, 0 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/ComovingPsatdAlgorithm.H b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/ComovingPsatdAlgorithm.H
new file mode 100644
index 000000000..2d9962e4d
--- /dev/null
+++ b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/ComovingPsatdAlgorithm.H
@@ -0,0 +1,92 @@
+#ifndef WARPX_COMOVING_PSATD_ALGORITHM_H_
+#define WARPX_COMOVING_PSATD_ALGORITHM_H_
+
+#include "SpectralBaseAlgorithm.H"
+
+#if WARPX_USE_PSATD
+
+/* \brief Class that updates the field in spectral space and stores the coefficients
+ * of the corresponding update equation, according to the comoving spectral scheme.
+ */
+class ComovingPsatdAlgorithm : public SpectralBaseAlgorithm
+{
+ public:
+
+ /**
+ * \brief Class constructor
+ */
+ ComovingPsatdAlgorithm (const SpectralKSpace& spectral_kspace,
+ const amrex::DistributionMapping& dm,
+ const int norder_x,
+ const int norder_y,
+ const int norder_z,
+ const bool nodal,
+ const amrex::Array<amrex::Real,3>& v_comoving,
+ const amrex::Real dt,
+ const bool update_with_rho);
+
+ /**
+ * \brief Override the update equations in Fourier space
+ */
+ virtual void pushSpectralFields (SpectralFieldData& f) const override final;
+
+ virtual int getRequiredNumberOfFields () const override final
+ {
+ return SpectralFieldIndex::n_fields;
+ };
+
+ /* \brief Initialize the coefficients needed in the update equations
+ */
+ void InitializeSpectralCoefficients (const SpectralKSpace& spectral_kspace,
+ const amrex::DistributionMapping& dm,
+ const amrex::Real dt);
+
+ /**
+ * \brief Virtual function for current correction in Fourier space.
+ * This function overrides the virtual function \c CurrentCorrection in the
+ * base class \c SpectralBaseAlgorithm and cannot be overridden by further
+ * derived classes.
+ *
+ * \param[in,out] field_data All fields in Fourier space
+ * \param[in,out] current Array of unique pointers to \c MultiFab storing
+ * the three components of the current density
+ * \param[in] rho Unique pointer to \c MultiFab storing the charge density
+ */
+ virtual void CurrentCorrection (SpectralFieldData& field_data,
+ std::array<std::unique_ptr<amrex::MultiFab>,3>& current,
+ const std::unique_ptr<amrex::MultiFab>& rho) override final;
+
+ /**
+ * \brief Virtual function for Vay current deposition in Fourier space.
+ * This function overrides the virtual function \c VayDeposition in the
+ * base class \c SpectralBaseAlgorithm and cannot be overridden by further
+ * derived classes.
+ *
+ * \param[in,out] field_data All fields in Fourier space
+ * \param[in,out] current Array of unique pointers to \c MultiFab storing
+ * the three components of the current density
+ */
+ virtual void VayDeposition (SpectralFieldData& field_data,
+ std::array<std::unique_ptr<amrex::MultiFab>,3>& current) override final;
+
+ private:
+
+ // Real and complex spectral coefficients
+ SpectralRealCoefficients C_coef, S_ck_coef;
+ SpectralComplexCoefficients Theta2_coef, X1_coef, X2_coef, X3_coef, X4_coef;
+
+ // k vectors
+ KVectorComponent kx_vec;
+#if (AMREX_SPACEDIM==3)
+ KVectorComponent ky_vec;
+#endif
+ KVectorComponent kz_vec;
+
+ // Additional member variables
+ amrex::Array<amrex::Real,3> m_v_comoving;
+ amrex::Real m_dt;
+ bool m_update_with_rho;
+};
+
+#endif // WARPX_USE_PSATD
+#endif // WARPX_COMOVING_PSATD_ALGORITHM_H_