pyissm.model.classes.geometry

class pyissm.model.classes.geometry(other=None)

Bases: manage_state

Geometry class for ISSM.

This class contains geometric parameters that define the ice sheet geometry in the ISSM framework. It stores elevation data for ice surface, thickness, base, and bed.

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.

surface

Ice upper surface elevation [m].

Type:: ndarray, default=np.nan

thickness

Ice thickness [m].

Type:: ndarray, default=np.nan

base

Ice base elevation [m].

Type:: ndarray, default=np.nan

bed

Bed elevation [m].

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

hydrostatic_ratio

Hydrostatic ratio for floating ice.

Type:: float, default=nan

Examples

>>> md.geometry = pyissm.model.classes.geometry()
>>> md.geometry.surface = surface_elevation
>>> md.geometry.thickness = ice_thickness
>>> md.geometry.bed = bed_elevation

__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:

Iterates through all attributes of the current instance

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

Compares field values using _fields_equal()

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 [geometry] parameters.
`issm_enum_string`()	Default ISSM C++ enum string used during marshalling.
`marshall_class`(fid, prefix[, md])	Marshall [geometry.geometry] parameters to a binary file.

check_consistency(md, solution, analyses)

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