ElectrostaticSolver.H

Go to the documentation of this file.

/* Copyright 2024 The WarpX Community
 *
 * This file is part of WarpX.
 *
 * Authors: Roelof Groenewald, Arianna Formenti, Revathi Jambunathan
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_ELECTROSTATICSOLVER_H_
#define WARPX_ELECTROSTATICSOLVER_H_
 
#include "PoissonBoundaryHandler.H"
#include "Fluids/MultiFluidContainer.H"
#include "Particles/MultiParticleContainer.H"
#include "Utils/WarpXProfilerWrapper.H"
 
#include <AMReX_Array.H>
 

class ElectrostaticSolver
{
public:
    ElectrostaticSolver() = default;
    ElectrostaticSolver( int nlevs_max );
 
    virtual ~ElectrostaticSolver();
 
    // Prohibit Move and Copy operations
    ElectrostaticSolver(const ElectrostaticSolver&) = delete;
    ElectrostaticSolver& operator=(const ElectrostaticSolver&) = delete;
    ElectrostaticSolver(ElectrostaticSolver&&) = delete;
    ElectrostaticSolver& operator=(ElectrostaticSolver&&) = delete;
 
    void ReadParameters ();
 
    virtual void InitData () {}

    virtual void ComputeSpaceChargeField (
        ablastr::fields::MultiFabRegister& fields,
        MultiParticleContainer& mpc,
        MultiFluidContainer* mfl,
        int max_level) = 0;

    void setPhiBC (
        ablastr::fields::MultiLevelScalarField const& phi,
        amrex::Real t
    ) const;

    void computePhi (
        ablastr::fields::MultiLevelScalarField const& rho,
        ablastr::fields::MultiLevelScalarField const& phi,
        std::array<amrex::Real, 3> beta,
        amrex::Real required_precision,
        amrex::Real absolute_tolerance,
        int max_iters,
        int verbosity,
        bool is_igf_2d_slices,
        std::optional<ablastr::fields::MultiLevelVectorField> efield = std::nullopt // only used for EB
    ) const;

    void computeE (
        ablastr::fields::MultiLevelVectorField const& E,
        ablastr::fields::MultiLevelScalarField const& phi,
        std::array<amrex::Real, 3> beta
    ) const;

    void computeB (
        ablastr::fields::MultiLevelVectorField const& B,
        ablastr::fields::MultiLevelScalarField const& phi,
        std::array<amrex::Real, 3> beta
    ) const;

    int num_levels;

    std::unique_ptr<PoissonBoundaryHandler> m_poisson_boundary_handler;

    amrex::Real self_fields_required_precision = 1e-11;
    amrex::Real self_fields_absolute_tolerance = 0.0;
    int self_fields_max_iters = 200;
    int self_fields_verbosity = 2;

    // 0: full 3D, 1: many 2D z-slices (quasi-3D)
    bool is_igf_2d_slices = false;
};
 
#endif // WARPX_ELECTROSTATICSOLVER_H_