CollisionBase.H

Go to the documentation of this file.

/* Copyright 2020 David Grote
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PARTICLES_COLLISION_COLLISIONBASE_H_
#define WARPX_PARTICLES_COLLISION_COLLISIONBASE_H_
 
#include "Particles/MultiParticleContainer_fwd.H"
 
#include <AMReX_REAL.H>
#include <AMReX_Vector.H>
 
#include <string>
 
enum class CollisionSteppingMode { Supercycle, Subcycle };
 
class CollisionBase
{
public:
 
    explicit CollisionBase (const std::string& collision_name);
 
    virtual void doCollisions (amrex::Real /*cur_time*/, amrex::Real /*dt*/, MultiParticleContainer* /*mypc*/ ){}
 
    CollisionBase(CollisionBase const &) = delete;
    CollisionBase(CollisionBase &&) = delete;
    CollisionBase & operator=(CollisionBase const &) = delete;
    CollisionBase & operator=(CollisionBase const &&) = delete;
 
    virtual ~CollisionBase() = default;
 
    void BackwardCompatibility ();
 
    [[nodiscard]] int get_ndt() const { return m_ndt; }
 
    [[nodiscard]] CollisionSteppingMode get_collision_stepping_mode() const
        { return m_collision_stepping_mode; }
 
    [[nodiscard]] bool use_global_debye_length() const {return m_use_global_debye_length;}
 
protected:
 
    std::string m_collision_name;
    amrex::Vector<std::string> m_species_names;
    int m_ndt = 1;
    CollisionSteppingMode m_collision_stepping_mode = CollisionSteppingMode::Supercycle;
 
    bool m_use_global_debye_length = false;
 
};
 
#endif // WARPX_PARTICLES_COLLISION_COLLISIONBASE_H_