core.sweeper module

class Sweeper(params)

Bases: object

Base abstract sweeper class, provides two base methods to generate QDelta matrices:

• get_Qdelta_implicit(qd_type):

  Returns a (pySDC-type) QDelta matrix of implicit type, i.e lower triangular with zeros on the first collumn.

• get_Qdelta_explicit(qd_type):

  Returns a (pySDC-type) QDelta matrix of explicit type, i.e strictly lower triangular with first node distance to zero on the first collumn.

All possible QDelta matrix coefficients are generated with qmat, check it out to see all available coefficient types.

logger

custom logger for sweeper-related logging

params

parameter object containing the custom parameters passed by the user

Type:

__Pars

coll

collocation object

Type:

pySDC.Collocation.CollBase

compute_end_point()

Abstract interface to end-node computation

compute_residual(stage='')

Computation of the residual using the collocation matrix Q

Parameters:

stage (str) – The current stage of the step the level belongs to

get_Qdelta_explicit(qd_type, k=None)

get_Qdelta_implicit(qd_type, k=None)

integrate()

Abstract interface to right-hand side integration

property level

Returns the current level

Returns:

the current level

Return type:

pySDC.Level.level

predict()

Predictor to fill values at nodes before first sweep

Default prediction for the sweepers, only copies the values to all collocation nodes and evaluates the RHS of the ODE there

property rank

setupGenerator(qd_type)

updateVariableCoeffs(k)

Potentially update QDelta implicit coefficients if variable …

Parameters:

k (int) – Index of the sweep (0 for initial sweep, 1 for the first one, …).

update_nodes()

Abstract interface to node update