MultiFluidContainer.H

Go to the documentation of this file.

/* Copyright 2023 Grant Johnson, Remi Lehe
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_MultiFluidContainer_H_
#define WARPX_MultiFluidContainer_H_
 
#include "WarpXFluidContainer_fwd.H"
 
#include <ablastr/fields/MultiFabRegister.H>
 
#include <AMReX_Geometry.H>
#include <AMReX_MultiFab.H>
#include <AMReX_Vector.H>
#include <AMReX_REAL.H>
 
#include <string>

class MultiFluidContainer
{
 
public:
 
    MultiFluidContainer ();
 
    ~MultiFluidContainer() = default;
 
    MultiFluidContainer (MultiFluidContainer const &)              = delete;
    MultiFluidContainer& operator= (MultiFluidContainer const & )  = delete;
    MultiFluidContainer(MultiFluidContainer&& )                    = default;
    MultiFluidContainer& operator=(MultiFluidContainer&& )         = default;
 
    [[nodiscard]] WarpXFluidContainer&
    GetFluidContainer (int ispecies) const {return *allcontainers[ispecies];}
 
#ifdef WARPX_USE_OPENPMD
    std::unique_ptr<WarpXFluidContainer>& GetUniqueContainer(int ispecies) {
      return  allcontainers[ispecies];
    }
#endif
 
    void AllocateLevelMFs (ablastr::fields::MultiFabRegister& m_fields, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm, int lev);
 
    void InitData (
        ablastr::fields::MultiFabRegister& m_fields, amrex::Box init_box, amrex::Real cur_time, int lev,
        const amrex::Geometry& geom_lev, amrex::Real gamma_boost, amrex::Real beta_boost);

    void Evolve (ablastr::fields::MultiFabRegister& fields,
                 int lev,
                 std::string const& current_fp_string,
                 amrex::Real cur_time,
                 bool skip_deposition=false);
 
    [[nodiscard]] int nSpecies() const {return static_cast<int>(species_names.size());}
 
    void DepositCharge (ablastr::fields::MultiFabRegister& m_fields, amrex::MultiFab &rho, int lev);
    void DepositCurrent (ablastr::fields::MultiFabRegister& m_fields,
        amrex::MultiFab& jx, amrex::MultiFab& jy, amrex::MultiFab& jz,
        int lev);
 
private:
 
    std::vector<std::string> species_names;
 
    // Vector of fluid species
    amrex::Vector<std::unique_ptr<WarpXFluidContainer>> allcontainers;
 
};
#endif /*WARPX_MultiFluidContainer_H_*/