Skip to content

Particle Class

Overview

Represents a single particle in the simulation

Methods

add_position()

add_position(self: smolsat._smolsat_core.Particle, pos: smolsat._smolsat_core.Coordinate) -> None

Add position for a new frame

add_unwrapped_position()

add_unwrapped_position(self: smolsat._smolsat_core.Particle, pos: smolsat._smolsat_core.Coordinate) -> None

Add unwrapped position for a new frame

add_velocity()

add_velocity(self: smolsat._smolsat_core.Particle, vel: smolsat._smolsat_core.Coordinate) -> None

Add velocity for a new frame

has_unwrapped_positions()

has_unwrapped_positions(self: smolsat._smolsat_core.Particle) -> bool

Check if particle has unwrapped position data

has_velocities()

has_velocities(self: smolsat._smolsat_core.Particle) -> bool

Check if particle has velocity data

id()

id(self: smolsat._smolsat_core.Particle) -> int

Get particle ID

mass()

mass(self: smolsat._smolsat_core.Particle) -> float

Get particle mass

num_frames()

num_frames(self: smolsat._smolsat_core.Particle) -> int

Get number of frames

position()

position(self: smolsat._smolsat_core.Particle, frame: int) -> smolsat._smolsat_core.Coordinate

Get position at given frame

set_mass()

set_mass(self: smolsat._smolsat_core.Particle, mass: float) -> None

Set particle mass

set_type_name()

set_type_name(self: smolsat._smolsat_core.Particle, type_name: str) -> None

Set particle type name

type()

type(self: smolsat._smolsat_core.Particle) -> int

Get particle type

type_name()

type_name(self: smolsat._smolsat_core.Particle) -> str

Get particle type name

unwrapped_position()

unwrapped_position(self: smolsat._smolsat_core.Particle, frame: int) -> smolsat._smolsat_core.Coordinate

Get unwrapped position at given frame

velocity()

velocity(self: smolsat._smolsat_core.Particle, frame: int) -> smolsat._smolsat_core.Coordinate

Get velocity at given frame

Usage Example

import smolsat

# Create Particle instance
# Particle usage example