BackgroundStopping.H

Go to the documentation of this file.

/* Copyright 2022 David Grote
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PARTICLES_COLLISION_BACKGROUNSTOPPING_H_
#define WARPX_PARTICLES_COLLISION_BACKGROUNSTOPPING_H_

#include "Particles/MultiParticleContainer.H"
#include "Particles/Collision/CollisionBase.H"

#include <AMReX_REAL.H>

#include <string>

enum class BackgroundStoppingType {
    INVALID,
    ELECTRONS,
    IONS,
};

class BackgroundStopping final
    : public CollisionBase
{
public:
    BackgroundStopping (std::string collision_name);

    virtual ~BackgroundStopping () = default;

    void doCollisions (amrex::Real cur_time, amrex::Real dt, MultiParticleContainer* mypc) override;

    void doBackgroundStoppingOnElectronsWithinTile (WarpXParIter& pti, amrex::Real dt, amrex::Real t,
                                                    amrex::ParticleReal species_mass, amrex::ParticleReal species_charge);

    void doBackgroundStoppingOnIonsWithinTile (WarpXParIter& pti, amrex::Real dt, amrex::Real t,
                                               amrex::ParticleReal species_mass, amrex::ParticleReal species_charge);

private:

    amrex::ParticleReal m_background_mass;
    amrex::ParticleReal m_background_charge_state;
    BackgroundStoppingType m_background_type;

    amrex::Parser m_background_density_parser;
    amrex::Parser m_background_temperature_parser;

    amrex::ParserExecutor<4> m_background_density_func;
    amrex::ParserExecutor<4> m_background_temperature_func;

};

#endif // WARPX_PARTICLES_COLLISION_BACKGROUNSTOPPING_H_