MGParameters

class emg3d.solver.MGParameters(verb: int, cycle: str, sslsolver: str, linerelaxation: int, semicoarsening: int, vnC: tuple, tol: float = 1e-06, maxit: int = 50, nu_init: int = 0, nu_pre: int = 2, nu_coarse: int = 1, nu_post: int = 2, clevel: int = -1, return_info: bool = False)

Bases: object

Collect multigrid solver settings.

This dataclass is used by the main solve()-routine. See solve() for a description of the mandatory and optional input parameters and more information .

Returns:

var : class:MGParameters

As required by multigrid().

Attributes Summary

clevel
max_level	Sets dimension-dependent level variable clevel.
maxit
nu_coarse
nu_init
nu_post
nu_pre
return_info
tol

Methods Summary

cprint(info, verbosity, **kwargs)	Conditional printing.
one_liner(l2_last[, last])	Print continuously updated one-liner.

Attributes Documentation

clevel = -1

max_level

Sets dimension-dependent level variable clevel.

Requires at least two cells in each direction (for nCx, nCy, and nCz).

maxit = 50

nu_coarse = 1

nu_init = 0

nu_post = 2

nu_pre = 2

return_info = False

tol = 1e-06

Methods Documentation

cprint(info, verbosity, **kwargs)

Conditional printing.

Prints info if self.verb > verbosity.

Parameters:

info : str

String to be printed.

verbosity : int

Verbosity of info.

kwargs : optional

Arguments passed to print.

one_liner(l2_last, last=False)

Print continuously updated one-liner.

Parameters:

l2_last : float

Current error.

last : bool

If True, adds exit_message and finishes line.