The Run Method

Class: kwave.toolbox.TimeDomainSolver Package: kwave.toolbox

Iteratively update the PDE solution.

Syntax

run(obj)
run(obj, Nt=100, dt=1e-6)
run(obj, CFL=0.3)
run(obj, EndTime=100e-6)
run(obj, CFL=0.3, EndTime=100e-6)

Description

Iteratively updates the PDE solution. There are four possible input variants:

  • Defining the number of time steps Nt and time step size dt.
  • Defining the Courant-Friedrichs-Lewy number CFL.
  • Defining the end time EndTime.
  • Defining both CFL and EndTime.

If Nt and dt are not provided, they are automatically calculated using the values for CFL and EndTime. Note, the time step is always adjusted such that Nt * dt = EndTime, so the exact value for CFL may be slightly smaller than the defined value. The default values and calculation method for CFL and EndTime are specified within the autoComputeTimeStep method of derived classes.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

  • Nt - (integer) Number of time steps.
  • dt - (numeric) Size of each time step.
  • CFL - (numeric) Courant-Friedrichs-Lewy (CFL) number.
  • EndTime - (numeric) Simulation time [s].