Skip to content

Commit d9e0ac8

Browse files
committed
docu: some docu on IMEXSweeper::predict
1 parent 14758f0 commit d9e0ac8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

include/pfasst/encap/imex_sweeper.hpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,15 @@ namespace pfasst
233233
}
234234
}
235235

236+
/**
237+
* Spreading initial value to all time nodes.
238+
*
239+
* This does not simply copy the initial value to all time nodes but carries out a
240+
* Crank-Nicolson step, i.e. a SDC sweep without the integral term.
241+
*
242+
* @param[in] initial if `true` the explicit and implicit part of the right hand side of the
243+
* ODE get evaluated with the initial value
244+
*/
236245
virtual void predict(bool initial)
237246
{
238247
const auto nodes = this->get_nodes();

0 commit comments

Comments
 (0)