pyissm.model.classes.calving

Calving classes for ISSM.

Classes

`crevassedepth`([other])	Crevasse depth calving parameters class for ISSM.
`default`([other])	Default calving parameters class for ISSM.
`dev`([other])	Development calving parameters class for ISSM.
`levermann`([other])	Levermann calving parameters class for ISSM.
`minthickness`([other])	Minimum thickness calving parameters class for ISSM.
`parameterization`([other])	Parameterization calving parameters class for ISSM.
`vonmises`([other])	Von Mises calving parameters class for ISSM.

class pyissm.model.classes.calving.crevassedepth(other=None)

Bases: manage_state

Crevasse depth calving parameters class for ISSM.

This class contains the parameters for the crevasse depth calving model in the ISSM framework. It defines parameters related to crevasse opening stress, threshold, and water height.

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.

crevasse_opening_stress

0: stress only in the ice-flow direction, 1: maximum principal stress.

Type:: int, default=1

crevasse_threshold

Ratio of full thickness to calve (e.g. 0.75 is for 75% of the total ice thickness).

Type:: float, default=1.0

water_height

Water height in the crevasse [m].

Type:: float, default=0.0

Examples

>>> md.calving = pyissm.model.classes.calving.crevassedepth()
>>> md.calving.crevasse_opening_stress = 1
>>> md.calving.crevasse_threshold = 0.75
>>> md.calving.water_height = 10.0

check_consistency(md, solution, analyses)

Check consistency of the [calving.crevassedepth] 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

marshall_class(fid, prefix, md=None)

Marshall [calving.crevassedepth] 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.calving.default(other=None)

Bases: manage_state

Default calving parameters class for ISSM.

This class contains the default parameters for calving in the ISSM framework. It defines the calving rate parameter.

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.

calvingrate

Calving rate at given location [m/a].

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

Examples

>>> md.calving = pyissm.model.classes.calving.default()
>>> md.calving.calvingrate = np.zeros(md.mesh.numberofvertices, )

check_consistency(md, solution, analyses)

Check consistency of the [calving.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

marshall_class(fid, prefix, md=None)

Marshall [calving.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.calving.dev(other=None)

Bases: manage_state

Development calving parameters class for ISSM.

This class contains the parameters for the development calving model in the ISSM framework. It defines stress thresholds for grounded and 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.

stress_threshold_groundedice

Maximum stress threshold applied to grounded ice [Pa].

Type:: float, default=1e6

stress_threshold_floatingice

Maximum stress threshold applied to floating ice [Pa].

Type:: float, default=150e3

Examples

>>> md.calving = pyissm.model.classes.calving.dev()
>>> md.calving.stress_threshold_groundedice = 2e6
>>> md.calving.stress_threshold_floatingice = 200e3

check_consistency(md, solution, analyses)

Check consistency of the [calving.dev] 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

marshall_class(fid, prefix, md=None)

Marshall [calving.dev] 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.calving.levermann(other=None)

Bases: manage_state

Levermann calving parameters class for ISSM.

This class contains the parameters for the Levermann calving model in the ISSM framework. It defines the proportionality coefficient used in the Levermann calving law.

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.

coeff

Proportionality coefficient in the Levermann calving model.

Type:: float, default=2e13

Examples

>>> md.calving = pyissm.model.classes.calving.levermann()

check_consistency(md, solution, analyses)

Check consistency of the [calving.levermann] 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

marshall_class(fid, prefix, md=None)

Marshall [calving.levermann] 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.calving.minthickness(other=None)

Bases: manage_state

Minimum thickness calving parameters class for ISSM.

This class contains the parameters for the minimum thickness calving model in the ISSM framework. It defines the minimum ice thickness below which no ice is allowed.

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.

min_thickness

Minimum thickness below which no ice is allowed [m].

Type:: class:float, default=100.

Examples

>>> md.calving = pyissm.model.classes.calving.minthickness()

check_consistency(md, solution, analyses)

Check consistency of the [calving.minthickness] 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

marshall_class(fid, prefix, md=None)

Marshall [calving.minthickness] 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.calving.parameterization(other=None)

Bases: manage_state

Parameterization calving parameters class for ISSM.

This class contains the parameters for the parameterization calving model in the ISSM framework. It defines parameters controlling the calving rate as a function of ice thickness, velocity, and other factors.

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.

min_thickness

Minimum thickness below which no ice is allowed [m].

Type:: float, default=0.

use_param

Parameterization mode selector:

-1: use frontal ablation rate,: 0: linear function, 1: tanh function, 2: tanh(thickness), 3: tanh(normalized velocity), 4: tanh(truncated velocity), 5: linear(truncated velocity).

Type:: float, default=0.

theta

Amplifier parameter for the calving law.

Type:: float, default=0.

alpha

Slope parameter for the calving law.

Type:: float, default=0.

xoffset

Offset in x-axis for the calving law.

Type:: float, default=0.

yoffset

Offset in y-axis for the calving law.

Type:: float, default=0.

vel_upperbound

Upper bound of ice velocity to reduce the calving rate [m/a].

Type:: float, default=6000.

vel_threshold

Threshold of ice velocity to reduce the calving rate [m/a].

Type:: float, default=0.

vel_lowerbound

Lower bound of ice velocity to reduce the calving rate [m/a].

Type:: float, default=0.

Examples

>>> md.calving = pyissm.model.classes.calving.parameterization()
>>> md.calving.min_thickness = 50.
>>> md.calving.use_param = 1
>>> md.calving.theta = 2.0
>>> md.calving.alpha = 0.01
>>> md.calving.xoffset = 10.0
>>> md.calving.yoffset = 0.5
>>> md.calving.vel_upperbound = 5000.
>>> md.calving.vel_threshold = 1000.
>>> md.calving.vel_lowerbound = 100.

check_consistency(md, solution, analyses)

Check consistency of the [calving.parameterization] 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

marshall_class(fid, prefix, md=None)

Marshall [calving.parametrization] 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.calving.vonmises(other=None)

Bases: manage_state

Von Mises calving parameters class for ISSM.

This class contains the parameters for the Von Mises calving model in the ISSM framework. It defines stress thresholds for grounded and floating ice, as well as the minimum ice thickness below which no ice is allowed.

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.

stress_threshold_groundedice

Maximum Von Mises stress threshold applied to grounded ice [Pa].

Type:: float, default=0

stress_threshold_floatingice

Maximum Von Mises stress threshold applied to floating ice [Pa].

Type:: float, default=0

min_thickness

Minimum thickness below which no ice is allowed [m].

Type:: float, default=0.

Examples

>>> md.calving = pyissm.model.classes.calving.vonmises()
>>> md.calving.stress_threshold_groundedice = 1e6
>>> md.calving.stress_threshold_floatingice = 150e3
>>> md.calving.min_thickness = 50.

check_consistency(md, solution, analyses)

Check consistency of the [calving.vonmises] 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

marshall_class(fid, prefix, md=None)

Marshall [calving.vonmises] 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