pyissm.model.classes.mask

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

Bases: manage_state

Mask parameters class for ISSM.

This class encapsulates mask parameters for the ISSM (Ice Sheet System Model) framework. It defines level-set functions that determine the presence of ice and ocean, allowing for precise tracking of ice fronts, coastlines, and grounding lines using signed distance functions.

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.

ice_levelset

Level-set function for ice: presence of ice if < 0, icefront position if = 0, no ice if > 0.

Type:

ndarray, default=nan

ocean_levelset

Level-set function for ocean: presence of ocean if < 0, coastline/grounding line if = 0, no ocean if > 0.

Type:

ndarray, default=nan

__init__(self, other=None)

Initializes the mask parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the mask parameters.

__str__(self)

Returns a short string identifying the class.

marshall_class(self, fid, prefix, md=None)

Marshall parameters to a binary file

Examples

md.mask = pyissm.model.classes.mask() md.mask.ice_levelset = ice_levelset_field md.mask.ocean_levelset = ocean_levelset_field

__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 [mask.mask] parameters.

issm_enum_string()

Default ISSM C++ enum string used during marshalling.

marshall_class(fid, prefix[, md])

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

Check consistency of the [mask.mask] 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 [mask.mask] 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 (ISSM model object, optional.) – ISSM model object needed in some cases.

Return type:

None