# A Graph Based Particle Simulator Based on D3-Force

## Documentation for package ‘particles’ version 0.2.2

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

particles-package | particles: A Graph Based Particle Simulator Based on D3-Force
add_interaction | Modify the particles in a simulation
add_particles | Modify the particles in a simulation
aquarium_genesis | Particle initialisation
bigbang_genesis | Particle initialisation
center_force | Center all particles around the origin without affecting velocity
clear_history | Start a simulation based on a graph
collision_force | Models particles as circles with a given radius and pushes overlapping particles apart
dominator_constraint | Restrict child position based on parent position
evolutions | Start a simulation based on a graph
evolve | Move the simulation forward one or more steps
field_force | Apply a vector field to particles
genesis | Particle initialisation
get_history | Start a simulation based on a graph
history_length | Start a simulation based on a graph
impose | Assign a force or constraint to a simulation
infinity_constraint | Reposition particles outside a canvas so they wrap around
is.simulation | Start a simulation based on a graph
link_force | Attract or repel linked particles
manybody_force | Model attraction or repulsion between all particles in the system
map_force | Apply a map to particles
mean_force | Apply the mean velocity of all the neighbors to a particle
particles | Start a simulation based on a graph
particles_package | particles: A Graph Based Particle Simulator Based on D3-Force
path_constraint | Limit particle position to be along a path or outline
petridish_genesis | Particle initialisation
phyllotactic_genesis | Particle initialisation
polygon_constraint | Fixes particles to be inside a polygon
position | Start a simulation based on a graph
predefined_genesis | Particle initialisation
random_force | Modify the velocity randomly at each step
record | Start a simulation based on a graph
reheat | Start a simulation based on a graph
reimpose | Assign a force or constraint to a simulation
reset_force | Reset the velocity verlet of particles to a fixed value
rewield | Assign a force or constraint to a simulation
simulate | Start a simulation based on a graph
simulation | Start a simulation based on a graph
simulation_modification | Modify the particles in a simulation
trap_force | Attract and trap particles within polygons
unimpose | Assign a force or constraint to a simulation
unwield | Assign a force or constraint to a simulation
velocity | Start a simulation based on a graph
velocity_constraint | Limits particles to a specific velocity range
wield | Assign a force or constraint to a simulation
x_constraint | Fixes particles to a horizontal position
x_force | Attract particles towards a horizontal position
y_constraint | Fixes particles to a vertical position
y_force | Attract particles towards a vertical position
_PACKAGE | particles: A Graph Based Particle Simulator Based on D3-Force