swiftest_util_set_particle_info Interface

interface
public module subroutine swiftest_util_set_particle_info(self, name, particle_type, status, origin_type, origin_time, collision_id, origin_rh, origin_vh, discard_time, discard_rh, discard_vh, discard_body_id)

Arguments

Type IntentOptional Attributes Name
class(swiftest_particle_info), intent(inout) :: self
character(len=*), intent(in), optional :: name

Non-unique name
character(len=*), intent(in), optional :: particle_type

String containing a description of the particle type (e.g. Central Body, Massive Body, Test Particle)
character(len=*), intent(in), optional :: status

Particle status description: Active, Merged, Fragmented, etc.
character(len=*), intent(in), optional :: origin_type

String containing a description of the origin of the particle (e.g. Initial Conditions, Disruption, etc.)
real(kind=DP), intent(in), optional :: origin_time

The time of the particle’s formation
integer(kind=I4B), intent(in), optional :: collision_id

The ID fo the collision that formed the particle
real(kind=DP), intent(in), optional, dimension(:) :: origin_rh

The heliocentric distance vector at the time of the particle’s formation
real(kind=DP), intent(in), optional, dimension(:) :: origin_vh

The heliocentric velocity vector at the time of the particle’s formation
real(kind=DP), intent(in), optional :: discard_time

The time of the particle’s discard
real(kind=DP), intent(in), optional, dimension(:) :: discard_rh

The heliocentric distance vector at the time of the particle’s discard
real(kind=DP), intent(in), optional, dimension(:) :: discard_vh

The heliocentric velocity vector at the time of the particle’s discard
integer(kind=I4B), intent(in), optional :: discard_body_id

The id of the other body involved in the discard (0 if no other body involved)