Planktos API

Simulations in Planktos are carried out using the environment class, which contains all information about the environment (both spatial and temporal), and the swarm class, which is a collection of agents sharing a similar motion model.

Planktos provides:

1. An environment class for agent swarms to move around in

2. A swarm class for agents

3. Supporting functions to handle data I/O, solving eqns of motion, etc.

Contents:

• environment class
  • environment
• swarm class
  • swarm
• motion module
  • Euler_brownian_motion()
  • RK45()
  • flatten_ode()
  • highRe_massive_drift()
  • inertial_particles()
  • tracer_particles()
• dataio module
  • load_netcdf()
  • netcdf_dep()
  • read_2DEulerian_Data_From_vtk()
  • read_IB2d_vertices()
  • read_stl_mesh()
  • read_vtk_Rectilinear_Grid_Vector()
  • read_vtk_Structured_Points()
  • read_vtk_Unstructured_Grid_Points()
  • read_vtu_mesh_velocity()
  • stl_dep()
  • write_vtk_2D_rectilinear_grid_scalars()
  • write_vtk_point_data()
  • write_vtk_rectilinear_grid_vectors()