WarpXAlgorithmSelection.H

Go to the documentation of this file.

/* Copyright 2019 David Grote, Luca Fedeli, Remi Lehe
 * Yinjian Zhao
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_UTILS_WARPXALGORITHMSELECTION_H_
#define WARPX_UTILS_WARPXALGORITHMSELECTION_H_
 
#include <AMReX_BaseFwd.H>
#include <AMReX_Enum.H>
#include <ablastr/utils/Enums.H>
 
#include <string>
 
using namespace ablastr::utils::enums;  // NOLINT(google-global-names-in-headers)
 

AMREX_ENUM(MediumForEM,
           Vacuum,
           Macroscopic,
           Default = Vacuum);

AMREX_ENUM(EvolveScheme,
           Explicit,
           Theta_Implicit_EM,
           Semi_Implicit_EM,
           Strang_Implicit_Spectral_EM,
           Semi_Implicit_Darwin,
           Default = Explicit);

AMREX_ENUM(MacroscopicSolverAlgo,
           BackwardEuler,
           LaxWendroff,
           Default = BackwardEuler);
 
AMREX_ENUM(ElectromagneticSolverAlgo,
           None,
           Yee,
           CKC,
           PSATD,
           ECT,
           HybridPIC,
           hybrid = HybridPIC,
           Default = Yee);
 
AMREX_ENUM(ElectrostaticSolverAlgo,
           None,
           Relativistic,
           LabFrameElectroMagnetostatic,
           LabFrame,
           LabFrameEffectivePotential,
           Default = None);
 
AMREX_ENUM(PoissonSolverAlgo,
           Multigrid,
           IntegratedGreenFunction,
           fft = IntegratedGreenFunction,
           Default = Multigrid);
 
AMREX_ENUM(ParticlePusherAlgo,
           Boris,
           Vay,
           HigueraCary,
           higuera = HigueraCary,
           Default = Boris);
 
AMREX_ENUM(CurrentDepositionAlgo,
           Esirkepov,
           Direct,
           Vay,
           Villasenor,
           Default = Esirkepov);
 
AMREX_ENUM(ChargeDepositionAlgo,
           Standard,
           Default = Standard);
 
AMREX_ENUM(GatheringAlgo,
           EnergyConserving,
           MomentumConserving,
           Default = EnergyConserving);
 
AMREX_ENUM(PSATDSolutionType,
           FirstOrder,
           SecondOrder,
           Default = SecondOrder);
 
AMREX_ENUM(TimeDependencyJ,
           Constant,
           Linear,
           Quadratic,
           Default = Constant);
 
AMREX_ENUM(TimeDependencyRho,
           Constant,
           Linear,
           Quadratic,
           Default = Linear);

AMREX_ENUM(LoadBalanceCostsUpdateAlgo,
           Timers,     
           Heuristic,  
           Default = Timers);

AMREX_ENUM(FieldBoundaryType,
           PML,
           Periodic,
           PEC,      
           PMC,      
           Neumann = PMC, // For electrostatic, the normal E is set to zero
           Damped,   // Fields in the guard cells are damped for PSATD
                     //in the moving window direction
           Absorbing_Silver_Mueller, // Silver-Mueller boundary condition
           None,    // The fields values at the boundary are not updated. This is
                    // useful for RZ simulations, at r=0.
           Open,    // Used in the Integrated Green Function Poisson solver
                    // Note that the solver implicitely assumes open BCs:
                    // no need to enforce them separately
           PEC_Insulator, // Mixed boundary with PEC and insulator
           Default = PML);

AMREX_ENUM(ParticleBoundaryType,
           Absorbing,     
           Open,          
           Reflecting,    
           Periodic,      
           Thermal,
           None,          
           Default = Absorbing);

AMREX_ENUM(ReductionType,
           Maximum,
           Minimum,
           Sum,
           Integral = Sum);

AMREX_ENUM(SubcyclingHalf,
           FirstHalf,
           SecondHalf,
           None,
           Default = None);

AMREX_ENUM(PushType,
           Explicit,  
           Implicit,  
           Default = Explicit);

AMREX_ENUM(PositionPushType,
           None,
           Full,
           Default = Full);

AMREX_ENUM(MomentumPushType,
           Full,
           FirstHalf,
           SecondHalf,
           Default = Full);

AMREX_ENUM(
    ParticleShufflingMethod,
    None,
    FisherYates,
    Modulus,
    Standard,
    Default = FisherYates
);

AMREX_ENUM(ScatteringAngleModel,
           Forward,    
           Backward,   
           Isotropic,  
           Default = Isotropic  
);
 
#endif // WARPX_UTILS_WARPXALGORITHMSELECTION_H_