浏览代码

Updating README to reflect solveMatrix option for runSolver

Andrej 2 月之前
父节点
当前提交
d43e0f22a1
共有 1 个文件被更改,包括 1 次插入0 次删除
  1. 1 0
      README.md

+ 1 - 0
README.md

@@ -25,6 +25,7 @@ Use windows terminal (ie. cmd.exe)
 Follow `cDiazepam.json`. Basic instructions:
 - `runSolver.main(setup,model,parameters,jobDir,srcDir)` 
    This constructs a model from the model file, sets it up with parameters from parameters file, uses the setup to drive calculation which it stores in jobDir. If srcDir is not a string NONE, it takes the solution from srcDir and continues it until tmax in setup is reached.
+   `setup['mode']` will select computation method. Typical value is `'IVP'`, which will use `LSODA` or a similar method, set through `setup['method']` to perofrm adaptable step solution of an inital value problem. Selecting `'solveMatrix'` as mode and `'solveSequential'` as method will calculate solution using matrix equation, which should be faster.
    
 - `runSolver.loadSolutionFromDir(jobDir,True)` 
    Read solution from dir jobDir. Returns a dict with fields