sll_m_particle_group_3d3v Module Reference

Description

Simple particle group group for 3d3v.

Author

Katharina Kormann, IPP

...

Derived types and interfaces
type	sll_t_particle_group_3d3v
	Simple version of a PIC particle group in 2d2v. More...

Functions/Subroutines
subroutine	delete_particle_group_3d3v (self)
	Destructor. More...
subroutine	initialize_particle_group_3d3v (self, n_particles, n_total_particles, charge, mass, n_weights)
	Initialize particle group. More...
subroutine, public	sll_s_new_particle_group_3d3v_ptr (particle_group, n_particles, n_total_particles, charge, mass, n_weights)
	Constructor for abstract type. More...
subroutine, public	sll_s_new_particle_group_3d3v (particle_group, n_particles, n_total_particles, charge, mass, n_weights)
	Constructor for abstract type. More...
pure real(kind=f64) function, dimension(3)	get_x_3d3v (self, i)
	Get positions of particle i. More...
pure real(kind=f64) function, dimension(3)	get_v_3d3v (self, i)
	Get velocities of particle i. More...
pure real(kind=f64) function	get_charge_3d3v (self, i, i_weight)
	Get charge of particle i ( q * particle_weight) More...
pure real(kind=f64) function	get_mass_3d3v (self, i, i_weight)
	Get mass of particle i ( m * particle_weight) More...
pure real(kind=f64) function, dimension(self%n_weights)	get_weights_3d3v (self, i)
	Get weights of particle i. More...
pure real(kind=f64) function	get_common_weight_3d3v (self)
	Set the common weight. More...
subroutine	set_x_3d3v (self, i, x)
	Set positions of particle i. More...
subroutine	set_v_3d3v (self, i, x)
	Set velocities of particle i. More...
subroutine	set_weights_3d3v (self, i, x)
	Set weights of particle i. More...
subroutine	set_common_weight_3d3v (self, x)
	Set the common weight. More...
subroutine	print_particle_group_3d3v (self, filename)
	Print particle array. More...
subroutine	read_particle_group_3d3v (self, filename)
	Read particle array from file. More...

Function/Subroutine Documentation

delete_particle_group_3d3v()

subroutine sll_m_particle_group_3d3v::delete_particle_group_3d3v ( class( sll_t_particle_group_3d3v ), intent(inout)  self )

private

Destructor.

Parameters

[in,out]

self

particle group

Definition at line 61 of file sll_m_particle_group_3d3v.F90.

get_charge_3d3v()

pure real(kind=f64) function sll_m_particle_group_3d3v::get_charge_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self, integer(kind=i32), intent(in)  i, integer(kind=i32), intent(in), optional  i_weight  )

private

Get charge of particle i ( 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 180 of file sll_m_particle_group_3d3v.F90.

get_common_weight_3d3v()

pure real(kind=f64) function sll_m_particle_group_3d3v::get_common_weight_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self )

private

Set the common weight.

Parameters

[in]

self

particle group

Returns

common weight

Definition at line 225 of file sll_m_particle_group_3d3v.F90.

get_mass_3d3v()

pure real(kind=f64) function sll_m_particle_group_3d3v::get_mass_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self, integer(kind=i32), intent(in)  i, integer(kind=i32), intent(in), optional  i_weight  )

private

Get mass of particle i ( 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 197 of file sll_m_particle_group_3d3v.F90.

get_v_3d3v()

pure real(kind=f64) function, dimension(3) sll_m_particle_group_3d3v::get_v_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self, integer(kind=i32), intent(in)  i  )

private

Get velocities of particle i.

Parameters

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

Returns

first two components hold the value of the particle velocity

Definition at line 168 of file sll_m_particle_group_3d3v.F90.

get_weights_3d3v()

pure real(kind=f64) function, dimension(self%n_weights) sll_m_particle_group_3d3v::get_weights_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self, integer(kind=i32), intent(in)  i  )

private

Get weights of particle i.

Parameters

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

Returns

particle mass(es)

Definition at line 214 of file sll_m_particle_group_3d3v.F90.

get_x_3d3v()

pure real(kind=f64) function, dimension(3) sll_m_particle_group_3d3v::get_x_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self, integer(kind=i32), intent(in)  i  )

private

Get positions of particle i.

Parameters

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

Returns

first two components hold the value of the particle position

Definition at line 157 of file sll_m_particle_group_3d3v.F90.

initialize_particle_group_3d3v()

subroutine sll_m_particle_group_3d3v::initialize_particle_group_3d3v ( class( sll_t_particle_group_3d3v ), 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

Initialize 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
[in]	n_weights	number of weights

Definition at line 70 of file sll_m_particle_group_3d3v.F90.

print_particle_group_3d3v()

subroutine sll_m_particle_group_3d3v::print_particle_group_3d3v ( class( sll_t_particle_group_3d3v ), intent(in)  self, character(len=*), intent(in)  filename  )

private

Print particle array.

Definition at line 278 of file sll_m_particle_group_3d3v.F90.

read_particle_group_3d3v()

subroutine sll_m_particle_group_3d3v::read_particle_group_3d3v ( class( sll_t_particle_group_3d3v ), intent(inout)  self, character(len=*), intent(in)  filename  )

private

Read particle array from file.

Parameters

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

Definition at line 299 of file sll_m_particle_group_3d3v.F90.

set_common_weight_3d3v()

subroutine sll_m_particle_group_3d3v::set_common_weight_3d3v ( class( sll_t_particle_group_3d3v ), 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 268 of file sll_m_particle_group_3d3v.F90.

set_v_3d3v()

subroutine sll_m_particle_group_3d3v::set_v_3d3v ( class( sll_t_particle_group_3d3v ), intent(inout)  self, integer(kind=i32), intent(in)  i, real(kind=f64), dimension(3), intent(in)  x  )

private

Set velocities of particle i.

Parameters

[in,out]	self	particle group
[in]	i	no. of the particle
[in]	x	component 1 and 2 hold the particle velocity to be set

Definition at line 246 of file sll_m_particle_group_3d3v.F90.

set_weights_3d3v()

subroutine sll_m_particle_group_3d3v::set_weights_3d3v ( class( sll_t_particle_group_3d3v ), 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) to be set

Definition at line 257 of file sll_m_particle_group_3d3v.F90.

set_x_3d3v()

subroutine sll_m_particle_group_3d3v::set_x_3d3v ( class( sll_t_particle_group_3d3v ), intent(inout)  self, integer(kind=i32), intent(in)  i, real(kind=f64), dimension(3), intent(in)  x  )

private

Set positions of particle i.

Parameters

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

Definition at line 235 of file sll_m_particle_group_3d3v.F90.

sll_s_new_particle_group_3d3v()

subroutine, public sll_m_particle_group_3d3v::sll_s_new_particle_group_3d3v	(	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 abstract type.

Parameters

[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 130 of file sll_m_particle_group_3d3v.F90.

sll_s_new_particle_group_3d3v_ptr()

subroutine, public sll_m_particle_group_3d3v::sll_s_new_particle_group_3d3v_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 abstract type.

Parameters

[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 102 of file sll_m_particle_group_3d3v.F90.