sll_m_time_propagator_pic_vm_3d3v_disgradec Module Reference

Description

Particle pusher based on antisymmetric splitting with discrete gradient method for 3d3v Vlasov-Maxwell, implicit charge conserving variant.

Author

Katharina Kormann, IPP

MPI parallelization by domain cloning. Periodic boundaries. Spline DoFs numerated by the point the spline starts. Reference: Kormann, Sonnendrücker, Energy-conserving time propagation for a structure-preserving particle-in-cell Vlasov–Maxwell solver, Journal of Computational Physics 425, 109890, 2021

Derived types and interfaces
type	sll_t_time_propagator_pic_vm_3d3v_disgradec
	Time propagator for Vlasov-Maxwell 3d3v. More...

Functions/Subroutines
subroutine	strang_splitting_pic_vm_3d3v (self, dt, number_steps)
	Finalization. More...
subroutine	lie_splitting_pic_vm_3d3v (self, dt, number_steps)
	Lie splitting. More...
subroutine	lie_splitting_back_pic_vm_3d3v (self, dt, number_steps)
	Lie splitting (oposite ordering) More...
subroutine	initialize_pic_vm_3d3v (self, maxwell_solver, particle_mesh_coupling, particle_group, phi_dofs, efield_dofs, bfield_dofs, x_min, Lx, filter, boundary_particles, solver_tolerance, iter_tolerance, max_iter, betar, force_sign, electrostatic, rhob, control_variate, jmean)
	Constructor. More...
subroutine	initialize_file_pic_vm_3d3v (self, maxwell_solver, particle_mesh_coupling, particle_group, phi_dofs, efield_dofs, bfield_dofs, x_min, Lx, filter, filename, boundary_particles, betar, force_sign, electrostatic, rhob, control_variate, jmean)
	Constructor. More...
subroutine	delete_pic_vm_3d3v (self)
	Destructor. More...

Function/Subroutine Documentation

delete_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_disgradec::delete_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_disgradec), intent(inout)  self )

private

Destructor.

Parameters

[in,out]

self

time propagator object

Definition at line 380 of file sll_m_time_propagator_pic_vm_3d3v_disgradEC.F90.

initialize_file_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_disgradec::initialize_file_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_disgradec), intent(out)  self, class(sll_c_maxwell_3d_base), intent(in), target  maxwell_solver, class(sll_c_particle_mesh_coupling_3d), intent(in), target  particle_mesh_coupling, class(sll_t_particle_array), intent(in), target  particle_group, real(kind=f64), dimension(:), intent(in), target  phi_dofs, real(kind=f64), dimension(:), intent(in), target  efield_dofs, real(kind=f64), dimension(:), intent(in), target  bfield_dofs, real(kind=f64), dimension(3), intent(in)  x_min, real(kind=f64), dimension(3), intent(in)  Lx, class(sll_c_filter_base_3d), target  filter, character(len=*), intent(in)  filename, integer(kind=i32), intent(in), optional  boundary_particles, real(kind=f64), dimension(2), intent(in), optional  betar, real(kind=f64), intent(in), optional  force_sign, logical, optional  electrostatic, real(kind=f64), dimension(:), intent(in), optional, target  rhob, class(sll_t_control_variates), intent(in), optional, target  control_variate, logical, intent(in), optional  jmean  )

private

Constructor.

Parameters

[out]	self	time propagator object
[in]	maxwell_solver	Maxwell solver
[in]	particle_mesh_coupling	Kernel smoother
[in]	particle_group	Particle group
[in]	phi_dofs	array for the coefficients of the scalar potential
[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]	boundary_particles	particle boundary conditions
[in]	betar	reciprocal plasma beta
[in]	force_sign	sign of particle force
	electrostatic	true for electrostatic simulation
[in]	rhob	charge at the boundary
[in]	control_variate	Control variate (if delta f)
[in]	jmean	logical for mean value of current

Definition at line 271 of file sll_m_time_propagator_pic_vm_3d3v_disgradEC.F90.

initialize_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_disgradec::initialize_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_disgradec), intent(out)  self, class(sll_c_maxwell_3d_base), intent(in), target  maxwell_solver, class(sll_c_particle_mesh_coupling_3d), intent(in), target  particle_mesh_coupling, class(sll_t_particle_array), intent(in), target  particle_group, real(kind=f64), dimension(:), intent(in), target  phi_dofs, real(kind=f64), dimension(:), intent(in), target  efield_dofs, real(kind=f64), dimension(:), intent(in), target  bfield_dofs, real(kind=f64), dimension(3), intent(in)  x_min, real(kind=f64), dimension(3), intent(in)  Lx, class(sll_c_filter_base_3d), target  filter, integer(kind=i32), intent(in), optional  boundary_particles, real(kind=f64), intent(in), optional  solver_tolerance, real(kind=f64), intent(in), optional  iter_tolerance, integer(kind=i32), intent(in), optional  max_iter, real(kind=f64), dimension(2), intent(in), optional  betar, real(kind=f64), intent(in), optional  force_sign, logical, intent(in), optional  electrostatic, real(kind=f64), dimension(:), intent(in), optional, target  rhob, class(sll_t_control_variates), intent(in), optional, target  control_variate, logical, intent(in), optional  jmean  )

private

Constructor.

Parameters

[out]	self	time propagator object
[in]	maxwell_solver	Maxwell solver
[in]	particle_mesh_coupling	Kernel smoother
[in]	particle_group	Particle group
[in]	phi_dofs	array for the coefficients of the scalar potential
[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]	boundary_particles	particle boundary conditions
[in]	solver_tolerance	solver tolerance
[in]	iter_tolerance	iteration tolerance
[in]	max_iter	maximal number of iterations
[in]	betar	reciprocal plasma beta
[in]	force_sign	sign of particle force
[in]	electrostatic	true for electrostatic simulation
[in]	rhob	charge at the boundary
[in]	control_variate	Control variate (if delta f)
[in]	jmean	logical for mean value of current

Definition at line 138 of file sll_m_time_propagator_pic_vm_3d3v_disgradEC.F90.

lie_splitting_back_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_disgradec::lie_splitting_back_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_disgradec), 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 113 of file sll_m_time_propagator_pic_vm_3d3v_disgradEC.F90.

lie_splitting_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_disgradec::lie_splitting_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_disgradec), 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 89 of file sll_m_time_propagator_pic_vm_3d3v_disgradEC.F90.

strang_splitting_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_disgradec::strang_splitting_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_disgradec), intent(inout)  self, real(kind=f64), intent(in)  dt, integer(kind=i32), intent(in)  number_steps  )

private

Finalization.

Strang splitting

Parameters

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

Definition at line 63 of file sll_m_time_propagator_pic_vm_3d3v_disgradEC.F90.