Source/Utils/WarpXAlgorithmSelection.H


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

#ifndef UTILS_WARPXALGORITHMSELECTION_H_
#define UTILS_WARPXALGORITHMSELECTION_H_

#include <AMReX_ParmParse.H>
#include <string>

struct MaxwellSolverAlgo {
    // These numbers corresponds to the algorithm code in WarpX's
    // `warpx_push_bvec` and `warpx_push_evec_f`
    enum {
        Yee = 0,
        CKC = 1
    };
};

struct ParticlePusherAlgo {
    // These numbers correspond to the algorithm code in WarpX's
    // `warpx_particle_pusher`
    enum {
        Boris = 0,
        Vay = 1
    };
};

struct CurrentDepositionAlgo {
    enum {
        // These numbers corresponds to the algorithm code in PICSAR's
        // `depose_jxjyjz_generic` and `depose_jxjyjz_generic_2d`
         Direct = 3,
         DirectVectorized = 2,
         EsirkepovNonOptimized = 1,
         Esirkepov = 0
    };
};

struct ChargeDepositionAlgo {
    // Only the Standard algorithm is implemented
    enum {
         Standard = 0
    };
};

struct GatheringAlgo {
    // These numbers corresponds to the algorithm code in PICSAR's
    // `geteb3d_energy_conserving_generic` function
    enum {
         Vectorized = 0,
         Standard = 1
    };
};

int
GetAlgorithmInteger( amrex::ParmParse& pp, const char* pp_search_key );

#endif // UTILS_WARPXALGORITHMSELECTION_H_