charged_particle_oct_m Module Reference

Data Types
interface	charged_particle_t
	class for a charged classical particle More...

Functions/Subroutines
class(charged_particle_t) function, pointer	charged_particle_constructor (namespace)
	The factory routine (or constructor) allocates a pointer of the corresponding type and then calls the init routine which is a type-bound procedure of the corresponding type. With this design, also derived classes can use the init routine of the parent class. More...
subroutine, public	charged_particle_init (this, namespace)
	The init routine is a module level procedure This has the advantage that different classes can have different signatures for the initialization routines because they are not type-bound and thus also not inherited. More...
subroutine	charged_particle_init_interaction (this, interaction)
subroutine	charged_particle_initial_conditions (this)
logical function	charged_particle_is_tolerance_reached (this, tol)
subroutine	charged_particle_update_quantity (this, iq)
subroutine	charged_particle_init_interaction_as_partner (partner, interaction)
subroutine	charged_particle_copy_quantities_to_interaction (partner, interaction)

Function/Subroutine Documentation

charged_particle_constructor()

class(charged_particle_t) function, pointer charged_particle_oct_m::charged_particle_constructor ( type(namespace_t), intent(in)  namespace )

private

The factory routine (or constructor) allocates a pointer of the corresponding type and then calls the init routine which is a type-bound procedure of the corresponding type. With this design, also derived classes can use the init routine of the parent class.

Definition at line 172 of file charged_particle.F90.

charged_particle_init()

subroutine, public charged_particle_oct_m::charged_particle_init	(	class(charged_particle_t), intent(inout)	this,
		type(namespace_t), intent(in)	namespace
	)

The init routine is a module level procedure This has the advantage that different classes can have different signatures for the initialization routines because they are not type-bound and thus also not inherited.

Definition at line 190 of file charged_particle.F90.

charged_particle_init_interaction()

subroutine charged_particle_oct_m::charged_particle_init_interaction ( class(charged_particle_t), intent(inout), target  this, class(interaction_t), intent(inout)  interaction  )

private

Definition at line 218 of file charged_particle.F90.

charged_particle_initial_conditions()

subroutine charged_particle_oct_m::charged_particle_initial_conditions ( class(charged_particle_t), intent(inout)  this )

private

Definition at line 237 of file charged_particle.F90.

charged_particle_is_tolerance_reached()

logical function charged_particle_oct_m::charged_particle_is_tolerance_reached ( class(charged_particle_t), intent(in)  this, real(real64), intent(in)  tol  )

private

Definition at line 248 of file charged_particle.F90.

charged_particle_update_quantity()

subroutine charged_particle_oct_m::charged_particle_update_quantity ( class(charged_particle_t), intent(inout)  this, integer, intent(in)  iq  )

private

Definition at line 260 of file charged_particle.F90.

charged_particle_init_interaction_as_partner()

subroutine charged_particle_oct_m::charged_particle_init_interaction_as_partner ( class(charged_particle_t), intent(in)  partner, class(interaction_surrogate_t), intent(inout)  interaction  )

private

Definition at line 280 of file charged_particle.F90.

charged_particle_copy_quantities_to_interaction()

subroutine charged_particle_oct_m::charged_particle_copy_quantities_to_interaction ( class(charged_particle_t), intent(inout)  partner, class(interaction_surrogate_t), intent(inout)  interaction  )

private

Definition at line 306 of file charged_particle.F90.