sll_m_time_propagator_pic_vm_3d3v_helper Module Reference

Description

Particle pusher based on antisymmetric splitting with AVF for 3d3v Vlasov-Maxwell.

Author

Katharina Kormann, IPP

MPI parallelization by domain cloning. Periodic boundaries. Spline DoFs numerated by the point the spline starts.

Derived types and interfaces
type	sll_t_time_propagator_pic_vm_3d3v_helper
	Helper for implicit time propagators for Vlasov-Maxwell 3d3v. More...

Functions/Subroutines
subroutine	advect_x_pic_vm_3d3v (self, dt)
	Finalization. More...
subroutine	compute_particle_boundary (self, xold, xnew, vi)
	Helper function for advect_x. More...
subroutine	advect_vb_pic_vm_3d3v (self, dt)
	advect_vb: Equations to be solved $(\mathbb{I}-\Delta \frac{\Delta t q}{2 m} \mathbb{B}(X^n,b^n) V^{n+1}=(\mathbb{I}+ \frac{\Delta t q}{2 m} \mathbb{B}(X^n,b^n) V^n$ More...
subroutine	advect_eb_schur_pic_vm_3d3v (self, dt)
	advect_eb: Equations to be solved Solution with Schur complement: $ S=M_1+\frac{\Delta t^2}{4} C^\top M_2 C $ $ e^{n+1}=S^{-1}( (M_1-\frac{\Delta t^2}{4} C^\top M_2 C)e^n+\Delta t C^\top M_2 b^n) $ $ b^{n+1}=b^n-\frac{\Delta t}{2} C(e^n+e^{n+1}) $ More...
subroutine	advect_e_pic_vm_3d3v (self, dt)
	advect_e: Equations to be solved Solution with Schur complement: $ S_{+}=M_1+\frac{\Delta t^2 q^2}{4 m} (\mathbb{\Lambda}^1)^T \mathbb{\Lambda}^1 $ $e^{n+1}=S_{+}^{-1}\left(S_{-}e^n-\Delta t (\mathbb{\Lambda}^1)^\top \mathbb{W}_q V^n \right)$ $V^{n+1}=V^n+\frac{\Delta t}{2} \mathbb{W}_{\frac{q}{m}} \mathbb{\Lambda}^1(e^{n+1}+e^n)$ More...
subroutine	advect_ex_pic_vm_3d3v (self, dt)
	advect_ex: Equations to be solved $\frac{X^{n+1}-X^n}{\Delta t}=\frac{V^{n+1}+V^n}{2}$ $\frac{V^{n+1}-V^n}{\Delta t}=\mathbb{W}_{\frac{q}{m}} \frac{1}{\Delta t}\int_{t^n}^{t^{n+1}} \mathbb{\Lambda}^1(X(\tau)) d\tau \frac{e^{n+1}+e^n}{2}$ $\frac{M_1 e^{n+1}-M_1 e^n}{\Delta t} = - \frac{1}{\Delta t} \int_{t^n}^{t^{n+1}} \mathbb{\Lambda}^1(X(\tau))^\top d\tau \mathbb{W}_q\frac{V^{n+1}+V^n}{2}$ More...
subroutine	compute_particle_boundary_current_evaluate (self, xi, xnew, vi, wi, sign)
	Helper function for advect_ex. More...
subroutine	advect_e_pic_vm_3d3v_trunc (self, dt)
	advect_e_trunc: This is a version of advect_e where the Particle Mass is approximated by the mass matrix 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, 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, filename, filter, boundary_particles, betar, force_sign, rhob, control_variate, jmean)
	Constructor. More...
subroutine	delete_pic_vm_3d3v (self)
	Destructor. More...

Function/Subroutine Documentation

advect_e_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::advect_e_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

advect_e: Equations to be solved Solution with Schur complement: $ S_{+}=M_1+\frac{\Delta t^2 q^2}{4 m} (\mathbb{\Lambda}^1)^T \mathbb{\Lambda}^1 $ $e^{n+1}=S_{+}^{-1}\left(S_{-}e^n-\Delta t (\mathbb{\Lambda}^1)^\top \mathbb{W}_q V^n \right)$ $V^{n+1}=V^n+\frac{\Delta t}{2} \mathbb{W}_{\frac{q}{m}} \mathbb{\Lambda}^1(e^{n+1}+e^n)$

Parameters

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

Definition at line 319 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

advect_e_pic_vm_3d3v_trunc()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::advect_e_pic_vm_3d3v_trunc ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

advect_e_trunc: This is a version of advect_e where the Particle Mass is approximated by the mass matrix

Parameters

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

Definition at line 771 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

advect_eb_schur_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::advect_eb_schur_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

advect_eb: Equations to be solved Solution with Schur complement: $ S=M_1+\frac{\Delta t^2}{4} C^\top M_2 C $ $ e^{n+1}=S^{-1}( (M_1-\frac{\Delta t^2}{4} C^\top M_2 C)e^n+\Delta t C^\top M_2 b^n) $ $ b^{n+1}=b^n-\frac{\Delta t}{2} C(e^n+e^{n+1}) $

Parameters

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

Definition at line 304 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

advect_ex_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::advect_ex_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

advect_ex: Equations to be solved $\frac{X^{n+1}-X^n}{\Delta t}=\frac{V^{n+1}+V^n}{2}$ $\frac{V^{n+1}-V^n}{\Delta t}=\mathbb{W}_{\frac{q}{m}} \frac{1}{\Delta t}\int_{t^n}^{t^{n+1}} \mathbb{\Lambda}^1(X(\tau)) d\tau \frac{e^{n+1}+e^n}{2}$ $\frac{M_1 e^{n+1}-M_1 e^n}{\Delta t} = - \frac{1}{\Delta t} \int_{t^n}^{t^{n+1}} \mathbb{\Lambda}^1(X(\tau))^\top d\tau \mathbb{W}_q\frac{V^{n+1}+V^n}{2}$

Parameters

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

Definition at line 521 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

Here is the call graph for this function:

advect_vb_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::advect_vb_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

advect_vb: Equations to be solved $(\mathbb{I}-\Delta \frac{\Delta t q}{2 m} \mathbb{B}(X^n,b^n) V^{n+1}=(\mathbb{I}+ \frac{\Delta t q}{2 m} \mathbb{B}(X^n,b^n) V^n$

Parameters

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

Definition at line 243 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

advect_x_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::advect_x_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), intent(in)  dt  )

private

Finalization.

advect_x: Equations to be solved $X^{n+1}=X^n + \Delta t V^n

Parameters

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

Definition at line 172 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

Here is the call graph for this function:

compute_particle_boundary()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::compute_particle_boundary ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), dimension(3), intent(inout)  xold, real(kind=f64), dimension(3), intent(inout)  xnew, real(kind=f64), dimension(3), intent(inout)  vi  )

private

Helper function for advect_x.

Parameters

[in,out]

self

time propagator object

Definition at line 204 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

Here is the caller graph for this function:

compute_particle_boundary_current_evaluate()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::compute_particle_boundary_current_evaluate ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self, real(kind=f64), dimension(3), intent(in)  xi, real(kind=f64), dimension(3), intent(inout)  xnew, real(kind=f64), dimension(3), intent(inout)  vi, real(kind=f64), dimension(1), intent(in)  wi, real(kind=f64), intent(in)  sign  )

private

Helper function for advect_ex.

Parameters

[in,out]

self

time splitting object

Definition at line 710 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

Here is the caller graph for this function:

delete_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::delete_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), intent(inout)  self )

private

Destructor.

Parameters

[in,out]

self

time propagator object

Definition at line 1405 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

initialize_file_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::initialize_file_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), 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, character(len=*), intent(in)  filename, class(sll_c_filter_base_3d), optional, target  filter, 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, 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
[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 1064 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.

Here is the call graph for this function:

initialize_pic_vm_3d3v()

subroutine sll_m_time_propagator_pic_vm_3d3v_helper::initialize_pic_vm_3d3v ( class(sll_t_time_propagator_pic_vm_3d3v_helper), 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, 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]	rhob	charge at the boundary
[in]	control_variate	Control variate (if delta f)
[in]	jmean	logical for mean value of current

Definition at line 879 of file sll_m_time_propagator_pic_vm_3d3v_helper.F90.