sll_m_time_propagator_pic_vm_1d2v_zigsub Module Reference

Description

Particle pusher based on the subcycling algorithm for the 1d2v Vlasov-Maxwell equation with splitting of the three H_p parts.

Author

Katharina Kormann, IPP

MPI parallelization by domain cloning. Periodic boundaries. Spline DoFs numerated by the point the spline starts. Reference: Hirvijoki, Kormann, Zonta, Subcycling of particle orbits in variational, geometric electromagnetic particle-in-cell methods, Physics of Plasmas 27, 092506 (2020). Control variate: Note the we do not account for the analytic j at the moment (TODO: control_variate for current)

Derived types and interfaces
type	sll_t_time_propagator_pic_vm_1d2v_zigsub
	Hamiltonian splitting type for Vlasov-Maxwell 1d2v. More...

Functions/Subroutines
subroutine	reinit_fields (self)
subroutine	strang_splitting_pic_vm_1d2v (self, dt, number_steps)
	Strang splitting. More...
subroutine	lie_splitting_pic_vm_1d2v (self, dt, number_steps)
	Lie splitting. More...
subroutine	lie_splitting_back_pic_vm_1d2v (self, dt, number_steps)
	Lie splitting (oposite ordering) More...
subroutine	operator_all (self, dt)
subroutine	initialize_pic_vm_1d2v (self, maxwell_solver, kernel_smoother_0, kernel_smoother_1, particle_group, efield_dofs, bfield_dofs, x_min, Lx, n_sub_iter, filter, jmean, control_variate, i_weight, electrostatic)
	Constructor. More...
subroutine	delete_pic_vm_1d2v (self)
	Destructor. More...
subroutine, public	sll_s_new_time_propagator_pic_vm_1d2v_zigsub (splitting, maxwell_solver, kernel_smoother_0, kernel_smoother_1, particle_group, efield_dofs, bfield_dofs, x_min, Lx, n_sub_iter, filter, jmean, control_variate, i_weight, electrostatic)
	Constructor for allocatable abstract type. More...
subroutine, public	sll_s_new_time_propagator_pic_vm_1d2v_zigsub_ptr (splitting, maxwell_solver, kernel_smoother_0, kernel_smoother_1, particle_group, efield_dofs, bfield_dofs, x_min, Lx, n_sub_iter, filter, jmean, electrostatic)
	Constructor for pointer abstract type. More...

Function/Subroutine Documentation

delete_pic_vm_1d2v()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::delete_pic_vm_1d2v ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(inout)  self )

private

Destructor.

Parameters

[in,out]

self

time propagator object

Definition at line 387 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

initialize_pic_vm_1d2v()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::initialize_pic_vm_1d2v ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(out)  self, class(sll_c_maxwell_1d_base), intent(in), target  maxwell_solver, class(sll_c_particle_mesh_coupling_1d), intent(in), target  kernel_smoother_0, class(sll_c_particle_mesh_coupling_1d), intent(in), target  kernel_smoother_1, class(sll_t_particle_array), intent(in), target  particle_group, real(kind=f64), dimension(:,:), intent(in), target  efield_dofs, real(kind=f64), dimension(:), intent(in), target  bfield_dofs, real(kind=f64), intent(in)  x_min, real(kind=f64), intent(in)  Lx, integer(kind=i32), intent(in)  n_sub_iter, type( sll_t_binomial_filter ), intent(in), target  filter, logical, intent(in), optional  jmean, class(sll_t_control_variates), intent(in), optional, target  control_variate, integer(kind=i32), intent(in), optional  i_weight, logical, optional  electrostatic  )

private

Constructor.

Parameters

[out]	self	time propagator object
[in]	maxwell_solver	Maxwell solver
[in]	kernel_smoother_0	Kernel smoother
[in]	kernel_smoother_1	Kernel smoother
[in]	particle_group	particle group
[in]	efield_dofs	array for the coefficients of the efields
[in]	bfield_dofs	array for the coefficients of the bfield
[in]	x_min	Lower bound of x domain
[in]	lx	Length of the domain in x direction.
[in]	n_sub_iter	number of subiterations
[in]	jmean	logical for mean value of current
[in]	control_variate	Control variate (if delta f)
[in]	i_weight	Index of weight to be used by propagator
	electrostatic	true for electrostatic simulation

Definition at line 302 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

lie_splitting_back_pic_vm_1d2v()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::lie_splitting_back_pic_vm_1d2v ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(inout)  self, real(kind=f64), intent(in)  dt, integer(kind=i32), intent(in)  number_steps  )

private

Lie splitting (oposite ordering)

Parameters

[in,out]	self	time propagator object
[in]	dt	time step
[in]	number_steps	number of time steps

Definition at line 144 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

Here is the call graph for this function:

lie_splitting_pic_vm_1d2v()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::lie_splitting_pic_vm_1d2v ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(inout)  self, real(kind=f64), intent(in)  dt, integer(kind=i32), intent(in)  number_steps  )

private

Lie splitting.

Parameters

[in,out]	self	time propagator object
[in]	dt	time step
[in]	number_steps	number of time steps

Definition at line 124 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

Here is the call graph for this function:

operator_all()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::operator_all ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

Parameters

[in,out]	self	time propagator object
[in]	dt	time step

Definition at line 163 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

Here is the caller graph for this function:

reinit_fields()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::reinit_fields ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(inout)  self )

private

Parameters

[in,out]

self

time propagator object

Definition at line 98 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

sll_s_new_time_propagator_pic_vm_1d2v_zigsub()

subroutine, public sll_m_time_propagator_pic_vm_1d2v_zigsub::sll_s_new_time_propagator_pic_vm_1d2v_zigsub	(	class(sll_c_time_propagator_base), intent(out), allocatable	splitting,
		class(sll_c_maxwell_1d_base), intent(in), target	maxwell_solver,
		class(sll_c_particle_mesh_coupling_1d), intent(in), target	kernel_smoother_0,
		class(sll_c_particle_mesh_coupling_1d), intent(in), target	kernel_smoother_1,
		class(sll_t_particle_array), intent(in), target	particle_group,
		real(kind=f64), dimension(:,:), intent(in), target	efield_dofs,
		real(kind=f64), dimension(:), intent(in), target	bfield_dofs,
		real(kind=f64), intent(in)	x_min,
		real(kind=f64), intent(in)	Lx,
		integer(kind=i32), intent(in)	n_sub_iter,
		type( sll_t_binomial_filter ), intent(in), target	filter,
		logical, intent(in), optional	jmean,
		class(sll_t_control_variates), intent(in), optional, target	control_variate,
		intent(in)	i_weight,
		logical, optional	electrostatic
	)

Constructor for allocatable abstract type.

Parameters

[out]	splitting	time propagator object
[in]	maxwell_solver	Maxwell solver
[in]	kernel_smoother_0	Kernel smoother
[in]	kernel_smoother_1	Kernel smoother
[in]	particle_group	Particle group
[in]	efield_dofs	array for the coefficients of the efields
[in]	bfield_dofs	array for the coefficients of the bfield
[in]	x_min	Lower bound of x domain
[in]	lx	Length of the domain in x direction.
[in]	n_sub_iter	number of subiterations
[in]	jmean	Should jmean be substracted in Ampere's law?
[in]	control_variate	Control variate (if delta f)
	electrostatic	true for electrostatic simulation

Definition at line 404 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

Here is the call graph for this function:

sll_s_new_time_propagator_pic_vm_1d2v_zigsub_ptr()

subroutine, public sll_m_time_propagator_pic_vm_1d2v_zigsub::sll_s_new_time_propagator_pic_vm_1d2v_zigsub_ptr	(	class(sll_c_time_propagator_base), intent(out), pointer	splitting,
		class(sll_c_maxwell_1d_base), intent(in), target	maxwell_solver,
		class(sll_c_particle_mesh_coupling_1d), intent(in), target	kernel_smoother_0,
		class(sll_c_particle_mesh_coupling_1d), intent(in), target	kernel_smoother_1,
		class(sll_t_particle_array), intent(in), target	particle_group,
		dimension(:,:), intent(in)	efield_dofs,
		dimension(:), intent(in)	bfield_dofs,
		intent(in)	x_min,
		intent(in)	Lx,
		intent(in)	n_sub_iter,
		type( sll_t_binomial_filter ), intent(in), target	filter,
		logical, intent(in), optional	jmean,
		logical, optional	electrostatic
	)

Constructor for pointer abstract type.

Parameters

[out]	splitting	time propagator object
[in]	maxwell_solver	Maxwell solver
[in]	kernel_smoother_0	Kernel smoother
[in]	kernel_smoother_1	Kernel smoother
[in]	particle_group	Particle group
[in]	jmean	logical for mean value of current
	electrostatic	true for electrostatic simulation

Definition at line 486 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

strang_splitting_pic_vm_1d2v()

subroutine sll_m_time_propagator_pic_vm_1d2v_zigsub::strang_splitting_pic_vm_1d2v ( class(sll_t_time_propagator_pic_vm_1d2v_zigsub), intent(inout)  self, real(kind=f64), intent(in)  dt, integer(kind=i32), intent(in)  number_steps  )

private

Strang splitting.

Parameters

[in,out]	self	time propagator object
[in]	dt	time step
[in]	number_steps	number of time steps

Definition at line 104 of file sll_m_time_propagator_pic_vm_1d2v_zigsub.F90.

Here is the call graph for this function: