Octopus
classical_particle_oct_m Module Reference

Data Types

interface  classical_particle_t
 class for a neutral classical particle More...
 

Functions/Subroutines

class(classical_particle_t) function, pointer classical_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 classical_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 classical_particle_init_interaction (this, interaction)
 
subroutine classical_particle_initial_conditions (this)
 
subroutine classical_particle_update_quantity (this, iq)
 
subroutine classical_particle_init_interaction_as_partner (partner, interaction)
 
subroutine classical_particle_copy_quantities_to_interaction (partner, interaction)
 
subroutine classical_particle_finalize (this)
 

Variables

integer, parameter output_coordinates = 1
 
integer, parameter output_energy = 2
 

Function/Subroutine Documentation

◆ classical_particle_constructor()

class(classical_particle_t) function, pointer classical_particle_oct_m::classical_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 171 of file classical_particle.F90.

◆ classical_particle_init()

subroutine, public classical_particle_oct_m::classical_particle_init ( class(classical_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 classical_particle.F90.

◆ classical_particle_init_interaction()

subroutine classical_particle_oct_m::classical_particle_init_interaction ( class(classical_particle_t), intent(inout), target  this,
class(interaction_t), intent(inout)  interaction 
)
private

Definition at line 247 of file classical_particle.F90.

◆ classical_particle_initial_conditions()

subroutine classical_particle_oct_m::classical_particle_initial_conditions ( class(classical_particle_t), intent(inout)  this)
private

Definition at line 272 of file classical_particle.F90.

◆ classical_particle_update_quantity()

subroutine classical_particle_oct_m::classical_particle_update_quantity ( class(classical_particle_t), intent(inout)  this,
integer, intent(in)  iq 
)
private

Definition at line 319 of file classical_particle.F90.

◆ classical_particle_init_interaction_as_partner()

subroutine classical_particle_oct_m::classical_particle_init_interaction_as_partner ( class(classical_particle_t), intent(in)  partner,
class(interaction_surrogate_t), intent(inout)  interaction 
)
private

Definition at line 338 of file classical_particle.F90.

◆ classical_particle_copy_quantities_to_interaction()

subroutine classical_particle_oct_m::classical_particle_copy_quantities_to_interaction ( class(classical_particle_t), intent(inout)  partner,
class(interaction_surrogate_t), intent(inout)  interaction 
)
private

Definition at line 370 of file classical_particle.F90.

◆ classical_particle_finalize()

subroutine classical_particle_oct_m::classical_particle_finalize ( type(classical_particle_t), intent(inout)  this)
private

Definition at line 393 of file classical_particle.F90.

Variable Documentation

◆ output_coordinates

integer, parameter classical_particle_oct_m::output_coordinates = 1
private

Definition at line 144 of file classical_particle.F90.

◆ output_energy

integer, parameter classical_particle_oct_m::output_energy = 2
private

Definition at line 144 of file classical_particle.F90.