pyshqg.core.source module

Submodule dedicated to sources.

class pyshqg.core.source.QGForcing(backend, forcing)

Bases: object

Class for a standard, constant forcing.

forcing

Forcing coefficients in grid space.

Type:

backend array, shape (Nlevel, Nlat, Nlon)

__init__(backend, forcing)

Constructor for the forcing.

Parameters:

• backend (pyshqg.backend.Backend object) – The backend.

• forcing (numpy.ndarray, shape (Nlevel, Nlat, Nlon)) – Forcing coefficients in grid space.

compute_forcing()

Computes the forcing

Note that the forcing coefficients have been pre-computed in the grid.

Returns:

forcing – Forcing coefficients in grid space.

Return type:

backend array, shape (Nlevel, Nlat, Nlon)