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.
More...
#include <Resampling.H>
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.
◆ Resampling() [1/2]
Resampling::Resampling |
( |
| ) |
|
|
default |
◆ Resampling() [2/2]
Resampling::Resampling |
( |
const std::string & |
species_name | ) |
|
Constructor of the Resampling class. Reads the chosen resampling algorithm from the input file.
- Parameters
-
[in] | species_name | the name of the resampled species |
◆ operator()()
A method that uses the ResamplingAlgorithm object to perform resampling.
- Parameters
-
[in] | pti | WarpX particle iterator of the particles to resample. |
[in] | lev | the index of the refinement level. |
[in] | pc | a pointer to the particle container. |
◆ triggered()
bool Resampling::triggered |
( |
int |
timestep, |
|
|
amrex::Real |
global_numparts |
|
) |
| const |
A method that returns true if resampling should be done for the considered species at the considered timestep.
- Parameters
-
[in] | timestep | the current timestep |
[in] | global_numparts | the total number of particles of the considered species |
◆ m_resampling_algorithm
◆ m_resampling_trigger
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Particles/Resampling/Resampling.H
- /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Particles/Resampling/Resampling.cpp