Report Typos and Errors    
Semi-Lagrangian Library
Modular library for kinetic and gyrokinetic simulations of plasmas in fusion energy devices.
Derived types and interfaces | Functions/Subroutines
sll_m_particle_sampling_interface Module Reference

Description

Interface routines for sampling and resampling particle groups.

Author
MCP

Derived types and interfaces

type  sll_t_conservative_sampling_params
 type used to enforce some conservation properties in the sampling – (there may be more than just one scalar) More...
 

Functions/Subroutines

subroutine set_total_charge (self, target_total_charge)
 
subroutine, public sll_s_sample_particle_group (particle_group, distribution_params, random_sampler, nb_weights, control_variate, conservative_sampling_params, xmin, Lx)
 sampling interface More...
 
subroutine, public sll_s_resample_particle_group (particle_group, conservative_sampling_params)
 resampling interface More...
 

Function/Subroutine Documentation

◆ set_total_charge()

subroutine sll_m_particle_sampling_interface::set_total_charge ( class(sll_t_conservative_sampling_params), intent(inout)  self,
real(kind=f64), intent(in)  target_total_charge 
)
private

Definition at line 65 of file sll_m_particle_sampling_interface.F90.

◆ sll_s_resample_particle_group()

subroutine, public sll_m_particle_sampling_interface::sll_s_resample_particle_group ( class(sll_c_particle_group_base), intent(inout), pointer  particle_group,
class(sll_t_conservative_sampling_params), intent(in), optional  conservative_sampling_params 
)

resampling interface

Definition at line 135 of file sll_m_particle_sampling_interface.F90.

◆ sll_s_sample_particle_group()

subroutine, public sll_m_particle_sampling_interface::sll_s_sample_particle_group ( class(sll_c_particle_group_base), intent(inout), pointer  particle_group,
class(sll_c_distribution_params), intent(inout)  distribution_params,
type(sll_t_particle_sampling), intent(inout), optional  random_sampler,
integer(kind=i32), intent(in), optional  nb_weights,
class(sll_t_control_variate), intent(in), optional  control_variate,
class(sll_t_conservative_sampling_params), intent(in), optional  conservative_sampling_params,
real(kind=f64), dimension(:), intent(in), optional  xmin,
real(kind=f64), dimension(:), intent(in), optional  Lx 
)

sampling interface

Parameters
[in,out]random_samplerif to be used, must be initialized
[in]control_variatePIC control variate
[in]xminlower bound of the domain
[in]lxlength of the domain.

default sampling strategy for lbf particles is type-bound deterministic, no use of (optional) random_sampler object

default sample using the (optional) random_sampler object

Definition at line 74 of file sll_m_particle_sampling_interface.F90.

Here is the call graph for this function:
    Report Typos and Errors