pyissm.model.classes.masstransport

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

Bases: manage_state

Mass transport solution parameters class for ISSM.

This class encapsulates parameters for configuring mass transport simulations in the ISSM (Ice Sheet System Model) framework. It controls ice thickness evolution, free surface behavior, stabilization methods, and hydrostatic adjustments for both 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.

spcthickness

Thickness constraints (NaN means no constraint) [m].

Type:: ndarray, default=nan

isfreesurface

Do we use free surfaces (FS only) or mass conservation.

Type:: int, default=0

min_thickness

Minimum ice thickness allowed [m].

Type:: float, default=1.0

hydrostatic_adjustment

Adjustment of ice shelves surface and bed elevations: ‘Incremental’ or ‘Absolute’.

Type:: str, default=’Absolute’

stabilization

Stabilization method: 0=no stabilization, 1=artificial diffusion, 2=streamline upwinding, 3=discontinuous Galerkin, 4=flux corrected transport, 5=streamline upwind Petrov-Galerkin (SUPG).

Type:: int, default=1

vertex_pairing

Vertex pairing parameter. Used during consistency checks.

Type:: float, default=nan

penalty_factor

Penalty factor for constraint enforcement.

Type:: float, default=3

requested_outputs

Additional outputs requested.

Type:: list, default=[‘default’]

__init__(self, other=None): Initializes the masstransport parameters, optionally inheriting from another instance.

__repr__(self): Returns a detailed string representation of the masstransport parameters.

__str__(self): Returns a short string identifying the class.

process_outputs(self, md=None, return_default_outputs=False): Process requested outputs, expanding ‘default’ to appropriate outputs.

marshall_class(self, fid, prefix, md=None): Marshall parameters to a binary file

Examples

md.masstransport = pyissm.model.classes.masstransport() md.masstransport.min_thickness = 10.0 md.masstransport.stabilization = 2 md.masstransport.hydrostatic_adjustment = ‘Incremental’

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

check_consistency(md, solution, analyses)

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