sll_m_particle_group_3d1v Module Reference

Description

Simple particle group type for 3d1v.

Author

Benedikt Perse, Ipp

...

Derived types and interfaces
type	sll_t_particle_group_3d1v
	Simple version of a PIC particle group in 3d1v. More...

Functions/Subroutines
subroutine	delete_particle_group_3d1v (self)
	print particle array to file More...
subroutine	initialize_particle_group_3d1v (self, n_particles, n_total_particles, charge, mass, n_weights)
	Initialization of the particle group. More...
subroutine, public	sll_s_new_particle_group_3d1v_ptr (particle_group, n_particles, n_total_particles, charge, mass, n_weights)
	Constructor for pointer. More...
subroutine, public	sll_s_new_particle_group_3d1v (particle_group, n_particles, n_total_particles, charge, mass, n_weights)
	Constructor for allocatable. More...
pure real(kind=f64) function, dimension(3)	get_x_3d1v (self, i)
	Get position. More...
pure real(kind=f64) function, dimension(3)	get_v_3d1v (self, i)
	Get velocity. More...
pure real(kind=f64) function	get_charge_3d1v (self, i, i_weight)
	Get charge of particle (q * particle_weight) More...
pure real(kind=f64) function	get_mass_3d1v (self, i, i_weight)
	Get mass of particle (m * particle_weight) More...
pure real(kind=f64) function, dimension(self%n_weights)	get_weights_3d1v (self, i)
	Get particle weights. More...
pure real(kind=f64) function	get_common_weight_3d1v (self)
	Set the common weight. More...
subroutine	set_x_3d1v (self, i, x)
	Set position of particle i. More...
subroutine	set_v_3d1v (self, i, x)
	Set velocity of particle i. More...
subroutine	set_weight_3d1v (self, i, x)
	Set weights of particle i. More...
subroutine	set_common_weight_3d1v (self, x)
	Set the common weight. More...
subroutine	print_particle_group_3d1v (self, filename)
	Print particle array to file. More...

Function/Subroutine Documentation

delete_particle_group_3d1v()

subroutine sll_m_particle_group_3d1v::delete_particle_group_3d1v ( class( sll_t_particle_group_3d1v ), intent(inout)  self )

private

print particle array to file

Destructor

Parameters

[in,out]

self

particle group

Definition at line 59 of file sll_m_particle_group_3d1v.F90.

get_charge_3d1v()

pure real(kind=f64) function sll_m_particle_group_3d1v::get_charge_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self, integer(kind=i32), intent(in)  i, integer(kind=i32), intent(in), optional  i_weight  )

private

Get charge of particle (q * particle_weight)

Parameters

[in]	self	particle group
[in]	i	no. of the particle
[in]	i_weight	index of weight to be used (default: 1)

Returns

charges(s) of particle i

Definition at line 179 of file sll_m_particle_group_3d1v.F90.

get_common_weight_3d1v()

pure real(kind=f64) function sll_m_particle_group_3d1v::get_common_weight_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self )

private

Set the common weight.

Parameters

[in]

self

particle group

Returns

common weight

Definition at line 222 of file sll_m_particle_group_3d1v.F90.

get_mass_3d1v()

pure real(kind=f64) function sll_m_particle_group_3d1v::get_mass_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self, integer(kind=i32), intent(in)  i, integer(kind=i32), intent(in), optional  i_weight  )

private

Get mass of particle (m * particle_weight)

Parameters

[in]	self	particle group
[in]	i	no. of the particle
[in]	i_weight	index of weight to be used (default: 1)

Returns

masses(s) of particle i

Definition at line 195 of file sll_m_particle_group_3d1v.F90.

get_v_3d1v()

pure real(kind=f64) function, dimension(3) sll_m_particle_group_3d1v::get_v_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self, integer(kind=i32), intent(in)  i  )

private

Get velocity.

Parameters

[in]	self	particle group
[in]	i	no. of the particle

Definition at line 167 of file sll_m_particle_group_3d1v.F90.

get_weights_3d1v()

pure real(kind=f64) function, dimension(self%n_weights) sll_m_particle_group_3d1v::get_weights_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self, integer(kind=i32), intent(in)  i  )

private

Get particle weights.

Parameters

[in]	self	particle group
[in]	i	no. of the particle

Returns

weight(s) of particle i

Definition at line 211 of file sll_m_particle_group_3d1v.F90.

get_x_3d1v()

pure real(kind=f64) function, dimension(3) sll_m_particle_group_3d1v::get_x_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self, integer(kind=i32), intent(in)  i  )

private

Get position.

Parameters

[in]	self	particle group
[in]	i	no. of the particle

Returns

position of particle i

Definition at line 155 of file sll_m_particle_group_3d1v.F90.

initialize_particle_group_3d1v()

subroutine sll_m_particle_group_3d1v::initialize_particle_group_3d1v ( class( sll_t_particle_group_3d1v ), intent(inout)  self, integer(kind=i32), intent(in)  n_particles, integer(kind=i32), intent(in)  n_total_particles, real(kind=f64), intent(in)  charge, real(kind=f64), intent(in)  mass, integer(kind=i32), intent(in)  n_weights  )

private

Initialization of the particle group.

Parameters

[in,out]	self	particle group
[in]	n_particles	number of particles local to the processor
[in]	n_total_particles	number of particles in total simulation
[in]	charge	charge of the particle species
[in]	mass	mass of the particle species(self, n_particles)
[in]	n_weights	number of weights

Definition at line 68 of file sll_m_particle_group_3d1v.F90.

print_particle_group_3d1v()

subroutine sll_m_particle_group_3d1v::print_particle_group_3d1v ( class( sll_t_particle_group_3d1v ), intent(in)  self, character(len=*), intent(in)  filename  )

private

Print particle array to file.

Parameters

[in]	self	particle group
[in]	filename	name of output file

Definition at line 277 of file sll_m_particle_group_3d1v.F90.

set_common_weight_3d1v()

subroutine sll_m_particle_group_3d1v::set_common_weight_3d1v ( class( sll_t_particle_group_3d1v ), intent(inout)  self, real(kind=f64), intent(in)  x  )

private

Set the common weight.

Parameters

[in,out]	self	particle group
[in]	x	common weight

Definition at line 266 of file sll_m_particle_group_3d1v.F90.

set_v_3d1v()

subroutine sll_m_particle_group_3d1v::set_v_3d1v ( class( sll_t_particle_group_3d1v ), intent(inout)  self, integer(kind=i32), intent(in)  i, real(kind=f64), dimension(3), intent(in)  x  )

private

Set velocity of particle i.

Parameters

[in,out]	self	particle group
[in]	i	no. of the particle
[in]	x	first component holds the values of the velocity to be set

Definition at line 243 of file sll_m_particle_group_3d1v.F90.

set_weight_3d1v()

subroutine sll_m_particle_group_3d1v::set_weight_3d1v ( class( sll_t_particle_group_3d1v ), intent(inout)  self, integer(kind=i32), intent(in)  i, real(kind=f64), dimension(self%n_weights), intent(in)  x  )

private

Set weights of particle i.

Parameters

[in,out]	self	particle group
[in]	i	no. of the particle
[in]	x	particle weight(s)

Definition at line 254 of file sll_m_particle_group_3d1v.F90.

set_x_3d1v()

subroutine sll_m_particle_group_3d1v::set_x_3d1v ( class( sll_t_particle_group_3d1v ), intent(inout)  self, integer(kind=i32), intent(in)  i, real(kind=f64), dimension(3), intent(in)  x  )

private

Set position of particle i.

Parameters

[in,out]	self	particle group
[in]	i	no. of the particle
[in]	x	the three components hold the value of the position to be set

Definition at line 232 of file sll_m_particle_group_3d1v.F90.

sll_s_new_particle_group_3d1v()

subroutine, public sll_m_particle_group_3d1v::sll_s_new_particle_group_3d1v	(	class( sll_c_particle_group_base ), intent(out), allocatable	particle_group,
		integer(kind=i32), intent(in)	n_particles,
		integer(kind=i32), intent(in)	n_total_particles,
		real(kind=f64), intent(in)	charge,
		real(kind=f64), intent(in)	mass,
		integer(kind=i32), intent(in)	n_weights
	)

Constructor for allocatable.

Parameters

[out]	particle_group	abstract particle group
[in]	n_particles	number of particles local to the processor
[in]	n_total_particles	number of particles in total simulation
[in]	charge	charge of the particle species
[in]	mass	mass of the particle species
[in]	n_weights	number of weights

Definition at line 128 of file sll_m_particle_group_3d1v.F90.

sll_s_new_particle_group_3d1v_ptr()

subroutine, public sll_m_particle_group_3d1v::sll_s_new_particle_group_3d1v_ptr	(	class( sll_c_particle_group_base ), intent(out), pointer	particle_group,
		integer(kind=i32), intent(in)	n_particles,
		integer(kind=i32), intent(in)	n_total_particles,
		real(kind=f64), intent(in)	charge,
		real(kind=f64), intent(in)	mass,
		integer(kind=i32), intent(in)	n_weights
	)

Constructor for pointer.

Parameters

[out]	particle_group	abstract particle group
[in]	n_particles	number of particles local to the processor
[in]	n_total_particles	number of particles in total simulation
[in]	charge	charge of the particle species
[in]	mass	mass of the particle species
[in]	n_weights	number of weights

Definition at line 101 of file sll_m_particle_group_3d1v.F90.