patrick-kidger / patrick-kidger/diffrax
Complex input in diffeqsolve with PIDController
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 189
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 1
Description
Hi, I encountered an issue while using the PIDController. When using complex input in diffeqsolve, I cannot change the coefficient of the PIDController. The default coefficients works fine but when I try to change I get an error leading me to believe that the time variable is converted to complex type somewhere.
Here is a MWE to reproduce the error
# %% ==========================================================================
# Imports
# =============================================================================
import jax.numpy as jnp
import diffrax as dx
from jaxtyping import Scalar
# %% ==========================================================================
# Smallest working example, solving a complex ODE with diffrax
# ODE to solve is dy/dt = iy with y a complex number
# Setting up the ODE
# =============================================================================
def vector_field(t: Scalar, y: Scalar, *args):
dotY = 1j * y
return dotY
tsave = jnp.linspace(0.0, 10.0, 1000)
sim_time = tsave[-1]
solver = dx.Tsit5()
saveat = dx.SaveAt(ts=tsave)
y0 = 1.0j
# %% ==========================================================================
# Solve using the default PIDController coefficients
# =============================================================================
stepsize_controller = dx.PIDController(rtol=1e-6, atol=1e-6, pcoeff=0, icoeff=1, dcoeff=0.0)
term = dx.ODETerm(vector_field = vector_field)
res_dx = dx.diffeqsolve(term, solver, t0=0.0, t1=sim_time, dt0=0.01, y0=y0, saveat=saveat,
stepsize_controller=stepsize_controller)
# %% ==========================================================================
# Solve using the non-zero P coefficient
# =============================================================================
stepsize_controller = dx.PIDController(rtol=1e-6, atol=1e-6, pcoeff=0.3, icoeff=0.3, dcoeff=0.0)
term = dx.ODETerm(vector_field = vector_field)
res_dx = dx.diffeqsolve(term, solver, t0=0.0, t1=sim_time, dt0=0.01, y0=y0, saveat=saveat,
stepsize_controller=stepsize_controller)
## Changing the coefficient in the PID controller seems to raise the error
ValueError: `body_fun` must have the same input and output structure. Difference is:
State(
y=c128[],
tprev=f64[],
- tnext=f64[],
+ tnext=c128[],
made_jump=bool[],
solver_state=(bool[], c128[]),
- controller_state=(bool[], bool[], f64[], c128[], c128[]),
+ controller_state=(bool[], bool[], c128[], c128[], c128[]),
result=EnumerationItem(
_value=i32[],
_enumeration=<class 'diffrax._solution.RESULTS'>
),
num_steps=i64[],
num_accepted_steps=i64[],
num_rejected_steps=i64[],
save_state=SaveState(
saveat_ts_index=i64[],
ts=_Buffer(
_array=f64[1000],
_pred=bool[],
_tag=<object object at 0x2e4dc0850>,
_makes_false_steps=False
),
ys=_Buffer(
_array=c128[1000],
_pred=bool[],
_tag=<object object at 0x2e4dc0850>,
_makes_false_steps=False
),
save_index=i64[]
),
dense_ts=None,
dense_infos=None,
dense_save_index=None
)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the provided complex-input MWE with diffeqsolve and compare the default PIDController coefficients with the non-zero pcoeff and icoeff case. Trace the PIDController and diffeqsolve entry points to find where the time or controller state changes type; done means the non-zero coefficients run without the reported body_fun structure mismatch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100