Adirondax API#

simulation#

class adirondax.simulation.Simulation(params)#

Simulation: The base class for a multi-physics simulation.

Parameters:

(dict) (params)

property box_size#

Return the box size of the simulation

property dim#

Return the dimension of the simulation

property kgrid#

Return the simulation spectral grid

property mesh#

Return the simulation mesh

property params#

Return the parameters of the simulation

property potential#

Return the gravitational potential

property resolution#

Return the resolution (per dimension) of the simulation

run()#

Run the simulation

property steps_taken#

Return the number of steps taken in the simulation

constants#

Physical Constants in cgs units

adirondax.constants#

alias of {‘atomic_mass_unit’: 1.6605e-24, ‘avogadro_number’: 6.02214076e+23, ‘boltzmann_constant’: 1.380649e-16, ‘electron_charge’: 4.8032e-10, ‘electron_mass’: 9.1094e-28, ‘faraday_constant’: 96485.3321, ‘gas_constant’: 8.3145, ‘gravitational_constant’: 6.6743e-08, ‘neutron_mass’: 1.6749e-24, ‘planck_constant’: 6.6261e-27, ‘proton_mass’: 1.6726e-24, ‘rydberg_constant’: 109737.316, ‘speed_of_light’: 29980000000.0, ‘stefan_boltzmann_constant’: 5.6704e-05}

visualization#

TODO

analysis#

TODO