Python API

This page is generated from docstrings by autodoc, so it stays in sync with the code automatically. The compiled _solvcon extension is mocked during the build (see conf.py), so these pages render even on a clean checkout where the C++ layer has not been compiled.

Below is an example that documents the one-dimensional Euler solver. Point automodule at any module to render its public surface.

One-dimensional Solver for the Euler Equations

class solvcon.onedim.euler1d.Euler1DSolver(xmin, xmax, ncoord, time_increment=0.05, keep_edge=False)

Bases: object

Numerical solver for the one-dimensional Euler equation by using the CESE method.

static calc_u2(gamma, density, velocity, pressure)

static init_solver(xmin, xmax, ncoord, time_increment, gamma)