pyissm.model.classes.private

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

Bases: manage_state

Private parameters class for ISSM.

This class encapsulates internal parameters used by the ISSM (Ice Sheet System Model) framework. These parameters are not intended to be modified directly by users and are primarily used for managing model consistency, runtime information, mesh properties, and solution type.

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.

isconsistent

Indicates whether the model is self-consistent.

Type:: bool, default=1

runtimename

Name of the run launched.

Type:: str, default=’’

bamg

Structure with mesh properties constructed if BAMG is used to mesh the domain.

Type:: collections.OrderedDict, default=OrderedDict()

solution

Type of solution launched.

Type:: str, default=’’

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

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

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

Examples

md.private = pyissm.model.classes.private() md.private.runtimename = ‘experiment_001’ md.private.solution = ‘StressBalance’

__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 [private.private] parameters.
`issm_enum_string`()	Default ISSM C++ enum string used during marshalling.

check_consistency(md, solution, analyses)

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