blob: 820b14f5dc5910684ade4624aac1ca759fe38b18 (
plain) (
blame)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/* Copyright 2019-2020 Neil Zaim
*
* This file is part of WarpX.
*
* License: BSD-3-Clause-LBNL
*/
#ifndef WARPX_RESAMPLING_H_
#define WARPX_RESAMPLING_H_
#include "ResamplingTrigger.H"
#include "Particles/WarpXParticleContainer_fwd.H"
#include <AMReX_REAL.H>
#include <memory>
#include <string>
/**
* \brief An empty base class from which specific resampling algorithms are derived.
*/
struct ResamplingAlgorithm
{
/**
* \brief Virtual operator() of the abstract ResamplingAlgorithm class
*/
virtual void operator() (WarpXParIter& /*pti*/, int /*lev*/, WarpXParticleContainer* /*pc*/) const = 0;
/**
* \brief Virtual destructor of the abstract ResamplingAlgorithm class
*/
virtual ~ResamplingAlgorithm () = default;
};
/**
* \brief This is a general class used for resampling that is instantiated as a member of
* MultiParticleContainer. It contains a ResamplingTrigger object used to determine if resampling
* should be done at a given timestep for a given species and a pointer to a ResamplingAlgorithm
* object used to carry out the resampling.
*/
class Resampling
{
public:
/**
* \brief Default constructor of the Resampling class.
*/
Resampling () = default;
/**
* \brief Constructor of the Resampling class. Reads the chosen resampling algorithm from the
* input file.
*
* @param[in] species_name the name of the resampled species
*/
Resampling (std::string species_name);
/**
* \brief A method that returns true if resampling should be done for the considered species
* at the considered timestep.
*
* @param[in] timestep the current timestep
* @param[in] global_numparts the total number of particles of the considered species
*/
bool triggered (int timestep, amrex::Real global_numparts) const;
/**
* \brief A method that uses the ResamplingAlgorithm object to perform resampling.
*
* @param[in] pti WarpX particle iterator of the particles to resample.
* @param[in] lev the index of the refinement level.
* @param[in] pc a pointer to the particle container.
*/
void operator() (WarpXParIter& pti, int lev, WarpXParticleContainer* pc) const;
private:
ResamplingTrigger m_resampling_trigger;
std::unique_ptr<ResamplingAlgorithm> m_resampling_algorithm;
};
#endif //WARPX_RESAMPLING_H_
|
