EffectivePotentialES.H

Go to the documentation of this file.

/* Copyright 2024-2025 The WarpX Community
 *
 * This file is part of WarpX.
 *
 * Authors: Roelof Groenewald (TAE Technologies)
 *
 * License: BSD-3-Clause-LBNL
 */
 
#ifndef WARPX_EFFECTIVEPOTENTIALES_H_
#define WARPX_EFFECTIVEPOTENTIALES_H_
 
#include "ElectrostaticSolver.H"
 
#include <ablastr/coarsen/sample.H>
#include <ablastr/fields/EffectivePotentialPoissonSolver.H>
 
class EffectivePotentialES final : public ElectrostaticSolver
{
public:
 
    explicit EffectivePotentialES (int nlevs_max) : ElectrostaticSolver (nlevs_max) {
        ReadParameters();
        WARPX_ALWAYS_ASSERT_WITH_MESSAGE(
            (nlevs_max == 1),
            "Effective potential electrostatic solver only supports one level at present"
        );
    }
 
    void InitData () override;
 
    void ComputeSpaceChargeField (
        ablastr::fields::MultiFabRegister& fields,
        MultiParticleContainer& mpc,
        MultiFluidContainer* mfl,
        int max_level) override;
 
    void ComputeSigma (
        ablastr::fields::MultiLevelScalarField const& rho_fp
    );
 
    void computePhi (
        ablastr::fields::MultiLevelScalarField const& rho,
        ablastr::fields::MultiLevelScalarField const& phi,
        ablastr::fields::MultiLevelVectorField const& efield
    );

    void computePhi (
        ablastr::fields::MultiLevelScalarField const& rho,
        ablastr::fields::MultiLevelScalarField const& phi,
        ablastr::fields::MultiLevelVectorField const& efield,
        amrex::Real required_precision,
        amrex::Real absolute_tolerance,
        int max_iters,
        int verbosity
    ) const;
 
    bool m_overwrite_sigma;
};
 
#endif // WARPX_EFFECTIVEPOTENTIALES_H_