pyissm.model.classes.materials

Classes

composite(*args, **kwargs)

damageice([other])

Damage ice materials parameters class for ISSM.

enhancedice([other])

Enhanced ice materials parameters class for ISSM.

estar([other])

E* (estar) ice materials parameters class for ISSM.

hydro([other])

Hydro materials parameters class for ISSM.

ice([other])

Ice materials parameters class for ISSM.

litho([other])

Lithosphere materials parameters class for ISSM.
class pyissm.model.classes.materials.composite(*args, **kwargs)

Bases: manage_state

class pyissm.model.classes.materials.damageice(other=None)

Bases: manage_state

Damage ice materials parameters class for ISSM.

This class defines the default physical parameters for damage ice used in ISSM.

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.

rho_ice

Ice density [kg/m^3]

Type:

float, default=917.

rho_water

Ocean water density [kg/m^3]

Type:

float, default=1023.

rho_freshwater

Fresh water density [kg/m^3]

Type:

float, default=1000.

mu_water

Water viscosity [N s/m^2]

Type:

float, default=0.001787

heatcapacity

Heat capacity [J/kg/K]

Type:

float, default=2093.

latentheat

Latent heat of fusion [J/m^3]

Type:

float, default=3.34e5

thermalconductivity

Ice thermal conductivity [W/m/K]

Type:

float, default=2.4

temperateiceconductivity

Temperate ice thermal conductivity [W/m/K]

Type:

float, default=0.24

effectiveconductivity_averaging

Computation of effective conductivity: (0) arithmetic mean, (1) harmonic mean, (2) geometric mean

Type:

int, default=1

meltingpoint

Melting point of ice at 1 atm [K]

Type:

float, default=273.15

beta

Rate of change of melting point with pressure [K/Pa]

Type:

float, default=9.8e-8

mixed_layer_capacity

Mixed layer capacity [W/kg/K]

Type:

float, default=3974.

thermal_exchange_velocity

Thermal exchange velocity [m/s]

Type:

float, default=1.00e-4

rheology_B

Flow law parameter [Pa s^(1/n)]

Type:

float, default=np.nan

rheology_n

Glen’s flow law exponent

Type:

float, default=np.nan

rheology_law

Law for the temperature dependence of the rheology: ‘None’, ‘BuddJacka’, ‘Cuffey’, ‘CuffeyTemperate’, ‘Paterson’, ‘Arrhenius’, ‘LliboutryDuval’, ‘NyeCO2’, or ‘NyeH2O’

Type:

str, default=’Paterson’

earth_density

Mantle density [kg/m^3]

Type:

float, default=5512.

__init__(self, other=None)

Initializes the default damage ice material parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the damage ice material 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.materials = pyissm.model.classes.materials.damageice()

check_consistency(md, solution, analyses)

Check consistency of the [materials.damageice] 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, write_type=True)

Marshall [materials.damageice] 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

class pyissm.model.classes.materials.enhancedice(other=None)

Bases: manage_state

Enhanced ice materials parameters class for ISSM.

This class defines the default physical parameters for enhanced ice used in ISSM.

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.

rho_ice

Ice density [kg/m^3]

Type:

float, default=917.

rho_water

Ocean water density [kg/m^3]

Type:

float, default=1023.

rho_freshwater

Fresh water density [kg/m^3]

Type:

float, default=1000.

mu_water

Water viscosity [N s/m^2]

Type:

float, default=0.001787

heatcapacity

Heat capacity [J/kg/K]

Type:

float, default=2093.

latentheat

Latent heat of fusion [J/m^3]

Type:

float, default=3.34e5

thermalconductivity

Ice thermal conductivity [W/m/K]

Type:

float, default=2.4

temperateiceconductivity

Temperate ice thermal conductivity [W/m/K]

Type:

float, default=0.24

effectiveconductivity_averaging

Computation of effective conductivity: (0) arithmetic mean, (1) harmonic mean, (2) geometric mean

Type:

int, default=1

meltingpoint

Melting point of ice at 1 atm [K]

Type:

float, default=273.15

beta

Rate of change of melting point with pressure [K/Pa]

Type:

float, default=9.8e-8

mixed_layer_capacity

Mixed layer capacity [W/kg/K]

Type:

float, default=3974.

thermal_exchange_velocity

Thermal exchange velocity [m/s]

Type:

float, default=1.00e-4

rheology_E

Enhancement factor

Type:

float, default=np.nan

rheology_B

Flow law parameter [Pa s^(1/n)]

Type:

float, default=np.nan

rheology_n

Glen’s flow law exponent

Type:

float, default=np.nan

rheology_law

Law for the temperature dependence of the rheology: ‘None’, ‘BuddJacka’, ‘Cuffey’, ‘CuffeyTemperate’, ‘Paterson’, ‘Arrhenius’, or ‘LliboutryDuval’

Type:

str, default=’Paterson’

earth_density

Mantle density [kg/m^3]

Type:

float, default=5512.

__init__(self, other=None)

Initializes the default enhanced ice material parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the enhanced ice material 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.materials = pyissm.model.classes.materials.enhancedice()

check_consistency(md, solution, analyses)

Check consistency of the [materials.enhancedice] 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, write_type=True)

Marshall [materials.enhancedice] 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

class pyissm.model.classes.materials.estar(other=None)

Bases: manage_state

E* (estar) ice materials parameters class for ISSM.

This class defines the default physical parameters for E* (estar) ice used in ISSM.

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.

rho_ice

Ice density [kg/m^3]

Type:

float, default=917.

rho_water

Ocean water density [kg/m^3]

Type:

float, default=1023.

rho_freshwater

Fresh water density [kg/m^3]

Type:

float, default=1000.

mu_water

Water viscosity [N s/m^2]

Type:

float, default=0.001787

heatcapacity

Heat capacity [J/kg/K]

Type:

float, default=2093.

latentheat

Latent heat of fusion [J/m^3]

Type:

float, default=3.34e5

thermalconductivity

Ice thermal conductivity [W/m/K]

Type:

float, default=2.4

temperateiceconductivity

Temperate ice thermal conductivity [W/m/K]

Type:

float, default=0.24

effectiveconductivity_averaging

Computation of effective conductivity: (0) arithmetic mean, (1) harmonic mean, (2) geometric mean

Type:

int, default=1

meltingpoint

Melting point of ice at 1 atm [K]

Type:

float, default=273.15

beta

Rate of change of melting point with pressure [K/Pa]

Type:

float, default=9.8e-8

mixed_layer_capacity

Mixed layer capacity [W/kg/K]

Type:

float, default=3974.

thermal_exchange_velocity

Thermal exchange velocity [m/s]

Type:

float, default=1.00e-4

rheology_B

Flow law parameter [Pa s^(1/3)]

Type:

ndarray, default=np.nan

rheology_Ec

Compressive enhancement factor

Type:

ndarray, default=np.nan

rheology_Es

Shear enhancement factor

Type:

ndarray, default=np.nan

rheology_law

Law for the temperature dependence of the rheology: ‘None’, ‘BuddJacka’, ‘Cuffey’, ‘CuffeyTemperate’, ‘Paterson’, ‘Arrhenius’, or ‘LliboutryDuval’

Type:

str, default=’Paterson’

earth_density

Mantle density [kg/m^3]

Type:

float, default=5512.

__init__(self, other=None)

Initializes the default E* ice material parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the E* ice material 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.materials = pyissm.model.classes.materials.estar()

check_consistency(md, solution, analyses)

Check consistency of the [materials.estar] 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, write_type=True)

Marshall [materials.estar] 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

class pyissm.model.classes.materials.hydro(other=None)

Bases: manage_state

Hydro materials parameters class for ISSM.

This class defines the default physical parameters for hydro (hydrology) used in ISSM.

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.

rho_ice

Ice density [kg/m^3]

Type:

float, default=917.

rho_water

Ocean water density [kg/m^3]

Type:

float, default=1023.

rho_freshwater

Fresh water density [kg/m^3]

Type:

float, default=1000.

earth_density

Mantle density [kg/m^3]

Type:

float, default=5512.

__init__(self, other=None)

Initializes the default hydro material parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the hydro material 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.materials = pyissm.model.classes.materials.hydro()

check_consistency(md, solution, analyses)

Check consistency of the [materials.hydro] 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, write_type=True)

Marshall [materials.hydro] 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

class pyissm.model.classes.materials.ice(other=None)

Bases: manage_state

Ice materials parameters class for ISSM.

This class defines the default physical parameters for ice used in ISSM.

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.

rho_ice

Ice density [kg/m^3]

Type:

float, default=917.

rho_water

Ocean water density [kg/m^3]

Type:

float, default=1023.

rho_freshwater

Fresh water density [kg/m^3]

Type:

float, default=1000.

mu_water

Water viscosity [N s/m^2]

Type:

float, default=0.001787

heatcapacity

Heat capacity [J/kg/K]

Type:

float, default=2093.

latentheat

Latent heat of fusion [J/m^3]

Type:

float, default=3.34e5

thermalconductivity

Ice thermal conductivity [W/m/K]

Type:

float, default=2.4

temperateiceconductivity

Temperate ice thermal conductivity [W/m/K]

Type:

float, default=0.24

effectiveconductivity_averaging

Computation of effective conductivity: (0) arithmetic mean, (1) harmonic mean, (2) geometric mean

Type:

int, default=1

meltingpoint

Melting point of ice at 1 atm [K]

Type:

float, default=273.15

beta

Rate of change of melting point with pressure [K/Pa]

Type:

float, default=9.8e-8

mixed_layer_capacity

Mixed layer capacity [W/kg/K]

Type:

float, default=3974.

thermal_exchange_velocity

Thermal exchange velocity [m/s]

Type:

float, default=1.00e-4

rheology_law

Law for the temperature dependence of the rheology: ‘None’, ‘BuddJacka’, ‘Cuffey’, ‘CuffeyTemperate’, ‘Paterson’, ‘Arrhenius’, ‘LliboutryDuval’, ‘NyeCO2’, or ‘NyeH2O’

Type:

str, default=’Paterson’

rheology_B

Flow law parameter [Pa s^(1/n)]

Type:

float, default=2.1e8

rheology_n

Glen’s flow law exponent

Type:

float, default=3.

earth_density

Mantle density [kg/m^3]

Type:

float, default=5512.

__init__(self, other=None)

Initializes the default ice material parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the ice material 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.materials = pyissm.model.classes.materials.ice()

check_consistency(md, solution, analyses)

Check consistency of the [materials.ice] 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, write_type=True)

Marshall [materials.ice] 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

class pyissm.model.classes.materials.litho(other=None)

Bases: manage_state

Lithosphere materials parameters class for ISSM.

This class defines the default physical parameters for the lithosphere used in ISSM.

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.

numlayers

Number of layers in the lithosphere model.

Type:

int, default=2

radius

Radii for each interface (numlayers + 1) [m].

Type:

list of float, default=[1e3, 6278e3, 6378e3]

viscosity

Viscosity for each layer (numlayers) [Pa.s].

Type:

list of float, default=[1e21, 1e40]

lame_mu

Shear modulus for each layer (numlayers) [Pa].

Type:

list of float, default=[1.45e11, 6.7e10]

lame_lambda

Lame lambda parameter for each layer (numlayers) [Pa].

Type:

list of float, default=[1.45e11, 6.7e10]

burgers_viscosity

Transient viscosity for Burgers rheologies (numlayers) [Pa.s].

Type:

list of float, default=[np.nan, np.nan]

burgers_mu

Transient shear modulus for Burgers rheologies (numlayers) [Pa].

Type:

list of float, default=[np.nan, np.nan]

ebm_alpha

Exponent parameter for EBM rheology (numlayers).

Type:

list of float, default=[np.nan, np.nan]

ebm_delta

Amplitude of transient relaxation for EBM rheology (numlayers).

Type:

list of float, default=[np.nan, np.nan]

ebm_taul

Starting period for transient relaxation for EBM rheology (numlayers) [s].

Type:

list of float, default=[np.nan, np.nan]

ebm_tauh

End period for transient relaxation for Burgers rheology (numlayers) [s].

Type:

list of float, default=[np.nan, np.nan]

rheologymodel

Rheology model for each layer: Maxwell (0), Burgers (1), or EBM (2).

Type:

list of int, default=[0, 0]

density

Density for each layer (numlayers) [kg/m^3].

Type:

list of float, default=[5.51e3, 5.50e3]

issolid

Whether each layer is solid (1) or liquid (0) (numlayers).

Type:

list of int, default=[1, 1]

earth_density

Mantle density [kg/m^3].

Type:

float, default=5512.

__init__(self, other=None)

Initializes the default lithosphere material parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the lithosphere material 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.materials = pyissm.model.classes.materials.litho()

check_consistency(md, solution, analyses)

Check consistency of the [materials.litho] 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, write_type=True)

Marshall [materials.litho] 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