Fronts

Welcome to the reference documentation for Fronts. This documentation covers the usage of all available functions and classes.

For an introduction to the software, please refer to the README file, which is displayed on the project’s GitHub and PyPI pages. Users may also want to review the example cases, found on the GitHub page under the examples directory.

Main module fronts

Solvers

solve(D, Si, Sb[, dS_dob_bracket, radial, …])

Solve an instance of the general problem.

solve_from_guess(D, Si, Sb, o_guess, S_guess)

Solve an instance of the general problem starting from a guess of the solution.

inverse(o, S)

Solve an inverse problem.

Solutions

Solution

Continuous solution to a problem.

BaseSolution

Base class for solutions using the Boltzmann transformation.

Boltzmann transformation

ode(D[, radial])

Transform the PDE into an ODE.

o(r, t)

Transform to the Boltzmann variable.

do_dr(r, t)

Spatial derivative of the Boltzmann transformation.

do_dt(r, t)

Time derivative of the Boltzmann transformation.

r(o, t)

Transform back from the Boltzmann variable into r.

t(o, r)

Transform back from the Boltzmann variable into t.

as_o([r, t, o])

Transform to the Boltzmann variable if called with r and t.

Submodule fronts.D: included D functions

D.constant(D0)

Return a constant D function.

D.power_law(k[, a, epsilon])

Return a power-law D function.

D.van_genuchten([n, m, l, alpha, Ks, k, nu, …])

Return a Van Genuchten moisture diffusivity function.

D.richards(C, kr[, Ks, k, nu, g])

Return a moisture diffusivity function for a Richards equation problem.