pyissm.model.classes.nodalvalue

Classes

nodalvalue([other])

Nodal value parameters class for ISSM.
class pyissm.model.classes.nodalvalue.nodalvalue(other=None)

Bases: manage_state

Nodal value parameters class for ISSM.

This class encapsulates parameters for extracting nodal values from ISSM (Ice Sheet System Model) simulations. It allows users to specify particular nodes or vertices from which to extract field values during the simulation, providing a way to monitor specific locations over time.

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.

name

Identifier for this nodalvalue response.

Type:

str, default=’’

definitionstring

String that identifies this output definition uniquely, from ‘Outputdefinition[1-10]’.

Type:

str, default=’’

model_string

String for field that is being retrieved.

Type:

str, default=’’

node

Vertex index at which we retrieve the value.

Type:

float, default=nan

__init__(self, other=None)

Initializes the nodalvalue parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the nodalvalue 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.nodalvalue = pyissm.model.classes.nodalvalue() md.nodalvalue.name = ‘velocity_at_glacier_terminus’ md.nodalvalue.model_string = ‘Vel’ md.nodalvalue.node = 1245

check_consistency(md, solution, analyses)

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