pde_opt.numerics.equations.base_eq

This module contains the base equation classes for the PDEs.

Classes

BaseEquation()	Base class for time-dependent PDE equations.
TimeSplittingEquation()	Time splitting equation.

class pde_opt.numerics.equations.base_eq.BaseEquation

Base class for time-dependent PDE equations.

Abstract base class for time-dependent PDE equations of the form

\[\frac{d}{dt} \text{state} = F(\text{state}, t)\]

where state is the state of the system and t is the time.

Subclasses should implement the rhs method, which returns the right hand side of the equation.

abstract rhs(state: State, t: float) → State

Right hand side of the equation.

class pde_opt.numerics.equations.base_eq.TimeSplittingEquation

Time splitting equation.

Time splitting equation of the form

\[\frac{d}{dt} \text{state} = A(\text{state}, t) + B(\text{state}, t)\]

where A(state, t) and B(state, t) are the A and B terms of the equation.

Subclasses should implement the A_terms and B_terms methods, which return the A and B terms of the equation.

abstract A_terms(state: State, t: float) → State

A terms of the equation.

abstract B_terms(state: State, t: float) → State

B terms of the equation.