pyissm.model.classes.results

Classes

default()	Default results container class for ISSM.
resultsdakota()	Results container class for Dakota-based ISSM runs.
solution(*args)	Results container class for ISSM solution steps.
solutionstep()	Results container class for a single ISSM solution step.

class pyissm.model.classes.results.default

Bases: manage_state

Default results container class for ISSM.

This class serves as the default results container in the ISSM (Ice Sheet System Model) framework. It stores simulation results and provides methods for displaying and accessing the stored data. The class dynamically stores results as attributes and provides formatted string representations of the results structure.

Parameters:

None

__init__(self)

Initializes the default results container.

__repr__(self)

Returns a detailed string representation of the results structure showing field names and sizes.

__str__(self)

Returns a short string identifying the class.

Notes

This class dynamically stores results as attributes. The actual attributes depend on the simulation type and requested outputs. Common attributes may include velocity fields, thickness, pressure, temperature, and other solution variables.

Examples

results = pyissm.model.classes.results.default()

check_consistency(md, solution, analyses)

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

class pyissm.model.classes.results.resultsdakota

Bases: manage_state

Results container class for Dakota-based ISSM runs.

This class is designed to store and manage results from Dakota uncertainty quantification or optimization runs within the ISSM (Ice Sheet System Model) framework. It dynamically stores results as attributes, which may include lists of results for each Dakota evaluation, summary statistics, or other relevant data.

Parameters:

None

__init__(self)

Initializes the resultsdakota container.

__repr__(self)

Returns a string representation of the results structure showing field names and summary information.

__str__(self)

Returns a short string identifying the class.

Notes

This class is typically used when ISSM is run in conjunction with Dakota for parameter studies, uncertainty quantification, or optimization. The actual attributes depend on the Dakota study configuration and requested outputs.

Examples

results = pyissm.model.classes.results.resultsdakota()

check_consistency(md, solution, analyses)

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

class pyissm.model.classes.results.solution(*args)

Bases: manage_state

Results container class for ISSM solution steps.

This class is designed to store and manage the results of solution steps within the ISSM (Ice Sheet System Model) framework. Each instance contains a list of solution steps, where each step holds the results for a particular time or iteration in the simulation.

Parameters:

args (list, optional) – If provided, should be a list of solutionstep instances. If not provided, initializes with a single default solutionstep.

steps

List containing the solution steps for the simulation.

Type:

list of solutionstep

__init__(self, \*args)

Initializes the solution container, optionally with a list of solutionstep instances.

__repr__(self)

Returns a string representation of the solution structure, showing field names and values.

__str__(self)

Returns a short string identifying the class.

Notes

This class is typically used to organize results from time-dependent or iterative ISSM simulations. Each solutionstep instance in the steps list contains the results for a single step.

Examples

results = pyissm.model.classes.results.solution()

check_consistency(md, solution, analyses)

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

class pyissm.model.classes.results.solutionstep

Bases: manage_state

Results container class for a single ISSM solution step.

This class is designed to store and manage the results for a single solution step within the ISSM (Ice Sheet System Model) framework. Each instance holds the results for a particular time or iteration in the simulation, such as velocity, thickness, temperature, or other relevant fields.

Parameters:

None

(Dynamic)

Attributes are dynamically assigned based on the simulation outputs for this step. Typical attributes may include velocity, thickness, pressure, temperature, etc.

__init__(self)

Initializes the solutionstep container.

__repr__(self)

Returns a string representation of the solutionstep structure, showing field names and values.

__str__(self)

Returns a short string identifying the class.

Notes

This class is typically used as an element of the steps list in the solution class, representing a single time step or iteration.

Examples

step = pyissm.model.classes.results.solutionstep()

check_consistency(md, solution, analyses)

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

get_fieldnames()