pyissm.model.classes.groundingline

class pyissm.model.classes.groundingline(other=None)

Bases: manage_state

Grounding line migration class for ISSM.

This class contains parameters for configuring grounding line migration in the ISSM framework. It controls how the grounding line (boundary between grounded and floating ice) moves during simulations, including migration methods and interpolation schemes for friction and melting on partially floating elements.

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.

migration

Type of grounding line migration: ‘SoftMigration’, ‘SubelementMigration’, ‘AggressiveMigration’, ‘Contact’, ‘None’.

Type:

str, default=’SubelementMigration’

friction_interpolation

Type of friction interpolation on partially floating elements: ‘SubelementFriction1’, ‘SubelementFriction2’, ‘NoFrictionOnPartiallyFloating’.

Type:

str, default=’SubelementFriction1’

melt_interpolation

Type of melt interpolation on partially floating elements: ‘SubelementMelt1’, ‘SubelementMelt2’, ‘IntrusionMelt’, ‘NoMeltOnPartiallyFloating’, ‘FullMeltOnPartiallyFloating’.

Type:

str, default=’NoMeltOnPartiallyFloating’

intrusion_distance

Distance of seawater intrusion from grounding line [m].

Type:

float, default=0

requested_outputs

Additional outputs requested for grounding line analysis.

Type:

list, default=[‘default’]

Examples

>>> md.groundingline = pyissm.model.classes.groundingline()
>>> md.groundingline.migration = 'AggressiveMigration'
>>> md.groundingline.friction_interpolation = 'SubelementFriction2'
>>> md.groundingline.melt_interpolation = 'SubelementMelt1'
__init__(other=None)

Initialize the instance with optional field inheritance.

Parameters:

other (object, optional) – Another instance to inherit field values from. If provided, any fields in the current instance that differ from the default values and exist in ‘other’ will be replaced with the values from ‘other’.

Notes

The inheritance process:

  1. Iterates through all attributes of the current instance

  2. Checks if the same attribute exists in the ‘other’ instance

  3. Compares field values using _fields_equal()

  4. If different, replaces the current value with the ‘other’ value

This enables the common ISSM pattern where classes can inherit configurations from existing instances while maintaining their default values for unspecified fields.

Methods

__init__([other])

Initialize the instance with optional field inheritance.

check_consistency(md, solution, analyses)

Check consistency of the [groundingline] parameters.

issm_enum_string()

Default ISSM C++ enum string used during marshalling.

marshall_class(fid, prefix[, md])

Marshall [groundingline.groundingline] parameters to a binary file.
check_consistency(md, solution, analyses)

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