pyissm.model.classes.basalforcings

Basal forcings classes for ISSM.

Classes

`beckmanngoosse`([other])	Beckmann-Goosse basal melt rate parameterization class for ISSM.
`default`([other])	Default basal forcings parameters class for ISSM.
`ismip6`([other])	ISMIP6 basal melt rate parameterization class for ISSM.
`linear`([other])	Linear basal forcings parameters class for ISSM.
`lineararma`([other])	Linear ARMA basal forcings parameters class for ISSM.
`mismip`([other])	MISMIP basal forcings parameters class for ISSM.
`pico`([other])	Potsdam Ice-shelf Cavity mOdel (PICO) basal forcings parameters class for ISSM.
`plume`([other])	Plume basal forcings parameters class for ISSM.
`spatiallinear`([other])	Spatial linear basal forcings parameters class for ISSM.

class pyissm.model.classes.basalforcings.beckmanngoosse(other=None)

Bases: manage_state

Beckmann-Goosse basal melt rate parameterization class for ISSM.

This class contains the parameters for the Beckmann-Goosse basal melt parameterization in the ISSM framework. It computes sub-shelf melt rates from ocean temperature and salinity (or thermal forcing directly).

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

geothermalflux

Geothermal heat flux [W/m^2].

Type:: float, default=np.nan

meltrate_factor

Melt rate factor [unitless].

Type:: float, default=0.5

ocean_temp

Ocean temperature [degrees C].

Type:: float, default=0.

ocean_salinity

Ocean salinity [psu].

Type:: numpy.ndarray, default=np.nan

ocean_thermalforcing

Ocean thermal forcing [K].

Type:: numpy.ndarray, default=np.nan

isthermalforcing

Boolean (0 or 1) indicating whether thermal forcing is provided directly.

Type:: int, default=0

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.beckmanngoosse()
>>> md.basalforcings.ocean_temp = -1.7 * np.ones((md.mesh.numberofvertices,))
>>> md.basalforcings.ocean_salinity = 35.0 * np.ones((md.mesh.numberofvertices,))
>>> md.basalforcings.meltrate_factor = 1.

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.beckmanngoosse] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.beckmanngoosse] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.beckmanngoosse()
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.beckmanngoosse] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.default(other=None)

Bases: manage_state

Default basal forcings parameters class for ISSM.

This class contains the default parameters for basal forcings in the ISSM framework. It defines the melting rates for grounded and floating ice, perturbation melting rate, and geothermal heat flux.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

floatingice_melting_rate

Basal melting rate for floating ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

perturbation_melting_rate

Optional perturbation in basal melting rate under floating ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

geothermalflux

Geothermal heat flux [W/m^2].

Type:: float, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.default()
>>> md.basalforcings.groundedice_melting_rate = np.zeros(md.mesh.numberofvertices,)
>>> md.basalforcings.floatingice_melting_rate = np.ones(md.mesh.numberofvertices,) * 2

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.default] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.default] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.default()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.default] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.ismip6(other=None)

Bases: manage_state

ISMIP6 basal melt rate parameterization class for ISSM.

This class contains the parameters for the ISMIP6 basal melt parameterization in the ISSM framework. It defines ocean thermal forcing fields by depth layer and basin, allowing depth- and basin-dependent computation of basal melt rates beneath floating ice.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

num_basins

Number of basins the model domain is partitioned into [unitless].

Type:: int, default=0

basin_id

Basin number assigned to each element [unitless].

Type:: numpy.ndarray, default=np.nan

gamma_0

Melt rate coefficient [m/yr].

Type:: float, default=14477.

tf

Thermal forcing (ocean temperature minus freezing point) [degrees C]. List of arrays of shape (numberofvertices+1, ntimes) for each depth layer.

Type:: list of numpy.ndarray, default=np.nan

tf_depths

Elevation of vertical layers in ocean thermal forcing dataset [m].

Type:: numpy.ndarray, default=np.nan

delta_t

Ocean temperature correction per basin [degrees C].

Type:: numpy.ndarray, default=np.nan

islocal

Boolean (0 or 1) to use local ISMIP6 melt rate parameterization (default false).

Type:: int, default=0

geothermalflux

Geothermal heat flux [W/m^2].

Type:: float, default=np.nan

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

melt_anomaly

Floating ice basal melt anomaly [m/yr].

Type:: numpy.ndarray, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.ismip6()
>>> md.basalforcings.num_basins = 2
>>> md.basalforcings.gamma_0 = 14477.

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.ismip6] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.ismip6] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.ismip6()
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.ismip6] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.linear(other=None)

Bases: manage_state

Linear basal forcings parameters class for ISSM.

This class contains the parameters for linear basal forcings in the ISSM framework. It defines the melting rates for deep and upper water, grounded ice, and geothermal flux, allowing for a depth-dependent representation of basal melting processes.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

deepwater_melting_rate

Basal melting rate applied for floating ice with base < deepwater_elevation [m/yr].

Type:: float, default=0.

deepwater_elevation

Elevation threshold for deepwater melting rate [m].

Type:: float, default=0.

upperwater_melting_rate

Basal melting rate applied for floating ice with base >= upperwater_elevation [m/yr].

Type:: float, default=0.

upperwater_elevation

Elevation threshold for upperwater melting rate [m].

Type:: float, default=0.

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

perturbation_melting_rate

Perturbation applied to computed melting rate (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

geothermalflux

Geothermal heat flux [W/m^2].

Type:: float, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.linear()
>>> md.basalforcings.deepwater_melting_rate = 1.5
>>> md.basalforcings.deepwater_elevation = -500
>>> md.basalforcings.upperwater_melting_rate = 0.5
>>> md.basalforcings.upperwater_elevation = -200

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.linear] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.linear] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.linear()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.linear] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.lineararma(other=None)

Bases: manage_state

Linear ARMA basal forcings parameters class for ISSM.

This class contains the parameters for linear ARMA basal forcings in the ISSM framework. It defines the structure for piecewise polynomial parameters, autoregressive and moving-average coefficients, and various melting rates and elevations for different basins.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

num_basins

Number of different basins [unitless].

Type:: int, default=0

num_params

Number of different parameters in the piecewise-polynomial (1:intercept only, 2:with linear trend, 3:with quadratic trend, etc.).

Type:: int, default=0

num_breaks

Number of different breakpoints in the piecewise-polynomial (separating num_breaks+1 periods).

Type:: int, default=0

polynomialparams

Coefficients for the polynomial (const, trend, quadratic, etc.), dim1 for basins, dim2 for periods, dim3 for orders.

Type:: numpy.ndarray, default=np.nan

datebreaks

Dates at which the breakpoints in the piecewise polynomial occur (1 row per basin) [yr].

Type:: numpy.ndarray, default=np.nan

ar_order

Order of the autoregressive model [unitless].

Type:: float, default=0.

ma_order

Order of the moving-average model [unitless].

Type:: float, default=0.

arma_timestep

Time resolution of the ARMA model [yr].

Type:: int, default=0

arlag_coefs

Basin-specific vectors of AR lag coefficients [unitless].

Type:: numpy.ndarray, default=np.nan

malag_coefs

Basin-specific vectors of MA lag coefficients [unitless].

Type:: numpy.ndarray, default=np.nan

basin_id

Basin number assigned to each element [unitless].

Type:: numpy.ndarray, default=np.nan

groundedice_melting_rate

Node-specific basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

deepwater_elevation

Basin-specific elevation of ocean deepwater [m].

Type:: numpy.ndarray, default=np.nan

upperwater_melting_rate

Basin-specific basal melting rate (positive if melting applied for floating ice with base >= upperwater_elevation) [m/yr].

Type:: numpy.ndarray, default=np.nan

upperwater_elevation

Basin-specific elevation of ocean upperwater [m].

Type:: numpy.ndarray, default=np.nan

geothermalflux

Node-specific geothermal heat flux [W/m^2].

Type:: numpy.ndarray, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.lineararma()

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.lineararma] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.lineararma] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.lineararma()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.lineararma] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.mismip(other=None)

Bases: manage_state

MISMIP basal forcings parameters class for ISSM.

This class contains the parameters for the MISMIP basal melt parameterization in the ISSM framework. It defines the basal melting rate for grounded ice, a melt rate factor, a threshold thickness for saturation of basal melting, an upper depth above which the melt rate is zero, and geothermal heat flux.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

meltrate_factor

Melt-rate factor [1/yr] (sign is opposite to MISMIP+ benchmark to remain consistent with ISSM convention of positive values for melting).

Type:: float, default=0.2

threshold_thickness

Threshold thickness for saturation of basal melting [m].

Type:: float, default=75.

upperdepth_melt

Depth above which melt rate is zero [m].

Type:: float, default=-100.

geothermalflux

Geothermal heat flux [W/m^2].

Type:: float, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.mismip()
>>> md.basalforcings.groundedice_melting_rate = np.zeros(md.mesh.numberofvertices,)
>>> md.basalforcings.meltrate_factor = 0.2
>>> md.basalforcings.threshold_thickness = 75.
>>> md.basalforcings.upperdepth_melt = -100.

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.mismip] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.mismip] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.mismip()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.mismip] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.pico(other=None)

Bases: manage_state

Potsdam Ice-shelf Cavity mOdel (PICO) basal forcings parameters class for ISSM.

This class contains the parameters for the PICO basal melt parameterization in the ISSM framework. It defines the structure of the ice shelf cavities, including the number of basins, basin IDs, and various parameters related to ocean temperature, salinity, and melting rates.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

num_basins

Number of basins the model domain is partitioned into [unitless].

Type:: int, default=0

basin_id

Basin number assigned to each node [unitless].

Type:: numpy.ndarray, default=np.nan

maxboxcount

Maximum number of boxes initialized under all ice shelves.

Type:: int, default=0

overturning_coeff

Overturning strength [m^3/s].

Type:: float, default=np.nan

gamma_T

Turbulent temperature exchange velocity [m/s].

Type:: float, default=0.

farocean_temperature

Depth averaged ocean temperature in front of the ice shelf for each basin [K].

Type:: numpy.ndarray, default=np.nan

farocean_salinity

Depth averaged ocean salinity in front of the ice shelf for each basin [psu].

Type:: numpy.ndarray, default=np.nan

isplume

Boolean (0 or 1) to use buoyant plume melt rate parameterization from Lazeroms et al., 2018 (default false).

Type:: int, default=0

geothermalflux

Geothermal heat flux [W/m^2].

Type:: float, default=np.nan

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.pico()
>>> md.basalforcings.num_basins = 3
>>> md.basalforcings.basin_id = np.array([1, 2, 3])
>>> md.basalforcings.farocean_temperature = np.array([273.15, 273.2, 273.1])

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.pico] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.pico] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.pico()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.pico] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.plume(other=None)

Bases: manage_state

Plume basal forcings parameters class for ISSM.

This class contains the parameters for plume basal forcings in the ISSM framework. It defines the structure of the mantle plume, including its radius, depth, and position, as well as parameters related to geothermal heat flux and melting rates.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

floatingice_melting_rate

Basal melting rate for floating ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

mantleconductivity

Mantle heat conductivity [W/m^3].

Type:: float, default=2.2

nusselt

Nusselt number, ratio of mantle to plume [1].

Type:: float, default=300

dtbg

Background temperature gradient [degree/m].

Type:: float, default=0.011

plumeradius

Radius of the mantle plume [m].

Type:: float, default=100000

topplumedepth

Depth of the mantle plume top below the crust [m].

Type:: float, default=10000

bottomplumedepth

Depth of the mantle plume base below the crust [m].

Type:: float, default=1050000

plumex

x coordinate of the center of the plume [m].

Type:: float, default=np.nan

plumey

y coordinate of the center of the plume [m].

Type:: float, default=np.nan

crustthickness

Thickness of the crust [m].

Type:: float, default=30000

uppercrustthickness

Thickness of the upper crust [m].

Type:: float, default=14000

uppercrustheat

Volumic heat of the upper crust [W/m^3].

Type:: float, default=1.7e-6

lowercrustheat

Volumic heat of the lower crust [W/m^3].

Type:: float, default=0.4e-6

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.plume()
>>> md.basalforcings.groundedice_melting_rate = np.zeros(md.mesh.numberofvertices, )
>>> md.basalforcings.floatingice_melting_rate = np.ones(md.mesh.numberofvertices, ) * 2

checkconsistency(md, solution, analyses)

Check consistency of the [basalforcings.plume] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.plume] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.plume()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.plume] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.basalforcings.spatiallinear(other=None)

Bases: manage_state

Spatial linear basal forcings parameters class for ISSM.

This class contains the parameters for spatial linear basal forcings in the ISSM framework. It defines the melting rates for grounded ice, deepwater, and upperwater, as well as geothermal heat flux and perturbation melting rate.

Parameters:: other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

groundedice_melting_rate

Basal melting rate for grounded ice (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

deepwater_melting_rate

Basal melting rate applied for floating ice with base < deepwater_elevation [m/yr].

Type:: numpy.ndarray, default=np.nan

deepwater_elevation

Elevation threshold for deepwater melting rate [m].

Type:: numpy.ndarray, default=np.nan

upperwater_melting_rate

Basal melting rate applied for floating ice with base >= upperwater_elevation [m/yr].

Type:: numpy.ndarray, default=np.nan

upperwater_elevation

Elevation threshold for upperwater melting rate [m].

Type:: numpy.ndarray, default=np.nan

geothermalflux

Geothermal heat flux [W/m^2].

Type:: numpy.ndarray, default=np.nan

perturbation_melting_rate

Basal melting rate perturbation added to computed melting rate (positive if melting) [m/yr].

Type:: numpy.ndarray, default=np.nan

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.spatiallinear()

check_consistency(md, solution, analyses)

Check consistency of the [basalforcings.spatiallinear] parameters.

Parameters:

md (pyissm.model.Model) – The model object to check.
solution (str) – The solution name to check.
analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [basalforcings.spatiallinear] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.basalforcings = pyissm.model.classes.basalforcings.spatiallinear()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.basalforcings.initialize(md)

marshall_class(fid, prefix, md=None)

Marshall [basalforcings.spatiallinear] parameters to a binary file.

Parameters:

fid (file object) – The file object to write the binary data to.
prefix (str) – Prefix string used for data identification in the binary file.
md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None